v1

latestOpenAPI 3.0.02026-07-22290108.6 KB

Request

V2/Request

Get payment calldata

Get the calldata needed to pay a request. For same-chain payments, returns transaction calldata that can be directly executed. For crosschain payments (when chain and token parameters are provided and differ from the request's native chain), returns a payment intent that needs to be signed and processed through the crosschain bridge. For off-ramp payments, use the query parameters clientUserId and paymentDetailsId. Note: Crosschain requests with an expectedAmount less than 1 are rejected.

get/v2/request/{requestId}/pay

Path parameters

requestIdstring required

Example:01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb

The requestId of the request

Query parameters

walletstring

Example:0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7

The wallet address of the payer.

chain'BASE' | 'OPTIMISM' | 'ARBITRUM' | 'ETHEREUM'

The source chain of the crosschain payment

token'USDC' | 'USDT'

The source token of the crosschain payment

amountstring

The amount to pay, in human readable format

clientUserIdstring

Example:user-123

Optional client user ID for off-ramp payments

paymentDetailsIdstring

Example:fa898aec-519c-46be-9b4c-e76ef4ff99d9

Optional payment details ID for off-ramp payments

feePercentagestring

Example:0.02

Fee percentage to apply at payment time (e.g., '2.5' for 2.5%)

feeAddressstring

Example:0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7

Address to receive the fee

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)

Response

Payment calldata retrieved successfully