InvoicesPayments and statements

Get a payment

GET
/v1/payments/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Path Parameters

id*string

Response Body

Success

application/json
  1. response

Success

id*string
number*string

Counts up from PMT-0001 across your account, with no gaps

customerId*string
amount*integer

Minor units of the invoice's currency

Range0 <= value
currency*string

ISO 4217 currency code

Value in"USD""EUR""GBP""CAD""AUD""NZD""CHF""SEK""NOK""DKK""PLN""INR""SGD""HKD""AED""ZAR""BRL""MXN"
date*string

When the money arrived, as you recorded it

Formatdate-time
method*string

How the money moved, outside this platform

Value in"bank_transfer""cash""card""other"
reference*string|null
allocations*array<>
unallocated*integer

amount less what allocations adds up to: the credit this payment left on the customer's account

Range0 <= value
shared*boolean

True once POST /payments/{id}/share has made a public receipt link, false again once revoked

issuer*|null
createdAt*string
Formatdate-time
curl -X GET "https://example.com/v1/payments/pmt_01K6XJ4Q8ZT3M9R5V2B7WDHNCA"
{  "id": "pmt_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "number": "PMT-0001",  "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "amount": 2878,  "currency": "USD",  "date": "2026-10-07T11:04:31.000Z",  "method": "bank_transfer",  "reference": null,  "allocations": [    {      "invoiceId": "inv_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "invoiceNumber": "INV-0001",      "amount": 2878    }  ],  "unallocated": 2878,  "shared": true,  "issuer": {    "name": "Northwind Telecom",    "legalName": null,    "addressLines": [],    "taxId": null,    "billingEmail": null  },  "createdAt": "2026-10-07T11:04:31.000Z"}