Skip to main content
POST
/
api
/
Payout
/
inter-bank-transfer
Inter Bank Transfer
curl --request POST \
  --url https://payout-staging.embedly.ng/api/Payout/inter-bank-transfer \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "destinationBankCode": "<string>",
  "destinationAccountNumber": "<string>",
  "destinationAccountName": "<string>",
  "sourceAccountNumber": "<string>",
  "sourceAccountName": "<string>",
  "remarks": "<string>",
  "amount": 123,
  "currencyId": "<string>",
  "customerTransactionReference": "<string>",
  "stagingStatus": "<string>"
}
'
{
    "data": "EMBe66029d4f6e2432a905a3642fa0dd380",
    "statusCode": 200,
    "code": "00",
    "message": "Request is being processed.",
    "succeeded": true
}

​
Transaction Reference (transactionRef)

When a payout transaction is successfully submitted, a transactionRef is included in the response payload under the data object.

​
Key Considerations:

  • Store the transactionRef securely on your end. It acts as the unique identifier for that specific transaction.
  • The transactionRef can be used to confirm the status of the transaction at a later time.
  • It is also essential for mapping webhook notifications to the correct payout transaction—especially for tracking successful debits.

​
Note:

On Staging environment, you must include the stagingStatus field in the request body. This allows you to simulate either a successful or failed payout. In both cases, a webhook notification will be sent indicating the outcome of the payout. On Production, you must skip this field entirely. Please ensure that you have configured your webhook URL on your staging dashboard in order to receive webhook notifications.
​
destinationBankCode
string
required
Example: 000010
​
destinationAccountNumber
string
required
Example: 1111111111
​
destinationAccountName
string
required
Example: Bruce Banner
​
sourceAccountNumber
string
required
Example: 9666055662
​
sourceAccountName
string
required
Example: Tony Stark
​
remarks
string
required
Example: Hello World
​
amount
integer
required
Example: 100000
​
currencyId
string
required
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
​
customerTransactionReference
string
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
​
stagingStatus
string
The status of the staging process. Possible values are success or failed.Note: This field doesn’t apply on production and should be removed entirely.Example: success
{
    "data": "EMBe66029d4f6e2432a905a3642fa0dd380",
    "statusCode": 200,
    "code": "00",
    "message": "Request is being processed.",
    "succeeded": true
}