Model: postAuthRetail

1 min

Model Parameters

postAuthRetail
Example
```
{
  "transactionID": "ABC123456",
  "transactionDateTime": "2022-03-11T17:07:24-07:00",
  "eventSource": "web",
  "accountID": "12363454566",
  "isGuestCheckout": false,
  "isAgenticCheckout": false,
  "paymentAmount": 1082.91,
  "taxAmount": 1.23,
  "deliveryAmount": 5.99,
  "currencyCode": "USD",
  "success": false,
  "ipAddress": "10.12.12.123",
  "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:72.0) Gecko/20100101 Firefox/72.0",
  "deviceTransactionID": "e1a1aade06e2557f34036eeb06173faf1fa05c64959383",
  "devicePayload": "afklasdjlasdjl3l23j23423klj",
  "ubaID": "3143e969395de649c48c1c9f3e363a3e7ae7",
  "ubaEvents": "lasjdlkfdsljelkrrjwl3kl324j32k432",
  "emailAddress": "[email protected]",
  "authenticationMethod": "magicLink",
  "failureCode": "authFailed",
  "brand": "acme",
  "phoneNumber": "3125555555",
  "latitude": 33.836,
  "longitude": -117.914,
  "accountStatus": "dormant",
  "firstName": "Jane",
  "middleName": "Marie",
  "lastName": "Doe",
  "purchaseType": "physicalItems",
  "listingID": "abcd1234",
  "isPaymentOptimization": false,
  "is3DS": false,
  "account": {
    "isEnrolledInLoyaltyProgram": true,
    "loyaltyNumber": "Id1234",
    "accountLocale": "en-US",
    "accountLevel": "Gold",
    "accountType": "family",
    "accountRegistrationDateTime": "2020-11-22T17:07:24-07:00",
    "accountEmailUpdatedDateTime": "2020-08-28T19:00:00-04:00",
    "accountPasswordUpdatedDateTime": "2021-06-15T10:30:00-07:00",
    "dateOfBirth": "1985-11-15",
    "loyaltyProgramName": "Members Plus",
    "loyaltyPointsBalance": 987654321
  },
  "payment": {
    "salesRepID": "SR#46k90",
    "referralCode": "API 210315",
    "isGift": true,
    "isPaymentInInstallments": false,
    "installmentAmount": 99.99,
    "installmentCurrencyCode": "USD",
    "installmentCount": 12,
    "isPaymentRecurring": false
  },
  "addresses": [
    {
      "addressID": "23l4jk23klj23",
      "addressType": "shipping",
      "primaryFlag": true,
      "isAddressOnFile": false,
      "firstName": "Jane",
      "middleName": "Marie",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phone": "3125555555",
      "phoneCountryCode": "001",
      "address1": "1863 Main Street",
      "address2": "Apt 7",
      "city": "Anaheim",
      "region": "CA",
      "postCode": "92802",
      "country": "US",
      "companyName": "Accertify, Inc",
      "addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
      "addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
    }
  ],
  "shippingAddresses": [
    {
      "addressID": "23l4jk23klj23",
      "primaryFlag": true,
      "isAddressOnFile": false,
      "firstName": "Jane",
      "middleName": "Marie",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phone": "3125555555",
      "phoneCountryCode": "001",
      "address1": "1863 Main Street",
      "address2": "Apt 7",
      "city": "Anaheim",
      "region": "CA",
      "postCode": "92802",
      "country": "US",
      "companyName": "Accertify, Inc",
      "addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
      "addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
    }
  ],
  "billingAddresses": [
    {
      "addressID": "23l4jk23klj23",
      "primaryFlag": true,
      "isAddressOnFile": false,
      "firstName": "Jane",
      "middleName": "Marie",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phone": "3125555555",
      "phoneCountryCode": "001",
      "address1": "1863 Main Street",
      "address2": "Apt 7",
      "city": "Anaheim",
      "region": "CA",
      "postCode": "92802",
      "country": "US",
      "companyName": "Accertify, Inc",
      "addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
      "addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
    }
  ],
  "paymentMethods": [
    {
      "paymentType": "creditCard",
      "paymentMethodID": "2ljr9vxsdfew",
      "paymentMethodAmount": 399,
      "isPaymentStoredOnFile": true,
      "cardNumber": "4111111111111111",
      "cardToken": "6f7%gf38hfUa",
      "expirationMonth": "11",
      "expirationYear": "2029",
      "nameOnCreditCard": "Jane Doe",
      "cardBin": "411111",
      "cardLastFour": "1111",
      "totalFailedAttempts": 1,
      "paymentMethodCreatedDateTime": "2020-03-28T17:07:24-07:00",
      "paymentMethodUpdatedDateTime": "2020-03-28T17:07:24-07:00",
      "addressID": "23kl4l32l",
      "nameOnAccount": "Jane Doe",
      "walletType": "Apple Pay",
      "walletStatus": "active",
      "isWalletProtectionEligible": true,
      "paymentMethodBalanceAmount": 4000.32,
      "giftCardNumber": "5555444433332222",
      "giftCardLastFour": "2222",
      "giftCardBIN": "654678",
      "expirationDay": 9,
      "points": 50000,
      "loyaltyProgramName": "Members Plus",
      "accountType": "checking",
      "avsResult": "matched",
      "cvvResult": "matched",
      "cardAuthorizationCode": "12345",
      "cardAuthorizationDateTime": "2022-03-11T17:07:25-07:00",
      "isPreAuthorizationReject": false,
      "postAuthorizationRejectReason": "creditReject",
      "eciIndicator": "unsuccessfulOrNotAttempted",
      "isSCASoftDecline": false,
      "sca3DSFlow": "frictionless",
      "sca3DSVersion": "2.2.0",
      "sca3DSChallengeRequestType": "02",
      "sca3DSTransactionStatus": "Y",
      "scaAuthorizationStatus": "approve",
      "scaAuthorizationError": "decline"
    }
  ],
  "items": [
    {
      "itemType": "physicalGood",
      "brandName": "Apple",
      "description": "Macbook Pro",
      "category": "Computers",
      "itemID": "af877wernnasnfes",
      "isHighRiskItem": true,
      "price": 1199.99,
      "faceValueAmount": 1599.99,
      "quantity": 2,
      "addressID": "2lkj34jldsoufsous82df",
      "productCondition": "new",
      "shippingCompany": "ups",
      "companyName": "Regional Courier Co",
      "shippingMethod": "ground",
      "shippingTrackingNumber": "23l4fdswerea02",
      "promoCode": "ABC12",
      "promoAmount": 50,
      "promoType": "employeeDiscount",
      "pickupLocation": "curbside",
      "pickupDateTime": "2022-03-11T17:07:24-07:00",
      "pickupPersonFirstName": "Betty",
      "pickupPersonLastName": "Smith"
    }
  ],
  "promotions": [
    {
      "promoCode": "ABC12",
      "promoAmount": 50,
      "promoType": "employeeDiscount"
    }
  ]
}
```
- objecttransactionCommon
  - transactionIDstringrequired
    Example
    ABC123456
    Description
    [Required] Unique transaction identifier (max 40 chars).
    Max Length
    40
  - transactionDateTimestring<date-time>required
    Example
    2022-03-11T17:07:24-07:00
    Description
    [Required] ISO 8601 timestamp of when the transaction occurred.
    Format
    date-time
  - eventSourcestring<agentPhone | agentStore | affiliate | kiosk | mobileApp | other | web>required
    Example
    web
    Description
    [Required] Originating channel; one of: agentPhone, agentStore, affiliate, kiosk, mobileApp, other, web.
    Allowed
    agentPhoneagentStoreaffiliatekioskmobileAppotherweb
  - accountIDstring
    Example
    12363454566
    Description
    [Conditional] Merchant internal account identifier; required when isGuestCheckout is "false".
  - isGuestCheckoutbooleanrequired
    Description
    [Required] Whether the customer checked out without an account ("true"/"false").
  - isAgenticCheckoutboolean
    Description
    [Optional] String "true"/"false" also accepted.
  - paymentAmountnumberrequired
    Example
    1082.91
    Description
    [Required] Total payment amount including tax and delivery; zero or positive, up to 2 decimal places.
    Minimum
    0
  - taxAmountnumberrequired
    Example
    1.23
    Description
    [Required] Tax portion of the payment amount; zero or positive, up to 2 decimal places.
    Minimum
    0
  - deliveryAmountnumberrequired
    Example
    5.99
    Description
    [Required] Delivery/shipping cost; zero or positive, up to 2 decimal places.
    Minimum
    0
  - currencyCodestringrequired
    Example
    USD
    Description
    [Required] ISO 4217 three-letter currency code for the transaction.
  - successbooleanrequired
    Description
    [Required] Outcome of the transaction attempt ("true"/"false").
  - ipAddressstring
    Example
    10.12.12.123
    Description
    [Conditional] Client IP address; required when eventSource is mobileApp or web.
  - userAgentstring
    Example
    Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:72.0) Gecko/20100101 Firefox/72.0
    Description
    [Conditional] Browser User-Agent string (max 250 chars); required when eventSource is web.
    Max Length
    250
  - deviceTransactionIDstring
    Example
    e1a1aade06e2557f34036eeb06173faf1fa05c64959383
    Description
    [Optional] Session token generated by the device data collection script.
  - devicePayloadstring
    Example
    afklasdjlasdjl3l23j23423klj
    Description
    [Optional] Raw payload from the device fingerprinting library.
  - ubaIDstring
    Example
    3143e969395de649c48c1c9f3e363a3e7ae7
    Description
    [Optional] UBA behavioral analytics session ID (max 100 chars).
    Max Length
    100
  - ubaEventsstring
    Example
    lasjdlkfdsljelkrrjwl3kl324j32k432
    Description
    [Optional] Serialized stream of UBA behavioral events captured during the session.
  - emailAddressstringrequired
    Example
    [email protected]
    Description
    [Required] Customer email address; must be a valid email format.
  - authenticationMethodstring<appAuthenticator | appPush | other | password | passkey | magicLink | SMS>
    Example
    magicLink
    Description
    [Optional] Method used to authenticate the customer; one of: appAuthenticator, appPush, magicLink, other, passkey, password, SMS.
    Allowed
    appAuthenticatorappPushotherpasswordpasskeymagicLinkSMS
  - failureCodestring<authFailed | exportCompliance | other>
    Example
    authFailed
    Description
    [Conditional] Reason the transaction was unsuccessful; one of: authFailed, exportCompliance, other. Required when success is "false".
    Allowed
    authFailedexportComplianceother
  - brandstring
    Example
    acme
    Description
    [Optional] Merchant sub-brand for multi-brand deployments (max 50 chars).
    Max Length
    50
  - phoneNumberstring
    Example
    3125555555
    Description
    [Optional] Customer billing phone number (max 25 chars).
    Max Length
    25
  - latitudenumber
    Example
    33.836
    Description
    [Optional] Geographic latitude of the transaction origin.
  - longitudenumber
    Example
    -117.914
    Description
    [Optional] Geographic longitude of the transaction origin.
  - accountStatusstring<active | dormant | suspended | terminated | trial | other>
    Example
    dormant
    Description
    [Optional] Current lifecycle status of the account; one of: active, dormant, suspended, terminated, trial, other.
    Allowed
    activedormantsuspendedterminatedtrialother
  - firstNamestring
    Example
    Jane
    Description
    [Optional] Customer billing first name.
  - middleNamestring
    Example
    Marie
    Description
    [Optional] Customer billing middle name.
  - lastNamestring
    Example
    Doe
    Description
    [Optional] Customer billing last name.
  - purchaseTypestring<physicalItems | digitalItems | services | other>required
    Example
    physicalItems
    Description
    [Required] Nature of the items in this order; one of: physicalItems, digitalItems, services, other.
    Allowed
    physicalItemsdigitalItemsservicesother
  - listingIDstring
    Example
    abcd1234
    Description
    [Optional] Marketplace listing identifier (max 50 chars).
    Max Length
    50
  - isPaymentOptimizationboolean
    Description
    [Optional] Whether payment optimization is enabled ("true"/"false").
  - is3DSboolean
    Description
    [Optional] Whether 3D Secure authentication was applied ("true"/"false").
- object
  - accountaccount
    - isEnrolledInLoyaltyProgramboolean
      Example
      true
      Description
      [Optional] Whether the account holds a loyalty membership ("true"/"false").
    - loyaltyNumberstring
      Example
      Id1234
      Description
      [Optional] Customer's loyalty program membership number.
    - accountLocalestring
      Example
      en-US
      Description
      [Optional] Account locale/language preference (e.g., "en-US").
    - accountLevelstring
      Example
      Gold
      Description
      [Optional] Customer tier within the loyalty or membership program (e.g., "Gold").
    - accountTypestring<individual | business | family | other>
      Example
      family
      Description
      [Optional] Account category; one of: individual, business, family, other.
      Allowed
      individualbusinessfamilyother
    - accountRegistrationDateTimestring<date-time>
      Example
      2020-11-22T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of when the account was created.
      Format
      date-time
    - accountEmailUpdatedDateTimestring<date-time>
      Example
      2020-08-28T19:00:00-04:00
      Description
      [Optional] ISO 8601 timestamp of the last email address change on the account.
      Format
      date-time
    - accountPasswordUpdatedDateTimestring<date-time>
      Example
      2021-06-15T10:30:00-07:00
      Description
      [Optional] ISO 8601 timestamp of the last password change on the account.
      Format
      date-time
    - dateOfBirthstring<date>
      Example
      1985-11-15
      Description
      [Optional] Customer's date of birth in ISO 8601 date format (YYYY-MM-DD).
      Format
      date
    - loyaltyProgramNamestring
      Example
      Members Plus
      Description
      [Optional] Name of the loyalty program the account belongs to (max 100 chars).
      Max Length
      100
    - loyaltyPointsBalanceinteger
      Example
      987654321
      Description
      [Optional] Current point balance in the loyalty program; zero or positive.
      Minimum
      0
  - paymentpayment
    - salesRepIDstring
      Example
      SR#46k90
      Description
      [Optional] Identifier of the sales representative who assisted with the order (max 20 chars).
      Max Length
      20
    - referralCodestring
      Example
      API 210315
      Description
      [Optional] Promotional or affiliate referral code applied at checkout (max 50 chars).
      Max Length
      50
    - isGiftboolean
      Example
      true
      Description
      [Optional] Indicates the order is being sent as a gift ("true"/"false").
    - isPaymentInInstallmentsboolean
      Description
      [Optional] Whether the total will be paid in multiple installments ("true"/"false").
    - installmentAmountnumber
      Example
      99.99
      Description
      [Optional] Amount of each individual installment payment; positive number.
      Minimum (exclusive)
      0
    - installmentCurrencyCodestring
      Example
      USD
      Description
      [Conditional] ISO 4217 currency code for installment amounts; required when isPaymentInInstallments is "true".
    - installmentCountinteger
      Example
      12
      Description
      [Conditional] Total number of installment payments; required when isPaymentInInstallments is "true".
      Minimum (exclusive)
      0
    - isPaymentRecurringboolean
      Description
      [Optional] Whether this is a recurring/subscription payment ("true"/"false").
    - orderMessagestring
      Example
      Enjoy the gift
      Description
      [Optional] Personal message or order instruction associated with the transaction.
  - addressesaddress[]
    - addressIDstringrequired
      Example
      23l4jk23klj23
      Description
      [Required] Merchant-assigned identifier for this address record.
    - addressTypestring<account | billing | bopis | curbside | departure | destination | fulfillment | listing | lodging | pickup | return | shipping | venue | other>required
      Example
      shipping
      Description
      [Required] Role of this address in the order.
      Allowed
      accountbillingbopiscurbsidedeparturedestinationfulfillmentlistinglodgingpickupreturnshippingvenueother
    - primaryFlagboolean
      Example
      true
      Description
      [Optional] Marks this as the account's primary address (true/false).
    - isAddressOnFileboolean
      Description
      [Optional] Whether this address was previously saved to the account ("true"/"false").
    - firstNamestringrequired
      Example
      Jane
      Description
      [Required] Recipient's first name at this address.
    - middleNamestring
      Example
      Marie
      Description
      [Optional] Recipient's middle name at this address.
    - lastNamestringrequired
      Example
      Doe
      Description
      [Required] Recipient's last name at this address.
    - emailAddressstring
      Example
      [email protected]
      Description
      [Conditional] Recipient's email address; required when addressType is account or billing.
    - phonestringrequired
      Example
      3125555555
      Description
      [Required] Recipient's phone number.
    - phoneCountryCodestringrequired
      Example
      001
      Description
      [Required] International dial prefix for the phone number (for example, "001").
    - address1stringrequired
      Example
      1863 Main Street
      Description
      [Required] Primary street address line.
    - address2string
      Example
      Apt 7
      Description
      [Optional] Secondary address line (suite, apartment, etc.).
    - citystringrequired
      Example
      Anaheim
      Description
      [Required] City component of the address.
    - regionstringrequired
      Example
      CA
      Description
      [Required] State or region component of the address.
    - postCodestringrequired
      Example
      92802
      Description
      [Required] Postal or ZIP code.
    - countrystringrequired
      Example
      US
      Description
      [Required] ISO 3166-1 alpha-2 country code.
    - companyNamestring
      Example
      Accertify, Inc
      Description
      [Optional] Business name at this address.
    - addressCreatedDateTimestring<date-time>
      Example
      2020-03-28T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of when this address was saved.
      Format
      date-time
    - addressUpdatedDateTimestring<date-time>
      Example
      2021-03-28T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of the last modification to this address.
      Format
      date-time
  - shippingAddressesaddressNoType[]
    - addressIDstringrequired
      Example
      23l4jk23klj23
      Description
      [Required] Merchant-assigned identifier for this address record.
    - primaryFlagboolean
      Example
      true
      Description
      [Optional] Marks this as the account's primary address ("true"/"false").
    - isAddressOnFileboolean
      Description
      [Optional] Whether this address was previously saved to the account ("true"/"false").
    - firstNamestringrequired
      Example
      Jane
      Description
      [Required] Recipient's first name at this address.
    - middleNamestring
      Example
      Marie
      Description
      [Optional] Recipient's middle name at this address.
    - lastNamestringrequired
      Example
      Doe
      Description
      [Required] Recipient's last name at this address.
    - emailAddressstring
      Example
      [email protected]
      Description
      [Optional] Recipient's email address for order communications.
    - phonestringrequired
      Example
      3125555555
      Description
      [Required] Recipient's phone number.
    - phoneCountryCodestringrequired
      Example
      001
      Description
      [Required] International dial prefix for the phone number (e.g., "001").
    - address1stringrequired
      Example
      1863 Main Street
      Description
      [Required] Primary street address line.
    - address2string
      Example
      Apt 7
      Description
      [Optional] Secondary address line (suite, apartment, etc.).
    - citystringrequired
      Example
      Anaheim
      Description
      [Required] City component of the address.
    - regionstringrequired
      Example
      CA
      Description
      [Required] State or region component of the address.
    - postCodestringrequired
      Example
      92802
      Description
      [Required] Postal or ZIP code.
    - countrystringrequired
      Example
      US
      Description
      [Required] ISO 3166-1 alpha-2 country code.
    - companyNamestring
      Example
      Accertify, Inc
      Description
      [Optional] Business name at this address.
    - addressCreatedDateTimestring<date-time>
      Example
      2020-03-28T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of when this address was saved.
      Format
      date-time
    - addressUpdatedDateTimestring<date-time>
      Example
      2021-03-28T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of the last modification to this address.
      Format
      date-time
  - billingAddressesaddressNoType[]
    - addressIDstringrequired
      Example
      23l4jk23klj23
      Description
      [Required] Merchant-assigned identifier for this address record.
    - primaryFlagboolean
      Example
      true
      Description
      [Optional] Marks this as the account's primary address ("true"/"false").
    - isAddressOnFileboolean
      Description
      [Optional] Whether this address was previously saved to the account ("true"/"false").
    - firstNamestringrequired
      Example
      Jane
      Description
      [Required] Recipient's first name at this address.
    - middleNamestring
      Example
      Marie
      Description
      [Optional] Recipient's middle name at this address.
    - lastNamestringrequired
      Example
      Doe
      Description
      [Required] Recipient's last name at this address.
    - emailAddressstring
      Example
      [email protected]
      Description
      [Optional] Recipient's email address for order communications.
    - phonestringrequired
      Example
      3125555555
      Description
      [Required] Recipient's phone number.
    - phoneCountryCodestringrequired
      Example
      001
      Description
      [Required] International dial prefix for the phone number (e.g., "001").
    - address1stringrequired
      Example
      1863 Main Street
      Description
      [Required] Primary street address line.
    - address2string
      Example
      Apt 7
      Description
      [Optional] Secondary address line (suite, apartment, etc.).
    - citystringrequired
      Example
      Anaheim
      Description
      [Required] City component of the address.
    - regionstringrequired
      Example
      CA
      Description
      [Required] State or region component of the address.
    - postCodestringrequired
      Example
      92802
      Description
      [Required] Postal or ZIP code.
    - countrystringrequired
      Example
      US
      Description
      [Required] ISO 3166-1 alpha-2 country code.
    - companyNamestring
      Example
      Accertify, Inc
      Description
      [Optional] Business name at this address.
    - addressCreatedDateTimestring<date-time>
      Example
      2020-03-28T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of when this address was saved.
      Format
      date-time
    - addressUpdatedDateTimestring<date-time>
      Example
      2021-03-28T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of the last modification to this address.
      Format
      date-time
  - paymentMethodspaymentMethodPostAuth[]
    - paymentMethodPreAuth
      - paymentTypestring<bankAccount | cash | check | creditCard | cryptoCurrency | digitalWallet | electronicFundTransfer | giftCard | invoice | loan | loyaltyPoints | moneyOrder | secCard | storeCredit | thirdParty | voucher>
        Example
        creditCard
        Description
        [Conditional] Type of payment instrument. Required when paymentMethodID is present.
        Allowed
        bankAccountcashcheckcreditCardcryptoCurrencydigitalWalletelectronicFundTransfergiftCardinvoiceloanloyaltyPointsmoneyOrdersecCardstoreCreditthirdPartyvoucher
      - paymentMethodIDstring
        Example
        2ljr9vxsdfew
        Description
        [Optional] Merchant-assigned identifier for this payment method.
      - paymentMethodAmountnumber
        Example
        399
        Description
        [Optional] Amount charged to this payment method.
        Minimum
        0
      - isPaymentStoredOnFileboolean
        Example
        true
        Description
        [Optional] Whether this instrument is saved to the account ("true"/"false").
      - cardNumberstring
        Example
        4111111111111111
        Description
        [Optional] Full card number (PAN) for credit card payments, validated using the Luhn algorithm.
      - cardTokenstring
        Example
        6f7%gf38hfUa
        Description
        [Optional] Tokenized representation of the card number.
      - expirationMonthstring<01 | 02 | 03 | 04 | 05 | 06 | 07 | 8 | 9 | 10 | 11 | 12>
        Example
        11
        Description
        [Conditional] Zero-padded two-digit card expiration month ("01".."12"); required when paymentType = creditCard.
        Allowed
        0102030405060789101112
      - expirationYearstring
        Example
        2029
        Description
        [Conditional] Card expiration year (4-digit); required when paymentType = creditCard.
      - nameOnCreditCardstring
        Example
        Jane Doe
        Description
        [Conditional] Cardholder name as embossed on the card; required when paymentType = creditCard.
      - cardBinstring
        Example
        411111
        Description
        [Optional] Bank Identification Number (6 to 11 digits) of the card.
      - cardLastFourstring
        Example
        1111
        Description
        [Optional] Last four digits of the card number.
      - totalFailedAttemptsinteger
        Example
        1
        Description
        [Optional] Number of failed payment attempts for this method.
        Minimum
        0
      - paymentMethodCreatedDateTimestring<date-time>
        Example
        2020-03-28T17:07:24-07:00
        Description
        [Optional] ISO 8601 timestamp of when this payment method was saved.
        Format
        date-time
      - paymentMethodUpdatedDateTimestring<date-time>
        Example
        2020-03-28T17:07:24-07:00
        Description
        [Optional] ISO 8601 timestamp of the last update to this payment method.
        Format
        date-time
      - addressIDstring
        Example
        23kl4l32l
        Description
        [Optional] Reference to the billing address record for this payment method.
      - nameOnAccountstring
        Example
        Jane Doe
        Description
        [Optional] Name on file for a wallet or account-based payment method.
      - walletTypestring
        Example
        Apple Pay
        Description
        [Optional] Digital wallet provider.
      - walletStatusstring<active | pending | inactive>
        Example
        active
        Description
        [Optional] Current status of the wallet.
        Allowed
        activependinginactive
      - isWalletProtectionEligibleboolean
        Example
        true
        Description
        [Optional] Whether the wallet is eligible for purchase protection ("true"/"false").
      - paymentMethodBalanceAmountnumber
        Example
        4000.32
        Description
        [Optional] Remaining balance available on this payment method.
        Minimum (exclusive)
        0
      - giftCardNumberstring
        Example
        5555444433332222
        Description
        [Optional] Full gift card number.
      - giftCardLastFourstring
        Example
        2222
        Description
        [Optional] Last four digits of the gift card number.
      - giftCardBINstring
        Example
        654678
        Description
        [Optional] Bank Identification Number (first 6 digits) of the gift card.
      - expirationDaystring
        Example
        9
        Description
        [Optional] Card expiration day, for payment types that include a day component.
      - pointsinteger
        Example
        50000
        Description
        [Optional] Loyalty or reward points balance associated with this payment method.
      - loyaltyProgramNamestring
        Example
        Members Plus
        Description
        [Optional] Name of the loyalty program associated with this payment method.
      - accountTypestring<checking | saving | moneyMarket | other>
        Example
        checking
        Description
        [Conditional] Bank account type; required when paymentType = bankAccount.
        Allowed
        checkingsavingmoneyMarketother
    - object
      - avsResultstring<matched | partialMatch | notMatched | notChecked | systemError | other>
        Example
        matched
        Description
        [Optional] Address Verification Service result code returned by the card network.
        Allowed
        matchedpartialMatchnotMatchednotCheckedsystemErrorother
      - cvvResultstring<matched | notMatched>
        Example
        matched
        Description
        [Optional] Card Verification Value validation result code returned by the card network.
        Allowed
        matchednotMatched
      - cardAuthorizationCodestring
        Example
        12345
        Description
        [Optional] Authorization approval code returned by the card network.
      - cardAuthorizationDateTimestring<date-time>
        Example
        2022-03-11T17:07:25-07:00
        Description
        [Optional] ISO 8601 timestamp of when the authorization was issued.
        Format
        date-time
      - isPreAuthorizationRejectboolean
        Description
        [Optional] Whether the authorization was rejected before submission ("true"/"false" also accepted).
      - postAuthorizationRejectReasonstring<creditReject | fraudReject | otherReject>
        Example
        creditReject
        Description
        [Optional] Reason the post-authorization was rejected.
        Allowed
        creditRejectfraudRejectotherReject
      - eciIndicatorstring<successful | unsuccessfulOrNotAttempted | attemptedButNotCompleted | other>
        Example
        unsuccessfulOrNotAttempted
        Description
        [Conditional] E-Commerce Indicator returned by the 3DS process; required when sca3DSFlow is present.
        Allowed
        successfulunsuccessfulOrNotAttemptedattemptedButNotCompletedother
      - isSCASoftDeclineboolean
        Description
        [Conditional] Whether the authorization received a soft decline requiring SCA ("true"/"false" also accepted); required when sca3DSFlow is present.
      - sca3DSFlowstring<challenge | frictionless | dataOnly>
        Example
        frictionless
        Description
        [Optional] 3DS authentication flow that was applied; one of: challenge, frictionless, dataOnly; when present, the SCA fields below become required.
        Allowed
        challengefrictionlessdataOnly
      - sca3DSVersionstring
        Example
        2.2.0
        Description
        [Conditional] 3DS protocol version used; required when sca3DSFlow is present.
      - sca3DSChallengeRequestTypestring<02 | 03 | 04 | 05 | 06 | 10 | 11>
        Example
        02
        Description
        [Conditional] Type of 3DS challenge initiated; one of: 02, 03, 04, 05, 06, 10, 11. Required when sca3DSFlow is present.
        Allowed
        02030405061011
      - sca3DSTransactionStatusstring<Y | N | U | A | I>
        Example
        Y
        Description
        [Conditional] 3DS transaction status returned by the issuer; one of: Y, N, U, A, I. Required when sca3DSFlow is present.
        Allowed
        YNUAI
      - scaAuthorizationStatusstring<approve | decline>
        Example
        approve
        Description
        [Conditional] SCA authorization outcome; one of: approve, decline. Required when sca3DSFlow is present.
        Allowed
        approvedecline
      - scaAuthorizationErrorstring<decline | fraudReject | insufficientFunds | invalidCard | incorrectInformation | lostOrStolen | withdrawalAmountExceeded | technicalError | other>
        Example
        decline
        Description
        [Conditional] Reason for a declined SCA authorization; required when scaAuthorizationStatus is "decline".
        Allowed
        declinefraudRejectinsufficientFundsinvalidCardincorrectInformationlostOrStolenwithdrawalAmountExceededtechnicalErrorother
  - itemsitem[]
    - itemTypestring<giftCard | parking | physicalGood | reservation | subscription | ticket | other>
      Example
      physicalGood
      Description
      [Optional] Category of item; one of: giftCard, parking, physicalGood, reservation, subscription, ticket, other.
      Allowed
      giftCardparkingphysicalGoodreservationsubscriptionticketother
    - brandNamestring
      Example
      Apple
      Description
      [Optional] Brand or manufacturer of the item.
    - descriptionstring
      Example
      Macbook Pro
      Description
      [Optional] Short description or name of the item.
    - categorystring
      Example
      Computers
      Description
      [Optional] Merchant-defined product category.
    - itemIDstring
      Example
      af877wernnasnfes
      Description
      [Optional] Merchant's unique product or SKU identifier.
    - isHighRiskItembooleanrequired
      Example
      true
      Description
      [Required] Whether the item is flagged as high risk ("true"/"false").
    - pricenumberrequired
      Example
      1199.99
      Description
      [Required] Unit price of the item; positive number.
      Minimum
      0
    - faceValueAmountnumber
      Example
      1599.99
      Description
      [Optional] Face or retail value of the item; zero or positive.
      Minimum
      0
    - quantitynumber
      Example
      2
      Description
      [Optional] Number of units of this item in the order.
    - addressIDstring
      Example
      2lkj34jldsoufsous82df
      Description
      [Conditional] Delivery address reference for this line item; required when shippingMethod is present.
    - productConditionstring<new | openPackage | other | refurbished | used>
      Example
      new
      Description
      [Optional] Condition of the item; one of: new, openPackage, other, refurbished, used.
      Allowed
      newopenPackageotherrefurbishedused
    - shippingCompanystring<dhl | fedex | ups | usps | other>
      Example
      ups
      Description
      [Optional] Carrier for this item; one of: dhl, fedex, ups, usps, other.
      Allowed
      dhlfedexupsuspsother
    - companyNamestring
      Example
      Regional Courier Co
      Description
      [Optional] Shipping company name for this item, when not one of the standard carriers (max 50 chars).
      Max Length
      50
    - shippingMethodstring<digital | ground | international | other | nextDay | sameDay | storePickup | twoDay | threeDay>required
      Example
      ground
      Description
      [Required] Shipping speed or method.
      Allowed
      digitalgroundinternationalothernextDaysameDaystorePickuptwoDaythreeDay
    - shippingTrackingNumberstring
      Example
      23l4fdswerea02
      Description
      [Optional] Carrier tracking number for this item (max 30 chars).
      Max Length
      30
    - promoCodestring
      Example
      ABC12
      Description
      [Optional] Promotion code applied specifically to this item (max 40 chars).
      Max Length
      40
    - promoAmountnumber
      Example
      50
      Description
      [Optional] Discount applied to this item; zero or positive.
      Minimum
      0
    - promoTypestring<bogo | bundle | employeeDiscount | freeShipping | loyaltyDiscount | newMemberDiscount | percentage | quantityPromotion | other>
      Example
      employeeDiscount
      Description
      [Optional] Category of the item-level promotion.
      Allowed
      bogobundleemployeeDiscountfreeShippingloyaltyDiscountnewMemberDiscountpercentagequantityPromotionother
    - pickupLocationstring<curbside | dropBox | inStore | other>
      Example
      curbside
      Description
      [Optional] In-store or curbside pickup method; one of: curbside, dropBox, inStore, other.
      Allowed
      curbsidedropBoxinStoreother
    - pickupDateTimestring<date-time>
      Example
      2022-03-11T17:07:24-07:00
      Description
      [Optional] ISO 8601 timestamp of the scheduled pickup.
      Format
      date-time
    - pickupPersonFirstNamestring
      Example
      Betty
      Description
      [Optional] First name of the person collecting the order (max 40 chars).
      Max Length
      40
    - pickupPersonLastNamestring
      Example
      Smith
      Description
      [Optional] Last name of the person collecting the order (max 40 chars).
      Max Length
      40
  - promotionspromotion[]
    - promoCodestring
      Example
      ABC12
      Description
      [Optional] Promotional code applied to the order.
    - promoAmountnumberrequired
      Example
      50
      Description
      [Required] Discount amount granted by this promotion; zero or positive.
      Minimum
      0
    - promoTypestring<bogo | bundle | employeeDiscount | freeShipping | loyaltyDiscount | newMemberDiscount | percentage | quantityPromotion | other>
      Example
      employeeDiscount
      Description
      [Optional] Category of the promotion (e.g., employeeDiscount, freeShipping).
      Allowed
      bogobundleemployeeDiscountfreeShippingloyaltyDiscountnewMemberDiscountpercentagequantityPromotionother

Request body for POST /postAuthRetail