The Create Local Bank Transfer (LBT) Transaction request obtains account details for a transaction. The shopper must complete the transaction. Their account is not immediately debited. For more information on Local Bank Transfer, refer to the Local Bank Transfer guide.

📘
Short payments
If the amount received from the shopper is less than the order total, this is considered a short payment. If a short payment requires your approval, send a Merchant Approve Transaction request with the transaction ID.

📘
Send a test request
Go to API Explorer to send a test request to our sandbox environment and receive a response in real time.

Request Content

Send an altTransaction object, with the following:

Property	Type	Required
`amount`	decimal	required
`currency`	string	required
`localBankTransferTransaction`	object	required (see localBankTransferTransaction)
`merchantTransactionId`	string	optional
`payerInfo`	object	required if `vaultedShopperId` is not sent (see payerInfo)
`productDescription`	string	optional
`softDescriptor`	string	optional
`taxReference`	string	optional
`transactionMetaData`	object	optional (see transactionMetaData)
`vaultedShopperId`	integer	required if `payerInfo` is not sent
`vendorsInfo`	object	required if using marketplace vendor(s) (see vendorsInfo)

Response Details

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

Property	Notes
`localBankTransferTransaction`	(see localBankTransferTransaction)
`processingInfo`	(see processingInfo)
`vaultedShopperId`

Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "amount": 70,
  "payerInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "country": "us"
  },
  "currency": "USD",
  "localBankTransferTransaction": {}
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "amount": 42,
  "payerInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "country": "us"
  },
  "currency": "USD",
  "localBankTransferTransaction": {},
  "softDescriptor": "ABCD COMPANY",
  "merchantTransactionId": "pk-lbt-020320-1",
  "transactionMetaData": {
    "metaData": [
      {
        "metaValue": "v1",
        "metaKey": "k1",
        "metaDescription": "test metadata"
      }
    ]
  }
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "amount": 70,
  "currency": "USD",
  "payerInfo": {
    "firstName": "Jane",
    "lastName": "Smith",
    "country": "us"
  },
  "localBankTransferTransaction": {},
  "vendorsInfo": {
    "vendorInfo": [{ "vendorId": "10398032" }]
  }
}'

curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "amount": 75.60,
  "payerInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "country": "us"
  },
  "currency": "USD",
  "taxReference": "048deff0-a285-47e1-bc39-42f79bf0095b",
  "localBankTransferTransaction": {}
}'

Response Examples

{
    "amount": 70,
    "currency": "USD",
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "country": "us"
    },
    "vaultedShopperId": 19582494,
    "localBankTransferTransaction": {
        "localBankTransferInfo": {
            "swiftCode": "RABOUS66XXX",
            "paymentReference": "410000782129",
            "accountHolder": "Global Collect BV",
            "bankCode": "ABA|122238420||Address|WESTLAKE VILLAGE, 2663 TOWNSGATE RD",
            "bankName": "Rabobank N.A.",
            "countryDescription": "United States",
            "bankCity": "Ontario USA",
            "bankAccountNumber": "0487369908"
        },
        "orderId": 4000835
    },
    "processingInfo": {
        "processingStatus": "PENDING",
        "transactionRegion": "US"
    }
}

{
    "merchantTransactionId": "pk-lbt-020320-1",
    "softDescriptor": "ABCD COMPANY",
    "amount": 42,
    "currency": "USD",
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "country": "us"
    },
    "vaultedShopperId": 19582592,
    "transactionMetaData": {
        "metaData": [
            {
                "metaKey": "k1",
                "metaValue": "v1",
                "metaDescription": "test metadata"
            }
        ]
    },
    "localBankTransferTransaction": {
        "localBankTransferInfo": {
            "swiftCode": "RABOUS66XXX",
            "paymentReference": "410000784219",
            "accountHolder": "Global Collect BV",
            "bankCode": "ABA|122238420||Address|WESTLAKE VILLAGE, 2663 TOWNSGATE RD",
            "bankName": "Rabobank N.A.",
            "countryDescription": "United States",
            "bankCity": "Ontario USA",
            "bankAccountNumber": "0487369908"
        },
        "orderId": 4000989
    },
    "processingInfo": {
        "processingStatus": "PENDING"
    }
}

{
  "vendorsInfo": {
    "vendorInfo": [
      {
        "vendorId": 10398032,
        "commissionPercent": 90.2
      }
    ]
  },
  "amount": 70,
  "currency": "USD",
  "payerInfo": {
    "firstName": "Jane",
    "lastName": "Smith",
    "country": "us"
  },
  "vaultedShopperId": 27670635,
  "localBankTransferTransaction": {
    "localBankTransferInfo": {
      "swiftCode": "RABOUS66XXX",
      "paymentReference": "410000932239",
      "accountHolder": "Global Collect BV",
      "bankCode": "ABA|122238420||Address|WESTLAKE VILLAGE, 2663 TOWNSGATE RD",
      "bankName": "Rabobank N.A.",
      "countryDescription": "United States",
      "bankCity": "Ontario USA",
      "bankAccountNumber": "0487369908"
    },
    "orderId": 17649597
  },
  "processingInfo": {
    "processingStatus": "PENDING"
  }
}

{
    "amount": 75.60,
    "currency": "USD",
    "taxReference": "048deff0-a285-47e1-bc39-42f79bf0095b",
    "payerInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "country": "us"
    },
    "vaultedShopperId": 19582494,
    "localBankTransferTransaction": {
        "localBankTransferInfo": {
            "swiftCode": "RABOUS66XXX",
            "paymentReference": "410000782129",
            "accountHolder": "Global Collect BV",
            "bankCode": "ABA|122238420||Address|WESTLAKE VILLAGE, 2663 TOWNSGATE RD",
            "bankName": "Rabobank N.A.",
            "countryDescription": "United States",
            "bankCity": "Ontario USA",
            "bankAccountNumber": "0487369908"
        },
        "orderId": 4000835
    },
    "processingInfo": {
        "processingStatus": "PENDING"
    }
}

📘
Order ID and status
Until the shopper completes the order, the processing status stays as PENDING and there is no transaction ID. You must use the orderId for the 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.

Create LBT Transaction

📘
Short payments

📘
Send a test request

Request Content

Response Details

Examples

Request Examples

Response Examples

📘
Order ID and status

API Explorer

📘Short payments

📘Send a test request

Request Content

Response Details

Examples

Request Examples

Response Examples

📘Order ID and status

API Explorer

📘
Short payments

📘
Send a test request

📘
Order ID and status