Bank Transfers

POST /api/v1/BankTransfers

Description

This endpoint is used for bank transfers.

Headers:

• Content-Type: application/json

ApiKey:

• No API key required

Request Body:

• An object of the BankTransferRequest schema.

URL:
{{baseUrl API url}}

Query Parameters:

• version: string, required

Response:

• A TransactionResponseResponse object.

Error Codes:

• 400: Bad Request
• 404: Resource not found
• 500: Internal server error

Example:

POST /api/v1/BankTransfers
Request Body:
{
  "accountId": "<uuid>",
  "amount": "<double>",
  "description": "<string>",
  "beneficiary": {
    "accountNumber": "<string>",
    "accountName": "<string>",
    "bankCode": "<string>",
    "bankName": "<string>"
  },
  "clientReference": "<string>"
}

Response:

HTTP/1.1 200 OK
{
  "transactionId": "1234567890",
  "status": "Success"
}

Method: POST

/api/v1/BankTransfers

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "accountId": "<uuid>",
  "amount": "<double>",
  "description": "<string>",
  "beneficiary": {
    "accountNumber": "<string>",
    "accountName": "<string>",
    "bankCode": "<string>",
    "bankName": "<string>"
  },
  "clientReference": "<string>"
}

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "id": "<uuid>",
    "beneficiaryAccount": {
      "accountNumber": "<string>",
      "accountName": "<string>",
      "bank": "<string>"
    },
    "sourceAccount": {
      "accountNumber": "<string>",
      "accountName": "<string>",
      "bank": "<string>"
    },
    "customerName": "<string>",
    "customerEmail": "<string>",
    "customerPhone": "<string>",
    "accountNumber": "<string>",
    "accountName": "<string>",
    "narration": "<string>",
    "amount": "<double>",
    "previousBalance": "<double>",
    "newBalance": "<double>",
    "transactionFee": "<double>",
    "settledAmount": "<double>",
    "transactionType": 0,
    "transactionStatus": 3,
    "transactionSource": 5,
    "transactionReference": "<uuid>",
    "customerId": "<string>",
    "merchantId": "<string>",
    "remarks": "<string>",
    "prevailingRate": "<string>",
    "processingAgentID": "<string>",
    "userTransactionRef": "<string>",
    "transactionDate": "<dateTime>",
    "deleted": "<boolean>",
    "externalReference": "<string>",
    "walletId": "<uuid>",
    "origin": 1,
    "currency": "<string>",
    "externalBankReference": "<string>",
    "originatorName": "<string>",
    "originatorAccountNumber": "<string>",
    "originatorBankName": "<string>"
  }
}