orgId | ID! | Organization identifier the payment session belongs to. |
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 |
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. |
createPendingPayment | Boolean | Optionally create a pending payment record for this payment session. Default
is false which means a payment record is created upon payment session
completion. Set this to true if you require a pending payment to be visible
in the payment list in the dashboard before payments are made. This is useful
for use cases involving payment sessions without expirations. This setting
may only be set on payment session creation. |
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. |
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 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. |
