Credit Card
Credit Card: Update
- Node
gateway.creditCard.update(creditCardToken, {
cardholderName: 'New Holder',
number: '4111111111111111',
expirationDate: '06/2022',
cvv: '456',
billingAddress: {
region: 'IL'
},
options: {
verifyCard: true
}
}, (err, result) => { });
Arguments
token
required, StringAn alphanumeric value that references a specific payment method stored in your Vault. Must be less than or equal to 36 characters. If using a custom integration, you can specify what you want the token to be. If not specified, the gateway will generate one that can be accessed on the result. If using our Drop-in UI with a customer ID to vault payment methods, you can't specify your own token. Length and format of gateway-generated tokens and IDs may change at any time.
Additional Parameters
company
StringcountryCodeAlpha2
StringThe ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.
countryCodeAlpha3
StringThe ISO 3166-1 alpha-3 country code specified in an address. The gateway only accepts specific alpha-3 values.
countryCodeNumeric
StringThe ISO 3166-1 numeric country code specified in an address. The gateway only accepts specific numeric values.
countryName
StringThe country name specified in an address. We only accept specific country names.
extendedAddress
StringfirstName
StringcountryCode
StringnationalNumber
StringlastName
Stringlocality
StringupdateExisting
boolphoneNumber
StringDeprecated.
We recommend using international_phone
. This functionality still exists in the gateway but is no longer documented. This parameter will be removed in the future.
postalCode
Stringregion
StringstreetAddress
StringcardholderName
Stringcvv
StringA 3 or 4 digit card verification value assigned to credit cards. The CVV will never be stored in the gateway, but it can be provided with one-time requests to verify the card.
expirationDate
StringThe expiration date, formatted MM/YY
or MM/YYYY
. May be used instead of expirationMonth and expirationYear.
expirationMonth
StringThe expiration month of a credit card, formatted MM
. May be used with expirationYear, and instead of expirationDate.
expirationYear
StringThe two or four digit year associated with a credit card, formatted YYYY
or YY
. May be used with expirationMonth, and instead of expirationDate.
number
StringThe 12-19 digit value consisting of a bank identification number (BIN) and primary account number (PAN). Passing the number directly (rather than passing a nonce) should only be done in a PCI compliant environment. If in doubt, use paymentMethodNonce
with Payment Method: Update
makeDefault
boolskipAdvancedFraudChecking
booleanPrevents the verification from being evaluated as part of Premium Fraud Management Tools checks. Use with caution – once you've skipped checks for a verification, it is not possible to run them retroactively.
venmoSdkSession
StringverificationAmount
StringSpecify the merchant account ID that you want to use to verify a card. See the merchantAccountId
on Transaction: Sale
to learn more. The merchant account can't be a marketplace sub-merchant account. See the Braintree Marketplace Guide to learn more.
verifyCard
boolThis option prompts the gateway to verify the card's number and expiration date. It also verifies the AVS and CVV information if you've enabled AVS and CVV rules.
In some cases, cardholders may see a temporary authorization on their account after their card has been verified. The authorization will fall off the cardholder's account within a few days and will never settle.
Only returns a Credit Card Verification
result if verification runs and is unsuccessful.
Results of a merchant-performed 3D Secure authentication. You will only need to use these fields if you've performed your own integration with a 3D Secure MPI provider (e.g. Cardinal Centinel). Otherwise, Braintree's SDKs handle this for you in our standard 3D Secure integration.
cavv
StringCardholder authentication verification value or CAVV. The main encrypted message issuers and card networks use to verify authentication has occurred. Mastercard uses an AVV message and American Express uses an AEVV message, each of which should also be passed in the cavv parameter.
dsTransactionId
StringTransaction identifier resulting from 3D Secure 2 authentication. This field must be supplied for Mastercard Identity Check.
eciFlag
StringThe value of the electronic commerce indicator (ECI) flag, which indicates the outcome of the 3DS authentication.
Accepted values for Mastercard:
00
= Failed or not attempted01
= Attempted02
= Success04
= Data-Only (Applies to limited processors)
Accepted values for all other card brands:
07
= Failed or not attempted06
= Attempted05
= Success
threeDSecureVersion
StringThe version of 3D Secure authentication used for the transaction. Required
on Visa and Mastercard authentications. Must be composed of digits separated
by periods (e.g. 1.0.2
).
xid
StringTransaction identifier resulting from 3D Secure authentication. Uniquely identifies the transaction and sometimes required in the authorization message. Must be base64-encoded. This field will no longer be used in 3D Secure 2 authentications.
Payment method nonces vs. raw card data
While it is possible to pass both raw card data and a payment method nonce in the same call, we recommend passing only a payment method nonce.
Passing both will result in a payment method that has a mix of their attributes, with precedence given to the fields individually, then to the attributes of the payment method nonce. For example, if you pass both a card number and a payment method nonce, the payment method will have the number you passed explicitly, but the rest of the attributes will be obtained through the nonce.