API BasicsPayment APIEmbedded PaymentsReporting & ToolsSupport GuidesBlueSnap.com
Top of Section

Update Bank Information

📘

Note

This feature is only available for non-regional payout merchant accounts in the following regions:

  • Australia
  • Canada
  • United States

After a merchant account is approved, you can update the merchant's payout bank information with a new payout bank in the same region as the original bank.

When BlueSnap receives the API request, we perform an underwriting review to verify the new payout bank information. The merchant continues to receive payout to the original account during the review.

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.

API Endpoint

https://platform.bluesnap.com/services/2/merchants/bank-update/{merchantId}

Update Bank Information API Parameters

This endpoint accepts the properties of a bankingInfo object in the same format as the Create Merchant API request. The bankingInfo object properties are unique for each region. For details about the properties required for your region, refer to the bankingInfo object in the parameters table in the following pages:

Examples

Requests

Australia

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

Canada

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

United States

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."
    }
  ]
}