Skip to main content

ProcessingPaymentCompletedEventPayload

context objectrequired
property name*any
entryModestring
lineItems object[]required
  • Array [
  • commodityCodestringnullable
    descriptionstringnullable
    discountAmountinteger<int64>nullable
    idstringnullable
    imageUrlstringnullable
    lineTotalinteger<int64>nullable
    namestringnullable
    priceIdstringnullable
    productCodestringnullable
    quantityinteger<int32>nullable
    taxAmountinteger<int64>nullable
    unitOfMeasurestringnullable
    unitPriceinteger<int64>nullable
  • ]
  • locationIdstringrequired
    merchantIdstringrequired
    paymentLifecycleStatestring
    paymentOutcomeEffectiveAtstring
    paymentOutcomeTimePrecisionstring
    paymentOutcomeVersioninteger<int64>
    processorReferenceIdstring
    processorTypestringrequired
    selectedTenderstring
    settlementFinalboolean
    sourcestringrequired
    statusstringrequired
    transaction objectrequired
    amountinteger<int64>required
    approvalCodestring
    capturedAmountinteger<int64>
    cardBrandstring
    cardLast4string
    createdAtstring
    currencystringrequired
    detailsAvailabilitystring
    gatewayCustomerIdstring
    locationIdstringrequired
    merchantIdstringrequired
    metadata objectrequired
    property name*any
    paymentLifecycleStatestring
    paymentOutcomeEffectiveAtstring
    paymentOutcomeTimePrecisionstring
    paymentOutcomeVersioninteger<int64>
    processedAmountinteger<int64>
    responseCodestring
    responseMessagestring
    selectedTenderstring
    settlementFinalboolean
    statusTransactionStatusrequired

    Possible values: [PENDING, PENDING_CONFIRMATION, EXPIRED_UNCONFIRMED, FRAUD_BLOCKED, FRAUD_HELD, APPROVED, DECLINED, CANCELLED, ERROR, VOIDED, CAPTURED, TIP_ADJUSTED, ENRICHED, SETTLED, REFUNDED, REVERSED]

    surchargeAmountinteger<int64>required
    tipAmountinteger<int64>required
    transactionChannelstring
    transactionIdstringrequired
    typestringrequired
    transactionChannelstring
    transactionIdstringrequired
    ProcessingPaymentCompletedEventPayload
    {
    "context": {},
    "entryMode": "string",
    "lineItems": [
    {
    "commodityCode": "string",
    "description": "string",
    "discountAmount": 0,
    "id": "string",
    "imageUrl": "string",
    "lineTotal": 0,
    "name": "string",
    "priceId": "string",
    "productCode": "string",
    "quantity": 0,
    "taxAmount": 0,
    "unitOfMeasure": "string",
    "unitPrice": 0
    }
    ],
    "locationId": "string",
    "merchantId": "string",
    "paymentLifecycleState": "string",
    "paymentOutcomeEffectiveAt": "string",
    "paymentOutcomeTimePrecision": "string",
    "paymentOutcomeVersion": 0,
    "processorReferenceId": "string",
    "processorType": "string",
    "selectedTender": "string",
    "settlementFinal": true,
    "source": "string",
    "status": "string",
    "transaction": {
    "amount": 0,
    "approvalCode": "string",
    "capturedAmount": 0,
    "cardBrand": "string",
    "cardLast4": "string",
    "createdAt": "string",
    "currency": "string",
    "detailsAvailability": "string",
    "gatewayCustomerId": "string",
    "locationId": "string",
    "merchantId": "string",
    "metadata": {},
    "paymentLifecycleState": "string",
    "paymentOutcomeEffectiveAt": "string",
    "paymentOutcomeTimePrecision": "string",
    "paymentOutcomeVersion": 0,
    "processedAmount": 0,
    "responseCode": "string",
    "responseMessage": "string",
    "selectedTender": "string",
    "settlementFinal": true,
    "status": "PENDING",
    "surchargeAmount": 0,
    "tipAmount": 0,
    "transactionChannel": "string",
    "transactionId": "string",
    "type": "string"
    },
    "transactionChannel": "string",
    "transactionId": "string"
    }