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.

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

zip_code

This is the zip code of the card's billing address. This is required as an additional security measure for online and phone transactions. This is string field.

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

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.

Last updated

Was this helpful?