v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Payments

Close external account

Closes an external account previously linked to a participant. After closure the account can no longer be used for new payments.

post/payments/external_accounts/{external_account_id}/close

Path parameters

external_account_idstring uuid required

Identifier of the external account to close.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required

Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Request body

participant_codestring required

Participant that owns the external account being closed.

Example request

{
  "participant_code": "ABCDEF"
}

Response

External account closed. Response contains the final snapshot of the account.

request_idstring

RequestID

Example response

{
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "external_account": {
    "account_number": "123456789",
    "routing_number": "011401533",
    "participant_code": "ALI123",
    "platform_code": "TES123",
    "account_nickname": "test1",
    "external_account_id": "0f68333e-2114-469d-b505-c850d776e063",
    "created_at": "2026-05-04T11:54:13.099Z"
  }
}