Skip to main content
POST
/
api
/
v1
/
collections
/
accounts
Create a collection account
curl --request POST \
  --url https://dev-api-partner.onecluster.co/api/v1/collections/accounts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "partnerId": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
  "accountType": "STATIC"
}
'
{
  "success": true,
  "responseCode": "00",
  "message": "Collection account created",
  "data": {
    "accountNumber": "9876543210",
    "bankCode": "032",
    "bankName": "Union Bank of Nigeria",
    "accountType": "STATIC"
  }
}

Authorizations

​
Authorization
string
header
required

Your API key, formatted as: ApiKey ubn_sb_your_key_here

  • Sandbox keys start with ubn_sb_
  • Production keys start with ubn_pk_
  • Never use production keys during testing — they will charge real money

Headers

​
X-Correlation-ID
string<uuid>

A UUID v4 you generate to trace this request through our systems. If you don't provide one, we generate it for you. Always include it in support requests — it helps us find your request in logs.

Example:

"7f3a9c21-4e8b-4a12-b6d1-3c8a7f2e1b09"

​
X-Idempotency-Key
string<uuid>
required

A UUID you generate. If you send the same request twice with the same key (within 24 hours), we return the original response — not a duplicate action. Generate a new UUID for every new operation.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
​
partnerId
string<uuid>
required
​
accountType
enum<string>
default:STATIC
required
Available options:
STATIC,
DYNAMIC
​
expiryHours
integer

Required when accountType is DYNAMIC

Response

Collection account created

Standard response wrapper for all successful API calls

​
success
boolean
required

Always true for successful responses

Example:

true

​
responseCode
string
required

00 means success

Example:

"00"

​
message
string
required

Human-readable description of the result

Example:

"Request processed successfully"

​
data
object
required

The actual response data (varies by endpoint)