payment.charge.created.event.v1 (v1.16.0)

Exchange: payment

60 properties
amount object
required

Amount specific to this payment action

executed string <date-time>
required
Min length: 1
paymentActionId string <guid>
required
Match pattern: ^[a-fA-F0-9]{32}$
Min length: 1
paymentMethodProvider string
merchantId string <guid>
required
Match pattern: ^[a-fA-F0-9]{32}$
Min length: 1
merchantAccountId nullstring <guid>
Match pattern: ^[a-fA-F0-9]{32}$
partnerId nullstring <guid>
Match pattern: ^[a-fA-F0-9]{32}$
paymentId string <guid>
required
Match pattern: ^[a-fA-F0-9]{32}$
Min length: 1
header object → EventHeader
invoiceDetails object → InvoiceDetails
orderItems array [object]
shipping object → ShippingInformation
reservationId string <guid>
required
Match pattern: ^[a-fA-F0-9]{32}$
Min length: 1
feeDetails object → Fee
reconciliationReference string
required
Min length: 1
Max length: 128
myReference string
Max length: 36
subscriptionId nullstring <guid>
Match pattern: ^[a-fA-F0-9]{32}$
surchargeAmount integer <int32>
orderAmount integer <int64>

The order amount is the sum of all the order items amount

finalCharge boolean

Final charge indicates whether this is the last charge for a given payment