Create LBT Transaction

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

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.

Try it in the API Explorer

Request Content

Send an altTransaction object, with the following:

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

Response Details

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

      vaultedShopperId
     localBankTransferTransaction     (see localBankTransferTransaction)
     processingInfo   (see processingInfo)

---

Examples

Request Examples

Basic request

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": {}
}'

with softDescriptor, MTI, and 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": 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"
      }
    ]
  }
}'

with vendors info

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" }]
  }
}'

with tax quote

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

Basic response: 200 OK

{
    "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"
    }
}

with softDescriptor, MTI, and metadata

{
    "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"
    }
}

with vendors info

{
  "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"
  }
}

with tax quote

{
    "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.

Back to Top

---

API Explorer

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

Tip: Use the JSON 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.

JSON

{
  "amount": 70,
  "payerInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "country": "us"
  },
  "currency": "USD",
  "localBankTransferTransaction": {}
}