- Overview
- Payments
- Payouts
- Reserved Account
Get Payments
GET
https://devapi.collect.africa/payments
Last modified:2025-04-19 09:05:16
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
perPage
integer <int32>
optional
Default:
15
page
integer <int32>
optional
Default:
1
status
enum<string>
optional
Allowed values:
pendingprocessingsuccessfailedtransfer-pendingtransfer-processingtransfer-failedstart
customer
string
optional
from
string
optional
Default:
2021-12-17
to
string
optional
Default:
2021-12-27
paylink
string
optional
reserved_account_id
string
optional
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://devapi.collect.africa/payments'Responses
🟢200OK
application/json
Body
message
string
optional
Example:
Fetched payments successful
data
array [object {25}]
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
metadata
object
optional
page
string
optional
Example:
1
perPage
string
optional
Example:
10
total
integer
optional
Default:
0
Example:
2
pageCount
integer
optional
Default:
0
Example:
10
previousPage
boolean
optional
Default:
true
Example:
false
nextPage
boolean
optional
Default:
true
Example:
false
totalPages
integer
optional
Default:
0
Example:
1
Example
{
"message":"Fetched payments 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":"Musa",
"middle_name":null,
"last_name":"Chidi",
"email":"test@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":"test9@test.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"
}
}
},
{
"id":2900,
"amount":22200,
"fee":0,
"pass_fee":false,
"currency":"NGN",
"status":"success",
"short_code":"SC_ckxrj9xy8000101p246cqf3px",
"reference":"C0M4JHDXBXHH5LL",
"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:47:42.368Z",
"charged_at":"2021-12-29T12:47:42.368Z",
"next_action":null,
"customer":{
"id":121,
"first_name":"Ade",
"middle_name":null,
"last_name":"Buhari",
"email":"test2@test.com",
"phone_number":"08182447114",
"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:47:42.318Z",
"updated_at":"2021-12-29T12:47:42.318Z",
"metadata":null,
"payment_instrument":{
"id":"61c315eddd8d302f92d417c8",
"type":"bank-transfer",
"method":"ng_bank_transfer",
"email":"test1@test.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"
}
}
}
],
"metadata":{
"page":"1",
"perPage":"10",
"total":2,
"pageCount":10,
"previousPage":false,
"nextPage":false,
"totalPages":1
}
}🟠400Bad Request