---
title: "Retract Account"
method: POST
path: "/inbound/v1/retraction"
tags: ["Account Retractions"]
---

# Retract Account

`POST /inbound/v1/retraction`

## Request

- Base URL: `https://virtserver.swaggerhub.com/felipediazc/integration/0.0.2`
- URL: `https://virtserver.swaggerhub.com/felipediazc/integration/0.0.2/inbound/v1/retraction`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/docs/inbound/v1/retraction/post.ts> (a function with typed inputs; its response is checked against the schema)

Account retractions - when an account is retracted the Retain system stops sending all communications to consumer. Please note, that for multi account/record retraction requests, if one or more of the accounts cannot be found in our system (e.g. an incorrect accountNumber or accountNamespace is provided), while other accounts in the request can be found, the validly identified accounts will be retracted and the response will indicate the accounts that were not properly identified in the request. A maximum of 175 accounts/records can be retracted in a single request.

## Request body

- RetractionInformation[]
  - `accountNumber` string, required: Account number of account to retract.
  - `accountNamespace` string, required: accountNamespace that the account to retract was originally placed with.
  - `recallReason` 'PAID' | 'BANKRUPT' | 'DISPUTED' | 'CLOSED' | 'CAMPAIGN_ENDED', required: Reason that the account is being retracted.

## Response `200`

successful operation

- InboundAPIResponsePaymentRetraction200
  - `ClientId` string, required: Client Id
  - `Status` string, required: Response status (SUCCESS)
  - `Message` string, required: Message description
  - `ProcessedRecords` integer, required: Number or records processed
  - `FailedRecords` FailedRecord[], nullable
    - `AccountNumber` string: AccountNumber of the record that has failed
    - `AccountNamespace` string: AccountNamespace of the record that has failed
    - `Message` string: Error Detail

## Other responses

- `400`: Bad request - refer to message and/or FailedRecords for additional information. Requests can fail for a variety of reasons, e.g. invalid JSON formatting, invalid or required fields not being present.
- `500`: Internal server error - an error occurred while processing the request.

## Changes

- **2023-05-16** `8a19069a1bb6`: 1 warning, 14 info
  - removed the request property `items/recallDate`
  - api tag `Account Retractions` added
  - api tag `Account Placements` removed
  - added the new `CAMPAIGN_ENDED` enum value to the request property `items/recallReason`
  - …11 more
- **2022-08-08** `ef0e23c8d084`: 1 info
  - the request property `items/recallDate` became optional
- **2022-05-20** `2d776a692387`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/changes/inbound/v1/retraction/post.md)

---

[API](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api.md) - [All operations](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trueaccord/apis/trueaccord-retain-inbound-api/revisions/22d6fde0b534?raw)