orgId | ID! | Organization identifier the payment session belongs to. |
id | ID! | Unique identifier for the payment session. |
amount | Amount | Total payment amount. Ex. 100.10 |
currency | Currency | Three letter ISO currency code. Ex. USD |
callbackUrl | String | URL to receive payment session events |
successUrl | String | URL to redirect after a payment session is completed by the customer |
contactId | ID | Optional contact for which this payment session is attached. You cannot
provide both a contactId and a contactRef. Note that some features are
unavailable if a contactId or contactRef is not provided. |
contactRef | PaymentSessionContactRefInput | Optional merchant supplied reference contact information external to the
platform. You cannot provide both a contactId and a contactRef. Note that some
features are unavailable if a contactId or contactRef is not provided. |
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 | [PaymentSessionInvoiceRefInput!] | 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. |
status | PaymentSessionStatus | Status of the payment session. |
paymentId | ID | Payment ID associated with this payment session. |
checkoutConfigurationId | ID | The checkout configuration ID to be used for this payment session. If a
checkout configuration ID is not provided, the default checkout configuration
will be used. |
brandLogoUrl | URL | Optional URL to a logo image to display during checkout, overriding the
default branding. The caller supplies a URL that is used to render the logo. |
brandName | String | Optional brand or merchant name to display during checkout, overriding the
organization name. |
