Create Pay by Bank Transaction

🚧

Beta Feature

Pay by Bank is currently in beta and not suitable for production environments.

The Create Pay by Bank Transaction request performs a transaction using the Pay by Ban payment method. For implementation details, see Pay by Bank (Open Banking).

Request Content

❗️

Important

The API Explorer Try It! feature does not currently send XML requests to our sandbox environment.

For request and response examples, refer to the Examples section.

Send an alt-transaction object. The type of shopper determines the content required in the request body:

The following table describes required and optional body parameters:

PropertyTypeRequired
amountdecimalrequired
authorized-by-shopperbooleanrequired, must be set to true
currencystringrequired
merchant-transaction-idstringoptional
pay-by-bank-transactionobjectrequired. See pay-by-bank-transaction.
payer-infoobjectrequired for a new shopper. See payer-info.
vaulted-shopper-idobjectrequired for a returning shopper. See vaulted-shopper.

Response

Successful requests return the HTTP response status code 200 OK and a response body that contains the following properties:

PropertyNotes
amountValue of the transaction in the provided currency.
currencyCurrency used to process the transaction.
merchant-transaction-idMerchant-provided unique identifier for the transaction.
pay-by-bank-transactionSee pay-by-bank-transaction.
payer-infoReturned when vaultedShopperId is not sent in the request. See payer-info.
processing-infoStatus of the transaction. See processing-info.
product-descriptionDetails about the product purchased in the transaction.
transaction-idUnique identifier for the transaction.
vaulted-shopper-idUnique identifier for the vaulted shopper.

Examples

Request Examples

curl -X POST 'https://sandbox.bluesnap.com/services/2/alt-transactions' \
     --header "Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==" \
     --header 'accept: application/xml' \
     --header 'content-type: application/xml' \
     --data '
     <alt-transaction xmlns="http://ws.plimus.com">
         <pay-by-bank-transaction>
             <return-url>https://returnURL/r?good=true</return-url>
             <cancel-url>https://cancelURL/r?bad=true</cancel-url>
             <iban>DE12345678909876543210</iban>
         </pay-by-bank-transaction>
         <amount>515</amount>
         <merchant-transaction-id>unique_test_id</merchant-transaction-id>
         <payer-info>
             <zip>12345</zip>
             <first-name>Jane</first-name>
             <last-name>Shopper</last-name>
             <country>de</country>
         </payer-info>
         <currency>EUR</currency>
         <authorized-by-shopper>true</authorized-by-shopper>
     </alt-transaction>'
curl -v POST 'https://sandbox.bluesnap.com/services/2/alt-transactions' \
     --header 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
     --header 'accept: application/xml' \
     --header 'content-type: application/xml' \
     --data '
    <alt-transaction xmlns="http://ws.plimus.com">   
      <pay-by-bank-transaction>
        <return-url>http://www.returnURL.com</return-url>
        <cancel-url>http://www.cancelURL.com</cancel-url>
      </pay-by-bank-transaction>
      <vaulted-shopper-id>51669859</vaulted-shopper-id>
      <amount>100.00</amount>
      <currency>EUR</currency>
    </alt-transaction>'

Response Examples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <merchant-transaction-id>unique_test_id</merchant-transaction-id>
    <transaction-id>1108066925</transaction-id>
    <amount>515</amount>
    <currency>EUR</currency>
    <payer-info>
        <first-name>Jane</first-name>
        <last-name>Shopper</last-name>
        <country>de</country>
        <zip>12345</zip>
    </payer-info>
    <vaulted-shopper-id>51668815</vaulted-shopper-id>
    <pay-by-bank-transaction>
        <pay-by-bank-url>https&#x3a;&#x2f;&#x2f;sandbox.bluesnap.com&#x2f;services&#x2f;fel&#x2f;pbb&#x2f;hostedpage&#x3f;hpid&#x3d;aHBpZDoxMTA4MDY2OTI1OjUxNTAw&#x26;invid&#x3d;1108066925</pay-by-bank-url>
        <iban-first-four>DE12</iban-first-four>
        <iban-last-four>3210</iban-last-four>
    </pay-by-bank-transaction>
    <product-description>N&#x2f;A</product-description>
    <processing-info>
        <processing-status>PENDING</processing-status>
        <transaction-region>UK</transaction-region>
    </processing-info>
</alt-transaction>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alt-transaction xmlns="http://ws.plimus.com">
    <transaction-id>1108070531</transaction-id>
    <amount>100.00</amount>
    <currency>EUR</currency>
    <vaulted-shopper-id>51669859</vaulted-shopper-id>
    <pay-by-bank-transaction>
        <pay-by-bank-url>https&#x3a;&#x2f;&#x2f;sandbox.bluesnap.com&#x2f;services&#x2f;fel&#x2f;pbb&#x2f;hostedpage&#x3f;hpid&#x3d;aHBpZDoxMTA4MDcwNTMxOjEwMDAw&#x26;invid&#x3d;1108070531</pay-by-bank-url>
        <iban-first-four>DE12</iban-first-four>
        <iban-last-four>3210</iban-last-four>
    </pay-by-bank-transaction>
    <product-description>N&#x2f;A</product-description>
    <processing-info>
        <processing-status>PENDING</processing-status>
        <transaction-region>UK</transaction-region>
    </processing-info>
</alt-transaction>

API Explorer

BlueSnap provides a sandbox environment so you can test basic requests with this endpoint. You can view the request in the API Explorer console and its response directly below the console.

The console includes a sample request with predefined parameter values. To send a request with custom values, edit the parameter fields below. As you edit the fields, your custom values display in the request in the console.

Click the Try it! button below the request example when you are ready to send your request.

Language
Authorization
Header
Click Try It! to start a request and see the response here!