Payment Transmission

This page describes the elements required to add a new payment method to an existing subscriber

Mapping Guide

POST members/{id}/payment_method

This function of the API allows you to create a payment_method . Each payment method contains:

Field	Description & Usage
payment_type	one of: card bank_account This central object holds the Card or Bank Account information associated with each payment method.

This API endpoint will redirect - on redirect please ensure your system redirects as a POST and not as a GET. GET is the default for redirects in many API visualization application, such as Postman.

Card and Account Details

Card Details

Field	Description & Usage
card_number	This field holds the primary account number (PAN). This card number is the unique 13-19 digit number on your credit, debit, or prepaid card. It is required for transmission, as it identifies the card and links it to the cardholder's account. This is string field.
security_code	A card's security code (CSC/CVC) is a 3 or 4-digit number that is required for transmission. Card Issuers designed this number as an additional security measure for online and phone transactions. This is string field.
expiration_date	This is the date on which the card is no longer active. This date is required for transmission. This is string field, with a date format of YYYY-MM-DD
first_name	This field holds the first name of the member associated with the card.
last_name	This field holds the last name of the member associated with the card.
billing_address	This object is used for the billing address that is related to this card. Includes: address_line_1 address_line_2 city state zip fips_county_code

Bank Account Details

Field	Description & Usage
account_number	This is the primary account number that is issued to each member by the bank. This is seperate from a routing_number. This can be the account number of a checking or a savings account. This is string field.
routing_number	This number is found commonly on checks or other account documents/applications. A routing number is used to identify the financial institution associated with your bank account. This is string field.
account_type	This is the type - checking or savings - of bank account associated with the account number above This field is an enumeration, with two possible values: checking savings
account_use	This the purpose of the account. This field is an enumeration, with the two possible values: personal business
first_name	This field holds the first name of the member associated with the bank account.
last_name	This field holds the last name of the member associated with the bank account.
billing_address	This object is used for the billing address that is related to this account. Includes: address_line_1 address_line_2 city state zip fips_county_code

Response

An id will be produced from a successful POST request. This id can be used as a primary key reference to this specific created payment method.

Additionally, a payment_expiration_date is created and available when a payment_method is created.