POST
/
api
/
transactions
/
payouts
/
banktransfers
curl --location --request POST 'https://api.xente.co/api/transactions/payouts/banktransfers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
  "requestId": "92399933543589", //Id from your system to uniquely identify the transaction
  "batchId": "batch5678", //Identifier og the batch from your system.
  "amount": 500,
  "type": "DEBIT",
  "message": "Testing",
  "product": {
    "productItemId": "producItemId" //These can be fetched from the products endpoint
  },
  "beneficiary": {
    "name": "recipient  name",
    "emailAddress": "recipient email address",
    "phoneNumber": "recipient  phone number",
    "data": {
      "bankAccount": "Bank account number where funds are to be deposited", 
      "bankName": "bank name" //The Code of the bank where account is held
    }
  }
}'

{
  "message": "Transaction Has Been Successfully Received. Notification Will Be Sent Shortly",
  "data": {
    "requestId": "req1234",
    "batchId": "123123123123",
    "transactionId": "0f9182ad-bf5e-4854-799e-08dc2bc9741e",
    "status": "PROCESSING",
    "message": "Processing Debit Transaction. Instant Payment Notification will be sent shortly",
    "createdOn": "2/12/2024 12:52:21 PM"
  },
  "code": 0,
  "status": "success"
}

Body

requestId
string
A unique identifier for the request.
batchId
string
A unique identifier for the batch.
accountNumber
string
The account number associated with the request.
amount
number
The monetary amount involved in the request.
type
string
The type of request, initially not set.
message
string
An optional message associated with the request.
metadata
string
Additional metadata as a string.
product.id
string
The product’s unique identifier.
product.productItemId
string
A specific item identifier within the product.
beneficiary.id
string
The beneficiary’s unique identifier.
beneficiary.name
string
The beneficiary’s name.
beneficiary.emailAddress
string
The beneficiary’s email address.
beneficiary.phoneNumber
string
The beneficiary’s phone number.
beneficiary.data.bankAccount
string
The bank account number of the beneficiary
beneficiary.data.bankCode
string
The ode of the bank where account is held (This can be gotten from the get products and get product items APIs)

Response

code
number
Indicates whether the call was successful. 0 if successful, error code if not.
status
string
Status message on outcome of the API call.
message
string
General message about the transaction status.
data
object
The contents of the transaction data.
curl --location --request POST 'https://api.xente.co/api/transactions/payouts/banktransfers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
  "requestId": "92399933543589", //Id from your system to uniquely identify the transaction
  "batchId": "batch5678", //Identifier og the batch from your system.
  "amount": 500,
  "type": "DEBIT",
  "message": "Testing",
  "product": {
    "productItemId": "producItemId" //These can be fetched from the products endpoint
  },
  "beneficiary": {
    "name": "recipient  name",
    "emailAddress": "recipient email address",
    "phoneNumber": "recipient  phone number",
    "data": {
      "bankAccount": "Bank account number where funds are to be deposited", 
      "bankName": "bank name" //The Code of the bank where account is held
    }
  }
}'

{
  "message": "Transaction Has Been Successfully Received. Notification Will Be Sent Shortly",
  "data": {
    "requestId": "req1234",
    "batchId": "123123123123",
    "transactionId": "0f9182ad-bf5e-4854-799e-08dc2bc9741e",
    "status": "PROCESSING",
    "message": "Processing Debit Transaction. Instant Payment Notification will be sent shortly",
    "createdOn": "2/12/2024 12:52:21 PM"
  },
  "code": 0,
  "status": "success"
}