API Referencepayments

Get payment

Get a payment by its ID

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Path parameters

idstringRequired

Response

200
idstring
Unique payment identifier.
numberinteger

Sequential payment number within your organization (shown as “PAY-0001”).

customerIdstring
The customer this payment belongs to.
invoiceIdstring or null
The invoice this payment was collected for, when created by an automatic charge. Null for manually recorded payments.
orderIdstring or null
The order this payment relates to, when known.
amountinteger

Payment amount in cents (minor currency units).

allocatedAmountinteger
Portion of the amount already allocated to invoice lines, in cents.
balanceinteger
Unallocated remainder of the payment, in cents.
currencystring

Three-letter ISO currency code.

paymentDatedatetime
When the payment was made.
paymentTypestring
How the payment was made, e.g. creditCard, bankTransfer, ach, cash, or check.
statusstring

Payment status: draft, posted, processing, requiresAction, failed, or canceled.

metadatamap from strings to any or null

Key-value metadata stored on the payment.

createdAtdatetime
updatedAtdatetime

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error