PaymentDTO

idstring

The ID of the payment.

The payment's total amount.

currency_codestring

The ISO 3 character currency code of the payment.

provider_idstring

The ID of the associated payment provider.

payment_collection_idstring

The ID of the associated payment collection.

raw_amountBigNumberValueOptional

The raw amount of the payment.

authorized_amountBigNumberValueOptional

The authorized amount of the payment.

raw_authorized_amountBigNumberValueOptional

The raw authorized amount of the payment.

dataRecord<string, unknown>Optional

The data relevant for the payment provider to process the payment.

created_atstring | DateOptional

When the payment was created.

updated_atstring | DateOptional

When the payment was updated.

captured_atstring | DateOptional

When the payment was captured.

canceled_atstring | DateOptional

When the payment was canceled.

captured_amountBigNumberValueOptional

The sum of the associated captures' amounts.

raw_captured_amountBigNumberValueOptional

The sum of the associated captures' raw amounts.

refunded_amountBigNumberValueOptional

The sum of the associated refunds' amounts.

raw_refunded_amountBigNumberValueOptional

The sum of the associated refunds' raw amounts.

capturesCaptureDTO[]Optional

The associated captures.

refundsRefundDTO[]Optional

The associated refunds.

payment_collectionPaymentCollectionDTOOptional

The associated payment collection.

payment_sessionPaymentSessionDTOOptional

The payment session from which the payment is created.

Was this page helpful?