Model: globalPaymentMethodsAP

1 min

Model Parameters

globalPaymentMethodsAP
- paymentMethodsobject[]
  Description
  Array introducing the paymentMethods block.
  - paymentTypestringrequired
    Description
    Required. User's method of payment.
    
    bankAccount
    
    cash
    
    check
    
    creditCard
    
    cryptoCurrency
    
    digitalWallet
    
    electronicFundTransfer
    
    giftCard
    
    invoice
    
    loan
    
    loyaltyPoints
    
    moneyOrder
    
    secCard
    
    storeCredit
    
    thirdParty
    
    Note: ACH is included in bankAccount. EFT is included in electronicFundTransfer.
  - paymentMethodIDstring
    Example
    2ljr9vxsdfey
    Description
    Optional. Unique identifier for the payment type. Maximum field length = 100 characters.
    
    Note: This is not a card number. Rather, it could be an identifier for a digital account or wallet.
  - paymentMethodAmountnumber
    Example
    500
    Description
    Optional. Amount that applies to this specific payment method in the currency specified by the transaction currencyCode field. Format = two decimals.
    
    Note: Payment amounts can be spread across several payment types in this array.
  - isPaymentStoredOnFileboolean
    Description
    Optional. Whether the payment used was stored on the user's account.
    
    Options are:
    
    true
    
    false
    Allowed
    truefalse
  - emailAddressstring
    Example
    [email protected]
    Description
    Optional. The email associated with the hold or payment. Maximum field length = 50 characters.
  - nameOnAccountstring
    Example
    Jane Doe
    Description
    Optional. Name on the account when you are sending payment. Maximum field length = 100 characters.
  - accountTypestring<checking | saving | moneyMarket | other>
    Description
    Optional. Type of account when bankAccount is the payment method.
    
    Options are:
    
    checking
    
    saving
    
    moneyMarket
    
    other
    Allowed
    checkingsavingmoneyMarketother
  - cardNumberstring
    Example
    Kb7ofu6hYN4WxM4_INAZigXoWlAi79LuhcSpwx5UcVc
    Description
    Imperative. Card number for the creditCard payment method. If the card number is tokenized, it would also go in this field.
    
    Note:
    
    If paymentType = creditCard then data must pass ISO/IEC 7812-1 LUHN validation. Minimum field length = 10 characters. Maximum field length = 19 characters.
    
    Shown hashed. We provide the Accertify Hashing Algorithm. If the value appears to be in plain text, we respond "400 Bad Request" with the appropriate errorResponse.
  - expirationMonthinteger
    Example
    11
    Description
    Imperative. Month the card, voucher, or loyalty points are expiring in MM form. Maximum field length = 2 characters.
  - expirationYearinteger
    Example
    2026
    Description
    Imperative. Year the card, voucher, or loyalty points are expiring in YYYY form. Maximum field length = 4 characters.
  - expirationDayinteger
    Example
    12
    Description
    Imperative. Day the voucher or loyalty points are expiring in DD form. Maximum field length = 10 characters.
  - nameOnCreditCardstring
    Example
    Jane Doe
    Description
    Imperative. Cardholder name for the creditCard or giftCard payment method. Maximum field length = 100 characters.
  - cardBininteger
    Example
    345678
    Description
    Imperative. Leading six digits of the credit card number.
    
    Note: Numbers only. Minimum field length = 6 digits. Maximum field length = 11 digits. For BIN lookups, Accertify will query the full/encrypted Payment Card Number (PAN).
  - cardLastFourinteger
    Example
    4564
    Description
    Imperative. Last four digits on the credit card.
    
    Note: Numbers only. Must be 4 digits.
  - avsResultstring<matched | partialMatch | notMatched | notChecked | systemError | other>
    Description
    Imperative. Result received from the Issuer when checking the address provided.
    
    Options are:
    
    matched
    
    partialMatch
    
    notMatched
    
    notChecked
    
    systemError
    
    other
    Allowed
    matchedpartialMatchnotMatchednotCheckedsystemErrorother
  - cvvResultstring<matched | notMatched>
    Description
    Imperative. Result from the Issuer when checking a CVV match.
    
    Options are:
    
    matched
    
    notMatched
    Allowed
    matchednotMatched
  - cardAuthorizationCodestring
    Example
    100
    Description
    Optional. Payment card authorization code. Maximum field length = 20 characters.
  - cardAuthorizationDateTimestring<date-time>
    Example
    2010-02-15T17:07:24-07:00
    Description
    Optional. Payment card authorization date in formatted yyyy-MM-dd'T'HH:mm
    .
    Format
    date-time
  - isPre-AuthorizationRejectboolean
    Description
    Optional. Whether the pre-authorization rejected the payment.
    
    Options are:
    
    true
    
    false
    Allowed
    truefalse
  - post-AuthorizationRejectReasonstring<creditReject | fraudReject | otherReject>
    Description
    Optional. The reason the credit card was rejected after it was authorized.
    
    Options are:
    
    creditReject
    
    fraudReject
    
    otherReject
    Allowed
    creditRejectfraudRejectotherReject
  - eciIndicatorstring<successful | unsuccessfulOrNotAttempted | attemptedButNotCompleted | other>
    Description
    Optional. Whether the Electronic Commerce Indicator (ECI) is returned by the card brand.
    
    Options are:
    
    successful
    
    unsuccessfulOrNotAttempted
    
    attemptedButNotCompleted
    
    other
    Allowed
    successfulunsuccessfulOrNotAttemptedattemptedButNotCompletedother
  - totalFailedAttemptsnumber
    Example
    88
    Description
    Optional. Number of times this payment method failed. Maximum field length = 100 characters.
  - paymentMethodCreatedDateTimestring<date-time>
    Example
    2020-03-28T17:07:24-07:00
    Description
    Optional. Payment method creation date formatted yyyy-MM-dd'T'HH:mm
    .
    Format
    date-time
  - paymentMethodUpdatedDateTimestring<date-time>
    Example
    2021-03-28T17:07:24-07:00
    Description
    Optional. Payment method update date formatted yyyy-MM-dd'T'HH:mm
    .
    Format
    date-time
  - giftCardNumberstring
    Example
    a789sdf8asdfasd89f789asd78
    Description
    Optional. Gift card number or account for this payment method. Maximum field length = 100 characters.
    
    Note: Shown hashed. We provide the Accertify Hashing Algorithm. If the value appears to be in plain text, we respond "400 Bad Request" with the appropriate errorResponse.
  - giftCardLastFourstring
    Example
    1111
    Description
    Optional. Last four digits on the gift card or account for this payment method. Must be 4 characters.
  - giftCardBINstring
    Example
    4111
    Description
    Optional. BIN number on the gift card or account for this payment method. Minimum field length = 6 characters
  - paymentMethodBalanceAmountnumber
    Example
    4000
    Description
    Optional. Balance on the card or account at the time of the request. Format = two decimals.
  - pointsinteger
    Example
    50000
    Description
    Optional. Number of points being redeemed. Maximum field length = 100 digits.
    
    Note: Numbers only. This could be miles, points, units, or however you refer to the points.
  - loyaltyProgramNamestring
    Example
    Acme Platinum
    Description
    Optional. Name of the program governing the points or loyalty program. Maximum field length = 100 characters.
  - walletTypestring
    Example
    Venmo, Google Pay
    Description
    Optional. Type of wallet with which the user paid. Maximum field length = 100 characters.
  - walletStatusstring<active | pending | inactive>
    Description
    Optional. Status of the wallet account.
    
    Options are:
    
    active
    
    pending
    
    inactive
    Allowed
    activependinginactive
  - isWalletProtectionEligibleboolean
    Description
    Optional. Whether the wallet is eligible for protection.
    
    Options are:
    
    true
    
    false
    Allowed
    truefalse