Create Debit Agreement

for Australia and Canada

πŸ“˜

This API can be used with BECS Direct Debit and Pre-Authorized Debit. Both are currently in Beta. Please reach out to BlueSnap Merchant Support to enable those payment methods.

The Create Debit Agreement request should generate a new mandate.


πŸ“˜

Tip

You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.

Request Content

  • Enter the region and type path parameters into the web service URL, in the format: services/2/batch-transactions/:region/:type For example: services/2/agreements/debit/ca/onetime
  • Next, add any query parameters you choose. For example: services/2/agreements/debit/ca/recurring?planId=2203220&overrideRecurringChargeAmount=23.85

Response Details

If successful, the response HTTP status code is 200 OK and will contain the agreement text.


Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/agreements/debit/ca/onetime \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
curl -v -X POST https://sandbox.bluesnap.com/services/2/agreements/debit/ca/recurring?planId=2203220&overrideRecurringChargeAmount=23.85 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Response Examples

{
    "region": "Canada",
    "debitType": "ONETIME",
    "agreementName": "Pre-Authorized Debit Agreement",
    "agreementId": 523,
    "agreementText": "I / we authorize onboardingDefault to debit the bank account I / we have identified on any future purchase that I / we make. \nThe amount debited should equal the checkout amount. \nonboardingDefault is not required to get my / our authorization for any future sporadic debit. \n\nI / we may revoke this authority at any time, subject to providing notice of (30 days). \nTo 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 \n\nonboardingDefault \n303 Wyman Street, Suite 300  \nCampbell, United States 02451 \nTel: +1 (866) 312-7733\nEmail: [email protected]\n\nI 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.  \nTo obtain more information on my recourse rights, I may contact my financial institution or visit www.payments.ca.  \n\nI authorize BlueSnap, Inc to process payments on behalf of onboardingDefault.",
    "status": "UNUSED"
}
{
    "region": "Canada",
    "debitType": "RECURRING",
    "agreementName": "Pre-Authorized Debit Agreement",
    "agreementId": 1069,
    "agreementText": "I / we authorize Best Shop Ever to debit the bank account I / we have identified as per my instructions on the regular recurring payments for payments arising under my / our account.   

I will be debited 23.85 USD on the 26th every 2 months (or around that day if it is not a business day).

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 

I/ we waive our right to receive pre-notification of the amount of the PAD and agreed that I/we do not require advance notice of the amount of PADs before the debit is processed.  

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.  

I authorize BlueSnap, Inc to process payments on behalf of Best Shop Ever.",
    "status": "UNUSED"
}

Back to Top


API Explorer

To test a call, enter region and type 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.

Language
Authentication
Header
Click Try It! to start a request and see the response here!