Model: paymentMethodPostAuth

1 min

Model Parameters

paymentMethodPostAuth
- objectpaymentMethodPreAuth
  - 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
  Description
  Payment method with additional 3D Secure and SCA authorization fields used in post-authorization events.
  - 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