curl --request PUT \
  --url https://service-sandbox.tazapay.com/v3/collection_account/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "usecase": "This account is used for USD payouts"
  }
}
'

{
  "status": "success",
  "message": "",
  "data": {
    "collection_account": {
      "id": "cva_crqinja9chqqs7moi8rg",
      "object": "virtual_account",
      "type": "virtual_account",
      "payment_method_type": "local_bank_transfer_cad",
      "country": "CA",
      "currencies": [
        "CAD"
      ],
      "status": "enabled",
      "alias": "CAD Collection Account",
      "virtual_account": {
        "account_holder_name": "testacc",
        "account_number": "testacc1234-56-1234",
        "bank_address": {
          "address_line_1": "testAdd",
          "address_line_2": "testAdd1",
          "country": "United States of America"
        },
        "bank_codes": {
          "ach_routing_number": "testRoutingNumber",
          "bank_code": "testBankCode",
          "bsb_code": "testBsbCode",
          "fedwire_routing_number": "TestFedWire",
          "routing_code": "testRoutingCode",
          "sort_code": "testSortCode",
          "swift_code": "testSwift"
        },
        "bank_branch": "testBankBranch",
        "bank_name": "testBank",
        "iban": "testIban"
      },
      "is_reenablement_supported": true,
      "status_description": "",
      "metadata": {
        "usecase": "This account is used for USD payouts"
      },
      "created_at": "2024-09-26 09:39:25.03501 +0000 UTC",
      "updated_at": "2024-09-26 09:41:43.349835 +0000 UTC"
    }
  }
}

Collection Account

Update Collection Account

Update the alias or metadata of an existing collection account, or disable or re-enable it by supplying action.

In production, disabling and re-enabling are asynchronous. The call creates a request against the account and returns immediately — the account keeps its current status until that request reaches succeeded. The response carries the account only: it does not include a requests array, so track progress by subscribing to the collection account webhooks or by polling the list endpoint.

In sandbox, disabling and re-enabling are synchronous. No request is created, no lifecycle webhook fires, reason is not recorded, and the returned account already reflects the new status. To exercise the asynchronous production flow in sandbox, drive the request states with the sandbox simulation endpoint instead.

Preconditions for action:

disable — the account must currently be enabled. Wallet accounts cannot be disabled through this endpoint.
reenable — the account must currently be disabled, must have been disabled by you rather than by Tazapay, and must have is_reenablement_supported set to true.
Either action is rejected while another request is already in progress against the account.

PUT

collection_account

{id}

curl --request PUT \
  --url https://service-sandbox.tazapay.com/v3/collection_account/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "usecase": "This account is used for USD payouts"
  }
}
'

{
  "status": "success",
  "message": "",
  "data": {
    "collection_account": {
      "id": "cva_crqinja9chqqs7moi8rg",
      "object": "virtual_account",
      "type": "virtual_account",
      "payment_method_type": "local_bank_transfer_cad",
      "country": "CA",
      "currencies": [
        "CAD"
      ],
      "status": "enabled",
      "alias": "CAD Collection Account",
      "virtual_account": {
        "account_holder_name": "testacc",
        "account_number": "testacc1234-56-1234",
        "bank_address": {
          "address_line_1": "testAdd",
          "address_line_2": "testAdd1",
          "country": "United States of America"
        },
        "bank_codes": {
          "ach_routing_number": "testRoutingNumber",
          "bank_code": "testBankCode",
          "bsb_code": "testBsbCode",
          "fedwire_routing_number": "TestFedWire",
          "routing_code": "testRoutingCode",
          "sort_code": "testSortCode",
          "swift_code": "testSwift"
        },
        "bank_branch": "testBankBranch",
        "bank_name": "testBank",
        "iban": "testIban"
      },
      "is_reenablement_supported": true,
      "status_description": "",
      "metadata": {
        "usecase": "This account is used for USD payouts"
      },
      "created_at": "2024-09-26 09:39:25.03501 +0000 UTC",
      "updated_at": "2024-09-26 09:41:43.349835 +0000 UTC"
    }
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

string

required

Unique ID of the collection account to update. 24 characters, starting with cva_ (virtual account) or cwa_ (wallet).

Body

application/json

metadata

object

Set of key-value pairs to attach to the collection account object.

Show child attributes

alias

string

Nickname for the account.

action

enum<string>

State transition to perform. Omit to update alias and metadata only. When supplied, a disablement or re-enablement request is created and processed asynchronously.

Available options:

disable,

reenable

reason

string

Reason recorded against the state transition. Applies only when action is supplied. Surfaced as disablement_reason on the resulting request object.

Response

200 - application/json

Collection account updated successfully.

status

string

message

string

data

object

Show child attributes

API Overview

Tazapay API

JavaScript SDK

Appendix

Update Collection Account

Authorizations

Path Parameters

Body

Response