Field
Type
Description
_id
The id we assign to this payment. Leave it out when creating a payment, and send it when updating one.
externalId
Your own id for this payment, from your software. Required when _id is not passed in. Send the same externalId 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.
displayName
The secure friendly display name of the payment method. Example: VISA **** 3421.
amount
The amount that was paid. This is an integer number of cents, so 1035 means $10.35.
paidOn
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:ss.SSSZ
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
manualStatusChange
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.
customer
The _id of the customer who made the payment.
type
The type of payment method used to make the payment. credit is a credit applied to an invoice (see credit); it is set by the system and cannot be sent.
One of payment_card, ach, eft, apple_pay, google_pay, oxxo, spei, bnpl, dlocal, cash, check, other, credit
subType
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, creditNote
totals
How the payment amount breaks down.
isRefund
Whether the payment is a refund of another payment.
origPayment
On a refund, the _id of the payment it refunded. Omitted on payments that are not refunds.
allocations
The allocations for the payment. This is an array of objects that specify how the payment was allocated to different orders or refunds.
credit
On a credit application (type credit), the _id of the credit that was applied; null on every other payment. A credit application moves no money through a payment gateway, carries no fees and cannot be refunded or updated through the API.
checkout
The customer portal checkout this payment was part of, so a card payment and the credits applied with it can be grouped; null otherwise.
syncToPrimaryOnly
true on a credit application: it records how an invoice was settled and must not be posted to an accounting system as a cash payment.
authCode
The authorization code the payment gateway returned when it approved the payment; null when it returned none, as on most bank payments.
paymentGatewayTransaction
The payment gateway's record of the payment.
paymentTransactionEvents
The transaction events for the payment. This is an array of objects that specify the history of the payment transaction, such as when it was authorized, captured, refunded, etc.