List Bank Transfers

Retrieves all bank transfer payments with optional filtering for the authenticated entity.

curl --request GET \
  --url https://api.nuvion.tech/bank-transfers \
  --header 'Authorization: <authorization>'

{
  "message": "Bank transfer payments retrieved successfully",
  "status": 200,
  "data": [
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "amount": 150000,
      "currency": "NGN",
      "unique_reference": "TRANS-REF-123456",
      "counterparty_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "status": "successful",
      "status_reason": "payment_completed",
      "narration": "Salary payment for June 2025",
      "type": "outflow",
      "applicable_fee": 1500,
      "meta": {},
      "created": 1692799432000,
      "updated": 1692799532000,
      "initiator": {
        "type": "account",
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
        "name": "Operations Account"
      },
      "recipient": {
        "type": "counterparty",
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
        "name": "John Doe",
        "issuer": {
          "code": "057"
        },
        "details": {
          "account_number": "1234567890"
        }
      }
    },
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "amount": 250000,
      "currency": "NGN",
      "unique_reference": "TRANS-REF-789012",
      "counterparty_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F8",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "status": "pending",
      "status_reason": "awaiting_processing",
      "narration": "Vendor payment",
      "type": "outflow",
      "applicable_fee": 2500,
      "meta": {},
      "created": 1692789432000,
      "updated": 1692789432000,
      "initiator": {
        "type": "account",
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
        "name": "Operations Account"
      },
      "recipient": {
        "type": "counterparty",
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F8",
        "name": "Acme Corp",
        "issuer": {
          "code": "044"
        },
        "details": {
          "account_number": "0987654321"
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "order": "desc",
      "has_next": true,
      "limit": 20,
      "has_previous": false,
      "next_cursor": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "previous_cursor": "01HJ5G6R7MXW5ZK2QD6YA8N9F3"
    },
    "filters_applied": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "payment_type": "bank-transfer",
      "sort": {
        "field": "created",
        "order": "desc"
      }
    }
  }
}

GET

bank-transfers

Retrieves all bank transfer payments with optional filtering for the authenticated entity.

curl --request GET \
  --url https://api.nuvion.tech/bank-transfers \
  --header 'Authorization: <authorization>'

{
  "message": "Bank transfer payments retrieved successfully",
  "status": 200,
  "data": [
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "amount": 150000,
      "currency": "NGN",
      "unique_reference": "TRANS-REF-123456",
      "counterparty_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "status": "successful",
      "status_reason": "payment_completed",
      "narration": "Salary payment for June 2025",
      "type": "outflow",
      "applicable_fee": 1500,
      "meta": {},
      "created": 1692799432000,
      "updated": 1692799532000,
      "initiator": {
        "type": "account",
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
        "name": "Operations Account"
      },
      "recipient": {
        "type": "counterparty",
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
        "name": "John Doe",
        "issuer": {
          "code": "057"
        },
        "details": {
          "account_number": "1234567890"
        }
      }
    },
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "amount": 250000,
      "currency": "NGN",
      "unique_reference": "TRANS-REF-789012",
      "counterparty_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F8",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "status": "pending",
      "status_reason": "awaiting_processing",
      "narration": "Vendor payment",
      "type": "outflow",
      "applicable_fee": 2500,
      "meta": {},
      "created": 1692789432000,
      "updated": 1692789432000,
      "initiator": {
        "type": "account",
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
        "name": "Operations Account"
      },
      "recipient": {
        "type": "counterparty",
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F8",
        "name": "Acme Corp",
        "issuer": {
          "code": "044"
        },
        "details": {
          "account_number": "0987654321"
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "order": "desc",
      "has_next": true,
      "limit": 20,
      "has_previous": false,
      "next_cursor": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "previous_cursor": "01HJ5G6R7MXW5ZK2QD6YA8N9F3"
    },
    "filters_applied": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "payment_type": "bank-transfer",
      "sort": {
        "field": "created",
        "order": "desc"
      }
    }
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Query Parameters

limit

number

Number of records to return per page

cursor

string

Cursor for pagination (next page)

prev_cursor

string

Cursor for pagination (previous page)

status

string

Status of the bank transfers to filter by

account_id

string

Filter by source account ID

counterparty_id

string

Filter by recipient counterparty ID

currency

string

Filter by currency code

payment_type

string

Type of payment to filter by

unique_reference

string

Filter by unique reference

amount_min

number

Minimum amount filter

amount_max

number

Maximum amount filter

date_from

string

Start date filter (ISO string)

date_to

string

End date filter (ISO string)

sort_by

string

Field to sort results by

sort_order

string

Sort direction

include_details

string

Flag to include additional details about the initiator and recipient

Response

Successful operation

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

List of bank transfer objects

Show child attributes

data.id

string

required

Unique identifier for the bank transfer

data.amount

number

required

The amount of the bank transfer in the smallest currency unit

data.currency

string

required

Three-letter ISO currency code

data.unique_reference

string

required

A unique reference for the bank transfer

data.counterparty_id

string

required

Unique identifier for the counterparty

data.account_id

string

required

Unique identifier for the account

data.entity_id

string

required

Unique identifier for the entity

data.status

string

required

Current status of the bank transfer

data.status_reason

string

required

Reason for the current status

data.narration

string

required

Description or purpose of the transfer

data.type

string

required

Direction of the transfer (inflow or outflow)

data.applicable_fee

number

required

Fee applied to the transfer in the smallest currency unit

data.meta

object

required

Additional metadata for the bank transfer

data.created

number

required

Timestamp when the bank transfer was created (Unix timestamp in milliseconds)

data.updated

number

required

Timestamp when the bank transfer was last updated (Unix timestamp in milliseconds)

data.initiator

object

required

Information about the initiator of the bank transfer

Show child attributes

data.initiator.type

string

required

Type of the initiator

data.initiator.id

string

required

Unique identifier for the initiator

data.initiator.name

string

required

Name of the initiator

data.recipient

object

required

Information about the recipient of the bank transfer

Show child attributes

data.recipient.type

string

required

Type of the recipient

data.recipient.id

string

required

Unique identifier for the recipient

data.recipient.name

string

required

Name of the recipient

data.recipient.issuer

object

required

Information about the recipient's bank

Show child attributes

data.recipient.issuer.code

string

required

Bank code of the recipient's bank

data.recipient.details

object

required

Additional details about the recipient

Show child attributes

data.recipient.details.account_number

string

required

Account number of the recipient

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

List Bank Transfers

Headers

Query Parameters

Response