Get Payment

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

id

string

required

merchant reference or collect id

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 payment successful

data

object

optional

id

integer

optional

Default:

0

Example:

2901

amount

integer

optional

Default:

0

Example:

5500

fee

integer

optional

Default:

0

Example:

0

pass_fee

boolean

optional

Default:

true

Example:

false

currency

string

optional

Example:

NGN

status

string

optional

Example:

success

short_code

string

optional

Example:

SC_ckxrjhxpd000301p2exxjci2m

reference

string

optional

Example:

3FTW2C9BT3VLD31

ip

optional

description

string

optional

Example:

Virtual account topup

payment_method

string

optional

Example:

ng_virtual_account

channel

string

optional

Example:

bank-transfer

gateway_message

optional

gateway_code

optional

paid_at

string

optional

Example:

2021-12-29T12:53:55.298Z

charged_at

string

optional

Example:

2021-12-29T12:53:55.298Z

next_action

optional

customer

object

optional

payment_link

optional

plan

optional

subscription

optional

created_at

string

optional

Example:

2021-12-29T12:53:55.270Z

updated_at

string

optional

Example:

2021-12-29T12:53:55.270Z

metadata

optional

payment_instrument

object

optional

Example

{
   "message":"Fetched payment successful",
   "data":{
      "id":2901,
      "amount":5500,
      "fee":0,
      "pass_fee":false,
      "currency":"NGN",
      "status":"success",
      "short_code":"SC_ckxrjhxpd000301p2exxjci2m",
      "reference":"3FTW2C9BT3VLD31",
      "ip":null,
      "description":"Virtual account topup",
      "payment_method":"ng_virtual_account",
      "channel":"bank-transfer",
      "gateway_message":null,
      "gateway_code":null,
      "paid_at":"2021-12-29T12:53:55.298Z",
      "charged_at":"2021-12-29T12:53:55.298Z",
      "next_action":null,
      "customer":{
         "id":121,
         "first_name":"Bassey",
         "middle_name":null,
         "last_name":"Olu",
         "email":"test3@test.com",
         "phone_number":"08000000000",
         "city":null,
         "address":null,
         "country":"NG",
         "code":"CUS_9bmn9mllcv",
         "risk_action":"whitelisted",
         "profile_image":null,
         "metadata":null,
         "created_at":"2021-12-02T07:15:01.490Z"
      },
      "payment_link":null,
      "plan":null,
      "subscription":null,
      "created_at":"2021-12-29T12:53:55.270Z",
      "updated_at":"2021-12-29T12:53:55.270Z",
      "metadata":null,
      "payment_instrument":{
         "id":"61c315eddd8d302f92d417c8",
         "type":"bank-transfer",
         "method":"ng_bank_transfer",
         "email":"test3@tset.com",
         "country":"NG",
         "authorization":"PI_opqdnm640neyyy9",
         "is_reusable":false,
         "is_active":true,
         "is_default":false,
         "signature":"SIG_1bca745099cd6d",
         "business_id":78,
         "customer_id":121,
         "created_at":"2021-12-22T12:11:25.715Z",
         "updated_at":"2021-12-22T12:11:25.715Z",
         "bank_account":{
            "account_name":"Test Customer",
            "bank_name":"Guaranty Trust Bank",
            "bank_code":"000013",
            "bank_id":0,
            "last_4":"******7890"
         }
      }
   }
}

🟠400Bad Request