A merchant-initiated movement of money between the merchant and a customer, by way of a payment method. Payments can represent money moving either from a customer to the merchant by charging a payment method (a Transaction), or from the merchant back to a customer by refunding a previous transaction (a Refund).
Fields
amountMonetaryThe amount charged or credited to the payment method. Note that in the case of a Transaction, this amount will represent the amount moving from the customer to the merchant, and in the case of a Refund, will represent the amount moving from the merchant back to the customer.
createdTimestampDate and time when the payment was created.
idID!Non-nullUnique identifier.
legacyID!Non-nullLegacy unique identifier.
merchantIDThe ID of the merchant account that processed this payment.
paymentPaymentSnapshot of payment method details used to create the payment, preserved at the time the transaction was created. This will always be present.
sourcePaymentHow the payment was created.
statusPaymentThe current status of this payment.
status[PaymentThe records of all statuses this payment has passed through, with additional information on why each status occurred. Returned in reverse chronological order, with the most recent event first in the list.
Possible types
TransactionTransactionRefundRefundinterface Payment {
id: ID!
legacyId: ID!
createdAt: Timestamp
amount: MonetaryAmount
orderId: String
status: PaymentStatus
statusHistory: [PaymentStatusEvent!]
merchantAccountId: ID
source: PaymentSource
paymentMethodSnapshot: PaymentMethodSnapshot
}