Create a payment method with a billing address ID, first name, last name, credit card or debit card number and its expiration date (MMYY)
Description of request parameters
- billingAddress
-
Optional
The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.
No validation rules - addressId
-
Optional
The unique identifier of the address.
No validation rules - addressLine1
-
Optional
Address
Validation rules:- The length should be between 2 and 40 characters
- addressLine2
-
Optional
Supplemental information for the address.
Validation rules:- Maximum length 40 characters
- city
-
Optional
BillingAddress: City.
Validation rules:
DynamicDescriptor: The payment facilitator’s sub-merchant’s city name.- BillingAddress: The length should be between 2 and 25 characters
- DynamicDescriptor: Maximum length of 20 characters
- state
-
Optional
Two-letter state abbreviation.
Validation rules:- Must be 2 characters in length
- postalCode
-
Optional
Postal code
Validation rules:- The length should be between 2 and 20 characters
- phoneNumber
-
Optional
The phone number associated with a payment method that is used for billing purposes.
- The length must not exceed 18 characters if a Nuvei processor is used.
-
Conditional. Email is required for processing transactions through Nuvei processor.
The email associated with a billing address.
No validation rules - country
-
Optional
Country
Validation rules:- The input must be a valid Alpha2 code, Alpha3 code, UN code, or full country name
- billingFirstName
-
Required
The customers’s first name associated with a payment method that is used for billing purposes.
No validation rules - billingLastName
-
Required
The customers’s last name associated with a payment method that is used for billing purposes.
No validation rules - creditCard
-
Conditional. One payment method type is required if neither the payment method ID nor the payment method
authorization ID is supplied.
Payment card information.
Validation rules:- Only one payment method type can be supplied
- paymentAccountNumber
-
Conditional. The PAN is required if the credit card payment method type is supplied in the request.
Validation rules:- The number must be a valid credit card number and will be verified using the Luhn algorithm.
- expirationDate
-
Conditional. The expiration date is required if the credit card payment method type is supplied in the
request.
The card expiration date.
Validation rules:- Must be in one of the following formats: MMYY, MMYYYY, MM/YYY and MM/YYYYY
- securityCode
-
Optional
The card verification code. It is considered best practice to always include this value for card-not-present transactions. Failure to do so may lead to higher rates of declines, an increase in chargeback cases, and/or transaction downgrades.
Validation rules:- The length should be between 3 and 4 characters
- ach
-
Conditional. One payment method type is required if neither the payment method ID nor the payment method
authorization ID is supplied.
ACH account information.
Validation rules:- Only one payment method type can be supplied
- routingNumber
-
Conditional. The routing number is required if the ACH payment method type is supplied in the
request.
The 9-digit ACH routing number of the account.
Validation rules:- Must be 9 characters in length
- accountNumber
-
Conditional. The account number is required if the ACH payment method type is supplied in the
request.
The US bank account number from which the payment will be debited.
Validation rules:- The length should be between 4 and 17 characters
- accountType
-
Conditional. The account type is required if the ACH payment method type is supplied in the
request.
Bank account type.
Validation rules:- Possible values: Checking or Savings
- googlePay
-
Conditional. One payment method type is required if neither the payment method ID nor the payment method
authorization ID is supplied.
GooglePay information.
Validation rules:- Only one payment method type can be supplied
- googlePayPaymentDataResponse
-
Conditional. The GooglePayPaymentDataResponse is required if the GooglePay payment method type is supplied in
the request.
The data returned by Google Pay.
Validation rules:- Must contain the valid serialized JSON object
- merchantPaymentMethodRefId
-
Optional
Merchant's unique identifier for the payment method.
No validation rules