--- title: "Update payment details" method: PUT path: "/api/v1/recipients/{recipientId}/payment_details/{paymentDetailsId}" tags: ["Recipients"] --- # Update payment details `PUT /api/v1/recipients/{recipientId}/payment_details/{paymentDetailsId}` ## Request - Base URL: `https://api-baas.wirexapp.com` - URL: `https://api-baas.wirexapp.com/api/v1/recipients/{recipientId}/payment_details/{paymentDetailsId}` - Auth: one of: - API key in header `Authorization` - API key in header `X-Chain-Id` and API key in header `X-User-Wallet` and API key in header `Authorization` Updates existing payment details for existing recipient ## Path parameters - `paymentDetailsId` string, required - `recipientId` string, required ## Request body `*/*` - RequestRecipientUpdateDetailsRequestBody - `ach` RequestRecipientPaymentDetailsAch - `account_number` string, required: Account number of the recipient bank account - `bank_name` string: Bank name of the recipient - `legal_address` RequestRecipientPaymentDetailsLegalAddress, required - `city` string, required: City of the recipient - `country` string, required: Country of the recipient - `line1` string, required: Street address of the recipient - `line2` string: Additional arbitrary address line of the recipient - `state` string: State or province of the recipient - `zip_code` string, required: Postal code of the recipient - `routing_number` string, required: Routing number of the recipient bank account - `bi_fast` RequestRecipientPaymentDetailsBiFast - `account_number` string, required: Account number of the recipient - `bank_code` string, required: Bank code - `bank_name` string: Name of the bank - `destination_country` string, required: Destination country code - `recipient_name` string, required: Name of the recipient - `card` RequestRecipientPaymentDetailsCard - `card_id` string, required: Card id of the recipient - `card_pan_last` string, required: Last 4 digits of recipient's card number - `cross_chain_crypto` RequestRecipientPaymentDetailsCrossChainCrypto - `address` string, required: Destination address for the cross-chain crypto transfer (non-EVM address formats are supported, e.g., Solana, Tron, Bitcoin) - `network` string, required: Network to use for the payment - `tag` string: Optional destination tag/memo (e.g., XRP destination tag, Stellar memo) - `crypto` RequestRecipientPaymentDetailsCrypto - `address` string: Deprecated: still accepted for backward compatibility, but callers should send recipient_address — this field carries the recipient destination address, which is now accepted as recipient_address. Either field may be supplied; if both are provided they must match. - `network` string, required: Network to use for the payment - `recipient_address` string: RecipientAddress is the destination address of the recipient crypto wallet. Preferred over address; either field may be supplied. - `currencies` string[], required: List of currencies that the recipient can accept - `faster_payments` RequestRecipientPaymentDetailsFasterPayment - `account_number` string, required: Account number of the recipient bank account - `sort_code` string, required: Sort code of the recipient bank account - `fps_hk` RequestRecipientPaymentDetailsFpsHk - `bank_code` string, required: Bank code - `fps_id` string, required: FPS ID of the recipient - `fps_id_type` string, required: Type of FPS ID (MOBILE, EMAIL, FPS_ID) - `legal_address` RequestRecipientPaymentDetailsLegalAddress, required - `city` string, required: City of the recipient - `country` string, required: Country of the recipient - `line1` string, required: Street address of the recipient - `line2` string: Additional arbitrary address line of the recipient - `state` string: State or province of the recipient - `zip_code` string, required: Postal code of the recipient - `recipient_name` string, required: Name of the recipient - `imps` RequestRecipientPaymentDetailsImps - `account_number` string, required: Account number of the recipient - `bank_name` string: Name of the bank - `destination_country` string, required: Destination country code - `ifsc_code` string, required: IFSC code of the bank - `recipient_name` string, required: Name of the recipient - `instapay` RequestRecipientPaymentDetailsInstapay - `account_number` string, required: Account number of the recipient - `bank_code` string, required: Bank code - `bank_name` string: Name of the bank - `destination_country` string, required: Destination country code - `recipient_name` string, required: Name of the recipient - `ipp` RequestRecipientPaymentDetailsIpp - `bank_name` string: Name of the bank - `destination_country` string, required: Destination country code - `iban` string, required: IBAN of the recipient - `recipient_name` string, required: Name of the recipient - `nip` RequestRecipientPaymentDetailsNip - `account_number` string, required: Account number of the recipient - `bank_code` string, required: Bank code - `bank_name` string: Name of the bank - `destination_country` string, required: Destination country code - `recipient_name` string, required: Name of the recipient - `pix` RequestRecipientPaymentDetailsPix - `legal_address` RequestRecipientPaymentDetailsLegalAddress, required - `city` string, required: City of the recipient - `country` string, required: Country of the recipient - `line1` string, required: Street address of the recipient - `line2` string: Additional arbitrary address line of the recipient - `state` string: State or province of the recipient - `zip_code` string, required: Postal code of the recipient - `national_id_number` string, required: National ID number of the recipient (CPF or CNPJ for PIX) - `pix_key` string, required: PIX key of the recipient - `pix_key_type` string, required: Type of PIX key (CPF, CNPJ, EMAIL, PHONE, EVP) - `recipient_name` string, required: Name of the recipient - `pse` RequestRecipientPaymentDetailsPse - `account_number` string, required: Account number of the recipient - `account_type` string, required: Account type (SAVINGS, CHECKING) - `bank_code` string, required: Bank code - `destination_country` string, required: Destination country code - `document_number` string, required: Document number - `document_type` string, required: Document type (CC, NIT, CE, PASSPORT) - `recipient_name` string, required: Name of the recipient - `sepa` RequestRecipientPaymentDetailsSepa - `bic` string, required: BIC of the recipient bank account - `iban` string, required: IBAN of the recipient bank account - `spei` RequestRecipientPaymentDetailsSpei - `clabe` string, required: CLABE of the recipient bank account - `legal_address` RequestRecipientPaymentDetailsLegalAddress, required - `city` string, required: City of the recipient - `country` string, required: Country of the recipient - `line1` string, required: Street address of the recipient - `line2` string: Additional arbitrary address line of the recipient - `state` string: State or province of the recipient - `zip_code` string, required: Postal code of the recipient - `national_id_number` string, required: National ID number of the recipient (CURP or RFC for SPEI) - `swift` RequestRecipientPaymentDetailsSwift - `bank_country` string, required: Bank country code (ISO 3166-1 alpha-2) - `bank_name` string, required: Bank name of the recipient - `bic` string, required: BIC of the recipient bank account - `iban` string, required: IBAN of the recipient bank account - `legal_address` RequestRecipientPaymentDetailsLegalAddress, required - `city` string, required: City of the recipient - `country` string, required: Country of the recipient - `line1` string, required: Street address of the recipient - `line2` string: Additional arbitrary address line of the recipient - `state` string: State or province of the recipient - `zip_code` string, required: Postal code of the recipient - `type` 'Crypto' | 'Sepa' | 'FasterPayment' | 'Ach' | 'Swift' | 'Spei' | 'Card' | 'Pix' | 'FpsHk' | 'Imps' | 'Instapay' | 'BiFast' | 'Nip' | 'Ipp' | 'Pse' | 'CrossChainCrypto', required ## Response `200` OK - ResponseRecipientPaymentDetailsResponse - `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_pan_last` string, required: Last 4 digits of recipient's card number - `cross_chain_crypto` ResponseRecipientPaymentDetailsCrossChainCrypto - `address` string, required: Destination address for the cross-chain crypto transfer (non-EVM address formats are supported, e.g., Solana, Tron, Bitcoin) - `network` string, required: Network to use for the payment - `tag` string: Optional destination tag/memo (e.g., XRP destination tag, Stellar memo) - `crypto` ResponseRecipientPaymentDetailsCrypto - `address` string, required: Deprecated: still populated for backward compatibility, but consumers should read recipient_address — this field carries the recipient destination address, which is now exposed as recipient_address. - `network` string, required: Network to use for the payment - `recipient_address` string, required: RecipientAddress is the destination address of the recipient crypto wallet. Preferred field; address mirrors the same value for backward compatibility. - `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 - `national_id_number` string: Recipient ID number (CPF or CNPJ) - `pix_key` string: PIX key of the recipient - `pix_key_type` string: Type of PIX key (CPF, CNPJ, EMAIL, PHONE, EVP) - `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 - `national_id_number` string: Recipient ID number (CURP or RFC) - `swift` ResponseRecipientPaymentDetailsSwift - `bank_country` string: Bank country code (ISO 3166-1 alpha-2) - `bank_name` string: Bank name of the recipient - `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' | 'CrossChainCrypto', required ## Other responses - `400`: Bad Request - `500`: Internal Server Error --- [API](https://skmtc.dev/wirexapp/apis/wirex-baas-api.md) - [All operations](https://skmtc.dev/wirexapp/apis/wirex-baas-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wirexapp/apis/wirex-baas-api/revisions/760446c7ebd2?raw)