1. Payments
ROZO Intents API
  • Payments
    • Get Payment
      GET
    • Create Payment
      POST
    • Get Payment by Order ID
      GET
    • Register Payin Transaction Hash
      POST
    • List Payments
      GET
  • Payout confirmed on the destination chain
  • Payin confirmed on the source chain
  • Schemas
    • PaymentRequest
    • WebhookEventType
    • CreatePaymentRequest
    • WebhookEvent
    • PaymentUpdateRequest
    • PaymentResponse
    • PaymentListResponse
    • DisplayInfo
    • TransactionsResponse
    • SourceRequest
    • SourceResponse
    • DestinationRequest
    • DestinationResponse
    • ErrorResponse
    • ChainId
    • TokenSymbol
    • PaymentStatus
    • PaymentErrorCode
    • FeeType
  1. Payments

List Payments

GET
/payments
Returns the merchant's payment orders, newest first.
Auth required. X-API-Key is mandatory for merchant appIds —
results are automatically scoped to the key's app_id, so you
only ever see your own orders (cross-tenant defense). Any
?appId= in the query string is ignored when a key is supplied.
Use this to power your own dashboard or reconciliation script.
For real-time updates, prefer webhooks over polling.

Request

Authorization
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
or
Query Params

Responses

🟢200
application/json
Page of payments belonging to the key's app_id.
Bodyapplication/json

🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://intentapiv4.rozo.ai/functions/v1/payment-api/payments?limit=undefined&offset=undefined&status=undefined&fromDate=2026-05-01T00%3A00%3A00Z&toDate=2026-05-11T23%3A59%3A59Z' \
--header 'X-API-Key: <api-key>'
Response Response Example
200 - Example 1
{
    "data": [
        {
            "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"
            }
        }
    ],
    "pagination": {
        "total": 137,
        "limit": 20,
        "offset": 0
    }
}
Modified at 2026-05-11 03:27:45
Previous
Register Payin Transaction Hash
Next
Payout confirmed on the destination chain
Built with