BlueSnap.comAPI BasicsPayment APIEmbedded PaymentsReporting & ToolsSupport GuidesTest
API Reference

Create SEPA DD Transaction

post https://sandbox.bluesnap.com/services/2/alt-transactions

The Create SEPA DD Transaction request performs a transaction (purchase) using the SEPA Direct Debit payment method. Note that the shopper's account is not immediately debited - it takes about 5 to 6 business days for the shopper's bank to approve the charge and for their account to be debited.

For more information, see the SEPA Direct Debit guide.


👍

Prerequisite: Have SEPA enabled for your account

Contact Merchant Support to have SEPA Direct Debit enabled for your account.

Try it in the API Explorer

Request Content

Send an alt-transaction container, with the following:

      merchant-transaction-id     string    optional
     soft-descriptor     string    optional
     amount     decimal    required
     currency     string    required   value must be EUR
     tax-reference string    optional
     country     string    optional
     vendors-info container    required if using marketplace vendor(s) (see vendors-info)
     payer-info     container    required if vaulted-shopper-id is not sent (see payer-info)
     vaulted-shopper-id     integer    required if payer-info is not sent
     sepa-direct-debit-transaction     container    required (see sepa-direct-debit-transaction)
     authorized-by-shopper     boolean    required   value must be true
     transaction-meta-data     container    optional (see transaction-meta-data)
     transaction-fraud-info     container    optional (see transaction-fraud-info)

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the request properties plus these additions:

      transaction-id
     vaulted-shopper-id
     processing-info   (see processing-info)
     fraud-result-info   (see fraud-result-info)
     vendors-info   (see vendors-info)

Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
  <sepa-direct-debit-transaction>
    <iban>DE09100100101234567893</iban>
  </sepa-direct-debit-transaction>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
  </payer-info>
  <amount>9.65</amount>
  <currency>EUR</currency>
  <country>FR</country>
  <soft-descriptor>ABC COMPANY</soft-descriptor>
  <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
  <sepa-direct-debit-transaction/>
  <vaulted-shopper-id>21786355</vaulted-shopper-id>
   <amount>100.00</amount>
   <currency>EUR</currency>
   <country>FR</country>
   <soft-descriptor>ABC COMPANY</soft-descriptor>
   <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
  <sepa-direct-debit-transaction>
    <iban-first-four>DE09</iban-first-four>
    <iban-last-four>7893</iban-last-four>
  </sepa-direct-debit-transaction>
  <vaulted-shopper-id>19557478</vaulted-shopper-id>
  <amount>100.00</amount>
  <currency>EUR</currency>
  <country>FR</country>
  <soft-descriptor>ABC COMPANY</soft-descriptor>
  <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
  <sepa-direct-debit-transaction>
    <iban>DE09100100101234567893</iban>
  </sepa-direct-debit-transaction>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
  </payer-info>
  <amount>12.65</amount>
  <currency>EUR</currency>
  <tax-reference>048deff0-a285-47e1-bc39-42f79bf0095b</tax-reference>
  <country>FR</country>
  <soft-descriptor>ABC COMPANY</soft-descriptor>
  <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>'

Response Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>1011189089</transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>9.65</amount>
    <currency>EUR</currency>
    <payer-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
    </payer-info>
    <vaulted-shopper-id>21781957</vaulted-shopper-id>
    <sepa-direct-debit-transaction>
        <iban-first-four>DE09</iban-first-four>
        <iban-last-four>7893</iban-last-four>
        <mandate-id>Ooo153451</mandate-id>
        <mandate-date>01-Aug-17</mandate-date>
        <pre-notification-text>The amount of 9.65 EUR will be collected using SEPA Direct Debit with Mandate Ooo153451 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account.</pre-notification-text>
        <pre-notification-translation-ref>https://sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=1011189089</pre-notification-translation-ref>
    </sepa-direct-debit-transaction>
    <processing-info>
        <processing-status>PENDING</processing-status>
    </processing-info>
</alt-transaction>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>38490478</transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>100.00</amount>
    <currency>EUR</currency>
    <vaulted-shopper-id>21786355</vaulted-shopper-id>
    <sepa-direct-debit-transaction>
        <iban-first-four>DE09</iban-first-four>
        <iban-last-four>7893</iban-last-four>
        <mandate-id>BS141932</mandate-id>
        <mandate-date>29-Jun-17</mandate-date>
        <pre-notification-text>The amount of 100.00 EUR will be collected using SEPA Direct Debit with Mandate BS141932 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account.</pre-notification-text>
        <pre-notification-translation-ref>https://sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=38490478</pre-notification-translation-ref>
    </sepa-direct-debit-transaction>
    <processing-info>
        <processing-status>PENDING</processing-status>
    </processing-info>
</alt-transaction>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>38490482</transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>100.00</amount>
    <currency>EUR</currency>
    <vaulted-shopper-id>19557478</vaulted-shopper-id>
    <sepa-direct-debit-transaction>
        <iban-first-four>DE09</iban-first-four>
        <iban-last-four>7893</iban-last-four>
        <mandate-id>BS141936</mandate-id>
        <mandate-date>29-Jun-17</mandate-date>
        <pre-notification-text>The amount of 100.00 EUR will be collected using SEPA Direct Debit with Mandate BS141936 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account.</pre-notification-text>
        <pre-notification-translation-ref>https://sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=38490482</pre-notification-translation-ref>
    </sepa-direct-debit-transaction>
    <processing-info>
        <processing-status>PENDING</processing-status>
    </processing-info>
</alt-transaction>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>1011189089</transaction-id>
    <soft-descriptor>ABC COMPANY</soft-descriptor>
    <amount>12.65</amount>
    <currency>EUR</currency>
   <tax-reference>048deff0-a285-47e1-bc39-42f79bf0095b</tax-reference>
    <payer-info>
        <first-name>John</first-name>
        <last-name>Doe</last-name>
    </payer-info>
    <vaulted-shopper-id>21781957</vaulted-shopper-id>
    <sepa-direct-debit-transaction>
        <iban-first-four>DE09</iban-first-four>
        <iban-last-four>7893</iban-last-four>
        <mandate-id>Ooo153451</mandate-id>
        <mandate-date>01-Aug-17</mandate-date>
        <pre-notification-text>The amount of 9.65 EUR will be collected using SEPA Direct Debit with Mandate Ooo153451 from your bank account IBAN DE09XXXXXX7893 in the next few days. Please ensure sufficient funds in your account.</pre-notification-text>
        <pre-notification-translation-ref>https://sandbox.bluesnap.com/services/2/translations/sepa/prenotification?transactionid=1011189089</pre-notification-translation-ref>
    </sepa-direct-debit-transaction>
    <processing-info>
        <processing-status>PENDING</processing-status>
    </processing-info>
</alt-transaction>

Back to Top

Example Descriptions

For details about the above examples, see:

Create basic SEPA DD Transaction with payer info

This example shows a basic Create SEPA DD Transaction request with a new shopper. For all SEPA DD transactions, you must collect a mandate acceptance from the shopper, authorizing
the funds to be pulled from their account. Include the authorized-by-shopper property with the value set to true to indicate that you have obtained the shopper's permission.

A successful response from BlueSnap will include a mandate-id and mandate-date, whose values identify the shopper's mandate acceptance and the date on which the mandate was accepted, respectively. These two values must be displayed on the post-checkout page, the pre-notification email, and the receipt email.

Additionally, the response will contain pre-notification-text - the standard text (in English) that you must display in the pre-notification email - and pre-notification-translation-ref - Get Pre-Notification Text endpoint to obtain text in another language.

Create SEPA DD Transaction with vaulted shopper with one saved account

To perform a Create SEPA DD Transaction with an existing vaulted shopper with one saved bank account, you'll include the vaulted-shopper-id property within the alt-transaction object in your request. The sepa-direct-debit-transaction property can be left empty, as shown in the example.

Create SEPA DD Transaction with vaulted shopper with multiple saved accounts

To perform a Create SEPA DD Transaction request with an existing vaulted shopper with multiple saved bank accounts, you'll include the vaulted-shopper-id property within the alt-transaction object in your request. Additionally, you'll specify the shopper's bank account by including iban-first-four and iban-last-four within the seba-direct-debit-transaction property.

The above example includes an existing vaulted shopper with ID 19557478, and their bank account is specified by the first four characters (DE09) and last four characters (7893) of the IBAN.


Back to Top

API Explorer

To test out a call, enter the request content below and then click Try it!

Tip: Use the code below as a starting point. You can enter different parameters to see how your test scenario would work. The request headers, including authorization, are already built in for you in this test area, so you should not include them here.

<alt-transaction xmlns="http://ws.plimus.com">
  <sepa-direct-debit-transaction>
    <iban>DE09100100101234567893</iban>
  </sepa-direct-debit-transaction>
  <payer-info>
    <first-name>John</first-name>
    <last-name>Doe</last-name>
  </payer-info>
  <amount>9.65</amount>
  <currency>EUR</currency>
  <soft-descriptor>ABC COMPANY</soft-descriptor>
  <authorized-by-shopper>true</authorized-by-shopper>
</alt-transaction>
Language
Credentials
:
Click Try It! to start a request and see the response here!