You are here: SOAP Services > Agreements > create

create

Summary

The create operation allows you to create member agreements. When successful, it returns an agreement number, and a unique member ID (GUID).

Use the service to create a membership agreement and specify contact information, payment plan, barcode, and billing information.

service type SOAP
service name Agreements
operation create
required request parameters
  • club
  • paymentPlanId
  • totalDownPayment
  • agreementContactInfo
  • firstName
  • lastName
  • gender
  • birthday
  • agreementAddressInfo
  • street
  • city
  • state
  • zipCode
  • todayBillingInfo
  • todayCcBillingZip
  • todayCcFirstName
  • todayCcLastName
  • todayCcType
  • todayCcAccountNumber
  • todayCcExpMonth
  • todayCcExpYear

Create makes only primary members.

The create operation only creates primary memberships and their agreements, not secondary members.

Request Parameters

The request has the following parameter hierarchy:

Parameter Name Required? Format Parent Parameter Description
club Y club number The ABC-provided club number.
paymentPlanId Y GUID

An ABC-generated string to uniquely identify the payment plans created in DataTrak.

Use the ?plans operation to retrieve plan details for a club, including GUIDs.

Web plans that have UDFs (user-defined fields) cannot be retrieved by this service.
totalDownPayment Y dollar value

The total amount of the down payment made by the member when the agreement is created.

This amount is billed to the payment method described in todayBillingInfo.

If the payment plan for the service does not require a down payment, use $0.00.
barcode barcode
agreementContactIfno Y

Contains the details of the contact info for the new member.

Child parameters:

  • firstName
  • middleInitial
  • lastName
  • email
  • homePhone
  • cellPhone
  • workPhone
  • workExt
firstName Y [a-zA-Z0-9 ]{1,15} agreementContactIfno The member's first name.
middleInitial

[a-zA-Z]

 agreementContactInfo The member's middle initial.
lastName Y [a-zA-Z0-9 ]{1,19} agreementContactInfo The member's last name.
email string agreementContactInfo The member's email address.
homePhone phone number agreementContactInfo The member's home phone number.
cellPhone phone number agreementContactInfo The member's cell phone number.
workPhone phone number agreementContactInfo The member's work phone number.
workExt string agreementContactInfo An extension to use with the member's work phone number.
gender Y string agreementContactInfo

Valid values:

  • Male
  • Female
  • NotSpecified
birthday Y MM/DD/YYYY agreementContactInfo The member's birthdate
emergencyContact

Contains the details of an emergency contact individual associated with the member.

Child parameters:

  • firstName
  • middleInitial
  • lastName
  • email
  • homePhone
  • cellPhone
  • workPhone
  • workExt
ecFirstName string emergencyContact The emergency contact's first name.
ecMiddleInitial string emergencyContact The emergency contact's middle initial.
ecLastName string emergencyContact The emergency contact's last name.
ecPhone phone number emergencyContact The emergency contact's phone number.
ecPhoneExtension string emergencyContact An extension to use with the emergency contact's phone number.
agreementAddressInfo

Contains the details of the member's mailing address.

Child parameters:

  • street
  • city
  • state
  • zip
street string, up to 40 characters agreementAddressInfo Contains the member's street address in uppercase.
city string, up to 17 characters agreementAddressInfo Contains the member's city in uppercase.
state state code agreementAddressInfo

Contains the value for the member's state of residence in uppercase.

This service does not support Canadian province codes or any other regional codes outside the United States.
zipCode Y string, up to 10 characters agreementAddressInfo

Contains the value for the member's ZIP code.

This service only supports United States zip codes.
todayCcBillingZip Y string todayBillingInfo The billing zip code on the credit card account.
todayBillingInfo Y

Contains the details of a credit card which is charged with the down payment.

This information will not be used for ongoing payments.

Child parameters:

  • todayCcAccountNumber
  • todayCcType
  • todayCcLine1
  • todayCcLine2
  • todayCcBillingZip
  • todayCcFirstName
  • todayCcLastName
  • todayCcExpMonth
  • todayCcExpYear
  • todayCcCwCode
todayCcFirstName Y string todayBillingInfo

The first name on the credit card account.
todayCcLastName Y string todayBillingInfo The last name on the credit card account.
todayCcType Y string todayBillingInfo

The type of credit card

Valid values:

  • Visa
  • Discover
  • AmericanExpress
  • MasterCard
todayCcAccountNumber Y string todayBillingInfo The credit card number used to pay the down payment.
todayCcLine1 string todayBillingInfo A line of additional information (for example, a street address) to use in validating the credit card.
todayCcLine2 string todayBillingInfo A line of additional information to use in validating the credit card.
todayCcExpMonth Y MM todayBillingInfo The month in which the credit card expires.
todayCcExpYear Y YYYY todayBillingInfo The year in which the credit card expires.
todayCcCwCode string todayBillingInfo The card verification code.
Found on the front of AmericanExpress cards and on the back of other card types.
draftBillingInfo

Contains the billing information for ongoing payments.

Must contains one instance of either draftCreditCard or draftBankAccount.
draftCreditCard draftBillingInfo

Contains the details of the credit card information used for ongoing payments.

Child parameters:

  • creditCardFirstName
  • creditCardLastName
  • creditCardType
  • creditCardAccountNumber
  • creditCardExpMonth
  • creditCardExpYear
creditCardFirstName string draftCreditCard The first name of the card account holder for the credit card use in ongoing payments.
creditCardLastName string draftCreditCard The last name of the card account holder for the credit card use in ongoing payments.
creditCardType string draftCreditCard

Valid values:

  • Visa
  • Discover
  • AmericanExpress
  • MasterCard
creditCardAccountNumber string draftCreditCard The credit card account number to be used in ongoing payments.
creditCardExpMonth string draftCreditCard The expiration month of the credit card.
creditCardExpYear string draftCreditCard The expiration year of the credit card.
draftBankAccount string draftBillingInfo Contains the details of a member's bank account used for ongoing payments.
draftAccountFirstName string draftBankAccount The first name associated with a bank account used in ongoing payments.
draftAccountLastName string draftBankAccount The last name associated with a bank account used in ongoing payments.
draftRoutingNumber string draftBankAccount The routing number associated with a bank account used in ongoing payments.
draftAccountNumber string draftBankAccount The account number associated with a bank account used in ongoing payments.
draftAccountType string draftBankAccount The account type of a bank account used in ongoing payments.

Return Data

The return data is included inside return parameters in the body of the response.

The data has the following parameter hierarchy:

Parameter Name Contents Parent Parameter Description
clubNumber club number The number for the club that has the new agreement.
agreementNumber agreement number The agreement number for the member's new membership agreement. The service automatically assigns a unique agreement number.
memberId GUID The unique member ID for the created member.
status Contains the details of a status message.
status string status

Contains a status code.

Examples:

  • 0 indicates a successful request.
  • Failed indicates a failed request.
status string status

Contains any additional details about the status (for example, how much the member was charged when the agreement was created).

 

 

ABC Financial Web Services
© 2014 ABC Financial Services, Inc. All rights reserved.