--- title: "Deactivate a Recipient" method: PUT path: "/v2.01/{ClientId}/recipients/{RecipientId}" tags: ["Recipients"] --- # Deactivate a Recipient `PUT /v2.01/{ClientId}/recipients/{RecipientId}` Permanently disable a Recipient ## Path parameters - `ClientId` string, required - `RecipientId` string, required ## Headers - `Authorization` string, required ## Request body - DeactivateARecipientRequest - `Status` string, required — **Allowed values:** `DEACTIVATED` The status of the recipient: - `DEACTIVATED` – Value to send to permanently disable the recipient so it can no longer be used. The Recipient must be `ACTIVE` to be deactivated. ## Response `200` Success - DeactivateARecipientResponse - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Status` string — **Returned values:** `PENDING`, `CANCELED`, `ACTIVE`, `DEACTIVATED` The status of the recipient: - `PENDING` – For `PAYOUT` scope recipients, the user must complete SCA before the recipient can become `ACTIVE`. For `PAYIN` scope recipients, the recipient creation is in progress. - `CANCELED` – SCA was not successfully completed and the recipient creation request was canceled. To retry, create another recipient to retrieve another `PendingUserAction.RedirectUrl`. The `CANCELED` status does not apply if `RecipientScope` is `PAYIN`. - `ACTIVE` – Recipient creation was successful (including SCA if `RecipientScope` is `PAYOUT`) and the recipient is ready to be used for payouts. - `DEACTIVATED` – The recipient has been permanently deactivated and can no longer be used. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `DisplayName` string, nullable — Length: 1–50; cannot contain: `&,'/` (pattern:`^(?!.*[&,'/]).{1,50}$`) A user-friendly name to identify the account. This value cannot be changed once the recipient is created. - `PayoutMethodType` string — **Returned values:** `InternationalBankTransfer`, `LocalBankTransfer` The payout method of the recipient: - `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` via the [domestic payment rail](/guides/payouts#payout-rails) (e.g. `EUR` via a SEPA local scheme to a SEPA country, `GBP` via FPS to a `GB` account, `USD` via ACH to a `US` account, etc). Payouts in non-local currencies return an error. - `InternationalBankTransfer` – The account can receive both non-local currencies via SWIFT and also local currency via domestic rails. - `RecipientType` string — **Returned values:** `Individual`, `Business` The recipient type: - `Individual` – An account held by a natural person, requiring the `IndividualRecipient` property. - `Business` – An account held by a legal entity, requiring the `BusinessRecipient` property. - `Currency` string — **Possible values:** `AED`, `AUD`, `CAD`, `CHF`, `CNH`, `CZK`, `DKK`, `EUR`, `GBP`, `HKD`, `HUF`, `ILS`, `JPY`, `MXN`, `NOK`, `NZD`, `PLN`, `RON`, `SAR`, `SEK`, `SGD`, `TRY`, `USD`, `ZAR` The currency of the recipient. - `Country` string — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The destination country of the payout method. - `UserId` string — The unique identifier of the user. - `RecipientScope` string — **Returned values:** `PAYIN`, `PAYOUT` The scope of the recipient: - `PAYOUT` – Usable for payouts and in pay-in use cases. A `PAYOUT` recipient can only be created by a user with the `UserCategory` `OWNER` and requires SCA. - `PAYIN` - Not usable for payouts but only usable for pay-in use cases, such as direct debit and refunds using payouts. A `PAYIN` recipient can be created by a user with the `UserCategory` `PAYER` or `OWNER`, and does not require SCA. Both `PAYIN` and `PAYOUT` scopes can be created for either `InternationalBankTransfer` or `LocalBankTransfer`, and for either `IndividualRecipient` or `BusinessRecipient`, and for any `Currency`. - `Tag` string, nullable — Max. length: 255 (pattern: `^.{0,255}$`) Custom data that you can add to this object. This value cannot be changed once the recipient is created. - `ScaContext` string — **Returned values:** `USER_PRESENT`, `USER_NOT_PRESENT` The SCA context provided in the create request. Returned in the create response and when viewing the recipient if a `ScaContext` value was sent when the recipient was registered. Omitted otherwise. - `IndividualRecipient` IndividualRecipientResponse — The account holder if the `RecipientType` is `Individual`. - `FirstName` string — Length: 1–255; cannot contain: `()&,.:_/` (Pattern: `^(?!.*[()&,.:_/]).{1,255}$`) The first name of the individual account holder. - `LastName` string — Length: 1–255; cannot contain: `()&,.:_/` (Pattern: `^(?!.*[()&,.:_/]).{1,255}$`) The last name of the individual account holder. - `Address` AddressRecipient — Information about the address. - `AddressLine1` string — Length: 1–255; cannot contain: `()/` (Pattern: `^(?!.*[()/]).{1,255}$`) The first line of the address. - `AddressLine2` string, nullable — Length: 1–255; cannot contain: `()/` (Pattern: `^(?!.*[()/]).{1,255}$`) The second line of the address. Parameter only returned if sent. - `City` string — Length: 1-80; cannot contain: `&,.:_'` (pattern: `^(?!.*[&,.:_]).{1,80}$`) The city of the address. - `Region` string, nullable — Length: 1–10; cannot contain: `&,.:_'-/` (pattern: `^(?!.*[&,.:_/]).{1,50}$`) The region of the address. Parameter only returned if sent. - `PostalCode` string — Length: 1–10; cannot contain: `()&,.:_'/` (pattern: `^(?!.*[()&,.:_'/]).{1,10}$`) The postal code of the address. - `Country` string — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `BusinessRecipient` BusinessRecipientResponse — The account holder if the `RecipientType` is `Business`. - `BusinessName` string — Length: 1–255; cannot contain: `(),.:/` (Pattern: `^(?!.*[(),.:/]).{1,255}$`) The name of the business account holder. - `Address` AddressRecipient — Information about the address. - `AddressLine1` string — Length: 1–255; cannot contain: `()/` (Pattern: `^(?!.*[()/]).{1,255}$`) The first line of the address. - `AddressLine2` string, nullable — Length: 1–255; cannot contain: `()/` (Pattern: `^(?!.*[()/]).{1,255}$`) The second line of the address. Parameter only returned if sent. - `City` string — Length: 1-80; cannot contain: `&,.:_'` (pattern: `^(?!.*[&,.:_]).{1,80}$`) The city of the address. - `Region` string, nullable — Length: 1–10; cannot contain: `&,.:_'-/` (pattern: `^(?!.*[&,.:_/]).{1,50}$`) The region of the address. Parameter only returned if sent. - `PostalCode` string — Length: 1–10; cannot contain: `()&,.:_'/` (pattern: `^(?!.*[()&,.:_'/]).{1,10}$`) The postal code of the address. - `Country` string — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `InternationalBankTransfer` InternationalBankTransferResponse — The account details if `PayoutMethodType` is `InternationalBankTransfer`. - `AccountNumber` string — The account number of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `LocalBankTransfer` LocalBankTransferDetails — The account details if `PayoutMethodType` is `LocalBankTransfer`, depending on the `Currency`. One of: - `CAD` LocalBankTransferCAD — Local bank transfer details for `Currency` value `CAD`. - `AccountNumber` string — Format: 7–35 digits (pattern: `^\d{7,35}$`). The account number of the Canadian account. - `InstitutionNumber` string — Format: 3 digits (pattern: `^\d{3}$`). The institution number of the Canadian account. - `BranchCode` string — Format: 5 digits (pattern: `^\d{5}$`). The branch code of the Canadian account. - `BankName` string — Length: 1–50. The bank name of the Canadian account. - `CHF` LocalBankTransferIBAN — Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`). - `IBAN` string — Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}\s*$`). The IBAN of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `CZK` LocalBankTransferIBAN — Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`). - `IBAN` string — Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}\s*$`). The IBAN of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `DKK` LocalBankTransferIBAN — Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`). - `IBAN` string — Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}\s*$`). The IBAN of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `EUR` LocalBankTransferIBAN — Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`). - `IBAN` string — Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}\s*$`). The IBAN of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `GBP` LocalBankTransferGBP — Local bank transfer details for `Currency` value `GBP`. - `AccountNumber` string — Format: 8 digits (pattern: `^\d{8}$`). The account number of the UK account. - `SortCode` string — Format: 6 digits (pattern: `^\d{6}$`). The sort code of the UK account. - `HUF` LocalBankTransferIBAN — Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`). - `IBAN` string — Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}\s*$`). The IBAN of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `NOK` LocalBankTransferIBAN — Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`). - `IBAN` string — Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}\s*$`). The IBAN of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `PLN` LocalBankTransferIBAN — Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`). - `IBAN` string — Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}\s*$`). The IBAN of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `RON` LocalBankTransferIBAN — Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`). - `IBAN` string — Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}\s*$`). The IBAN of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `SEK` LocalBankTransferIBAN — Local bank transfer details for IBAN-based currencies (`CHF`, `CZK`, `DKK`, `EUR`, `HUF`, `NOK`, `PLN`, `RON`, `SEK`). - `IBAN` string — Format: A valid IBAN (pattern: `^[a-zA-Z]{2}\d{2}\s*(\w{4}\s*){2,7}\w{1,4}\s*$`). The IBAN of the account. - `BIC` string — The BIC of the account. For IBAN countries, the returned `BIC` is generated from the IBAN. - `USD` LocalBankTransferUSD — Local bank transfer details for `Currency` value `USD`. - `AccountNumber` string — Format: 8–12 alphanumeric characters (pattern: `^[0-9a-zA-Z]{8,12}$`). The account number of the US account. - `ABA` string — Format: 9 digits (pattern: `^\d{9}$`). The ABA routing number of the US account. - `FFC` string — Format: 8-12 digits then `FFC` then a space then a string of characters up to 140 total length (pattern: `^(?=.{0,140}$)[0-9]{8,12}/FFC [0-9a-zA-Z/\-?:().,'+ ]+$`). FFC transfer information for the US account. - `PendingUserAction` PendingUserAction — Object containing the `RedirectUrl` needed for SCA redirection if triggered by the API call (otherwise returned `null`). - `RedirectUrl` string — The URL to which to redirect the user to perform strong customer authentication (SCA) via a Mangopay-hosted webpage. This value is a variable and should not be hardcoded. The SCA session link expires 10 minutes after it's generated. **Caution:** Before redirecting the user on this URL, you must add the query parameter `ReturnUrl` with the percent-encoded URL to which you want the SCA session to return the user after authentication (whether successful or not). For more details, see [How to redirect a user for an SCA session](/guides/sca/session#how-to-redirect-a-user-for-sca). ## Other responses - `400` — Bad Request --- [API](https://skmtc.net/mangopay/apis/api-reference.md) · [All operations](https://skmtc.net/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mangopay/api-reference/versions/795281070285/schema)