Transfer

Send a POST request to the transfer service endpoint. The service responds with a JSON object containing the processing result.

Request

{{baseUrl}}/api/transfer

curl --request POST \
     --url {{baseUrl}}/api/transfer
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "account_bank": "Flick",
  "account_number": "00011122233",
  "amount": 1000,
  "narration": "What for",
  "currency": "NGN",
  "beneficiary_name": "Kings Ike",
  "reference": "Sample_PMCK",
  "debit_currency": "NGN",
  "meta": {
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "mobile_number": "string",
    "recipient_address": "string"
  }
}
'

Request Parameters

get parameter	type	description
id	string	valid account number
account_bank	string	subject bank
account_number	bool	subject account number
amount	Int	amount to be sent
narration	string	payment summary
currency	string	Local currency type
beneficiary_name	string	receiver
reference	string	transaction summary
debit_currency	string	Local currency debited
meta	object	receiver details

Response

Successful Response

{
  "id": "009945",
  "account_number": "00011122233",
  "bank_code": "012",
  "full_name": "Docas Kings",
  "created_at": "2020-01-20T16:09:34.000Z",
  "currency": "NGN",
  "debit_currency": "USSD",
  "amount": 1000,
  "fee": 200,
  "status": "NEW",
  "reference": "akhlm-pstmnpyt-rfxx007_PMCKDU_1",
  "meta": "null",
  "narration": "Akhlm Pstmn Trnsfr xx007",
  "is_approved": 1,
  "bank_name": "ACCESS BANK NIGERIA"
}

Error Handling (Failed Response)
If there is an issue with the request or the transfer cannot be completed, the service will respond with an error message and an appropriate HTTP status code.

{
  "id": "009945",
  "account_number": "00011122233",
  "bank_code": "012",
  "full_name": "Docas Kings",
  "created_at": "2020-01-20T16:09:34.000Z",
  "currency": "NGN",
  "debit_currency": "USSD",
  "amount": 1000,
  "fee": 200,
  "status": 405,
  "reference": "akhlm-pstmnpyt-rfxx007_PMCKDU_1",
  "meta": "null",
  "narration": "Akhlm Pstmn Trnsfr xx007",
  "is_approved": 1,
  "bank_name": "N/A",
  "complete_message": "Beneficiary not found"
}

Verify Transfer

Send a GET request to the verify transfer service endpoint. The service responds with a JSON object containing the processing result.

Request

	{{baseUrl}}/api/verify/{id}

Response

Successful Response

{
  "id": 26251,
  "account_number": "0000111122",
  "bank_code": "012",
  "bank_name": "Flick",
  "full_name": "Docas Kings",
  "created_at": "2020-01-20T16:09:34.000Z",
  "currency": "NGN",
  "debit_currency": "USSD",
  "amount": 1000,
  "fee": 200,
  "status": "NEW",
  "reference": "akhlm-pstmnpyt-rfxx007_PMCKDU_1",
  "meta": "null",
  "narration": "Akhlm Pstmn Trnsfr xx007",
  "complete_message": "Transfer fee fetched",
  "requires_approval": 0,
  "is_approved": 1
}

Error Handling (Failed Response)
If there is an issue with the request or the transfer cannot be completed, the service will respond with an error message and an appropriate HTTP status code.

	{
  "status": 400,
  "error": "Transfer failed"
}

{
  "status": 404,
  "error": "ID not found"
}