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 Bank payment method. For implementation details, see Pay by Bank (Open Banking).
Request Content
Send a test request
Go to API Explorer to send a test request to our sandbox environment and receive a response in real time.
Send an altTransaction object. The type of shopper determines the content required in the request body:
- New shopper — include a payerInfo object.
- Returning shopper — include the
vaultedShopperIdto identify the shopper and their payment information.
The following table describes required and optional body parameters:
| Property | Type | Required |
|---|---|---|
amount | decimal | required |
currency | string | required |
merchantTransactionId | string | optional |
payByBankTransaction | object | required. See payByBankTranscation. |
payerInfo | object | required for a new shopper. See payerInfo. |
productDescription | string | optional |
softDescriptor | string | optional |
transactionMetaData | object | optional (see transactionMetaData) |
vaultedShopperId | integer | required for a returning shopper. See vaultedShopper. |
vendorsInfo | object | required if using marketplace vendors (see vendorsInfo) |
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. |
merchantTransactionId | Merchant-provided unique identifier for the transaction. |
payByBankTransaction | See payByBankTranscation. |
payerInfo | Returned when vaultedShopperId is not sent in the request. See payerInfo. |
processingInfo | Status of the transaction. See processingInfo. |
productDescription | Details about the product purchased in the transaction. |
transactionId | Unique identifier for the transaction. |
vaultedShopperId | Unique identifier for the vaulted shopper. |
Examples
Request Examples
curl --request POST \
--url https://sandbox.bluesnap.com/services/2/alt-transactions \
--header 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
--header 'accept: application/json' \
--header 'bluesnap-version: 3.0' \
--header 'content-type: application/json' \
--data '
{
"payByBankTransaction": {
"returnUrl": "https://path/to/success-page?success=true",
"cancelUrl": "https://path/to/failure-page?failure=true",
"iban": "DE12345678901234567890"
},
"amount": 100,
"payerInfo": {
"zip": "12345",
"firstName": "Jane",
"lastName": "Doe",
"country": "de"
},
"currency": "EUR"
}'
curl --request POST \
--url https://sandbox.bluesnap.com/services/2/alt-transactions \
--header 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
--header 'accept: application/json' \
--header 'bluesnap-version: 3.0' \
--header 'content-type: application/json' \
--data '
{
"payByBankTransaction": {
"returnUrl": "https://returnURL?success=true",
"cancelUrl": "https://cancelURL?failure=true"
},
"vaultedShopperId": 87654321,
"amount": 100,
"currency": "EUR"
}'
Response Examples
{
"transactionId": "12345678",
"amount": 100,
"currency": "EUR",
"payerInfo": {
"firstName": "Jane",
"lastName": "Doe",
"country": "de",
"zip": "12345"
},
"vaultedShopperId": 87654321,
"payByBankTransaction": {
"payByBankUrl": "https://<hostname>:8444/services/fel/pbb/hostedpage?hpid=<hosted-page-id>==&invid=<invid-id>",
"ibanFirstFour": "DE12",
"ibanLastFour": "7890"
},
"productDescription": "N/A",
"processingInfo": {
"processingStatus": "PENDING"
}
}
{
"transactionId": "12345678",
"amount": 100,
"currency": "EUR",
"vaultedShopperId": 87654321,
"payByBankTransaction": {
"payByBankUrl": "https://<hostname>:8444/services/fel/pbb/hostedpage?hpid=<hosted-page-id>==&invid=<invid-id>",
"ibanFirstFour": "DE12",
"ibanLastFour": "7890"
},
"productDescription": "N/A",
"processingInfo": {
"processingStatus": "PENDING"
}
}
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.