Skip to main content
POST
/
api
/
external
/
collection
Initiate a collection
curl --request POST \
  --url https://api-prod.blaaiz.com/api/external/collection \
  --header 'Content-Type: application/json' \
  --header 'x-blaaiz-api-key: <api-key>' \
  --data '
{
  "customer_id": "customer_123",
  "wallet_id": "wallet_123",
  "amount": 50000,
  "currency": "NGN",
  "method": "open_banking",
  "phone_number": "+2348012345678",
  "email": "[email protected]",
  "reference": "collection_ref_001",
  "narration": "Payment for services",
  "redirect_url": "https://yourapp.com/payment/success"
}
'
{
  "status": true,
  "message": "Collection initiated successfully",
  "data": {
    "id": "collection_123456789",
    "transaction_id": "txn_987654321",
    "customer_id": "customer_123",
    "wallet_id": "wallet_123",
    "amount": 50000,
    "currency": "NGN",
    "method": "open_banking",
    "status": "pending",
    "payment_url": "https://checkout.blaaiz.com/pay/abc123xyz",
    "reference": "collection_ref_001",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Authorizations

​
x-blaaiz-api-key
string
header
required

Headers

​
Accept
string
default:application/json

Content type header.

Body

application/json
​
customer_id
string
required

Unique identifier of the customer making the payment.

​
wallet_id
string
required

Wallet ID where funds will be credited.

​
amount
number
required

Amount to collect (including all fees).

​
currency
string
required

Currency code (e.g., NGN, USD, EUR, GBP).

​
method
enum<string>
required

Collection method. Only open_banking is currently supported.

Available options:
open_banking
​
phone_number
string

Customer's phone number (required for certain methods).

​
email
string<email>

Customer's email address.

​
reference
string

Your unique reference for this transaction.

​
narration
string

Description or note for the collection.

​
redirect_url
string<uri>

URL to redirect the customer after payment completion.

Response

Collection initiated successfully. Redirect customer to payment_url for open_banking.

​
message
string
required
​
transaction_id
string
required
​
url
string<uri>
required

URL to redirect customer to complete payment