See also the
CreditCard response object.
$result = $gateway->creditCard()->create([ 'customerId' => $customerId, 'number' => '4111111111111111', 'expirationDate' => '06/22', 'cvv' => '100' ]);
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.
The country name specified in an address. We only accept specific country names.
The postal code. Postal code must be a string of 4-9 alphanumeric characters, optionally separated by a dash or a space. Spaces, hyphens, and all other special characters are ignored.
The billing street address. 255 character maximum. Required to perform card verification when AVS rules are configured to require street address.
The two-letter value for an address associated with a specific customer ID. The maximum number of addresses per customer is 50.
A string value representing an existing customer in your Vault that you want to add a credit card for.
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.
The expiration date, formatted
MM/YYYY. May be used instead of
The expiration month of a credit card, formatted
MM. May be used with
expirationYear, and instead of
The two or four digit year associated with a credit card, formatted
YY. May be used with
expirationMonth, and instead of
If this option is passed and the same payment method has already been added to the Vault for any customer, the request will fail.
Specify a non-negative 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 processor and/or card type.
This 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. If you want to verify all cards before they are stored in your Vault, you can turn on card verification for your entire account in the Control Panel.
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
CreditCardVerification result if verification runs and is unsuccessful.
An 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.
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.
Still have questions?
If you can’t find an answer, contact our Support team