post
https://sandbox.bluesnap.com/services/2/balance/fund-transactions
Initiates a transaction to direct debit funds to a merchant account balance for a given region and currency.
Request Content
Send a fundTransaction object, with the following:
| Property | Type | Required |
|---|---|---|
transactionRegion | string | required |
amount | decimal | required |
payerInfo | object | required; refer to payerInfo |
merchantTransactionId | string | optional |
softDescriptor | string | optional |
currency | string | required; refer to Currency Codes |
targetMerchantId | number | optional |
transactionMetaData | object | optional; refer to transactionMetaData |
ecpTransaction | object | required for ACH (ECP) transactions; refer to ecpTransaction |
sepaDirectDebitTransaction | object | required for SEPA Direct Debit transactions; refer to sepaDirectDebitTransaction |
becsDirectDebitTransaction | object | required for BECS Direct Debit Transaction; refer to becsDirectDebitTransaction |
acssDirectDebitTransaction | object | required for Pre-Authorized Debit Transaction; refer to acssDirectDebitTransaction |
Response Details
If successful, the response HTTP status code is 200 OK and contains the fundTransaction object.
Examples
Request Examples
curl -v -X POST https://sandbox.bluesnap.com/services/2/balance/fund-transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"acssDirectDebitTransaction": {
"routingNumber": "001004820",
"accountNumber": "9990000001",
"accountType": "PERSONAL",
"agreementId": 5721
},
"amount": 11,
"payerInfo": {
"zip": "12345",
"firstName": "John",
"lastName": "Doe",
"country": "CA"
},
"currency": "CAD",
"transactionRegion": "CA"
}'curl -v -X POST https://sandbox.bluesnap.com/services/2/balance/fund-transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"ecpTransaction": {
"routingNumber": "011075150",
"accountType": "CONSUMER_CHECKING",
"accountNumber": "4099999992"
},
"amount": 5.99,
"payerInfo": {
"zip": "12345",
"firstName": "John",
"lastName": "Doe",
"address": "blue lane 21",
"email": "[email protected]"
},
"currency": "USD",
"transactionRegion": "none"
}'curl -v -X POST https://sandbox.bluesnap.com/services/2/balance/fund-transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"sepaDirectDebitTransaction": {
"iban": "DE91100000001234400020"
},
"payerInfo": {
"firstName": "John",
"lastName": "Doe"
},
"softDescriptor": "SV Fund Prep",
"amount": 9.65,
"currency": "EUR",
"country": "FR",
"transactionRegion": "none"
}'curl -v -X POST https://sandbox.bluesnap.com/services/2/balance/fund-transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"becsDirectDebitTransaction": {
"bsbNumber": "980201",
"accountNumber": "9990000001",
"accountName": "Jane Doe",
"financialInstitution": "financialInstitution",
"branchName": "branchName",
"agreementId": 5801
},
"amount": 77,
"payerInfo": {
"zip": "12345",
"firstName": "Jane",
"lastName": "Doe",
"country": "au"
},
"currency": "AUD",
"transactionRegion": "AU"
}'Response Examples
{
"transactionId": "2148126006",
"amount": 11,
"currency": "CAD",
"payerInfo": {
"firstName": "John",
"lastName": "Doe",
"country": "ca",
"zip": "12345"
},
"acssDirectDebitTransaction": {
"routingNumber": "001004820",
"accountType": "PERSONAL",
"publicAccountNumber": "0001",
"agreementId": 5721
},
"processingInfo": {
"processingStatus": "PENDING"
}
}{
"transactionId": "1177823841",
"amount": 5.99,
"currency": "USD",
"payerInfo": {
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"address": "blue lane 21",
"zip": "12345"
},
"ecpTransaction": {
"accountType": "CONSUMER_CHECKING",
"publicAccountNumber": "99992",
"publicRoutingNumber": "75150"
},
"processingInfo": {
"processingStatus": "PENDING",
"transactionRegion": "US"
}
}{
"transactionId": "2148866942",
"softDescriptor": "SV Fund Prep",
"amount": 9.65,
"currency": "EUR",
"payerInfo": {
"firstName": "John",
"lastName": "Doe"
},
"sepaDirectDebitTransaction": {
"ibanFirstFour": "DE91",
"ibanLastFour": "0020",
"mandateId": "She183914",
"mandateDate": "09-Apr-26",
"preNotificationText": "The amount of 9.65 EUR will be collected using SEPA Direct Debit with Mandate She183914 from your bank account IBAN DE91XXXXXX0020 in the next few days. Please ensure sufficient funds in your account.",
"preNotificationTranslationRef": "http://localhost:8086/services/2/translations/sepa/prenotification?transactionid=2148866942"
},
"processingInfo": {
"processingStatus": "PENDING",
"transactionRegion": "UK"
}
}{
"transactionId": "2148885716",
"amount": 77,
"currency": "AUD",
"payerInfo": {
"firstName": "Jane",
"lastName": "Doe",
"country": "au",
"zip": "12345"
},
"becsDirectDebitTransaction": {
"bsbNumber": "980201",
"accountName": "Jane Doe",
"financialInstitution": "financialInstitution",
"branchName": "branchName",
"publicAccountNumber": "0001",
"agreementId": 5801,
"preNotificationRef": "http://localhost:8086/services/2/agreements/prenotification/2148885716"
},
"processingInfo": {
"processingStatus": "PENDING",
"transactionRegion": "AU"
}
}API Explorer