SETSimple Easy Transactions
SET DocsAPI reference and complianceUpdated 2026-11-10
Browse: SET Direct Deposit API

SET Direct Deposit API · Sandbox

Simulate an address being deactivated

POST/api/partner/sandbox/address_deactivated

Key scope: partner key · Staging only · Success: 201

Staging only. Sends you address.deactivated for an address you have checked with GET /api/partner/address, so you can test how your system stops paying it. The address itself is not changed.

Body

chain "base" | "ethereum"required
The address's network.
address stringrequired
A staging address you checked.
reason "payee_removed" | "provider_deactivated"
Default payee_removed.

Errors

  • 400 body_invalid
  • 400 chain_invalid
  • 400 address_invalid
  • 404 address_unknown
  • 401 partner_key_required
  • 401 partner_key_invalid
  • 403 ip_not_allowed
  • 429 rate_limited
  • 503 direct_deposit_disabled

All codes: Errors.