Activate or Deactivate Source Account API

patch

https://api-uat.ncome.in/api/v1/escrow/source-account/status

This API allows a merchant to deactivate (soft delete) a source account by changing its status to "INACTIVE" in the Digital Escrow system. It also allows the merchant to reactivate a previously deactivated source account by updating its status back to "ACTIVE". Additionally, merchants can disable deposit restrictions altogether by setting all source accounts to "INACTIVE", thereby enabling deposits from any bank account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

escrowId

string

required

The escrow ID for which the source account status is to be updated.

accountNumber

string

The source account number whose status needs to be changed. If specified, only the status of this particular account will be updated. If not provided, and the status is set to "INACTIVE" (or "no"), then all source accounts linked to the given linked_va_id will be marked as inactive—effectively allowing deposits from any account. However, the reverse operation (setting all accounts to "ACTIVE" in bulk) is not allowed for safety and control reasons.

active

string

required

The status that needs to be set for the source account. Can be only "yes" (Active) or "no" (Inactive).

Headers

X-API-KEY

string

Defaults to {{x-api-key}}

xAPI key shared separately by Castler

X-CLIENT-KEY

string

Defaults to {{X-Client-Key}}

API key generated from Castler dashboard

Responses

200200

400400

422422