HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Authorize a payment method with a specified amount. A new payment method will be created and authorized.

Description of request parameters

networkProcessing
Optional

Network processing information.

No validation rules

processingType
Optional

Processing type is used to define the initial or subsequent transaction in a recurring or installment stream.
If no value is supplied, a transaction is considered a one-time payment and will not be linked to the initial one.

Validation rules:
  • Possible values: initialInstallment, initialRecurring, installment, recurring.

originalNetworkTransactionId
Optional

Element defines the networkTransactionId returned in the response messages for Visa, Mastercard, and Discover Auth/Sale transactions. You must include this element and the original value returned for subsequent (after the initial) Visa, Mastercard or Discover recurring/installment payments.

No validation rules

amount
Required

The amount information for the payment.

No validation rules

currency
Optional. Default - USD

The three-character ISO currency code (currently only USD is supported).

Validation rules:
  • Must be 3 characters in length

value
Required

The amount information for the payment.

Validation rules:
  • Must NOT be less than zero

paymentMethod
Required

The payment method information for the payment. Only one payment method type should be provided with a transaction.
Supported payment methods: Credit card, ACH*, GooglePay*.
*Supported for specific processors.

No validation rules

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.
DynamicDescriptor: The payment facilitator’s sub-merchant’s city name.

Validation rules:
  • 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.

No validation rules

email
Optional

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.

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.

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.

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

Language
Click Try It! to start a request and see the response here!