Supported Regions
This feature is only available for non-regional payout merchant accounts in the following regions:
- Australia
- Canada
- United States
Update the payout bank information for an approved merchant. The new payout account must be in the same region as the original account.
When BlueSnap receives the API request, we perform an underwriting review to verify the new payout bank information. During the review, the merchant continues to receive payout to the original account.
After the review is complete, BlueSnap sends an email to notify you whether the update was approved or declined. Payouts are sent to the new payout bank account only after the underwriting review is approved.
Endpoint
https://platform.bluesnap.com/services/2/merchants/bank-update/{merchantId}
Request Content
This endpoint requires a path parameter to specify the merchant and a request body that contains the updated bank information.
Path Parameters
| Parameter | Required | Description |
|---|---|---|
{merchantId} | required | Unique identifier that BlueSnap assigned to the merchant. |
Request Body
The request body accepts the properties of the bankingInfo object that was sent in the New Application API request. Each supported region accepts different bankingInfo properties, which are outlined in the tables below.
Australia
| Parameter | Required | Details |
|---|---|---|
bsb | Yes | Routing number for the merchant's business bank account. Type: string Limits: - Maximum 6 characters - Numbers only |
accountNumber | Yes | Account number for the merchant's business bank account. Type: string Limits: - Maximum 9 characters - Numbers only |
minimalPayoutAmount | Yes | The minimum amount at which the customer will be paid. Until this value is reached, funds continue to accumulate. Type: string Limits: Minimum $35 USD. |
refundReserve | Yes | The amount of funds kept in the account to cover refunds. Type: string Limits: Minimum $100 USD. |
paymentReference | No | Reference text that appears on the customer's bank statement when they are paid out. Type: string Limits: Maximum 100 alphanumeric character |
Canada
| Parameter | Required | Details |
|---|---|---|
payoutCurrency | Yes | Currency in which the merchant will be paid. Type: string Limits: CAD |
minimalPayoutAmount | Yes | The minimum amount at which the customer will be paid. Until this value is reached, funds continue to accumulate. Type: string Limits: - This must be specified in the currency selected in payoutCurrency (CAD).- Minimum value is the equivalent of $35 USD. |
refundReserve | Yes | The amount of funds kept in the account to cover refunds. Type: string Limits: - This must be specified in the currency selected in payoutCurrency (CAD).- Minimum value is the equivalent of $100 USD. |
bankProvince | Yes | Province where the bank is located. Type: string Limits: 2-letter code. Refer to State and Province Codes. |
transitNumber | Yes | Routing number. Generally, this is a 5-digit code. Type: string Limits: - Maximum 5 characters - Numbers only |
institutionNumber | Yes | Financial institution number. Type: string Limits: 3 digit number |
accountNumber | Yes | Bank account number. Type: string Limits: - Maximum 12 characters - Numbers only |
paymentReference | No | Reference text that appears on the customer's bank statement when they are paid out. Type: string Limits: Maximum 100 alphanumeric characters |
United States
| Parameter | Required | Details |
|---|---|---|
routingNumber | Yes | Routing number for the merchant's business bank account. Type: string Limits: - Maximum 9 characters - Numbers only |
accountNumber | Yes | Account number for the merchant's business bank account. Type: string Limits: - Must be 17 characters - Numbers only |
bankState | Yes | Merchant's bank address state. Type: string Must be a valid 2-letter US State code. Refer to State and Province Codes. |
accountType | Yes | Type of accountfor the merchant's business bank account. Type: string Valid input: - Checking - Savings |
minimalPayoutAmount | Yes | The minimum amount at which the customer will be paid. Until this value is reached, funds continue to accumulate. Type: string Limits: Minimum $35. |
refundReserve | Yes | The amount of funds kept in the account to cover refunds. Type: string |
paymentReference | No | Reference text that appears on the customer's bank statement when they are paid out. Type: string Limits: Maximum 100 alphanumeric characters |
Examples
Requests
curl -v -X PUT https://platform.bluesnap.com/services/2/merchants/bank-update/1234567 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
-d '
{
"accountNumber": "12345678",
"bsb": "123456",
"minimalPayoutAmount": "0",
"paymentReference": "Payment Reference Partner AU",
"refundReserve": "0"
}'
curl -v -X PUT https://platform.bluesnap.com/services/2/merchants/bank-update/1234567 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
-d '
{
"accountNumber": "123456780",
"bankProvince": "QC",
"institutionNumber": "567",
"minimalPayoutAmount": "0",
"paymentReference": "Payment Reference Partner CA",
"refundReserve": "0",
"transitNumber": "12345"
}'
curl -v -X PUT https://platform.bluesnap.com/services/2/merchants/bank-update/1234567 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic QVBJXzE2MTk2MjgyMzU0ODkyMDM5MTMzODc0OkFsdG9pZHMxIQ==' \
-d '
{
"accountNumber": "12345678",
"accountType": "CHECKING",
"bankState": "CA",
"minimalPayoutAmount": "0",
"paymentReference": "Payment Reference Partner US",
"refundReserve": "0",
"routingNumber": "123456789"
}'
Responses
{
"message": "success"
}
{
"message": [
{
"errorName": "MERCHANT_VALIDATION_ERROR",
"code": "30400",
"description": "Change of PO bank details via API not available at this time. Please contact BlueSnap support."
}
]
}
{
"message": [
{
"errorName": "MERCHANT_VALIDATION_ERROR",
"code": "30400",
"description": "The application is declined. Change of PO bank details via API not available at this time. Please contact BlueSnap support."
}
]
}
{
"message": [
{
"errorName": "MERCHANT_VALIDATION_ERROR",
"code": "30400",
"description": "The application has not yet been approved. Change of PO bank details via API not available at this time. Please contact BlueSnap support."
}
]
}
{
"message": [
{
"errorName": "MERCHANT_VALIDATION_ERROR",
"code": "30400",
"description": "A pending bank update request already exists."
}
]
}