HUhub2
Deposits

List deposits

Changed on

This endpoint allows you to list deposits.

get/deposits

Request

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

Query parameters

merchantIdstring
Example:876

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

currencystring
Example:XOF

Filter by currency

minAmountstring

Minimum deposit amount

maxAmountstring

Maximum deposit amount

providerstring
Example:ecobank

Filter by provider name

accountType'collection' | 'transfer' | 'transfer-irt' | 'cross-border'

Filter by account type

fromstring
Example:2024-01-01T00:00:00Z

Start date (ISO 8601)

tostring
Example:2024-12-31T23:59:59Z

End date (ISO 8601)

status'created' | 'failed' | 'pending' | 'successful'
Example:failed

Filter by status

filterBystring
Example:createdAt

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

matchingCodestring

Only transactions matching the given matching code.

mode'live' | 'sandbox'

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

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

Unique identifier for the deposit

merchantIdstring required

Merchant identifier

merchantNamestring

Merchant display name

merchantAccountIdstring required

Merchant account identifier

matchingCodestring required

Reference to use for the bank transfer

descriptionstring

Description of the deposit

amountnumber required

Amount of the deposit

currencystring required

Currency of the deposit (ISO 4217 format)

accountType'collection' | 'transfer' | 'transfer-irt' | 'delegated' | 'cross-border' required

Type of merchant account

status'created' | 'failed' | 'pending' | 'successful' required

Status of the deposit

statusDetails'waiting_provider' | 'waiting_proof' | 'unverified' | 'verified' | 'mismatch' required

Status details of the deposit

mode'live' | 'sandbox' required

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

feesDepositFee[] required

List of fees associated with the deposit

createdAtstring required

Date and time when the deposit was created

createdBystring required

User id or merchant id who created the deposit

updatedAtstring required

Date and time when the deposit was last updated

nextActionobject

Next action required, if any

Example response

[
  {
    "method": {
      "type": "bank_transfer",
      "hub2Iban": "FR7630006000011234567890189",
      "country": "FR",
      "provider": "ecobank"
    }
  }
]

Changes