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

Get Payment by Order ID

GET
/payments/order/{appId}/{orderId}
Looks up a payment by the merchant-supplied orderId (same value
you passed on POST /). Useful for idempotency — call this on
retry to recover the existing payment instead of creating a
duplicate.
Auth: X-API-Key is recommended; the lookup is scoped to the
key's app_id. Without a key the endpoint still works for legacy
callers, but cross-tenant defense is disabled.

Request

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

Responses

🟢200
application/json
Payment found
Bodyapplication/json

🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://intentapiv4.rozo.ai/functions/v1/payment-api/payments/order/merchant_hellocoffee/CAFE-1768921337803' \
--header 'X-API-Key: <api-key>'
Response Response Example
200 - 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:45
Previous
Create Payment
Next
Register Payin Transaction Hash
Built with