Create payment

Create a hosted checkout payment for one of your merchants. Optional `token` / `networkId` limit which asset or network the buyer can use.

Create a hosted checkout payment for one of your merchants. Optional token / networkId limit which asset or network the buyer can use.

Authorization

bearerAuth requestSignature

AuthorizationBearer <token>

Partner API key (orq_pk_test_… or orq_pk_live_…). Paste the key.

In: header

X-Request-Signature<token>

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

In: header

Header Parameters

Idempotency-Key*string

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

merchantId*string

Formatuuid

amount*string

email*string

Formatemail

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?

externalUserId?string

addressMode?string

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

Default"invoice"

Value in

"invoice"
"customer"

Response Body

`application/json`

curl -X POST "https://example.com/v1/partner/payments" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "merchantId": "cccccccc-cccc-4ccc-8ccc-cccccccccccc",    "amount": "10.50",    "email": "payer@example.com",    "token": "USDC",    "networkId": 11155111,    "referenceId": "your-order-id",    "successUrl": "https://your-app.example/success",    "cancelUrl": "https://your-app.example/cancel"  }'

{  "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",  "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b"}

{  "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",  "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b"}

{  "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

404application/json

`application/json`

`application/json`

`application/json`

`application/json`