Skip to main content
GET
List deposits

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

Query Parameters

merchantId
string

Deprecated and ignored: deposits are always listed for the merchant making the call.

Example:

"876"

currency
string

Filter by currency

Example:

"XOF"

minAmount
string

Minimum deposit amount

Example:

1000

maxAmount
string

Maximum deposit amount

Example:

5000

provider
string

Filter by provider name

Example:

"ecobank"

accountType
enum<string>

Filter by account type

Available options:
collection,
transfer,
transfer-irt,
cross-border
from
string

Start date (ISO 8601)

Example:

"2024-01-01T00:00:00Z"

to
string

End date (ISO 8601)

Example:

"2024-12-31T23:59:59Z"

status
enum<string>

Filter by status

Available options:
created,
failed,
pending,
successful
Example:

"failed"

filterBy
string

Variable that will be use for ordering and filtering. Can be updatedAt or createdAt. default is updatedAt

Example:

"createdAt"

matchingCode
string

Only transactions matching the given matching code.

mode
enum<string>

Deprecated and ignored: deposits are always listed in the environment (live or sandbox) of the API key making the call.

Available options:
live,
sandbox

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