Skip to main content
POST
Create a deposit

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
amount
number
required

The amount to deposit

Example:

1000

currency
string
required

The currency of the deposit

Example:

"XOF"

accountType
enum<string>
default:transfer
required

The account type to deposit funds on. Only TRANSFER, TRANSFER_IRT and CROSS_BORDER are allowed for deposits.

Available options:
transfer,
transfer-irt,
cross-border
method
object
required

Informations about HUB2 account

description
string

Description of the deposit

Maximum string length: 300

Response

id
string
required

Unique identifier for the deposit

merchantId
string
required

Merchant identifier

merchantAccountId
string
required

Merchant account identifier

matchingCode
string
required

Reference to use for the bank transfer

amount
number
required

Amount of the deposit

currency
string
required

Currency of the deposit (ISO 4217 format)

accountType
enum<string>
required

Type of merchant account

Available options:
collection,
transfer,
transfer-irt,
delegated,
cross-border
method
object
required

Method used for the deposit

status
enum<string>
required

Status of the deposit

Available options:
created,
failed,
pending,
successful
statusDetails
enum<string>
required

Status details of the deposit

Available options:
waiting_provider,
waiting_proof,
unverified,
verified,
mismatch
mode
enum<string>
required

Application mode (e.g., live or sandbox)

Available options:
live,
sandbox
fees
object[]
required

List of fees associated with the deposit

createdAt
string
required

Date and time when the deposit was created

createdBy
string
required

User id or merchant id who created the deposit

updatedAt
string
required

Date and time when the deposit was last updated

merchantName
string

Merchant display name

description
string

Description of the deposit

Maximum string length: 300
failureCause
object

Optional failure cause details

nextAction
object

Next action required, if any

Legal data of the deposit