Payment

Represents a payment against an invoice or order

A Payment usually represents a transaction at a Payment Service Provider. A Payment can also represent a retry attempt. In this case it is linked to an original or top-level Payment record. A top-level payment record is then associated with an Invoice or Order.

Fields

amountCents (Int!)

Payment amount in cents.

amountWithSymbol (String!)

Payment amount with currency symbol.

createdAt (ISO8601DateTime!)

When the payment record was first created.

currency (String)

Payment currency

id (ID!)

The database ID of the payment.

invoice (Invoice)

The invoice associated with this payment. The original payment and all its retry attempts are associated with one invoice.

paymentId (ID)

The external payment reference from the payment service provider.

paymentStatus (PaymentStatusEnum!)

Status of the payment.

paymentType (PaymentTypeEnum!)

The type of transaction that this payment represents

refunds ([Refund!])

The refunds for this payment.

retryPaymentUrl (String)

Send your customer to this URL to allow them to retry the failed payment. Append ?return_url=https://your-url to send the customer back after a successful payment.

status (String)

Deprecated: Use the 'payment_status' field instead.

subscription (Subscription!)

The subscription associated with this payment.

token (ID!)

Token to identify the payment with

updatedAt (ISO8601DateTime!)

When the payment record was last updated.