{"_id":"5c6c23e4735b81006177d05a","category":{"_id":"5c6c23e4735b81006177d011","version":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-07T20:09:16.689Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":35,"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 vaulted 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\": \"`ibanFirstFour`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"*Only relevant for Subscriptions*\\n**Required** if sending vaulted shopper ID and shopper has multiple saved payment sources.\",\n    \"2-3\": \"First four characters of IBAN.\",\n    \"3-0\": \"`ibanLastFour`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"*Only relevant for Subscriptions*\\n**Required** if sending vaulted shopper ID and shopper has multiple saved payment sources.\",\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\": \"`ibanFirstFour`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"First four characters of IBAN.\",\n    \"2-0\": \"`ibanLastFour`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Last four characters of IBAN.\",\n    \"3-0\": \"`mandateId`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"ID used to identify the shopper's acceptance of the SEPA Direct Debit mandate.\",\n    \"4-0\": \"`mandateDate`\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"Date (day-month-year) on which the shopper accepted the SEPA Direct Debit mandate.\\nFor example: `\\\"21-Jul-17\\\"`\",\n    \"5-0\": \"`preNotificationText`\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"Text for [pre-notification email]( /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](/v8976-Tools/docs/get-pre-notification-text) API.\",\n    \"6-0\": \"`preNotificationTranslationRef`\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"[Get Pre-Notification Text](/v8976-Tools/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":"Contains bank account details for the SEPA Direct Debit payment method for vaulted shoppers","slug":"sepadirectdebit","type":"basic","title":"sepaDirectDebit"}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

sepaDirectDebit

Contains bank account details for the SEPA Direct Debit payment method for vaulted shoppers

Request

Property Name
Type
Required
Description

iban

string

Required
Optional if sending vaulted shopper ID

International Bank Account Number (IBAN).

14 - 34 alphanumeric characters.

bic

string

Optional

Bank Identifier Code (BIC).

8 - 12 alphanumeric characters.

ibanFirstFour

string

Only relevant for Subscriptions
Required if sending vaulted shopper ID and shopper has multiple saved payment sources.

First four characters of IBAN.

ibanLastFour

string

Only relevant for Subscriptions
Required if sending vaulted shopper ID and shopper has multiple saved payment sources.

Last four characters of IBAN.

Response

Property Name
Type
Description

bic

string

Bank Identifier Code (BIC).

8 - 12 Alphanumeric characters.

ibanFirstFour

string

First four characters of IBAN.

ibanLastFour

string

Last four characters of IBAN.

mandateId

string

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

mandateDate

string

Date (day-month-year) on which the shopper accepted the SEPA Direct Debit mandate.
For example: "21-Jul-17"

preNotificationText

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.

preNotificationTranslationRef

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"