Skip to main content
POST
/
api
/
PaymentMethod
Error
A valid request URL is required to generate request examples
{
  "paymentMethodId": 1,
  "billingAddressId": 1,
  "billingAddress": {
    "addressId": 1,
    "addressLine1": "123 Main",
    "addressLine2": null,
    "city": "Santa Ana",
    "state": "CA",
    "postalCode": "90000",
    "phoneNumber": null,
    "email": null,
    "country": "US"
  },
  "billingFirstName": "John",
  "billingLastName": "Smith",
  "merchantPaymentMethodRefId": "payment-method-ref-id_hgays-213-4rf4",
  "paymentMethodAchDetails": null,
  "paymentMethodCreditCardDetails": {
    "binNumber": "411111",
    "paymentLast4Digit": "1111",
    "paymentExpirationDate": "1025",
    "accountUpdateMessage": null,
    "accountUpdateDateTime": null,
    "accountUpdateCode": null
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

​
billingFirstName
string

Conditional: either both BillingFirstName and BillingLastName or BillingFullName must be provided.

The customers’s first name associated with a payment method that is used for billing purposes.

Maximum string length: 100
​
billingLastName
string

Conditional: either both BillingFirstName and BillingLastName or BillingFullName must be provided.

The customers’s last name associated with a payment method that is used for billing purposes.

Maximum string length: 100
​
billingFullName
string

Conditional: either BillingFullName or both BillingFirstName and BillingLastName must be provided.

The customers’s full name associated with a payment method that is used for billing purposes.

Maximum string length: 200
​
billingAddress
object

The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.

​
creditCard
object

Conditional: one payment method type is required.

Payment card information.

​
ach
object

Conditional: one payment method type is required.

ACH account information.

​
googlePay
object

Conditional: one payment method type is required.

Google Pay information.

​
applePay
object
​
merchantPaymentMethodRefId
string

Merchant's unique identifier for the payment method.

Maximum string length: 100

Response

The payment method was successfully created

​
paymentMethodId
integer<int64>

The unique identifier for the payment method information.

Required range: 1 <= x <= 1000000000
​
billingAddressId
integer<int64>

The unique identifier of the address.

Required range: 1 <= x <= 1000000000
​
billingAddress
object
​
billingFirstName
string | null
Maximum string length: 100
​
billingLastName
string | null
Maximum string length: 100
​
merchantPaymentMethodRefId
string

Merchant's unique identifier for the payment method.

Maximum string length: 100
​
paymentMethodAchDetails
object

ACH account information.

​
paymentMethodCreditCardDetails
object

The details of credit card payment method.