Sign in

v1

latestOpenAPI 3.0.02026-07-22290108.6 KB
Request
V2/Request

Create a new request

Create a new payment request

post/v2/request

Headers

x-api-keystring

API key for authentication (optional if using Client ID)

x-client-idstring

Client ID for frontend authentication (optional if using API key)

Originstring

Origin header (required for Client ID auth, automatically set by browser)

Request body

payerstring

The wallet address of the payer

payeestring

The wallet address of the payee (Ethereum 0x... or TRON T...). Required for all requests except crypto-to-fiat

amountstring required

The payable amount of the invoice, in human readable format

invoiceCurrencystring required

Invoice Currency ID, from the Request Network Token List e.g: USD

paymentCurrencystring required

Payment currency ID, from the Request Network Token List e.g: ETH-sepolia-sepolia

isCryptoToFiatAvailableboolean

Whether crypto-to-fiat payment is available for this request

referencestring

Merchant reference for receipt tracking and identification

originalRequestIdstring

ID of the original request for recurring payments

originalRequestPaymentReferencestring

Payment reference of the original request for recurring payments

Response

Request created successfully

paymentReferencestring

Unique identifier of the request, used to pay the request as well as check the status of the request

requestIdstring

Unique identifier of the request, commonly used to look up a request in Request Scan

Example response

{
  "paymentReference": "0xb3581f0b0f74cc61",
  "requestId": "01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb"
}