Get a payment route

GET

/v1/payment-routes/:routeId

GET

/v1/payment-routes/:routeId

$ curl https://public-api.alphax.com/v1/payment-routes/01KZ2RT4Q8N7YB3D5F6G7H8J9K \
>      -H "X-Company-Id: 01KZ2WJKWVFPCVAB6MY106QRZV" \
>      -H "X-API-Key: <apiKey>"

1 {
2   "paymentRoute": {
3     "id": "01KZ2RT4Q8N7YB3D5F6G7H8J9K",
4     "type": "offramp",
5     "status": "active",
6     "currency": "USD",
7     "feePercent": 0.9,
8     "depositAddress": "TTRRSXZza9kJuv1fSUeehfkJsZntqUQSqp",
9     "source": {
10       "type": "crypto",
11       "currency": "USDT",
12       "paymentRail": "tron",
13       "address": "TTRRSXZza9kJuv1fSUeehfkJsZntqUQSqp"
14     },
15     "destination": {
16       "type": "crypto",
17       "currency": "USDT",
18       "paymentRail": "tron",
19       "address": "TTRRSXZza9kJuv1fSUeehfkJsZntqUQSqp"
20     },
21     "createdAt": "2024-01-15T09:30:00Z"
22   }
23 }

Full deposit instructions. depositAddress is the short answer to “where does the payer send money”.

Authentication

X-API-Keystring

Your partner API key.

Path parameters

routeIdstringRequired

A payment route ULID.

Response

paymentRouteobjectOptional

Errors

403

Forbidden Error

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors