{"_id":"59e8f602aa561e00241c454d","category":{"_id":"59e8f600aa561e00241c44b3","version":"59e8f600aa561e00241c44aa","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"59e8f600aa561e00241c44aa","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-10-19T18:59:12.596Z","releaseDate":"2017-10-19T18:59:12.596Z","categories":["59e8f600aa561e00241c44ab","59e8f600aa561e00241c44ac","59e8f600aa561e00241c44ad","59e8f600aa561e00241c44ae","59e8f600aa561e00241c44af","59e8f600aa561e00241c44b0","59e8f600aa561e00241c44b1","59e8f600aa561e00241c44b2","59e8f600aa561e00241c44b3","59e8f600aa561e00241c44b4","59e8f600aa561e00241c44b5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.23 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-02T19:16:29.881Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":127,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`iban`\",\n    \"0-1\": \"*string*\",\n    \"0-3\": \"International Bank Account Number (IBAN). \\n\\n14 - 34 alphanumeric characters\",\n    \"h-4\": \"Description\",\n    \"0-2\": \"**Required**\\nOptional if sending shopper ID\",\n    \"1-0\": \"`bic`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Optional\",\n    \"1-3\": \"Bank Identifier Code (BIC). \\n\\n8 - 12 alphanumeric characters.\",\n    \"2-0\": \"`iban-first-four`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"**Required** if sending shopper ID and shopper has multiple saved payment methods.\",\n    \"2-3\": \"First four characters of IBAN.\",\n    \"3-0\": \"`iban-last-four`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"**Required** if sending shopper ID and shopper has multiple saved payment methods.\",\n    \"3-3\": \"Last four characters of IBAN.\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Description\",\n    \"0-0\": \"`bic`\",\n    \"0-1\": \"*string*\",\n    \"0-3\": \"Bank Identifier Code (BIC). \\n\\n8 - 12 Alphanumeric characters.\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"Bank Identifier Code (BIC). \\n\\n8 - 12 Alphanumeric characters.\",\n    \"1-0\": \"`iban-first-four`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"First four characters of IBAN.\",\n    \"2-0\": \"`iban-last-four`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Last four characters of IBAN.\",\n    \"3-0\": \"`mandate-id`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"ID used to identify the shopper's acceptance of the SEPA Direct Debit mandate.\\n\\n*Returned only in Create Subscription requests.*\",\n    \"4-0\": \"`mandate-date`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"Date (dd-mm-yy) on which the shopper accepted the SEPA Direct Debit mandate.\\nFor example: `\\\"21-Jul-17\\\"`\",\n    \"5-0\": \"`pre-notification-text`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Text for [pre-notification email]( /v1.0/docs/sepa-direct-debit#section-step-3-display-a-confirmation-message-send-a-pre-notification-email) in English. \\n\\nFor example: \\n\\\"The amount of 100.00 EUR will be collected using SEPA Direct Debit with Mandate BS141928 from your bank account IBAN DE09XXXXXX7891 in the next few days. Please ensure sufficient funds in your account\\\"\\n\\n**Note**: To get the text in another language, you may use the [Get Pre-Notification Text](/v4.0/docs/get-pre-notification-text) API.\",\n    \"6-0\": \"`pre-notification-text-ref`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"[Get Pre-Notification Text](/v4.0/docs/get-pre-notification-text) endpoint with transaction ID in query string. \\n\\nFor example: \\n\\\"https:<span>//sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=1011148871\\\"</span>\\n\\n**Note**: Specify the desired translation by including the language code in the query string. \\n\\nFor example: \\n\\\"https://<span>sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=1011148871&language=fr\\\"</span>\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"sepa-direct-debit","type":"basic","title":"sepa-direct-debit"}

Request

Property Name
Type
Required
Description

iban

string

Required
Optional if sending shopper ID

International Bank Account Number (IBAN).

14 - 34 alphanumeric characters

bic

string

Optional

Bank Identifier Code (BIC).

8 - 12 alphanumeric characters.

iban-first-four

string

Required if sending shopper ID and shopper has multiple saved payment methods.

First four characters of IBAN.

iban-last-four

string

Required if sending shopper ID and shopper has multiple saved payment methods.

Last four characters of IBAN.

Response

Property Name
Type
Description

bic

string

Bank Identifier Code (BIC).

8 - 12 Alphanumeric characters.

iban-first-four

string

First four characters of IBAN.

iban-last-four

string

Last four characters of IBAN.

mandate-id

string

ID used to identify the shopper's acceptance of the SEPA Direct Debit mandate.

Returned only in Create Subscription requests.

mandate-date

string

Date (dd-mm-yy) on which the shopper accepted the SEPA Direct Debit mandate.
For example: "21-Jul-17"

pre-notification-text

string

Text for pre-notification email in English.

For example:
"The amount of 100.00 EUR will be collected using SEPA Direct Debit with Mandate BS141928 from your bank account IBAN DE09XXXXXX7891 in the next few days. Please ensure sufficient funds in your account"

Note: To get the text in another language, you may use the Get Pre-Notification Text API.

pre-notification-text-ref

string

Get Pre-Notification Text endpoint with transaction ID in query string.

For example:
"https://sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=1011148871"

Note: Specify the desired translation by including the language code in the query string.

For example:
"https://sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=1011148871&language=fr"