Skip to main content
POST
/
api
/
v1
/
business
/
collections
Create a local-rails collection (S2S)
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.

Headers

x-api-key
string
required

Body

application/json
amount
number
required

Amount in major units (matches hosted checkout)

currency
string
required
Example:

"ngn"

country
string
required
Example:

"NG"

customer
object
required
channel
object
metadata
object
successUrl
string

Used for hosted-page rails such as ZA EFT

expiresInSeconds
number
default:600
Required range: 60 <= x <= 3600
idempotencyKey
string

Response

Created

success
boolean
required
Example:

true

data
object
required