Australia and Canada only.
This API can be used with BECS Direct Debit and Pre-Authorized Debit. Please reach out to BlueSnap Merchant Support to enable those payment methods.
The Get Pre-Notification Debit Agreement request retrieves two concatenated texts:
- The shopper's bank account information
- The mandate that the shopper was presented with (the same mandate that was generated by the merchant through the Create Debit Agreement API).
Send a test request
Go to API Explorer to send a test request to our sandbox environment and receive a response in real time.
Request Content
No content is required in the request body. Enter the information in the request URL as path and query string parameters:
services/2/agreements/prenotification/{transactionId}
For example:
https://sandbox.bluesnap.com/services/2/agreements/prenotification/1105235763
Path Parameters
| Path parameters | Type | Required | Description |
|---|---|---|---|
| {transactionId} | string | required | Unique identifier for the transaction. |
Response Details
If successful, the response HTTP status code is 200 OK. The response contains the shopper's bank account information and the mandate text.
Examples
Request Examples
curl -v -X GET https://sandbox.bluesnap.com/services/2/agreements/prenotification/1105235763 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
Response Examples
{
"preNotificationAgreementText": "
Dear Becs Test,
Thank for you authorizing debits from the bank account listed below.
We have also included the service agreement details for your reference.
BANK ACCOUNT INFORMATION:
Financial Institution: Bank of Nova Scotia
Branch: Nova Scotia
Account Name: Vasya Utkin
BSB Number: 333222
Account Number (Last 4): 9992
DIRECT DEBIT REQUEST (DDR) SERVICE AGREEMENT
By signing a Direct Debit Request, you have authorised us to arrange for your nominated account to be debited according to the agreement we have with you.
Changes by us - We will advise you 14 days in advance of any changes to the Direct Debit arrangements.
(NOTE - The Direct Debit arrangements must be set out in reasonable detail the terms to apply including, if applicable, the basis on which billing advices will be issued to the Customer).
Changes by you - For all matters relating to the Direct Debit arrangement, including deferment, stops, cancellations or alteration of any of the arrangements, please contact us
By Phone - +1-212-552-0482
By Email - [email protected]
Please allow 7 days for the amendments to take effect.
Disputes - If you believe that there has been an error in debiting your account, you should contact us in the first instance to confirm the details so that we can investigate the matter and advise you in writing whether your account has been incorrectly or correctly debited. \nIf we can not resolve the matter, you can still refer it to your Financial Institution and they may lodge a claim on your behalf.
Your responsibility - It is your responsibility to ensure you have sufficient cleared funds available in the account to be debited when payments are due.
If the due date for a payment falls on a non-working day or public holiday in New South Wales, the payment will be processed on the next working day.
If you are uncertain as to when the debit will be processed to your account, you should contact your Financial Institution.
Returned Payments - In the event that the debit to your account is returned to us unpaid, the following procedures will apply:
You will be notified by phone that your payment has been returned unpaid.
You will have 7 days to pay the amount. You may request us to debit your account under this DDR again.
A fee of $20 will be charged per returned payment unpaid.
All customer records and account details will be kept private and confidential to be disclosed only at the request of the customer or Financial Institution in connection with a claim (including JP Morgan) made to an alleged incorrect or wrongful debit.
."
}
API Explorer
To test a call, enter the transactionId query parameter into the available fields. This automatically inserts the ID into the request URL. You can also use the default values and click Try It when you're ready to run the request.