📘
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.

📘
Tip
You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.

Request Content

Send an altTransaction object with the following:

Property	Type	Required
`merchantTransactionId`	string	optional
`softDescriptor`	string	optional
`amount`	decimal	required
`currency`	string	required
`taxReference`	string	optional
`vendorsInfo`	object	optional (see vendorsInfo)
`payerInfo`	object	required if `vaultedShopperId` is not sent (see payerInfo)
`vaultedShopperId`	integer	required if `payerInfo` is not sent
`pfToken`	string	optional
`becsDirectDebitTransaction`	object	required (see becsDirectDebitTransaction)
`authorizedByShopper`	boolean	required, value must be true
`transactionMetaData`	object	optional (see transactionMetaData)
`transactionFraudInfo`	object	optional (see transactionFraudInfo)

Response Details

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


`transactionId`
`vaultedShopperId`
`processingInfo`	see processingInfo
`fraudResultInfo`	see fraudResultInfo

Examples

Request Examples

📘
Note
The agreementId in the examples below should be replaced with the agreementId you 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"
    }
}

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

API Explorer

To test out a basic API request, click the "Try It!" button in the right-hand column to test using the default, pre-populated sample values. To test with your own values, edit the parameter fields below. You'll see them populate in the right-hand column and you can click the "Try It!" button to submit your test request and see a response.