v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB

Transfers

List transfers

get/transfers

Query parameters

nextstring

Example:MjAyNC0xMS0yN1QxMjozMjozNC42MjBa

previousstring

Example:MjAyNC0xMS0yOVQwMjoxMDo1My45OTla

sizeinteger

Length of data returned. Defaults to 10.

bulk_idstring

ID of a bulk transfer

recipient_idstring

ID of the recipient

sender_idstring

ID of the sender

destination_currencystring

Destination currency in the payment instruction

source_currencystring

Source currency in the payment instruction

action'instant' | 'deferred' | 'scheduled' | 'retry'

Action of the transfer

type'bank' | 'mobile_money' | 'wallet' | 'cash_pickup'

type of transfer

status'new' | 'pending' | 'failed' | 'successful' | 'cancelled'

The status of transfer

fromstring

The start date and time for a period. This parameter is used in conjunction with the 'to' parameter to define a time range. The value should be in ISO 8601 format.

tostring

The end date and time for a period. This parameter is used in conjunction with the 'from' parameter to define a time range. The value should be in ISO 8601 format.

Headers

X-Trace-Idstring

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Response

status'success' | 'failed'

messagestring

Example response

{
  "data": {
    "cursor": {
      "next": "MjAyNC0xMS0yN1QxMjozMjozNC42MjBa",
      "previous": "MjAyNC0xMS0yOVQwMjoxMDo1My45OTla",
      "limit": 10,
      "total": 1000
    },
    "transfers": [
      {
        "id": "trf_yuK89vb",
        "type": "bank",
        "reversal": {
          "initial_status": "SUCCESSFUL",
          "reconciliation_status": "REVERSED"
        },
        "narration": "Salary payment for January",
        "source_currency": "NGN",
        "destination_currency": "NGN",
        "amount": {
          "value": 3000.44
        },
        "fee": {
          "currency": "NGN",
          "value": 10.35
        },
        "debit_information": {
          "currency": "NGN",
          "actual_debit_amount": 100.35,
          "rate_used": 100.35,
          "vat": 100.35
        },
        "extra_information": {
          "amount_credited": "USDT 100"
        },
        "payment_information": {
          "proof": "11000224070317345400001414441712312381"
        },
        "retry": {
          "parent_id": "trf_HUQUYb1Sp5CkiIJFebk1Z",
          "parent_reference": "flw_z882wFGMjc"
        },
        "duplicate": {
          "parent_id": "trf_HUQUYb1Sp5CkiIJFebk1Z",
          "parent_reference": "flw_z882wFGMjc"
        },
        "callback_url": "https://example.com/flw/callback",
        "provider_response": {
          "message": "DISBURSE FAILED: Insufficient wallet balance"
        },
        "recipient": {
          "name": {
            "first": "King",
            "middle": "Leo",
            "last": "LeBron"
          },
          "currency": "NGN",
          "national_identification": {
            "identifier": "FLY5869798686",
            "expiration_date": "2029-07-08"
          },
          "phone": {
            "country_code": "234",
            "number": "08012345678"
          },
          "email": "cornelius@gmail.com",
          "address": {
            "city": "New York",
            "country": "US",
            "line1": "123 Main Street",
            "line2": "Apt 4B",
            "postal_code": "10001",
            "state": "New York"
          }
        },
        "sender": {
          "name": {
            "first": "King",
            "middle": "Leo",
            "last": "LeBron"
          },
          "national_identification": {
            "identifier": "FLY5869798686",
            "expiration_date": "2029-07-08"
          },
          "phone": {
            "country_code": "234",
            "number": "08012345678"
          },
          "email": "cornelius@gmail.com",
          "address": {
            "city": "New York",
            "country": "US",
            "line1": "123 Main Street",
            "line2": "Apt 4B",
            "postal_code": "10001",
            "state": "New York"
          }
        },
        "transfer_purpose": "personal"
      }
    ]
  }
}