📘
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 Create Debit Agreement request should generate a new mandate.

Request Content

No content is required in the request body. Enter the relevant information in the request URL as path and query string parameters:

services/2/agreements/debit/{region}/{type}?param=value

For example:

https://sandbox.bluesnap.com/services/2/agreements/debit/ca/onetime?planid=1234567

Path Parameters

Path parameter

Required

Description

{region}

required

The country that you want to generate a new mandate for. Accepts the following values:

au: Australia
ca: Canada

{type}

required

Specifies how often the mandate is provided to the shopper. Accepts the following values:

onetime
-recurring
ondemand

Query String Parameters

Query string parameter

Type

Required

Description

language

string

optional

Generates the mandate in the specified language. By default, the mandate is generated in English.
Accepts the following values:

en: English
fr: French

overriderecurringchargeamount

decimal

optional

Overrides the existing subscription pricing with the specified value.

plainid

integer

optional

Stock keeping unit (SKU) number for the purchase item.

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 POST 'https://sandbox.bluesnap.com/services/2/agreements/debit/ca/onetime' \
-H 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
-H 'Content-Type: application/json' \
-H 'accept: application/json' \
-H 'Accept: application/json'

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

curl -v -X POST 'https://sandbox.bluesnap.com/services/2/agreements/debit/ca/onetime?language=fr' \
-H 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
-H 'Content-Type: application/json' \
-H 'accept: application/json' \
-H 'Accept: application/json'

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: john.doe@bluesnap.com\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: avish.yeshurun@bluesnap.com 

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"
}

{
    "region": "Canada",
    "debitType": "ONETIME",
    "agreementName": "Pre-Authorized Debit Agreement",
    "agreementId": 10168,
    "agreementText": "J'autorise ou nous autorisons onboardingDefault à débiter le compte bancaire que j'ai indiqué lors de tout achat futur que j'effectuerai ou que nous effectuerons.\nLe montant débité doit être égal au montant du paiement.\nonboardingDefault n'est pas tenu d'obtenir mon ou notre autorisation pour tout futur débit ponctuel.\n\nJe peux ou nous pouvons révoquer cette autorisation à tout moment, sous réserve d'un préavis de (30 jours).\nPour obtenir un modèle de formulaire d'annulation ou pour plus d'informations sur mon droit d'annuler un contrat avec DPA, je peux contacter mon établissement financier ou aller sur le site www.payments.ca\n\nonboardingDefault\n303 Wyman Street, Suite 300 \nCampbell, United States 02451\nTél. : +1 (866) 312-7733\nE-mail : sarahi@bluesnap.com\n\nJe dispose de certains droits de recours si un prélèvement n'est pas conforme à cet accord. Par exemple, j'ai le droit de recevoir le remboursement de tout prélèvement qui n'est pas conforme à cet accord avec DPA.\nPour obtenir plus d'informations sur mes droits de recours, je peux contacter mon établissement financier ou aller sur le site www.payments.ca.\n\nJ'autorise BlueSnap, Inc à traiter les paiements pour le compte de onboardingDefault.",
    "status": "UNUSED"
}

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.