Transfer API
These are suites of API that allows you move funds from your Squad Wallet to a bank Account.
This documentation site has been deprecated as of September 8, 2025, and will no longer receive updates. Please refer to the new documentation site at https://docs.squadco.com.
Authorization Any request made without the authorization key (secret key) will fail with a 401 (Unauthorized) response code.
Example: Authorization: Bearer sandbox_sk_94f2b798466408ef4d19e848ee1a4d1a3e93f104046f
Account Lookup
This API allows you lookup/confirm the account name of the recipient you intend to credit. This should be done before initiating the transfer.
This API allows you confirm Account Name to be transferred to.
POST https://sandbox-api-d.squadco.com/payout/account/lookup
Request Body
bank_code*
String
Unique NIP code that identifies a bank.
account_number*
String
Account number you want to transfer to
{
"status": 200,
"success": true,
"message": "Success",
"data": {
"account_name": "JENNY SQUAD",
"account_number": "0123456789"
}
}{
"success": false,
"message": "Merchant authentication failed",
"data": {}
}Available Bank Codes
Sample Request
Sample Response
Fund Transfer
This API allows you to transfer funds from your Squad Wallet to the account you have looked up. Please be informed that we will not be held liable for mistake in transferring to a wrong account or an account that wasn't looked up. Transaction Reference: Transaction Reference used to initiate a transfer must be unique per transfer. Kindly ensure that you append your merchant ID to the transaction Reference you are creating. This is compulsory as it will throw an error if you don't append it. For instance: If my Squad Merchant ID is SBABCKDY and i want to create a transaction ref for my transfer, then I will have something like: "transaction_reference":"SBABCKDY_12345".
ERROR CODE
These are the various error codes that you might get on the transfer API and the one you should re-query
200 -- Success: 400 --- Bad request 422 --- Unprocessed 424 --- Timeout/failed --- Should re-query 404 --- Not found 412 ---- reversed
POST https://sandbox-api-d.squadco.com/payout/transfer
This is for the movement of funds from Squad Dashboard to any bank account
Request Body
transaction_reference*
String
Unique Transaction Reference used to initiate a transfer. Please ensure that you append your merchant ID to the transaction Reference you are creating. This is compulsory as it will throw an error if you don't append it.
amount*
String
Amount to be transferred. Value is in Kobo.
bank_code*
String
Unique NIP Code that identifies a bank.
account_number*
String
10-digit NUBAN account number to be transferred to. Must be an account that has been looked up and vetted to be transferred to.
account_name*
String
The account name tied to the account number you are transferring to which you have looked up using our look up API.
currency_id*
String
Takes only the value "NGN"
remark*
String
A unique remark that will be sent with the transfer.
Sample Request
Sample Response
Re-query Transfer
This API allows you re-query the status of a transfer made to know if it was successful, failed, reversed or pending.
This API allows you re-query the status of a transfer
POST https://sandbox-api-d.squadco.com/payout/requery
Request Body
transaction_reference*
String
Unique Transaction Reference used to initiate a transfer. Please ensure that you append your merchant ID to the transaction Reference you are creating. This is compulsory as it will throw an error if you don't append it.
Sample Request
Get All Transfers
This API allows you to retrieve the details of all transfers made
GET https://sandbox-api-d.squadco.com/payout/list
Query Parameters
page
Integer
Number of Pages
perPage
Integer
Number of records per page
dir
String
Allows you sort the records in either ascending or descending order. It takes the value "ASC" or "DESC"
Sample Response: 200-ok
Last updated
Was this helpful?