Create payment

Create a hosted checkout payment. Send the buyer to `checkoutUrl`. Optional `token` and `networkId` limit which asset or network the buyer can use. Returns an error if that option is not available for your account.

Create a hosted checkout payment. Send the buyer to checkoutUrl.

Optional token and networkId limit which asset or network the buyer can use. Returns an error if that option is not available for your account.

Authorization

bearerAuth requestSignature

AuthorizationBearer <token>

Merchant API key (orq_mk_test_… or orq_mk_live_…).

In: header

X-Request-Signature<token>

Signing secret (orq_ms_…). Playground signs for you.

In: header

Header Parameters

Idempotency-Key*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

email*string

Formatemail

externalUserId?string

Your user id for the payer (optional).

addressMode?string

invoice (default) — new pay address per payment. customer — reuse a stable address for this payer.

Default"invoice"

Value in

"invoice"
"customer"

token?string

Limit checkout to this token.

Value in

"USDC"
"USDT"

networkId?integer

Limit checkout to this network. See Networks docs.

referenceId?string

Your order id (unique per merchant × environment).

successUrl?string

cancelUrl?string

metadata?

Response Body

`application/json`

curl -X POST "https://example.com/v1/payments" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "amount": "10.50",    "email": "payer@example.com",    "token": "USDC",    "networkId": 11155111,    "referenceId": "order-123"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "string",  "environment": "test",  "addressMode": "invoice",  "amount": "string",  "amountReceived": "string",  "remaining": "string",  "surplus": "string",  "token": "string",  "referenceId": "string",  "email": "string",  "checkoutUrl": "http://example.com",  "expiresAt": "2019-08-24T14:15:22Z",  "successUrl": "string",  "cancelUrl": "string",  "depositAddresses": [    {      "networkId": 0,      "chainName": "string",      "family": "evm",      "address": "string",      "token": "string",      "chainId": "9e7fb22a-9e5b-420e-8fd7-e3454fcfd5fd"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "string",  "environment": "test",  "addressMode": "invoice",  "amount": "string",  "amountReceived": "string",  "remaining": "string",  "surplus": "string",  "token": "string",  "referenceId": "string",  "email": "string",  "checkoutUrl": "http://example.com",  "expiresAt": "2019-08-24T14:15:22Z",  "successUrl": "string",  "cancelUrl": "string",  "depositAddresses": [    {      "networkId": 0,      "chainName": "string",      "family": "evm",      "address": "string",      "token": "string",      "chainId": "9e7fb22a-9e5b-420e-8fd7-e3454fcfd5fd"    }  ],  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

Create payment

Authorization

Header Parameters

Request Body

Response Body

200application/json

201application/json

400application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`