Sandbox

Release a sandbox fixed-route account number

Changed on

Sandbox only. Disables the fixed route if it is still enabled, then parks its bank account number so the next pay-in for this customer reuses it instead of issuing a new one. In-flight transfers must finish or be cancelled first. Disabling the route alone does not free the account-number quota.

post/v1/sandbox/fixed-routes/{id}/release

Request

Path parameters

idstring required

Fixed route source account id (vba_)

Headers

X-API-Keystring

API key

Request body

reasonstring

Why the account number is being released for reuse

Response

Account number parked for reuse

idstring required

Fixed route source account id

enabledboolean required

Route is disabled after release

accountNumberReleasedboolean required

The account number is parked for the next pay-in on this customer to reuse

alreadyReleasedboolean required

True when the account number was already parked

Example response

{
  "id": "vba_123"
}

Changes