GET
/
transfers
[
  {
    "id": "tr_z1urYtVFgEebtcj8fxp4v",
    "merchantId": "<string>",
    "createdAt": "2020-10-15T12:09:49.355Z",
    "updatedAt": "2020-10-15T12:16:26.128Z",
    "reference": "ref_2020_11_10_001",
    "description": "<string>",
    "status": "successful",
    "amount": 100,
    "currency": "XOF",
    "mode": "live",
    "destination": {
      "type": "mobile_money",
      "country": "CI",
      "recipientName": "<string>",
      "number": "<string>",
      "provider": "orange"
    },
    "fees": [
      {
        "id": "lAe5HnFpvOjwdT9vSIgPA",
        "rate": 123,
        "type": "flat",
        "amount": 5,
        "currency": "XOF",
        "label": "<string>",
        "taxes": [
          "<string>"
        ]
      }
    ],
    "failureCause": {
      "code": "<string>",
      "message": "<string>",
      "params": [
        "<string>"
      ]
    },
    "origin": {
      "name": "<string>",
      "country": "<string>"
    },
    "overrideBusinessName": "<string>",
    "overrideBusinessId": "<string>",
    "isIrt": true,
    "providerReference": "<string>"
  }
]

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

​
reference
string

The reference provided by the client during the creation of this transfer. It will most likely be the internal ID of the transaction.

​
to
string

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

​
from
string

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

​
page
number

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

​
perPage
number

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

Response

200
application/json

The response is of type object[].