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

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

New shopper — include a payer-info object.
Returning shopper — include the vaultedShopperId to identify the shopper and their payment information.

The following table describes required and optional body parameters:

Property	Type	Required
`amount`	decimal	required
`authorized-by-shopper`	boolean	required, must be set to `true`
`currency`	string	required
`merchant-transaction-id`	string	optional
`pay-by-bank-transaction`	object	required. See pay-by-bank-transaction.
`payer-info`	object	required for a new shopper. See payer-info.
`product-description`	string	optional
`soft-descriptor`	string	optional
`transaction-meta-data`	object	optional (see transaction-meta-data)
`vaulted-shopper-id`	object	required for a returning shopper. See vaulted-shopper.
`vendors-info`	object	required if using marketplace vendors (see vendors-info)

Response

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

Property	Notes
`amount`	Value of the transaction in the provided currency.
`currency`	Currency used to process the transaction.
`merchant-transaction-id`	Merchant-provided unique identifier for the transaction.
`pay-by-bank-transaction`	See pay-by-bank-transaction.
`payer-info`	Returned when `vaultedShopperId` is not sent in the request. See payer-info.
`processing-info`	Status of the transaction. See processing-info.
`product-description`	Details about the product purchased in the transaction.
`transaction-id`	Unique identifier for the transaction.
`vaulted-shopper-id`	Unique 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>

🚧Beta Feature

Request Content

Response

Examples

Request Examples

Response Examples

🚧
Beta Feature