Get Transfer By Reference

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

reference

string

required

Your reference passed when creating a transfer

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

200

Body

message

string

optional

Example:

Fetched transfer successful

data

object

optional

id

integer

optional

Default:

0

Example:

1

amount

integer

optional

Default:

0

Example:

193000

fee

integer

optional

Default:

0

Example:

5000

currency

string

optional

Example:

NGN

status

string

optional

Example:

success

short_code

string

optional

Example:

TRF_afphbmp1le

reference

string

optional

Example:

payment-string

narration

string

optional

Example:

Payment to Wale

source

string

optional

Example:

balance

metadata

optional

recipient

object

optional

transferred_at

string

optional

Example:

2021-05-24T08:59:03.709Z

created_at

string

optional

Example:

2021-05-24T07:59:00.883Z

updated_at

string

optional

Example:

2021-05-24T08:01:37.395Z

Example

{
  "message": "Fetched transfer successful",
  "data": {
    "id": 1,
    "amount": 193000,
    "fee": 5000,
    "currency": "NGN",
    "status": "success",
    "short_code": "TRF_afphbmp1le",
    "reference": "payment-string",
    "narration": "Payment to Wale",
    "source": "balance",
    "metadata": null,
    "recipient": {
      "id": 1,
      "name": "Wale Mart",
      "account_name": "MARTINS ADEWALE",
      "account_number": "0227172618",
      "short_code": "TRP_rt8sm0j1je",
      "bank_name": "Guaranty Trust Bank",
      "bank_code": "058",
      "currency": "NGN",
      "country": "NG",
      "created_at": "2021-05-22T14:01:07.638Z",
      "updated_at": "2021-05-22T14:01:07.638Z"
    },
    "transferred_at": "2021-05-24T08:59:03.709Z",
    "created_at": "2021-05-24T07:59:00.883Z",
    "updated_at": "2021-05-24T08:01:37.395Z"
  }
}

🟠400Bad Request