Skip to main content
POST
/
bank-transfers
Creates a new bank transfer payment for the authenticated entity.
curl --request POST \
  --url https://api.nuvion.tech/bank-transfers \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "NGN",
  "amount": 150000,
  "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
  "narration": "Salary payment for June 2025",
  "counterparty_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
  "unique_reference": "TRANS-REF-123456",
  "meta": {
    "custom_field1": "value1",
    "custom_field2": "value2"
  }
}
'
{
  "message": "Bank transfer payment created successfully",
  "status": 201,
  "data": {
    "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
    "amount": 150000,
    "currency": "NGN",
    "unique_reference": "TRANS-REF-123456",
    "counterparty_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
    "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
    "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
    "status": "pending",
    "status_reason": "awaiting_processing",
    "narration": "Salary payment for June 2025",
    "type": "outflow",
    "applicable_fee": 1500,
    "meta": {},
    "created": 1692799432000,
    "updated": 1692799432000
  }
}

Headers

Authorization
string
required

Authorization header: Bearer {jwt or Secretkey}

Body

application/json
currency
string
required

The currency code for the transfer

amount
number
required

The amount to transfer in the smallest currency unit (e.g., kobo, pesewas)

account_id
string
required

The unique identifier (ULID) of the source account

narration
string
required

The description or purpose of the transfer

counterparty_id
string
required

The unique identifier (ULID) of the recipient/counterparty

unique_reference
string
required

A unique reference for this transaction to prevent duplication

meta
object

Optional metadata for the transfer

Response

Created successfully

message
string
required

A descriptive message indicating the result of the operation

status
string
required

The status of the API operation (successful, error, failed, pending)

data
object
required

Contains the details of the created bank transfer