Skip to main content
POST
/
api
/
v1
/
initiate
Initiate Checkout
curl --request POST \
  --url https://routexapi.xoroai.cloud/api/v1/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "email": "jsmith@example.com",
    "name": "<string>"
  },
  "amount": 123,
  "currency": "NGN",
  "reference": "<string>"
}
'
{
  "status": true,
  "message": "Charge created successfully",
  "reference": "TXN_123456",
  "checkout_url": "https://checkout.payment.com/tx/123",
  "selected_gateway": "fltw",
  "gateway_reference": "FLTW_PROC_001",
  "routing": {
    "decision_id": "<string>",
    "selection_reason": "highest score among eligible gateways",
    "fallback_order": [
      "<string>"
    ],
    "score_breakdown": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
customer
Customer · object
required
​
amount
number
required
​
currency
enum<string>
required

Currency in lower case

Available options:
NGN,
KES,
GES,
XAF,
XOF,
EGP,
TZS,
BTC,
ETH,
USDT,
SOL
​
reference
string
required
​
gateway_code
string | null

Optional gateway override. Use pstk, fltw, kora, or isw. If omitted, RouteX routes automatically.

Example:

"pstk"

​
redirect_url
string | null
​
notification_url
string | null
​
narration
string | null
​
metadata
Metadata · object

Response

Successful Response

​
status
boolean
required

Indicates if the transaction initialization was successful

Example:

true

​
message
string
required

Human-readable message

Example:

"Charge created successfully"

​
reference
string | null

Transaction reference

Example:

"TXN_123456"

​
checkout_url
string | null

URL for customer to complete payment

Example:

"https://checkout.payment.com/tx/123"

​
selected_gateway
string | null

Gateway selected by the router

Example:

"fltw"

​
gateway_reference
string | null

Gateway-facing reference for the routed transaction

Example:

"FLTW_PROC_001"

​
routing
RoutingMetadata · object

Routing decision details for the transaction