Field
Type
Description
external_id
Your own id for this payment, from your software. Send the same external_id again to update this payment instead of adding a new one. We match on this value but do not stop duplicates, so keep it unique within the site.
_id
The id of the payment, assigned by the system.
display_name
The secure friendly display name of the payment method. Example: VISA **** 3421.
last_4
The last 4 digits of the payment method. Only returned for payments taken through a stored payment method; a payment recorded through this API has none, so it is omitted.
amount
The amount that was paid. Format = 0.00
paid_on
The date and time of when the payment was made. A moment in time in ISO 8601, with a time zone. Format = YYYY-MM-DDTHH:mm:ssZ
gateway_transaction_id
The unique id that was assigned to the payment record from the gateway when the payment was processed.
tip
The tip amount that was added. Format = 0.00
tax
The tax amount that was added. Format = 0.00
fee
The fee amount that was added. Format = 0.00
invoice
A reference to the invoice record. On a write this is how the payment is applied to an invoice; it is echoed back on a read, alongside the fuller allocations list.
payment_type
The type of payment method used to make the payment.
One of payment_card, ach, eft, apple_pay, google_pay, oxxo, spei, bnpl, dlocal, cash, check, other
payment_sub_type
The sub type of the payment method used to make the payment.
One of visa, mastercard, amex, discover, diners, jcb, checking, savings, oxxo, spei, bnpl, google_pay, dlocal, cash, check, other
status
The current status of the payment. created: recorded but not yet sent to the processor. failed: the attempt errored before the processor answered. declined: the processor declined it. expired: it was not completed in time. cancelled: it was cancelled before it was processed. authorized: the card was approved and the funds are held, but not yet charged. captured: the payment was charged and has not settled yet. settled: the processor has settled the funds. voided: cancelled before it settled, so no money moved. refundRequested: a refund is waiting for the payment to settle. returned: the bank sent the payment back. chargebacked: the cardholder disputed the payment. A refund is its own payment, with refunded, refundSettled or refundFailed.
Default = captured | One of failed, declined, created, expired, cancelled, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled, chargebacked, refundRequested
created_at
The date the payment was created. A moment in time in ISO 8601, with a time zone. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updated_at
The date the payment was last updated. A moment in time in ISO 8601, with a time zone. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
manual_status_change
The latest status change a user made by hand in the app, such as marking a payment declined. Use it to tell a manual change apart from one the payment gateway reported. Omitted when no one has changed the payment's status by hand.
reference_number
The unique reference number assigned to the payment by the system, displayed to the merchant.
early_pay_discounts_and_late_fees
The net of any early payment discount and late fee applied to the payment. Format = 0.00
is_refund
Whether the payment is a refund of another payment.
orig_payment
On a refund, the _id of the payment it refunded. Omitted on payments that are not refunds.
custom_fields
The custom fields recorded on the payment, as name/value pairs. {} when there are none.
allocations
How the payment was applied. A payment split across several invoices has one entry per invoice.