{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/agreements/:agreementId","auth":"optional","method":"get","results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"params":[{"name":"agreementId","type":"string","default":"","desc":"Argument included in the response for the Create Debit Agreement request","required":false,"in":"query","ref":"","_id":"62e428a6ec39660069255cfe"}]},"next":{"description":"","pages":[]},"title":"Get Debit Agreement","type":"endpoint","slug":"get-debit-agreement","excerpt":"for Australia and Canada","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This API can be used with BECS Direct Debit and Pre-Authorized Debit. Both are currently in Beta.\"\n}\n[/block]\n##Definition\nhttps<span>:://sandbox.bluesnap.com/services/2/agreements/{agreementId}</span>\n\n##Documentation\nThe 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.\n\n###Request Content\nEnter the `agreementId` query parameter into the web service URL, in the format:\n`services/2/agreements/:agreementId`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK. The response contains the mandate text.\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/agreements/1065 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Get Debit Agreement Request\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"region\\\": \\\"Canada\\\",\\n    \\\"debitType\\\": \\\"ONETIME\\\",\\n    \\\"agreementName\\\": \\\"Pre-Authorized Debit Agreement\\\",\\n    \\\"agreementId\\\": 1065,\\n    \\\"agreementText\\\": \\\"I / we authorize Best Shop Ever to debit the bank account I / we have identified on any future purchase that I / we make. \\n\\nThe amount debited should equal the checkout amount. \\\\nBest Shop Ever 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).\\n\\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\\nBest Shop Ever\\n\\nApartment 10F 300 East 56 St \\n\\nNew York, United States 10022\\n\\nTel: +1-212-552-0482\\n\\nEmail: avish.yeshurun:::at:::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.  \\n\\nTo obtain more information on my recourse rights, I may contact my financial institution or visit www.payments.ca.  \\n\\nauthorize BlueSnap, Inc to process payments on behalf of Best Shop Ever.\\\",\\n    \\\"status\\\": \\\"UNUSED\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Get Debit Agreement Response\"\n    }\n  ]\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"62e422d681d36e006531b8cb","createdAt":"2022-07-29T18:11:34.428Z","user":"606df105d9ab93003f73cb10","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Mandates","slug":"mandates","order":17,"from_sync":false,"reference":false,"_id":"62e1d5717d2b2c0073d572f2","createdAt":"2022-07-28T00:16:49.375Z","version":"62e153e6f9a69e007d2a5dc1","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.43 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62e153e6f9a69e007d2a5d03","62e153e6f9a69e007d2a5d04","62e153e6f9a69e007d2a5d05","62e153e6f9a69e007d2a5d06","62e153e6f9a69e007d2a5d07","62e153e6f9a69e007d2a5d08","62e153e6f9a69e007d2a5d09","62e153e6f9a69e007d2a5d0a","62e153e6f9a69e007d2a5d0b","62e153e6f9a69e007d2a5d0c","62e153e6f9a69e007d2a5d0d","62e153e6f9a69e007d2a5d0e","62e153e6f9a69e007d2a5d0f","62e153e6f9a69e007d2a5d10","62e153e6f9a69e007d2a5d11","62e153e6f9a69e007d2a5d12","62e153e6f9a69e007d2a5d13","62e153e6f9a69e007d2a5d14","62e153e6f9a69e007d2a5d15","62e153e6f9a69e007d2a5d16","62e15419e4138b00a861da23","62e1c7b1fad68000919a63b4","62e1d5717d2b2c0073d572f2"],"_id":"62e153e6f9a69e007d2a5dc1","project":"57336fd5a6a9c40e00e13a0b","__v":3,"forked_from":"628531cd1258c8003f6dd27d","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":10,"parentDoc":null}

getGet Debit Agreement

for Australia and Canada

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

agreementId:
string
Argument included in the response for the Create Debit Agreement request

Documentation

This API can be used with BECS Direct Debit and Pre-Authorized Debit. Both are currently in Beta.

Definition

https:://sandbox.bluesnap.com/services/2/agreements/{agreementId}

Documentation

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.

Request Content

Enter the agreementId query parameter into the web service URL, in the format:
services/2/agreements/:agreementId

Response Details

If successful, the response HTTP status code is 200 OK. The response contains the mandate text.


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/agreements/1065 \
-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: 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.  

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

User Information

Try It Out


get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}