{"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 Local Bank Transfer, refer to the [Local Bank Transfer](https://support.bluesnap.com/docs/local-bank-transfer) guide. If you would like to offer Local Bank Transfer, contact [Merchant Support](https://bluesnap.zendesk.com/hc/en-us/requests/new?ticket_form_id=360000127087) to have it enabled for your account. \n<br />\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Short payments\",\n \"body\": \"If the amount received from the shopper is less than the order total, this is considered a [short payment](https://support.bluesnap.com/docs/local-bank-transfer#short-payments). If a short payment requires your approval, send a [Merchant Approve Transaction](/v8976-JSON/docs/merchant-approval) request with the transaction ID.\"\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 `merchantTransactionId` *string* optional\n\n `softDescriptor` *string* optional\n\n `amount` *decimal* <span style=\"color:#F37500\">**required**</span>\n\n `currency` *string* <span style=\"color:#F37500\">**required**</span>\n\n `vendorsInfo` *object* <span style=\"color:#F37500\">**required** if using marketplace vendor(s)</span> (see [vendorsInfo](doc:vendorsinfo))\n\n `payerInfo` *object* <span style=\"color:#F38A00\">**required** if `vaultedShopperId` is not sent</span> (see [payerInfo](doc:payer-info))\n\n `vaultedShopperId` *integer* <span style=\"color:#F38A00\">**required** if `payerInfo` is not sent</span>\n\n `localBankTransferTransaction` *object* <span style=\"color:#F37500\">**required**</span> (see [localBankTransferTransaction](https://developers.bluesnap.com/v8976-JSON/docs/localbanktransfertransaction))\n\n `transactionMetaData` *object* 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 `vaultedShopperId`\n\n `localBankTransferTransaction` (see [localBankTransferTransaction](https://developers.bluesnap.com/v8976-JSON/docs/localbanktransfertransaction))\n\n `processingInfo` (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\\\": {\\n \\\"metaData\\\": [\\n {\\n \\\"metaValue\\\": \\\"v1\\\",\\n \\\"metaKey\\\": \\\"k1\\\",\\n \\\"metaDescription\\\": \\\"test metadata\\\"\\n }\\n ]\\n }\\n}'\",\n \"language\": \"curl\",\n \"name\": \"with softDescriptor, MTI, and metadata\"\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\\\": 70,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"Jane\\\",\\n \\\"lastName\\\": \\\"Smith\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"localBankTransferTransaction\\\": {},\\n \\\"vendorsInfo\\\": {\\n \\\"vendorInfo\\\": [{ \\\"vendorId\\\": \\\"10398032\\\" }]\\n }\\n}'\",\n \"language\": \"curl\",\n \"name\": \"with vendors info\"\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 \"code\": \"{\\n \\\"vendorsInfo\\\": {\\n \\\"vendorInfo\\\": [\\n {\\n \\\"vendorId\\\": 10398032,\\n \\\"commissionPercent\\\": 90.2\\n }\\n ]\\n },\\n \\\"amount\\\": 70,\\n \\\"currency\\\": \\\"USD\\\",\\n \\\"payerInfo\\\": {\\n \\\"firstName\\\": \\\"Jane\\\",\\n \\\"lastName\\\": \\\"Smith\\\",\\n \\\"country\\\": \\\"us\\\"\\n },\\n \\\"vaultedShopperId\\\": 27670635,\\n \\\"localBankTransferTransaction\\\": {\\n \\\"localBankTransferInfo\\\": {\\n \\\"swiftCode\\\": \\\"RABOUS66XXX\\\",\\n \\\"paymentReference\\\": \\\"410000932239\\\",\\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\\\": 17649597\\n },\\n \\\"processingInfo\\\": {\\n \\\"processingStatus\\\": \\\"PENDING\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"with vendors info\"\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 `orderId` 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":"5ed0377101fdb400214deda5","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":"5ed0377101fdb400214ded10","createdAt":"2020-03-24T21:25:24.892Z","version":"5ed0377101fdb400214dedaa","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.34.0 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ed0377101fdb400214ded00","5ed0377101fdb400214ded01","5ed0377101fdb400214ded02","5ed0377101fdb400214ded03","5ed0377101fdb400214ded04","5ed0377101fdb400214ded05","5ed0377101fdb400214ded06","5ed0377101fdb400214ded07","5ed0377101fdb400214ded08","5ed0377101fdb400214ded09","5ed0377101fdb400214ded0a","5ed0377101fdb400214ded0b","5ed0377101fdb400214ded0c","5ed0377101fdb400214ded0d","5ed0377101fdb400214ded0e","5ed0377101fdb400214ded0f","5ed0377101fdb400214ded10"],"_id":"5ed0377101fdb400214dedaa","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5e5d3aa2dc4d35003d784d9d","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 Local Bank Transfer, refer to the Local Bank Transfer guide. If you would like to offer Local Bank Transfer, contact Merchant Support to have it enabled for your account.
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.
Request Content
Send an altTransaction object, with the following:
merchantTransactionId string optional
softDescriptor string optional
amount decimal required
currency string required
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
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" }]
}
}'{
"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"
}
}{
"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"
}
}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
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": {}
}
