Create a new membership profile, configure recurring billing settings, and associate customer payment information using this administration function.

Membership Administration - Add Member

Overview

The Add Member operation creates a new membership profile and associates billing information, payment credentials, membership settings, and recurring billing schedules with the customer account.

Request Parameters

Account Credentials

Variable Requirement Type Max Size Possible Values / Example Description
publisher-name Mandatory string N/A — Gateway account username issued to you.
publisher-password Mandatory string N/A — Remote Client Password. This is different than the password used to log in to the gateway.
mode Mandatory string N/A add_member Value must be set to add_member.

Membership Information

Variable Requirement Type Max Size Possible Values / Example Description
orderID Optional string 20 — Unique membership profile identifier. A value will be generated if not supplied.
username Mandatory string 12 — Customer profile username.
password Optional string 12 — Customer profile password.
status Optional string 9 active, pending, cancelled Allowed values: active, pending, cancelled.
purchaseid Optional string 20 — Used for custom features such as group names.
plan Optional string 5 — Membership Plan ID.

Billing Schedule

Variable Requirement Type Max Size Possible Values / Example Description
startdate Optional string 8 YYYYMMDD Membership start or creation date.
Format: YYYYMMDD
enddate Mandatory string 8 YYYYMMDD Next scheduled payment date for the recurring profile.
Format: YYYYMMDD
billcycle Optional integer 2 — Recurring billing cycle in months. Set to 0 for non-recurring profiles.
recfee Optional decimal 10 1234.56 Recurring billing amount. 1
balance Optional decimal 10 1234.56 Total amount to be billed. Typically used for installment billing. 1

Billing Address

Variable Requirement Type Max Size Possible Values / Example Description
card-name Mandatory string 39 — Customer name as it appears on the payment method.
card-address1 Mandatory string 39 — Billing Address Line 1.
card-address2 Optional string 39 — Billing Address Line 2.
card-city Mandatory string 39 — Billing city.
card-state Mandatory string 2 — Two-character state or province code.
card-zip Mandatory string 10 — Billing postal or ZIP code.
card-country Mandatory string 3 — Three-character country code.

Credit Card Information

Variable Requirement Type Max Size Possible Values / Example Description
card-number Mandatory string 16 4111111111111111 Credit card number. Numeric characters only.
Format: 4111111111111111
See Credit Card Storage Validation Policy.
card-exp Mandatory string 5 MM/YY Credit card expiration date.
Format: MM/YY

ACH / eCheck Information

Variable Requirement Type Max Size Possible Values / Example Description
accttype Optional string 8 checking, savings, credit Allowed values: checking, savings, and credit. Required for ACH transactions.
routingnum Optional string 9 — ABA routing number. Required for ACH transactions.
accountnum Optional string 20 — ABA account number. Required for ACH transactions.

ACH/eCheck fields are only required when creating a membership profile that uses bank account payments.

Shipping Information

Variable Requirement Type Max Size Possible Values / Example Description
shipname Optional string 39 — Shipping recipient name.
address1 Optional string 39 — Shipping Address Line 1.
address2 Optional string 39 — Shipping Address Line 2.
city Optional string 39 — Shipping city.
state Optional string 2 — Shipping state or province code.
zip Optional string 10 — Shipping postal or ZIP code.
country Optional string 3 — Shipping country code.

Response Parameters

The following response values are returned after the membership profile has been processed.

Variable Value Description
FinalStatus success, problem success indicates the profile was created successfully.
problem indicates the profile could not be created.
auth-msg string Additional response message.
MErrMsg string Error message when applicable.
resp-code string Alphanumeric response code.

⚠️ Important: Include only the fields you plan to define; omit any unused fields.

⚠️ Formatting Rule (Applies to All Amount Fields)

  1. All monetary values must be numeric only in the format 1234.56. Do not include currency symbols, commas, or formatting. Exactly two decimal places are required. ↩︎ ↩︎