Skip to content

API

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.
payload JSON object JSON object with custom fields required for merchant notifications.

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