The PayURL Cancellation API and its use
Overview
SBT customers can cancel a previously sent PayURL via the PayURL Cancellation API. This workflow allows customers to cancel a PayURL sent to a consumer if the consumer has used another method of payment; for example, an in-person cash payment or check, or a different online method.
PayURL cancellation allows customers to more effectively manage their accounts and payments and reduce the potential for duplicate or erroneous payments.
If the consumer clicks a canceled link they will be they will see one of the following two options:
- A cancellation page via the UI.
- A text message letting them know the PayURL has been cancelled.
Workflow
The PayURL Cancellation API workflow can be set up as part of your normal integration during your payments onboarding project or can be added later by a member of the SBT technical consultant team.
FPA File Layout/API Data Parameters
File Name Structure: CANCELPAY_{PROFILE_NAME}_{YYYY-MM-DD}_{SEQUENCE_NO}.csv
Start each file with CANCELPAY to denote this is a payment request cancellation file.
| Field Name (Requirement) |
Data Type & Limits | Data Format | Example | Description | Callouts |
| Payment Request ID (Required) |
Alphanumeric; max 50 chars. | pr_ + 1 character of environment identifier + 14 alphanumeric characters | pr_pseoSFuwoRpy7JM | See below | This field is found via your webhooks (if API) or your daily payment request response file (if FPA) |
| Merchant Profile (Required) |
Alphanumeric; max 25 chars. | Discount50 | Name of the profile sent with the original payment request. Ensures the right payment request is identified and cancelled properly via workflow. | The default profile will be used if one is not specified. |
Payment Request ID
The Payment Request ID is an SBT-generated ID number associated with each unique payment request sent to a consumer. This number identifies the specific user request; the payment request ID is associated with the payment request sent to a specific subscriber/consumer phone number.
Customers will receive the Payment Request ID in the following ways:
- API customers: In the webhook response
- FPA customers: In an outbound FPA response file
User Interface
Consumers will see a new status page with the cancellation message. The message on the page can be configured during your onboarding process.
Sample language: Your payment request link has been canceled. Please contact {PhoneNumber} for more information and/or a new payment request. To Opt Out, reply STOP.
During onboarding, SBT customers are required to provide a phone number or email address to provide support for the Pay Page message.