Create Payment

POST

Creates a new cross-chain payment request.

Conditional auth: if the request's appId starts with wallet_,
merchant, or rozomerchant, the request must include header
X-API-Key: rz_live_xxxxx. Other appIds are public (no key required).

Key is authoritative when present. If a valid X-API-Key is
supplied, the body's appId is silently overridden with the key's
app_id — passing the wrong appId in the body is harmless as long as
the key is correct. The appId field stays in the body for legacy
unkeyed callers.

Errors:

400 missing_api_key — appId requires a key but none was provided

400 invalid_api_key — key is unknown, revoked, expired, or inactive

Example with key:

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Payment created successfully

Bodyapplication/json

🟠400

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://intentapiv4.rozo.ai/functions/v1/payment-api/' \
--header 'Content-Type: application/json' \
--data '{
    "appId": "rozoBridgeStellar",
    "type": "exactIn",
    "display": {
        "title": "Deposit",
        "currency": "USD"
    },
    "source": {
        "chainId": 1,
        "tokenSymbol": "USDT",
        "amount": "1.00",
        "tokenAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7"
    },
    "destination": {
        "chainId": 1500,
        "receiverAddress": "GC56BXCNEWL6JSGKHD3RJ5HJRNKFEJQ53D3YY3SMD6XK7YPDI75BQ7FD",
        "tokenSymbol": "USDC",
        "tokenAddress": "USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN"
    },
    "metadata": {
        "intent": "Deposit"
    }
}'

Response Example

201 - Example 1

{
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "appId": "string",
    "orderId": "string",
    "errorCode": "string",
    "errorMessage": "string",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "expiresAt": "2019-08-24T14:15:22.123Z",
    "webhookSecret": "string",
    "metadata": {},
    "status": "payment_unpaid",
    "type": "exactIn",
    "display": {
        "title": "string",
        "description": "string",
        "currency": "string"
    },
    "destination": {
        "chainId": "string",
        "receiverAddress": "string",
        "receiverMemo": "string",
        "tokenSymbol": "string",
        "tokenAddress": "string",
        "amount": "string",
        "txHash": "string",
        "confirmedAt": "2019-08-24T14:15:22.123Z"
    },
    "source": {
        "chainId": "string",
        "tokenSymbol": "string",
        "tokenAddress": "string",
        "amount": "string",
        "receiverAddress": "string",
        "receiverMemo": "string",
        "fee": "string",
        "senderAddress": "string",
        "txHash": "string",
        "amountReceived": "string",
        "confirmedAt": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-05-11 03:27:37

Get Payment

Get Payment by Order ID