GuidesAPI Reference
Changelog
GuidesAPI Reference
Changelog
  1. Transfer Recipient
  • Overview
  • Payments
    • Overview
    • Get Payment
      GET
    • Get Payments
      GET
    • Create PayLink
      POST
    • Charge
      POST
    • Payment Initialize
      POST
    • Initialize Crypto Payment
      POST
    • Initialize Card Payment
      POST
  • Payouts
    • Overview
    • Transfer Recipient
      • Create Transfer Recipient
        POST
      • Get Transfer Recipients
        GET
      • Get Transfer Recipient
        GET
    • Transfers
      • Create Transfer
      • Get Transfers
      • Get Transfer
      • Get Transfer By Reference
    • Banks
      GET
    • Account Resolve
      GET
  • Reserved Account
    • Overview
    • Get Reserved Accounts
      GET
    • Get Reserved Account By Reference
      GET
    • Get Reserved Account
      GET
    • Update Reserved Account
      PUT
    • Delete Reserved Account
      DELETE
    • Create Reserved Account
      POST
  1. Transfer Recipient

Get Transfer Recipients

GET
https://devapi.collect.africa/transfers/recipients
Last modified:2025-04-19 09:05:16
Fetch a list of transfer recipients

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
name
string 
optional
payment
integer <int32>
optional
to
string 
optional
End date
Default:
2021-12-27
from
string 
optional
Start date
Default:
2021-12-17

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/recipients'

Responses

🟢200OK
application/json
200
Body
message
string 
optional
Example:
Fetched transfer recipients successful
data
array [object {11}] 
optional
id
integer 
optional
Default:
0
Example:
1
name
string 
optional
Example:
Wale Test
account_name
string 
optional
Example:
MARTINS ADEWALE
account_number
string 
optional
Example:
0227171712
short_code
string 
optional
Example:
TRP_rt8sm0j1je
bank_name
string 
optional
Example:
Guaranty Trust Bank
bank_code
string 
optional
Example:
058
currency
string 
optional
Example:
NGN
country
string 
optional
Example:
NG
created_at
string 
optional
Example:
2021-05-22T14:01:07.638Z
updated_at
string 
optional
Example:
2021-05-22T14:01:07.638Z
metadata
object 
optional
page
integer 
optional
Default:
0
Example:
1
perPage
integer 
optional
Default:
0
Example:
50
total
integer 
optional
Default:
0
Example:
1
pageCount
integer 
optional
Default:
0
Example:
1
previousPage
boolean 
optional
Default:
true
Example:
false
nextPage
boolean 
optional
Default:
true
Example:
false
totalPages
integer 
optional
Default:
0
Example:
1
Example
{
  "message": "Fetched transfer recipients successful",
  "data": [
    {
      "id": 1,
      "name": "Wale Test",
      "account_name": "MARTINS ADEWALE",
      "account_number": "0227171712",
      "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"
    }
  ],
  "metadata": {
    "page": 1,
    "perPage": 50,
    "total": 1,
    "pageCount": 1,
    "previousPage": false,
    "nextPage": false,
    "totalPages": 1
  }
}
🟠400Bad Request
Previous
Create Transfer Recipient
Next
Get Transfer Recipient
Built with