type PaymentSession
Represents a payment session a customer can use to make a payment. This session is used to configuration and setup the payment experience for an individual customer's session during checkout.
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier for the payment session. |
orgId | ID! | Organization identifier the payment session belongs to. |
status | PaymentSessionStatus! | Status of the payment session. |
amount | Amount! | Total payment amount. Ex. 100.10 |
currency | Currency! | Three letter ISO currency code. Ex. USD |
callbackUrl | URL | URL to receive payment session events |
successUrl | URL | URL to redirect after a payment session is completed by the customer |
link | URL | Link to the payment session. This will be null if the session is expired or completed. This link is used to redirect the user to the payment page or may be used to embedded payment flow depending on the configuration provided. |
contactId | ID | ID for the contact for which this payment session is attached. |
contact | Contact | Contact for which this payment session is attached. |
contactRef | PaymentSessionContactRef | Optional merchant supplied reference contact information external to the platform. |
transactionRef | String | Optional merchant supplied reference ID for the transaction external to the platform. |
invoiceIds | [String!] | Optional array of invoice IDs which this payment session is attached to. You cannot provide both invoiceIds and invoiceRefs. Note that some feature are unavailable unless at least one invoiceId or invoiceRef is provided. |
invoiceRefs | [PaymentSessionInvoiceRef!] | Optional array of invoice references which this payment session is attached to. You cannot provide both invoiceIds and invoiceRefs. Note that some features are unavailable unless at least one invoiceId or invoiceRef is provided. |
expirationDate | DateTime | Optional expiration date for the payment session. ISO 8601 format. |
paymentId | ID | Payment ID associated with this payment session. If the payment session status is completed, this will be populated. It may also be populated if the payment session was attached to a pre-created payment record. |
createdAt | DateTime! | Date the payment session was created |
updatedAt | DateTime! | Date the payment session was last updated |
checkoutConfigurationId | ID | The checkout configuration ID used for this payment session. |
invoiceTotal | Amount | Optional total amount due across the referenced invoices. When the payment amount exceeds this total (for example because of a surcharge or tip), financing options such as FlexPay are disabled since they cannot finance the additional amount. |
brandLogoUrl | URL | Optional caller-supplied URL to a logo image to display during checkout, overriding the default branding. |
brandName | String | Optional caller-supplied brand or merchant name to display during checkout, overriding the organization name. |