Server-Side API Requests/
Credit Card Verification/
Create

Credit Card Verification: Create

You can perform a standalone credit card verification without storing the card in the Vault. However, to do so you must pass raw credit card data, which should only be done in a PCI compliant environment. If in doubt, use a paymentMethodNonce to perform a standard card verification and vault the card. ;
Parameters
'billingAddress'
A billing address associated with a specific customer ID. It can be further associated with a specific payment method. The maximum number of addresses per customer is 50.
'company'string
Company name. 255 character maximum.
'countryCodeAlpha2'string

The ISO 3166-1 alpha-2 country code specified in an address. The gateway only accepts specific alpha-2 values.

'countryCodeAlpha3'string

The ISO 3166-1 alpha-3 country code specified in an address. The gateway only accepts specific alpha-3 values.

'countryCodeNumeric'string

The ISO 3166-1 numeric country code specified in an address. The gateway only accepts specific numeric values.

'countryName'string

The country name specified in an address. We only accept specific country names.

'extendedAddress'string
The extended address information—such as apartment or suite number. 255 character maximum.
'firstName'string
The first name. 255 character maximum.
'internationalPhone'
The phone number that belongs to the address that is structured with country code and national number.
'countryCode'string
Country code of phone number. 1-3 digits. Required.
'nationalNumber'string
National number of phone number. 4-12 digits. Required.
'lastName'string
The last name. 255 character maximum.
'locality'string
The locality/city. 255 character maximum.
'phoneNumber'string

Deprecated.

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'string
The postal code. Postal code must be a string of 4-9 alphanumeric characters, optionally separated by a dash or a space. Spaces and hyphens are ignored.
'region'string
The state or province. 255 character maximum.
'streetAddress'string
The billing street address. 255 character maximum. Required to perform card verification when AVS rules are configured to require street address.
'cardholderName'string
The cardholder name associated with the credit card. 175 character maximum.
'cvv'string
A 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'string

The expiration date, formatted MM/YY or MM/YYYY. May be used instead of expirationMonth and expirationYear.

'expirationMonth'string

The expiration month of a credit card, formatted MM. May be used with expirationYear, and instead of expirationDate.

'expirationYear'string

The 2 or 4 digit year associated with a credit card, formatted YYYY or YY. May be used with expirationMonth, and instead of expirationDate.

'number'string
The 12-19 digit value consisting of a bank identification number (BIN) and primary account number (PAN).
'externalVault'
Options used to indicate when a payment method is externally vaulted. These fields should be provided when storing a customer's payment methods in an external vault (e.g. third-party vault, not tokenizing through Braintree).
'previousNetworkTransactionId'string
Network transaction identifier issued by the card brand network during a previous transaction or verification. Currently only applicable for Visa payment methods. Visa provides network transaction identifiers to improve authorization approval rates for stored credential transactions.
'status'string

The option indicates the vaulted status of the externally vaulted payment method. Accepted values:

  • vaulted = Indicates the payment method is already stored on behalf of the customer.
  • will_vault = Indicates the payment method is intended to be vaulted upon successful processing of the verification.
'options'
Optional values that can be passed with a request.
'amount'string
Specify a positive, non-zero amount that you want to use to verify a card. If you do not pass this option, the gateway will automatically use a verification amount of $0 or $1, depending on the card type.
'merchantAccountId'string

Specify the merchant account ID that you want to use to verify a card. See the merchantAccountId on Transaction: Sale to learn more.

'paymentMethodNonce'string
One-time-use reference to payment information provided by your customer, such as a credit card or PayPal account.
'riskData'
Customer request information. Sent to processor to help verify transaction integrity.
'customerBrowser'string
The User Agent field provided by the customer. Maximum 255 characters.
'customerIp'string
The customer's IP address.
'threeDSecureAuthenticationId'string
ID of the 3D Secure authentication performed for this transaction. Do not provide this field if you are using a nonce for this transaction that is 3D Secure enriched.
'threeDSecurePassThru'

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'string

Cardholder 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'string

Transaction identifier resulting from 3D Secure 2 authentication. This field must be supplied for Mastercard Identity Check.

'eciFlag'string

The value of the electronic commerce indicator (ECI) flag, which indicates the outcome of the 3DS authentication.

Accepted values for Mastercard:

  • 00 = Failed or not attempted
  • 01 = Attempted
  • 02 = Success
  • 04 = Data-Only (Applies to limited processors)

Accepted values for all other card brands:

  • 07 = Failed or not attempted
  • 06 = Attempted
  • 05 = Success
'threeDSecureVersion'string

The 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'string

Transaction 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.

;