- Overview
- Payments
- Payouts
- Reserved Account
Get Transfers
GET
https://devapi.collect.africa/transfers
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:
pendingprocessingsuccessfailed
recipient
string
optional
payment
integer <int32>
optional
from
string
optional
Default:
2021-12-17
to
string
optional
Default:
2021-12-27
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/transfers'Responses
🟢200OK
application/json
Body
message
string
optional
Example:
Fetched transfers successful
data
array [object {15}]
optional
id
integer
optional
Default:
0
Example:
1
amount
integer
optional
Default:
0
Example:
10000
fee
integer
optional
Default:
0
Example:
5000
currency
string
optional
Example:
NGN
status
string
optional
Example:
processing
short_code
string
optional
Example:
TRF_qm11kfckpf
reference
string
optional
Example:
1112222
narration
string
optional
Example:
string
source
string
optional
Example:
balance
metadata
object
optional
recipient
object
optional
payment
optional
transferred_at
string
optional
Example:
2021-05-24T12:36:44.217Z
created_at
string
optional
Example:
2021-05-24T11:36:42.000Z
updated_at
string
optional
Example:
2021-05-24T11:36:44.260Z
metadata
object
optional
page
integer
optional
Default:
0
Example:
1
perPage
integer
optional
Default:
0
Example:
50
total
integer
optional
Default:
0
Example:
2
pageCount
integer
optional
Default:
0
Example:
2
previousPage
boolean
optional
Default:
true
Example:
false
nextPage
boolean
optional
Default:
true
Example:
false
totalPages
integer
optional
Default:
0
Example:
1
Example
{
"message": "Fetched transfers successful",
"data": [
{
"id": 1,
"amount": 10000,
"fee": 5000,
"currency": "NGN",
"status": "processing",
"short_code": "TRF_qm11kfckpf",
"reference": "1112222",
"narration": "string",
"source": "balance",
"metadata": {},
"recipient": {
"id": 1,
"name": "Wale Test",
"account_name": "MARTINS ADEWALE",
"account_number": "027299911",
"short_code": "TRP_rt8sm0j1je",
"bank_name": "Guaranty Trust Bank",
"bank_code": "058",
"currency": "NGN",
"created_at": "2021-05-22T14:01:07.638Z",
"updated_at": "2021-05-22T14:01:07.638Z"
},
"payment": null,
"transferred_at": "2021-05-24T12:36:44.217Z",
"created_at": "2021-05-24T11:36:42.000Z",
"updated_at": "2021-05-24T11:36:44.260Z"
},
{
"id": 2,
"amount": 193000,
"fee": 5000,
"currency": "NGN",
"status": "success",
"short_code": "TRF_afphbmp1le",
"reference": "payment-string",
"narration": "Payment to Wale Test",
"source": "payment",
"metadata": null,
"recipient": {
"id": 1,
"name": "Wale Test",
"account_name": "MARTINS ADEWALE",
"account_number": "0181881818",
"short_code": "TRP_rt8sm0j1je",
"bank_name": "Guaranty Trust Bank",
"bank_code": "058",
"currency": "NGN",
"created_at": "2021-05-22T14:01:07.638Z",
"updated_at": "2021-05-22T14:01:07.638Z"
},
"payment": {
"id": 1,
"amount": 200000,
"fee": 2000,
"currency": "NGN",
"status": "success",
"reference": "string",
"description": "Payment to Wale Test",
"paid_at": "2021-05-24T09:01:37.416Z",
"metadata": null
},
"transferred_at": "2021-05-24T08:59:03.709Z",
"created_at": "2021-05-24T07:59:00.883Z",
"updated_at": "2021-05-24T08:01:37.395Z"
}
],
"metadata": {
"page": 1,
"perPage": 50,
"total": 2,
"pageCount": 2,
"previousPage": false,
"nextPage": false,
"totalPages": 1
}
}🟠400Bad Request