POST
/
transfer
/
customer
/
initiate
curl --request POST \
  --url https://devapi.withedge.co/gateway/api/v1/transfer/customer/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'requestId: <requestid>' \
  --data '{
  "nameEnquirySessionId": "<string>",
  "customerId": "<string>",
  "sourceAccountName": "<string>",
  "sourceAccountNumber": "<string>",
  "beneficiaryAccountName": "<string>",
  "beneficiaryAccountNumber": "<string>",
  "beneficiaryBankCode": "<string>",
  "amount": 123,
  "narration": "<string>"
}'
{
	"statusCode": 00,
	"message": "Transfer initiated successfully."
	"data": {
		"amount": 1213211231,
		"beneficiaryAccountName": "Peter Parker",
		"beneficiaryAccountNumber": "1234567890",
		"beneficiaryBankCode": "001001",
		"narration": "Transfer to John Doe",
		"transactionId": "txn_0011223344",
		"otpReferneceId": "654578797858"
	},
	"errors": []
}

​
Initiate Customer Transfer Request

​
Use this endpoint to initiate a transfer request on behalf of a customer using their generated account numbers.

​
Additional Information

Note
You can initiate transfer requests only with account numbers generated specifically for your customer.

​
Request Parameters

​
requestId
string
required

A unique identifier for the request, used for idempotency.
Example: e0b9f8d0-7a57-4a67-a8b2-4d7c7b5a37c9

​
nameEnquirySessionId
string
required

The session ID from a name enquiry request, required to confirm the beneficiary’s details.
Example: session_0011223344

​
customerId
string
required

The unique identifier of the customer initiating the transfer.
Example: cus_0011223344

​
sourceAccountName
string
required

The name associated with the source account of the customer.
Example: John Doe

​
sourceAccountNumber
string
required

The account number of the customer from which the transfer is being initiated.
Example: 1234567890

​
beneficiaryAccountName
string
required

The name of the beneficiary receiving the transfer.
Example: Peter Parker

​
beneficiaryAccountNumber
string
required

The account number of the beneficiary.
Example: 0987654321

​
beneficiaryBankCode
string
required

The bank code of the beneficiary’s bank.
Example: 001001

​
amount
double
required

The amount to be transferred.
Example: 5000.00

​
narration
string

A brief description of the transaction.
Example: Payment for services

{
	"statusCode": 00,
	"message": "Transfer initiated successfully."
	"data": {
		"amount": 1213211231,
		"beneficiaryAccountName": "Peter Parker",
		"beneficiaryAccountNumber": "1234567890",
		"beneficiaryBankCode": "001001",
		"narration": "Transfer to John Doe",
		"transactionId": "txn_0011223344",
		"otpReferneceId": "654578797858"
	},
	"errors": []
}

Was this page helpful?

Name EnquiryValidate Customer Transfer Request