Sign in

v2

latestOpenAPI 3.1.02026-07-267085761.0 MB
Platform Cross-Border

Get a Cross-Border Payment

Fetches a single cross-border payment by its id.

Returns the payment record — status, source and payout amounts, currency, exchange rate, description and invoice number. Returns 404 if the payment is not found for the platform or is not a cross-border payout.

get/api/platform/cross-border/payments/{payment_id}

Path parameters

payment_idstring uuid required

Unique identifier (UUID) of the cross-border payment.

Unique identifier (UUID) of the cross-border payment.

Headers

X-Platform-IDstring uuid required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signaturestring required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

messagestring

A short, human-readable message describing the result of the request.

queryGeneratedTimenumber nullable

The Unix timestamp (in seconds) indicating when the response was generated.

Example response

{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "payment_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "status": "PROCESSING",
    "amount": 20,
    "currency": "USD",
    "payout_currency": "INR",
    "payout_amount": 1930,
    "exchange_rate": 94.8907,
    "invoice_number": "INV-2024-001234"
  },
  "queryGeneratedTime": 1718006400
}