You are here: SOAP Services > Agreements > renew

renew

Summary

The renew operation allows you to renew member agreements.

Service Type SOAP
Service Name Agreements
Operations renew
Required Request Parameters
  • club
  • paymentPlanId
  • memberId
  • draftBillingInfo

Request parameters

The request has the following parameter hierarchy.

Parameter Format 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 plan. Use the plans operation to retrieve plan details for a club, including GUIDs.
memberId Y GUID An ABC-generated string to uniquely identify the member whose account will be renewed.
draftBillingInfo Y
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 credit card use in ongoing payments.
creditCardLastName string draftCreditCard The last name of the card account holder for 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 date 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 with ongoing payments.
draftAccountLastName string draftBankAccount The last name associated with a bank account used with ongoing payments.
draftRoutingNumber string draftBankAccount The routing number associated with a bank account used with ongoing payments.
draftAccountNumber string draftBankAccount The account number associated with a bank account used with ongoing payments.
draftAccountType string draftBankAccount The account type of a bank account used with 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.

 

 

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