Order Payment Request Object


Properties
amountPriceimmutable

Amount to collect. Set when the order payment request is created and can't be changed afterward.


blockedPaymentMethodsArray <string>betamaxItems 1

List of payment methods that can't be used for this order payment request.


createdDatestringRead-onlyformat date-time

Date and time the order payment request was created.


currencystringRead-onlyformat CURRENCY

Three-letter currency code in ISO-4217 alphabetic format. Always matches the order's currency.


descriptionstringmaxLength 300

Description displayed to the customer on the payment page.


expirationDatestringimmutableformat date-time

Date and time the order payment request expires. If not provided, the order payment request doesn't expire.


extendedFieldsExtendedFields

Custom field data for this order payment request.

Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringRead-onlyformat GUID

Order payment request ID.


imageImage

Image to display to the customer on the payment page.


orderIdstringformat GUIDimmutable

Order ID.


orderNumberstringRead-onlymaxLength 100

Order number.


paymentGatewayOrderIdstringRead-onlyminLength 1maxLength 100

Payment gateway order ID associated with this payment request.


sourceSourceimmutable

Details about the source that created the order payment request.


statusstringRead-only

Payment request status. Set by the system. A new order payment request starts as UNPAID, unless expirationDate is already in the past at creation time, in which case it is created as EXPIRED. The system sets the status to PAID once payment is collected, EXPIRED when the expiration date passes, or VOIDED when the request is voided.


titlestringminLength 1maxLength 200

Title displayed to the customer on the payment page.


updatedDatestringRead-onlyformat date-time

Date and time the order payment request was last updated.

Did this help?