Get payment
Get a payment by its ID
Authentication
AuthorizationBearer
API Key authentication using Bearer token
Path parameters
id
Response
200
id
Unique payment identifier.
number
Sequential payment number within your organization (shown as “PAY-0001”).
customerId
The customer this payment belongs to.
invoiceId
The invoice this payment was collected for, when created by an automatic charge. Null for manually recorded payments.
orderId
The order this payment relates to, when known.
amount
Payment amount in stored minor units: cents for USD; for JPY, hundredths when currencyDecimals is 2 and whole yen when it is 0.
allocatedAmount
Portion allocated to invoice lines, in stored minor units described by currencyDecimals.
balance
Unallocated remainder, in stored minor units described by currencyDecimals.
currency
Three-letter ISO currency code.
currencyDecimals
Decimals of this payment’s amounts, from the currency and how Paid stores it: 2 for USD (4999 is $49.99); for JPY 2 while Paid stores yen in hundredths, then 0. Divide amounts by 10^currencyDecimals; never assume 100.
paymentDate
When the payment was made.
paymentType
How the payment was made, e.g. creditCard, bankTransfer, ach, cash, or check.
status
Payment status: draft, posted, processing, requiresAction, failed, or canceled.
metadata
Key-value metadata stored on the payment.
createdAt
updatedAt
Errors
400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error