SupportDashboard
HomeGet StartedPaymentsCryptoComplianceChangelog

List transactions

Retrieve a paginated list of completed API transactions for your business. You can filter by date range, status, customer, wallet, and transaction type. Use type: SWAP to return only swap transactions. Required scope: transaction:read.

POSTapi-prod.blaaiz.com/api/external/transaction

Authorization

oauth2ClientCredentials transaction:read
AuthorizationBearer <token>

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

In: header

Scope: transaction:read

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

List transactions
curl --request POST \  --url 'https://example.com/api/external/transaction' \  --header 'Content-Type: application/json' \  --data '{  "start_date": "2026-03-01",  "end_date": "2026-03-13",  "status": "SUCCESSFUL",  "type": "SWAP"}'
{  "message": "Transactions retrieved successfully",  "data": [    {      "id": "txn_collection_001",      "business_id": "business_123",      "business_customer_id": "customer_123",      "business_wallet_id": "wallet_ngn_001",      "status": "SUCCESSFUL",      "refund_status": null,      "type": "collection",      "reference": "collection_ref_001",      "external_reference": "NGN-COLLECTION-001",      "currency": "NGN",      "amount": 50000,      "amount_without_fee": 50000,      "fee": 0,      "rate": null,      "date": "2026-03-13T09:10:00.000000Z",      "payee_collection_email": "customer@company.com",      "source_information": {        "collection_email": "collections@blaaiz.com",        "collection_name": "John Doe"      },      "swap_details": null,      "recipient": null    },    {      "id": "txn_payout_001",      "business_id": "business_123",      "business_customer_id": "customer_123",      "business_wallet_id": "wallet_ngn_001",      "status": "SUCCESSFUL",      "refund_status": null,      "type": "payout",      "reference": "payout_ref_001",      "external_reference": "NGN-PAYOUT-001",      "currency": "NGN",      "amount": 50000,      "amount_without_fee": 49500,      "fee": 500,      "rate": null,      "date": "2026-03-13T10:30:00.000000Z",      "payee_collection_email": null,      "source_information": {        "collection_email": null,        "collection_name": null      },      "swap_details": null,      "recipient": {        "id": "recipient_123",        "account_number": "0123456789",        "account_name": "John Doe",        "amount": 50000,        "currency": "NGN",        "bank_name": "Access Bank",        "bank_code": "044",        "status": "SUCCESSFUL",        "routing_number": null,        "email": null      }    },    {      "id": "txn_swap_001",      "business_id": "business_123",      "business_customer_id": null,      "business_wallet_id": "wallet_usd_001",      "status": "SUCCESSFUL",      "refund_status": null,      "type": "swap",      "reference": "swap_ref_001",      "external_reference": null,      "currency": "USD",      "amount": 100,      "amount_without_fee": 99,      "fee": 1,      "rate": null,      "date": "2026-03-13T11:45:00.000000Z",      "payee_collection_email": null,      "source_information": {        "collection_email": null,        "collection_name": null      },      "swap_details": {        "from_business_wallet_id": "wallet_usd_001",        "to_business_wallet_id": "wallet_ngn_001",        "from_currency": "USD",        "from_amount": 100,        "from_amount_without_fee": 99,        "to_currency": "NGN",        "to_amount": 160000,        "amount_type": "from",        "exchange_rate": 1600      },      "recipient": null    }  ],  "links": {    "first": "https://api-prod.blaaiz.com/api/external/transaction?page=1",    "last": "https://api-prod.blaaiz.com/api/external/transaction?page=1",    "prev": null,    "next": null  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "path": "https://api-prod.blaaiz.com/api/external/transaction",    "per_page": 10,    "to": 3,    "total": 3  }}

GETGet transaction

Retrieve a completed API transaction by its transaction ID, its reference, or the merchant_reference that you supplied. Required scope: `transaction:read`.

POSTCreate a customer

Create a new customer. Verification stays `PENDING` until the type-specific verification flow completes. **For `type=individual`**, `id_type` and `id_number` are required. After creation, upload identity files via the legacy KYC flow (see [Creating your first payout](/docs/guides/creating-first-payout)). Only Driver's License, Passport, or Resident Permit are accepted as `id_type`. **For `type=business`**, `business_name` + `registration_number` + `incorporation_country` are required. The legacy `id_type` / `id_number` fields are no longer required (still accepted for back-compat — when supplied, `id_type` must be `certificate_of_incorporation`). After creation, follow the [Business customer KYB](/docs/guides/kyb/overview) flow: register beneficial owners, upload owner ID files, register KYB documents, then call `/submit`. ID cards (National Identity Cards) are not accepted at any stage. All uploaded documents must be clear, legible, and authentic — unclear images will be rejected. Fraudulent or falsified documents will result in the customer being permanently blacklisted from the platform. Required scope: `customer:write`.