v38

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-192793126.4 KB
Payments

Gets a payment by ID or external ID.

get/payments/{payment_ref}

Path parameters

payment_refstring required

Payment ID or external ID.

Example:pmt_abc123

Response

Success

Example response

{
  "data": {
    "id": "pmt_abc123",
    "external_id": "pmt_ext_123",
    "direction": "payin",
    "amount": "10000",
    "currency": "USD",
    "status": "settled",
    "payment_flow_id": "pf_xyz789",
    "payment_account_id": "pmt_account_abc123",
    "transaction_ids": [
      "txn_abc123"
    ],
    "created": "2024-01-01T00:00:00.000Z",
    "modified": "2024-01-01T00:00:00.000Z"
  }
}