Model: globalPaymentMethods

1 min

Model Parameters

globalPaymentMethods
- paymentMethodsobject[]
  Description
  [OPTIONAL]
  - paymentTypestring<bankAccount | cash | check | creditCard | cryptoCurrency | digitalWallet | electronicFundTransfer | giftCard | invoice | loan | loyaltyPoints | moneyOrder | secCard | storeCredit | thirdParty | voucher>required
    Description
    [REQUIRED] User's tender type (ACH in bankAccount; EFT in electronicFundTransfer).
    Allowed
    bankAccountcashcheckcreditCardcryptoCurrencydigitalWalletelectronicFundTransfergiftCardinvoiceloanloyaltyPointsmoneyOrdersecCardstoreCreditthirdPartyvoucher
  - paymentMethodIDstring
    Example
    2ljr9vxsdfey
    Description
    [OPTIONAL] Unique identifier for the payment method (not a card number). Maximum field length = 100 characters.
  - paymentMethodAmountnumber
    Example
    500
    Description
    [OPTIONAL] Amount applied to this method (transaction currency). Format = two decimals.
    
    Note: Payment amounts can be spread across several payment types in this array.
  - isPaymentStoredOnFilestring<true | false>
    Description
    [OPTIONAL] Indicates if method was stored on file.
    Allowed
    truefalse
  - emailAddressstring
    Example
    [email protected]
    Description
    [OPTIONAL] Email associated with the 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] Account type when paymentType=bankAccount.
    Allowed
    checkingsavingmoneyMarketother
  - cardNumberstring
    Example
    5555555555554444
    Description
    [OPTIONAL] Primary account number for creditCard. Data must pass ISO/IEC 7812-1 LUHN validation. Minimum field length = 10 characters. Maximum field length = 19 characters.
  - cardTokenstring
    Example
    6f7%gf38hfUa
    Description
    [IMPERATIVE] Tokenized card number for creditCard.
  - expirationMonthstring
    Example
    11
    Description
    [IMPERATIVE] Expiry month (MM) for cards/vouchers/points where applicable. Maximum field length = 2 characters.
  - expirationYearstring
    Example
    2026
    Description
    [IMPERATIVE] Expiry year (YYYY) for cards/vouchers/points where applicable. Maximum field length = 4 characters.
  - expirationDaystring
    Example
    12
    Description
    [IMPERATIVE] Expiry day (DD) for vouchers/points when used. Maximum field length = 10 characters.
  - nameOnCreditCardstring
    Example
    Jane Doe
    Description
    [IMPERATIVE] Cardholder name (creditCard/giftCard). Maximum field length = 100 characters.
  - cardBininteger
    Example
    345678
    Description
    [IMPERATIVE] Leading 6–11 digits of the credit card number (numeric only). Minimum field length = 6 digits. Maximum field length = 11 digits. For BIN lookups, Accertify will query the full/encrypted Payment Card Number (PAN).
  - cardLastFourstring
    Example
    4444
    Description
    [IMPERATIVE] Last four digits (numeric only). Must be 4 characters.
  - avsResultstring<matched | partialMatch | notMatched | notChecked | systemError | other>
    Description
    [IMPERATIVE] Issuer AVS result.
    Allowed
    matchedpartialMatchnotMatchednotCheckedsystemErrorother
  - cvvResultstring<matched | notMatched>
    Description
    [IMPERATIVE] Issuer CVV result.
    Allowed
    matchednotMatched
  - cardAuthorizationCodestring
    Example
    100
    Description
    [OPTIONAL] Payment card authorization code when available. 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-AuthorizationRejectstring<true | false>
    Description
    [OPTIONAL] Whether pre-authorization rejected the payment.
    Allowed
    truefalse
  - post-AuthorizationRejectReasonstring<creditReject | fraudReject | otherReject>
    Description
    [OPTIONAL] Reason for post-authorization reject.
    Allowed
    creditRejectfraudRejectotherReject
  - eciIndicatorstring<successful | unsuccessfulOrNotAttempted | attemptedButNotCompleted | other>
    Description
    [OPTIONAL] ECI status from card brand.
    Allowed
    successfulunsuccessfulOrNotAttemptedattemptedButNotCompletedother
  - totalFailedAttemptsnumber
    Example
    88
    Description
    [OPTIONAL] Number of failed attempts on this method. 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 of gift card. 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] Monetary amount left 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, PayPal
    Description
    [OPTIONAL] Type of wallet with which the user paid. Maximum field length = 100 characters.
  - walletStatusstring<active | pending | inactive>
    Description
    [OPTIONAL] Wallet account status.
    Allowed
    activependinginactive
  - isWalletProtectionEligiblestring<true | false>
    Description
    [OPTIONAL] Whether the wallet is eligible for wallet protection.
    Allowed
    truefalse

Array of payment methods used (split or single tender).