Skip to main content
Skip to main content

PaymentDTO

idstringRequired
The ID of the payment.
amountBigNumberValueRequired
The payment's total amount.
currency_codestringRequired
The ISO 3 character currency code of the payment.
provider_idstringRequired
The ID of the associated payment provider.
authorized_amountBigNumberValue
The authorized amount of the payment.
cart_idstring
The ID of the associated cart.
order_idstring
The ID of the associated order.
order_edit_idstring
The ID of the associated order edit.
customer_idstring
The ID of the associated customer.
dataRecord<string, unknown>
The data relevant for the payment provider to process the payment.
created_atstring | Date
When the payment was created.
updated_atstring | Date
When the payment was updated.
captured_atstring | Date
When the payment was captured.
canceled_atstring | Date
When the payment was canceled.
captured_amountBigNumberValue
The sum of the associated captures' amounts.
refunded_amountBigNumberValue
The sum of the associated refunds' amounts.
capturesCaptureDTO[]
The associated captures.
refundsRefundDTO[]
The associated refunds.
payment_collectionPaymentCollectionDTO
The associated payment collection.
payment_sessionPaymentSessionDTO
The payment session from which the payment is created.
Was this section helpful?