🛠 API Documentation
To view the documentation, you can use this link:
https://staging.api.xert.brsdev.com/docs
Create Payment Request
Overview
This endpoint creates a new payment request.
It requires payment details, the recipient address, and callback URLs.
On success, it returns a unique payment_request_id and its status.
Request Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
| amount | number or string | ✅ | The payment amount. |
| payout_address | string | ✅ | The recipient address for the payout (merchant address). |
| webhook_url | string (URI) | ✅ | URL where the merchant receives notifications about the payment status. |
| return_url | string (URI) | ✅ | URL where the user will be redirected after payment. Length: 1–2083 characters. |
| chain_ids | array of integers | ❌ | List of blockchain chain IDs where the payment can be processed. |
Responses
200 — Successful Response
Response Schema: application/json
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | ✅ | Payment Request ID |
| created_at | string |
✅ | Timestamp of creation |
422 — Validation Error
Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| detail | Array of objects | Validation error details |
Finalize Payment Request
Overview
This endpoint finalizes an existing payment request identified by payment_request_id.
It requires specifying the chain_id where the payment is expected.
Upon success, a background task is triggered to verify transactions sent to the temporary address.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| payment_request_id | string | ✅ | Payment Request ID |
Request Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
| chain_id | integer | ✅ | Blockchain network ID where the payment is expected. |
Responses
200 — Successful Response
Response Schema: application/json
(any)
422 — Validation Error
Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| detail | Array of objects | Validation error details |
Get Payment Info
Overview
This endpoint returns information about a payment request identified by payment_request_id.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| payment_request_id | string | ✅ | Payment Request ID |
Responses
200 — Successful Response
Response Schema: application/json
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | ✅ | Id |
| status | string | ✅ | Status |
| amount_expected | string (regex: ^(?!^[-+.]$)[+-]?0\d.?\d$) | ✅ | Amount Expected |
| crypto | object (CryptoAmounts) | ✅ | Crypto amounts |
| dates | object (DatesInfo) | ✅ | Dates info |
| chain | ChainData (object) or null | ✅ | Chain data |
| links | object (PaymentLinks) | ✅ | Payment links |
| wallets | Array of objects (Wallets) | ✅ | Wallets |
422 — Validation Error
Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| detail | Array of objects | Validation error details |
Get Chains Info
Overview
This endpoint returns the list of available chains for the specified payment_request_id.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| payment_request_id | string | ✅ | Payment Request ID |
Responses
200 — Successful Response
Response Schema: application/json
| Field | Type | Required | Description |
|---|---|---|---|
| chains | Array of objects (Chains) | ✅ | List of chains |
422 — Validation Error
Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| detail | Array of objects | Validation error details |
Alchemy Webhook
Overview
This endpoint receives webhook notifications from Alchemy.
Request Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
| webhookId | string | ✅ | Webhook ID |
| id | string | ✅ | Id |
| createdAt | string | ✅ | Created at |
| type | string | ✅ | Type |
| event | object (Event) | ✅ | Event payload |
Responses
200 — Successful Response
(no schema)
422 — Validation Error
Response Schema: application/json
| Field | Type | Description |
|---|---|---|
| detail | Array of objects | Validation error details |