POST
/
irt
/
transfer

Headers

ApiKey
string
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.

MerchantId
string
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
enum<string>
required

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

Available options:
live,
sandbox

Body

application/json
reference
string
required

A reference provided by the client during the creation of this Transfer

amount
number
required

Amount intended to be sent to the recipient. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).

currency
string
required

Three-letter ISO currency code.

description
string
required

An arbitrary string attached to the Transfer. Mostly useful for displaying to user.

destination
object
required

Information about the recipient of this Transfer

overrideBusinessName
string

This field is mandatory for aggregators and allows you to override the business name displayed to the end users. This is useful if you don't want your clients to see "Hub2" as the target of their payment but your company name instead.

forexRate
string

Forex rate between corridors

srcCountry
string
required

sourceCountry

srcZone
string
required

Zone of the source country

srcOperator
string
required

source provider

srcCurrency
string
required

currency of source country

srcAmount
number
required

amount at the originating transaction

srcOriginFunds
string
required

origin of funds

Response

201 - application/json
id
string
required

Unique identifier for the Transfer

merchantId
string
required

Identifier of the merchant owning this Transfer

createdAt
string
required

Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.

updatedAt
string
required

Datetime in UTC timezone at which this object was updated for the last time . Follows the Datetime ISO.

reference
string
required

A reference provided by the client during the creation of this Transfer

description
string
required

An arbitrary string attached to the Transfer. Mostly useful for displaying to user.

status
enum<string>
required

The current status of this Transfer

Available options:
created,
successful,
pending,
failed
amount
number
required

Amount intended to be sent to the recipient. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency).

currency
string
required

Three-letter ISO currency code.

mode
enum<string>
required

Mode in which this transfer exists. The sandbox mode can be used during the integration phase and is available as soon as the merchant account is created. No real transactions are made in this mode. The live mode has to be used to make real transactions.

Available options:
live,
sandbox
destination
object
required

Information about the recipient of this Transfer

fees
object[]
required

Fees applied to merchant's transfer-account uppon success

failureCause
object

In case of failure, this object will describe the reason of the failure

origin
object

Information about the origin of this transfer

overrideBusinessName
string

override business name for aggregator

overrideBusinessId
string

override business id for merchant

isIrt
boolean
required

indicate if the transfer was international

providerReference
string
required

provider reference that identify this transfer

Retrieve a IRT transfers collectionRetrieve a Transfer collection