Update Merchant Bank Info

Update the bank account information for a merchant

Endpoint

PUT https://api.digitzs.com/merchants/{id}

Overview

Use this endpoint to update a merchant’s bank account information used for receiving payment deposits.

Changing bank information affects where funds are deposited. Verify all details carefully before submitting.

Authentication

Header	Value	Required
x-api-key	Your API key	Yes
Authorization	Bearer {appToken}	Yes
appId	Your application ID	Yes
Content-Type	application/json	Yes

Path Parameters

id · string · required

The merchant account ID

Request Body

data.type · string · required

Must be "merchants"

data.attributes.group · string · required

Must be "bankInfo"

data.attributes.bankInfo · object · required

New bank account information

Show Bank info properties

bankName · string · required

Name of financial institution

accountOwnership · string · required

"personal" or "business"

accountType · string · required

"checking" or "savings"

accountName · string · required

Account holder name

accountNumber · string · required

Bank account number

routingNumber · string · required

9-digit routing number

Example Request

{
  "data": {
    "type": "merchants",
    "attributes": {
      "group": "bankInfo",
      "bankInfo": {
        "bankName": "Chase Bank",
        "accountOwnership": "business",
        "accountType": "checking",
        "accountName": "Acme Corporation",
        "accountNumber": "9876543210",
        "routingNumber": "026009593"
      }
    }
  }
}

Response

Success Response (200 OK)

{
  "links": {
    "self": "https://api.digitzs.com/merchants/merchant_abc123"
  },
  "data": {
    "type": "merchants",
    "id": "merchant_abc123",
    "attributes": {
      "bankInfo": {
        "bankName": "Chase Bank",
        "accountType": "checking",
        "last4": "3210",
        "updatedAt": "2024-01-20T15:30:00Z"
      }
    }
  }
}

Code Examples

cURL

curl -X PUT https://api.digitzs.com/merchants/merchant_abc123 \
  -H "x-api-key: your-api-key" \
  -H "Authorization: Bearer your-app-token" \
  -H "appId: your-app-id" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "type": "merchants",
      "attributes": {
        "group": "bankInfo",
        "bankInfo": {
          "bankName": "Chase Bank",
          "accountOwnership": "business",
          "accountType": "checking",
          "accountName": "Acme Corporation",
          "accountNumber": "9876543210",
          "routingNumber": "026009593"
        }
      }
    }
  }'

Important Notes

Verification Required: New bank accounts may require verification before funds can be deposited. Check with Digitzs support for verification procedures.

Pending Deposits: Existing pending deposits will complete to the old account. Only new deposits use the updated account.

Double Check: Verify routing and account numbers carefully. Incorrect information will cause deposit failures.

Best Practices

1. Validate Before Update: Verify bank details with merchant before submission
2. Notify Merchant: Inform merchant of bank account changes
3. Audit Trail: Log all bank account updates for compliance
4. Test Deposits: Consider micro-deposit verification for added security

Next Steps

Get Merchant Details

Verify updated bank information