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 Debit Agreement request retrieves the mandate generated by the merchant using the Create Debit Agreement API request. The mandate is retrieved using the given agreement ID.
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/{agreementId}
For example:
https://sandbox.bluesnap.com/services/2/agreements/28521
Path Parameters
| Path parameters | Type | Required | Description |
|---|---|---|---|
| {agreementId} | string | required | Unique identifier for the mandate. |
Response Details
Successful requests return the HTTP response status code 200 OK and a response body that contains the mandate in the agreementText property.
Examples
Request Examples
curl -v -X GET https://sandbox.bluesnap.com/services/2/agreements/28521 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
Response Examples
{
"region": "Canada",
"debitType": "ONETIME",
"agreementName": "Pre-Authorized Debit Agreement",
"agreementId": 1065,
"agreementText": "I / we authorize Best Shop Ever to debit the bank account I / we have identified on any future purchase that I / we make.
The amount debited should equal the checkout amount. \nBest Shop Ever is not required to get my / our authorization for any future sporadic debit.
I / we may revoke this authority at any time, subject to providing notice of (30 days).
To obtain a sample cancellation form, or for more information on my right to cancel a PAD Agreement, I may contact my financial institution or visit www.payments.ca
Best Shop Ever
Apartment 10F 300 East 56 St
New York, United States 10022
Tel: +1-212-552-0482
Email: [email protected]
I have certain recourse rights if any debit does not comply with this agreement for example, I have the right to receive reimbursement for any debit that is not consistent with this PAD Agreement.
To obtain more information on my recourse rights, I may contact my financial institution or visit www.payments.ca.
authorize BlueSnap, Inc to process payments on behalf of Best Shop Ever.",
"status": "UNUSED"
}
Back to Top
API Explorer
To test a call, enter the agreementId 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.