curl --request POST \
--url http://localhost:3001/api/v1/business/collections \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"amount": 123,
"currency": "ngn",
"country": "NG",
"customer": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"metadata": {},
"successUrl": "<string>",
"expiresInSeconds": 600,
"idempotencyKey": "<string>"
}
'{
"success": true,
"data": {
"id": "<string>",
"object": "collection",
"status": "pending",
"amount": 123,
"currency": "<string>",
"country": "<string>",
"expiresAt": "<string>",
"channel": {
"rail": "bank",
"provider": "<string>",
"channelId": "<string>"
},
"instructions": {
"kind": "bank_transfer",
"bankName": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"reference": {},
"phone": "<string>",
"prompt": "<string>",
"url": "<string>",
"provider": "<string>"
},
"businessPaymentId": "<string>",
"source": "api",
"createdAt": "<string>",
"metadata": {}
}
}curl --request POST \
--url http://localhost:3001/api/v1/business/collections \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"amount": 123,
"currency": "ngn",
"country": "NG",
"customer": {
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"metadata": {},
"successUrl": "<string>",
"expiresInSeconds": 600,
"idempotencyKey": "<string>"
}
'{
"success": true,
"data": {
"id": "<string>",
"object": "collection",
"status": "pending",
"amount": 123,
"currency": "<string>",
"country": "<string>",
"expiresAt": "<string>",
"channel": {
"rail": "bank",
"provider": "<string>",
"channelId": "<string>"
},
"instructions": {
"kind": "bank_transfer",
"bankName": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"reference": {},
"phone": "<string>",
"prompt": "<string>",
"url": "<string>",
"provider": "<string>"
},
"businessPaymentId": "<string>",
"source": "api",
"createdAt": "<string>",
"metadata": {}
}
}Documentation Index
Fetch the complete documentation index at: https://docs.useaxra.com/llms.txt
Use this file to discover all available pages before exploring further.
Amount in major units (matches hosted checkout)
"ngn"
"NG"
Show child attributes
Show child attributes
Used for hosted-page rails such as ZA EFT
60 <= x <= 3600