v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB

Transfer Recipients

List transfer recipients

get/transfers/recipients

Query parameters

nextstring

Example:MjAyNC0xMS0yN1QxMjozMjozNC42MjBa

previousstring

Example:MjAyNC0xMS0yOVQwMjoxMDo1My45OTla

sizeinteger

Length of data returned. Defaults to 10.

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
    },
    "recipients": [
      {
        "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"
        }
      }
    ]
  }
}