Skip to main content

PortalTransaction

amountinteger<int64>required
approvalCodestringnullable
autoVoidedbooleanrequired
capturedAmountinteger<int64>nullable
cardBrandstringnullable
cardLast4stringnullable
cashDiscountAmountinteger<int64>required
createdAtstringnullable
currencystringrequired
lineItems object[]required
  • Array [
  • descriptionstringnullable
    discountAmountinteger<int64>nullable
    lineTotalinteger<int64>nullable
    namestringnullable
    quantityinteger<int32>nullable
    taxAmountinteger<int64>nullable
    unitPriceinteger<int64>nullable
  • ]
  • partiallyApprovedbooleanrequired
    processedAmountinteger<int64>nullable
    remainingAuthorizedAmountinteger<int64>nullable
    responseCodestringnullable
    responseMessagestringnullable
    settledAtstringnullable

    Settlement anchor used for billing; this is not necessarily the time the settlement batch closed. The anchor may be midnight on the settlement business date in the merchant time zone.

    settlementObservedAtstringnullable

    Instant when Gateway observed settlement. May be null for historical transactions.

    statusPortalTransactionStatusrequired

    Possible values: [PENDING, APPROVED, DECLINED, ERROR, VOIDED, CAPTURED, TIP_ADJUSTED, ENRICHED, SETTLED, REFUNDED]

    surchargeAmountinteger<int64>required
    tipAmountinteger<int64>required
    transactionIdstringrequired
    typePortalTransactionTyperequired

    Possible values: [SALE, AUTH, CAPTURE, VOID, REFUND, RECURRING, FORCE_AUTH]

    updatedAtstringnullable
    PortalTransaction
    {
    "amount": 0,
    "approvalCode": "string",
    "autoVoided": true,
    "capturedAmount": 0,
    "cardBrand": "string",
    "cardLast4": "string",
    "cashDiscountAmount": 0,
    "createdAt": "string",
    "currency": "string",
    "lineItems": [
    {
    "description": "string",
    "discountAmount": 0,
    "lineTotal": 0,
    "name": "string",
    "quantity": 0,
    "taxAmount": 0,
    "unitPrice": 0
    }
    ],
    "partiallyApproved": true,
    "processedAmount": 0,
    "remainingAuthorizedAmount": 0,
    "responseCode": "string",
    "responseMessage": "string",
    "settledAt": "string",
    "settlementObservedAt": "string",
    "status": "PENDING",
    "surchargeAmount": 0,
    "tipAmount": 0,
    "transactionId": "string",
    "type": "SALE",
    "updatedAt": "string"
    }