The schedulepayment allows you to schedule a single payment, for a specific date, and with a specified billing method.
| Service Type | SOAP |
| Service Name | Billing |
| Operation | schedulepayment |
| Required Request Parameters |
and either
or
|
The required parameter billingInfo must contain either creditCard or bankAccount.
If billingInfo = creditCard, the five additional credit card parameters are required.
If billingInfo = bankAccount, the four additional bank account parameters are required.
Availability of payment data
Individual payments are only viewable after posting.
Cancellations not available
Currently, you can schedule but not cancel payments via ABC Web Services.
The request has the following parameters:
| Parameter Name | Required? | Format | Parent Parameter | Description |
|---|---|---|---|---|
| club | Y | club number | The number for the club. | |
| agreementNumber | Y | agreement number | The nine-digit agreement number for the membership agreement. | |
| paymentDate | Y | YYYY-MM-DD | The beginning of the date range from which payment history will be drawn. | |
| paymentAmount | Y | ####.## | The amount of the payment. Must be a positive number. | |
| accountFirstName | Y | string |
The first name associated with the payment being made. accountFirstName and accountLastName will be associated with the payment being submitted only. Providing a name that is different than the account holder's name will not change the account information. |
|
| accountLastName | Y | string |
The last name associated with the payment being made. accountFirstName and accountLastName will be associated with the payment being submitted only. Providing a name that is different than the account holder's name will not change the account information. |
|
| billingInfo | Y | Contains the billing information for ongoing payments. Must contain one instance of either creditCard or bankAccount. | ||
| creditCard | billingInfo |
Contains the details of the credit card information used for ongoing payments.
Child parameters:
|
||
| creditCardType | Yes, if billingInfo = creditCard | string | creditCard |
Valid values:
|
| creditCardAccountNumber | Yes, if billingInfo = creditCard | string | creditCard | The credit card account number used to make the payment. |
| creditCardExpMonth | Yes, if billingInfo = creditCard | ## | creditCard | The expiration month of the credit card. |
| creditCardExpYear | Yes, if billingInfo = creditCard | #### | creditCard | The expiration year of the credit card. |
| bankAccount | string | billingInfo | Contains the details of a member's bank account for the payment. | |
| routingNumber | Yes, if billingInfo = bankAccount | string | bankAccount | The routing number associated with the member's bank account. |
| accountNumber | Yes, if billingInfo = bankAccount | string | bankAccount | The account number associated with the member's bank account. |
| accountType | Yes, if billingInfo = bankAccount | string | bankAccount | The account type of the bank account. |
The return data is included inside return parameters in the body of the response.
The data has the following parameter hierarchy:
| Parameter Name | Format | Parent Parameter | Description |
|---|---|---|---|
| club | 4-digit club number | The number for the club. | |
| agreementNumber | 9-digit agreement number | The agreement number for the membership agreement. | |
| status | Contains the details of a status message. | ||
| status | string | status |
Contains a status code. Example:
|
| message | string | status | Contains any additional details about the status. |
Note: Error message 0068 reads: "Error: Cannot Process. A payment request for today was already received."
This error message appears when a payment request is made to the same account for the same paymentDate. The paymentDate will not necessarily be today's date.