---
title: "Update recipient"
method: PUT
path: "/api/v1/recipients/{recipientId}"
tags: ["Recipients"]
deprecated: true
---

# Update recipient

`PUT /api/v1/recipients/{recipientId}`

## Request

- Base URL: `https://api-business.wirexapp.com`
- URL: `https://api-business.wirexapp.com/api/v1/recipients/{recipientId}`
- Auth: API key in header `Authorization`

> **Deprecated.**

Updates recipient with provided personal information

## Path parameters

- `recipientId` string, required

## Request body `*/*`

- RequestRecipientUpdateRequestBody
  - `company_name` string: Name of the company/business this recipient is for (<span style="color:red">MUST</span> be provided if the recipient is a **business**)
  - `first_name` string: First name of the recipient (<span style="color:red">MUST</span> be provided if the recipient is a **person**)
  - `is_business` boolean, required: Indicator of whether the recipient is a business
  - `last_name` string: Last name of the recipient (<span style="color:red">MUST</span> be provided if the recipient is a **person**)
  - `nick_name` string: Optional nickname for the recipient (max 127 characters)

## Response `200`

OK

- ResponseRecipientResponse
  - `id` string, required: Unique identifier of the recipient
  - `name_check` ResponseRecipientNameCheck
    - `name_matched` boolean, required: Indicates whether the name provided by the user matches the name on the recipient's account
    - `resolved_name` string: Name resolved from the recipient account details. Filled only when the provided name partially matches the name on the recipient's account
  - `payment_details` ResponseRecipientPaymentDetailsResponse[]: Payment details of the recipient
    - `ach` ResponseRecipientPaymentDetailsAch
      - `account_number` string, required: Account number of the recipient bank account
      - `bank_name` string: Name of the bank of the recipient
      - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
        - `city` string, required: City of the recipient's legal address
        - `country` string, required: Country of the recipient's legal address
        - `line1` string, required: Street address of the recipient's legal address
        - `line2` string: Additional street address information of the recipient's legal address
        - `state` string: State of the recipient's legal address
        - `zip_code` string, required: Postal code of the recipient's legal address
      - `routing_number` string, required: Routing number of the recipient bank account
    - `bi_fast` ResponseRecipientPaymentDetailsBiFast
      - `account_number` string: Account number of the recipient
      - `bank_code` string: Bank code
      - `bank_name` string: Name of the bank
      - `destination_country` string: Destination country code
      - `recipient_name` string: Name of the recipient
    - `card` ResponseRecipientPaymentDetailsCard
      - `card_id` string, required: Card id of the recipient card
      - `card_pan_last` string, required: Last 4 digits of recipient's card number
    - `crypto` ResponseRecipientPaymentDetailsCrypto
      - `address` string, required: Address of the recipient crypto wallet
      - `network` string, required: Network to use for the payment
    - `currencies` string[], required: List of currencies that the recipient can accept
    - `faster_payment` ResponseRecipientPaymentDetailsFasterPayment
      - `account_number` string, required: Account number of the recipient bank account
      - `sort_code` string, required: Sort code of the recipient bank account
    - `fps_hk` ResponseRecipientPaymentDetailsFpsHk
      - `bank_code` string: Bank code
      - `fps_id` string: FPS ID of the recipient
      - `fps_id_type` string: Type of FPS ID (MOBILE, EMAIL, FPS_ID)
      - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
        - `city` string, required: City of the recipient's legal address
        - `country` string, required: Country of the recipient's legal address
        - `line1` string, required: Street address of the recipient's legal address
        - `line2` string: Additional street address information of the recipient's legal address
        - `state` string: State of the recipient's legal address
        - `zip_code` string, required: Postal code of the recipient's legal address
      - `recipient_name` string: Name of the recipient
    - `id` string, required: Unique identifier of the recipient details
    - `imps` ResponseRecipientPaymentDetailsImps
      - `account_number` string: Account number of the recipient
      - `bank_name` string: Name of the bank
      - `destination_country` string: Destination country code
      - `ifsc_code` string: IFSC code of the bank
      - `recipient_name` string: Name of the recipient
    - `instapay` ResponseRecipientPaymentDetailsInstapay
      - `account_number` string: Account number of the recipient
      - `bank_code` string: Bank code
      - `bank_name` string: Name of the bank
      - `destination_country` string: Destination country code
      - `recipient_name` string: Name of the recipient
    - `ipp` ResponseRecipientPaymentDetailsIpp
      - `bank_name` string: Name of the bank
      - `destination_country` string: Destination country code
      - `iban` string: IBAN of the recipient
      - `recipient_name` string: Name of the recipient
    - `nip` ResponseRecipientPaymentDetailsNip
      - `account_number` string: Account number of the recipient
      - `bank_code` string: Bank code
      - `bank_name` string: Name of the bank
      - `destination_country` string: Destination country code
      - `recipient_name` string: Name of the recipient
    - `pix` ResponseRecipientPaymentDetailsPix
      - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
        - `city` string, required: City of the recipient's legal address
        - `country` string, required: Country of the recipient's legal address
        - `line1` string, required: Street address of the recipient's legal address
        - `line2` string: Additional street address information of the recipient's legal address
        - `state` string: State of the recipient's legal address
        - `zip_code` string, required: Postal code of the recipient's legal address
      - `pix_key` string: PIX key of the recipient
      - `pix_key_type` string: Type of PIX key (CPF, CNPJ, EMAIL, PHONE, EVP)
      - `recipient_id_number` string: Recipient ID number (CPF or CNPJ)
      - `recipient_name` string: Name of the recipient
    - `pse` ResponseRecipientPaymentDetailsPse
      - `account_number` string: Account number of the recipient
      - `account_type` string: Account type (SAVINGS, CHECKING)
      - `bank_code` string: Bank code
      - `destination_country` string: Destination country code
      - `document_number` string: Document number
      - `document_type` string: Document type (CC, NIT, CE, PASSPORT)
      - `recipient_name` string: Name of the recipient
    - `sepa` ResponseRecipientPaymentDetailsSepa
      - `bic` string, required: BIC of the recipient bank account
      - `iban` string, required: IBAN of the recipient bank account
    - `spei` ResponseRecipientPaymentDetailsSpei
      - `clabe` string, required: CLABE of the recipient bank account
      - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
        - `city` string, required: City of the recipient's legal address
        - `country` string, required: Country of the recipient's legal address
        - `line1` string, required: Street address of the recipient's legal address
        - `line2` string: Additional street address information of the recipient's legal address
        - `state` string: State of the recipient's legal address
        - `zip_code` string, required: Postal code of the recipient's legal address
      - `recipient_id_number` string: Recipient ID number (CURP or RFC)
    - `swift` ResponseRecipientPaymentDetailsSwift
      - `bank_country` string: Country of the recipient's bank
      - `bank_name` string: Name of the recipient's bank
      - `bic` string, required: BIC of the recipient bank account
      - `iban` string, required: IBAN of the recipient bank account
      - `legal_address` ResponseRecipientPaymentDetailsLegalAddress
        - `city` string, required: City of the recipient's legal address
        - `country` string, required: Country of the recipient's legal address
        - `line1` string, required: Street address of the recipient's legal address
        - `line2` string: Additional street address information of the recipient's legal address
        - `state` string: State of the recipient's legal address
        - `zip_code` string, required: Postal code of the recipient's legal address
    - `type` 'Crypto' | 'Sepa' | 'FasterPayment' | 'Ach' | 'Swift' | 'Spei' | 'Card' | 'Pix' | 'FpsHk' | 'Imps' | 'Instapay' | 'BiFast' | 'Nip' | 'Ipp' | 'Pse', required
  - `personal_info` ResponseRecipientPersonalInfo, required
    - `company_name` string: Name of the company/business this recipient is for (<span style="color:red">WOULD</span> be provided if the recipient is a **business**)
    - `first_name` string: First name of the recipient (<span style="color:red">WOULD</span> be provided if the recipient is a **person**)
    - `is_business` boolean, required: Indicator of whether the recipient is a business
    - `last_name` string: Last name of the recipient (<span style="color:red">WOULD</span> be provided if the recipient is a **person**)
    - `nick_name` string: Optional nickname for the recipient

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/wirexapp/apis/wirex-corporate-baas-api.md) - [All operations](https://skmtc.dev/wirexapp/apis/wirex-corporate-baas-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wirexapp/apis/wirex-corporate-baas-api/revisions/6525bfbc8f99?raw)