post https://sandbox.bluesnap.com/services/2/alt-transactions
Please reach out to BlueSnap Merchant Support to enable this payment method.
The Create BECS Direct Debit Transaction request performs a transaction (purchase) using the BECS Direct Debit payment method. For more information about this payment method, see the BECS Direct Debit guide.
Prerequisite: Enable the BECS Direct Debit payment method in your account
In the Merchant Portal, go to Checkout Page > Payment Methods and select Show in the menu next to the BECS Direct Debit payment method. Click Submit to save your changes.
Request Content
Send an altTransaction object with the following:
| Property | Type | Required |
|---|---|---|
amount | decimal | required |
authorizedByShopper | boolean | required, value must be true |
becsDirectDebitTransaction | object | required (see becsDirectDebitTransaction) |
currency | string | required |
merchantTransactionId | string | optional |
payerInfo | object | required if vaultedShopperId is not sent (see payerInfo) |
pfToken | string | optional |
productDescription | string | optional |
softDescriptor | string | optional |
taxReference | string | optional |
transactionFraudInfo | object | optional (see transactionFraudInfo) |
transactionMetaData | object | optional (see transactionMetaData) |
vaultedShopperId | integer | required if payerInfo is not sent |
vendorsInfo | object | optional (see vendorsInfo) |
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the request properties plus these additions:
fraudResultInfo | see fraudResultInfo |
processingInfo | see processingInfo |
transactionId | |
vaultedShopperId |
Examples
Request Examples
Note
The
agreementIdin the examples below should be replaced with theagreementIdyou obtain through the Create Debit Agreement mandate API 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 '
{
"becsDirectDebitTransaction": {
"bsbNumber": "980201",
"accountNumber": "9990000001",
"accountName": "Boris Britva",
"financialInstitution": "financialInstitution",
"branchName": "branchName",
"agreementId": 81
},
"amount": 77,
"payerInfo": {
"zip": "12345",
"firstName": "Boris",
"lastName": "Britva",
"country": "au"
},
"currency": "AUD",
"authorizedByShopper": true
}
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 '
{
"becsDirectDebitTransaction": {},
"amount": 11,
"currency": "AUD",
"vaultedShopperId":19610968,
"authorizedByShopper": true
}
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 '
{
"becsDirectDebitTransaction": {
"bsbNumber": "980201",
"publicAccountNumber": "5557",
"agreementId": 81
},
"amount": 11,
"currency": "AUD",
"vaultedShopperId":19602910,
"authorizedByShopper": true
}
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 '
{
"transactionOrderSource": "MOTO",
"becsDirectDebitTransaction": {
"bsbNumber": "980201",
"accountNumber": "9990000001",
"accountName": "Boris Britva",
"financialInstitution": "financialInstitution",
"branchName": "branchName",
"agreementId": 81
},
"amount": 77,
"payerInfo": {
"zip": "12345",
"firstName": "Boris",
"lastName": "Britva",
"country": "au"
},
"currency": "AUD",
"authorizedByShopper": true
}
Response Examples
{
"transactionId": "38701844",
"amount": 77,
"currency": "AUD",
"payerInfo": {
"firstName": "Boris",
"lastName": "Britva",
"country": "au",
"zip": "12345"
},
"vaultedShopperId": 19610968,
"becsDirectDebitTransaction": {
"bsbNumber": "980201",
"accountName": "Boris Britva",
"financialInstitution": "financialInstitution",
"branchName": "branchName",
"publicAccountNumber": "0002",
"agreementId": 81,
"preNotificationRef": "https://localhost:8444/services/2/agreements/prenotification/38701844"
},
"processingInfo": {
"processingStatus": "PENDING",
"transactionRegion": "AU"
}
}
{
"transactionId": "38702772",
"amount": 11,
"currency": "AUD",
"vaultedShopperId": 19610968,
"becsDirectDebitTransaction": {
"bsbNumber": "980201",
"accountName": "Boris Britva",
"financialInstitution": "financialInstitution",
"branchName": "branchName",
"publicAccountNumber": "0002",
"agreementId": 81,
"preNotificationRef": "https://localhost:8444/services/2/agreements/prenotification/38702772"
},
"processingInfo": {
"processingStatus": "PENDING"
}
}
{
"transactionId": "38702776",
"amount": 11,
"currency": "AUD",
"vaultedShopperId": 19602910,
"becsDirectDebitTransaction": {
"bsbNumber": "980201",
"accountName": "Vasya Pupkin",
"financialInstitution": "financialInstitution",
"branchName": "branchName",
"publicAccountNumber": "5557",
"agreementId": 81,
"preNotificationRef": "https://localhost:8444/services/2/agreements/prenotification/38702776"
},
"processingInfo": {
"processingStatus": "PENDING"
}
}
{
"transactionId": "38701844",
"amount": 77,
"currency": "AUD",
"payerInfo": {
"firstName": "Boris",
"lastName": "Britva",
"country": "au",
"zip": "12345"
},
"vaultedShopperId": 19610968,
"becsDirectDebitTransaction": {
"bsbNumber": "980201",
"accountName": "Boris Britva",
"financialInstitution": "financialInstitution",
"branchName": "branchName",
"publicAccountNumber": "0002",
"agreementId": 81,
"preNotificationRef": "https://localhost:8444/services/2/agreements/prenotification/38701844"
},
"processingInfo": {
"processingStatus": "PENDING"
}
}