HUhub2
IRT

Retrieve a cross-border transactions collection

Changed on

Returns your own cross-border transactions, most recent first. Optionally filtered by period (from/to) or current state.

get/irt/v1/transactions

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Query parameters

state'created' | 'pending' | 'compliance_review' | 'pending_manual' | 'successful' | 'failed' | 'cancelled'
Example:pending

Restrict the result to transactions currently in this state.

tostring
Example:2020-10-15T12:09:49.355Z

A date in UTC timezone to filters data to, inclusively. Follows the Datetime ISO. The default value is now().

fromstring
Example:2020-10-15T12:09:49.355Z

A date in UTC timezone to filters data from, inclusively. Follows the Datetime ISO. The default value is the first day of this month.

pagenumber
Example:2

The page number in the returned data. The default value is 1. Do use with 'perPage' query parameter to paginate properly.

perPagenumber
Example:5

The maximum number of results that will be return. The default value is 10. Do use with 'page' query parameter to paginate properly.

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

idstring required

Hub2 transaction identifier

externalIdstring required

Merchant-owned idempotency key echoed back

status'created' | 'pending' | 'compliance_review' | 'pending_manual' | 'successful' | 'failed' | 'cancelled' required

Current state. A successful create-and-fund returns pending: the float is reserved and the payout is on its way.

senderIdstring required

Registered sender the payout was initiated for

corridorstring required

Corridor the payout was priced on

rail'mobile_wallet' | 'bank_transfer' required

Last-mile rail

inputCurrencystring required

Input currency, ISO 4217

inputAmountstring required

Amount sent, exact decimal string. This is the amount converted and paid out — the Hub2 fee is charged on top of it, so the float is debited inputAmount plus hub2Fee.

outputCurrencystring required

Output currency, ISO 4217

outputAmountstring required

Amount the recipient receives, frozen at funding. Priced on the full inputAmount — the Hub2 fee is additive and never reduces it.

hub2Feestring required

Total Hub2 fee applied, frozen at funding. The sum of the fees lines. Charged in addition to inputAmount, not deducted from it.

hub2Ratestring required

Exchange rate applied, frozen at funding and never recalculated

descriptionstring

Free-text description carried on the transaction

createdAtstring required

Creation timestamp, ISO 8601

updatedAtstring required

Timestamp of the last state change, ISO 8601. Equal to "createdAt" until the transaction first moves, so a lookup can tell a payout still awaiting its partner from one that settled without a webhook arriving.

idempotentReplaytrue

Present, and true, only when the response replays an existing payout (idempotent replay, HTTP 200 with the X-Idempotent-Replay: true header). Absent when the transaction has just been created.

Example response

[
  {
    "id": "cbt_V1StGXR8Z5jdHi6BmyT",
    "externalId": "MTO-TX-00123",
    "status": "pending",
    "senderId": "snd_V1StGXR8Z5jdHi6BmyT",
    "corridor": "XOF_MOBILE_SENEGAL",
    "rail": "mobile_wallet",
    "inputCurrency": "EUR",
    "inputAmount": "200",
    "outputCurrency": "XOF",
    "outputAmount": "129223",
    "hub2Fee": "10.00",
    "fees": [
      {
        "id": "fee_V1StGXR8Z5jdHi6BmyT",
        "rate": "5.00",
        "type": "percent",
        "amount": "10.00",
        "currency": "EUR",
        "taxes": [
          {
            "id": "tax_V1StGXR8Z5jdHi6BmyT",
            "taxType": "tva",
            "type": "percent",
            "value": "18.00"
          }
        ]
      }
    ],
    "hub2Rate": "646.1176450000",
    "failureCause": {
      "code": "insufficient_funds"
    },
    "duplicateConfirmation": {
      "rejectionId": "ndr_V1StGXR8_Z5jdHi6B-myT"
    },
    "idempotentReplay": true
  }
]

Changes