{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/alt-transactions","auth":"optional","results":{"codes":[{"code":"","language":"text"}]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"method":"post","params":[]},"next":{"description":"","pages":[]},"title":"Create LBT Transaction","type":"endpoint","slug":"create-lbt-transaction","excerpt":"","body":"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 how Local Bank Transfers work, refer to the [Local Bank Transfer](https://support.bluesnap.com/docs/local-bank-transfer) guide.\n\n<br>\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Contact [Merchant Support](https://bluesnap.zendesk.com/hc/en-us/requests/new?ticket_form_id=360000127087) to have Local Bank Transfer enabled for your account.\",\n  \"title\": \"Prerequisite: Have Local Bank Transfer enabled for your account\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nSend an **[altTransaction](doc:alt-transaction)** object, with the following:\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`merchantTransactionId` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`softDescriptor` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`amount` &nbsp;&nbsp;&nbsp; *decimal* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`currency` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`payerInfo` &nbsp;&nbsp;&nbsp; *object* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required** if `vaultedShopperId` is not sent</span> (see [payerInfo](doc:payer-info))\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vaultedShopperId` &nbsp;&nbsp;&nbsp; *integer* &nbsp;&nbsp;&nbsp;<span style=\"color:#F38A00\">**required** if `payerInfo` is not sent</span>\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`localBankTransferTransaction` &nbsp;&nbsp;&nbsp; *object* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span> (see [localBankTransferTransaction](https://developers.bluesnap.com/v8976-JSON/docs/localbanktransfertransaction))\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transactionMetaData` &nbsp;&nbsp;&nbsp; *object* &nbsp;&nbsp;&nbsp;optional (see [transactionMetaData](doc:transaction-meta-data))\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the request properties plus these additions:\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vaultedShopperId`\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`localBankTransferTransaction` &nbsp;&nbsp;&nbsp; (see [localBankTransferTransaction](https://developers.bluesnap.com/v8976-JSON/docs/localbanktransfertransaction))\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`processingInfo`&nbsp;&nbsp;&nbsp;(see [processingInfo](doc:processing-info))\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"amount\\\": 70,\\n      \\\"payerInfo\\\": {\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n              \\\"country\\\": \\\"us\\\"\\n    },\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"localBankTransferTransaction\\\": {}\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Basic request\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"amount\\\": 42,\\n      \\\"payerInfo\\\": {\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n              \\\"country\\\": \\\"us\\\"\\n    },\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"localBankTransferTransaction\\\": {},\\n      \\\"softDescriptor\\\": \\\"ABCD COMPANY\\\",\\n      \\\"merchantTransactionId\\\": \\\"pk-lbt-020320-1\\\",\\n        \\\"transactionMetaData\\\": {\\\"metaData\\\": [\\n       {\\n            \\\"metaValue\\\": \\\"v1\\\",\\n            \\\"metaKey\\\": \\\"k1\\\",\\n            \\\"metaDescription\\\": \\\"test metadata\\\"\\n        }\\n    ]}\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with softDescriptor, MTI, and metadata\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"amount\\\": 70,\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"payerInfo\\\": {\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n        \\\"country\\\": \\\"us\\\"\\n    },\\n    \\\"vaultedShopperId\\\": 19582494,\\n    \\\"localBankTransferTransaction\\\": {\\n        \\\"localBankTransferInfo\\\": {\\n            \\\"swiftCode\\\": \\\"RABOUS66XXX\\\",\\n            \\\"paymentReference\\\": \\\"410000782129\\\",\\n            \\\"accountHolder\\\": \\\"Global Collect BV\\\",\\n            \\\"bankCode\\\": \\\"ABA|122238420||Address|WESTLAKE VILLAGE, 2663 TOWNSGATE RD\\\",\\n            \\\"bankName\\\": \\\"Rabobank N.A.\\\",\\n            \\\"countryDescription\\\": \\\"United States\\\",\\n            \\\"bankCity\\\": \\\"Ontario USA\\\",\\n            \\\"bankAccountNumber\\\": \\\"0487369908\\\"\\n        },\\n        \\\"orderId\\\": 4000835\\n    },\\n    \\\"processingInfo\\\": {\\n        \\\"processingStatus\\\": \\\"PENDING\\\"\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Basic response:  200 OK\"\n    },\n    {\n      \"code\": \"{\\n    \\\"merchantTransactionId\\\": \\\"pk-lbt-020320-1\\\",\\n    \\\"softDescriptor\\\": \\\"ABCD COMPANY\\\",\\n    \\\"amount\\\": 42,\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"payerInfo\\\": {\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n        \\\"country\\\": \\\"us\\\"\\n    },\\n    \\\"vaultedShopperId\\\": 19582592,\\n    \\\"transactionMetaData\\\": {\\n        \\\"metaData\\\": [\\n            {\\n                \\\"metaKey\\\": \\\"k1\\\",\\n                \\\"metaValue\\\": \\\"v1\\\",\\n                \\\"metaDescription\\\": \\\"test metadata\\\"\\n            }\\n        ]\\n    },\\n    \\\"localBankTransferTransaction\\\": {\\n        \\\"localBankTransferInfo\\\": {\\n            \\\"swiftCode\\\": \\\"RABOUS66XXX\\\",\\n            \\\"paymentReference\\\": \\\"410000784219\\\",\\n            \\\"accountHolder\\\": \\\"Global Collect BV\\\",\\n            \\\"bankCode\\\": \\\"ABA|122238420||Address|WESTLAKE VILLAGE, 2663 TOWNSGATE RD\\\",\\n            \\\"bankName\\\": \\\"Rabobank N.A.\\\",\\n            \\\"countryDescription\\\": \\\"United States\\\",\\n            \\\"bankCity\\\": \\\"Ontario USA\\\",\\n            \\\"bankAccountNumber\\\": \\\"0487369908\\\"\\n        },\\n        \\\"orderId\\\": 4000989\\n    },\\n    \\\"processingInfo\\\": {\\n        \\\"processingStatus\\\": \\\"PENDING\\\"\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"with softDescriptor, MTI, and metadata\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Order ID and status\",\n  \"body\": \"Until the shopper completes the order, the processing status stays as `PENDING` and there is no transaction ID.  You must use the `order-id` for the transaction.\"\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, enter the request content below and then click **Try it!**\n\n**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.*\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"amount\\\": 70,\\n      \\\"payerInfo\\\": {\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n              \\\"country\\\": \\\"us\\\"\\n    },\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"localBankTransferTransaction\\\": {}\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e7a7b64817456006a394882","createdAt":"2020-03-24T21:28:04.534Z","user":"5beb1b96bc2003003ecd645e","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Local Bank Transfer transactions","slug":"local-bank-transfer-transactions","order":5,"from_sync":false,"reference":false,"_id":"5e7a7ac40efab8003ae688c3","createdAt":"2020-03-24T21:25:24.892Z","version":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"Live","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e5d3aa2dc4d35003d784cf0","5e5d3aa2dc4d35003d784cf1","5e5d3aa2dc4d35003d784cf2","5e5d3aa2dc4d35003d784cf3","5e5d3aa2dc4d35003d784cf4","5e5d3aa2dc4d35003d784cf5","5e5d3aa2dc4d35003d784cf6","5e5d3aa2dc4d35003d784cf7","5e5d3aa2dc4d35003d784cf8","5e5d3aa2dc4d35003d784cf9","5e5d3aa2dc4d35003d784cfa","5e5d3aa2dc4d35003d784cfb","5e5d3aa2dc4d35003d784cfc","5e5d3aa2dc4d35003d784cfd","5e5d3aa2dc4d35003d784cfe","5e5d57ed1362cf0064910881","5e7a7ac40efab8003ae688c3"],"_id":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","__v":2,"forked_from":"5c6c23e4735b81006177d0a4","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

postCreate LBT Transaction


Definition

{{ api_url }}{{ page_api_url }}

Documentation

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 how Local Bank Transfers work, refer to the Local Bank Transfer guide.


Prerequisite: Have Local Bank Transfer enabled for your account

Contact Merchant Support to have Local Bank Transfer enabled for your account.

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

      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

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

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

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 order-id 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.

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

User Information

Try It Out


post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}