---
updatedAt: 2026-08-16T05:24:11.000Z
agentTools:
projectIndex: https://docs.wirexapp.com/llms.txt
---
# Update payment details
Updates existing payment details for existing recipient
# OpenAPI definition
```json
{
"components": {
"schemas": {
"request.RecipientDetailsType": {
"enum": [
"Crypto",
"Sepa",
"FasterPayment",
"Ach",
"Swift",
"Spei",
"Card",
"Pix",
"FpsHk",
"Imps",
"Instapay",
"BiFast",
"Nip",
"Ipp",
"Pse"
],
"type": "string",
"x-enum-varnames": [
"RecipientDetailsTypeCrypto",
"RecipientDetailsTypeSepa",
"RecipientDetailsTypeFasterPayment",
"RecipientDetailsTypeAch",
"RecipientDetailsTypeSwift",
"RecipientDetailsTypeSpei",
"RecipientDetailsTypeCard",
"RecipientDetailsTypePix",
"RecipientDetailsTypeFpsHk",
"RecipientDetailsTypeImps",
"RecipientDetailsTypeInstapay",
"RecipientDetailsTypeBiFast",
"RecipientDetailsTypeNip",
"RecipientDetailsTypeIpp",
"RecipientDetailsTypePse"
]
},
"request.RecipientPaymentDetailsAch": {
"properties": {
"account_number": {
"description": "Account number of the recipient bank account",
"example": "123456789",
"type": "string"
},
"bank_name": {
"description": "Bank name of the recipient",
"example": "Bank of America",
"type": "string"
},
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
},
"routing_number": {
"description": "Routing number of the recipient bank account",
"example": "123456789",
"type": "string"
}
},
"required": [
"account_number",
"legal_address",
"routing_number"
],
"type": "object"
},
"request.RecipientPaymentDetailsBiFast": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"bank_code": {
"description": "Bank code",
"example": "014",
"type": "string"
},
"bank_name": {
"description": "Name of the bank",
"example": "Bank Central Asia",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "ID",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"required": [
"account_number",
"bank_code",
"destination_country",
"recipient_name"
],
"type": "object"
},
"request.RecipientPaymentDetailsCard": {
"properties": {
"card_id": {
"description": "Card id of the recipient",
"example": "wirex_abc123",
"type": "string"
},
"card_pan_last": {
"description": "Last 4 digits of recipient's card number",
"example": "1234",
"type": "string"
}
},
"required": [
"card_id",
"card_pan_last"
],
"type": "object"
},
"request.RecipientPaymentDetailsCrypto": {
"properties": {
"address": {
"description": "Address of the recipient crypto wallet",
"example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"type": "string"
},
"network": {
"description": "Network to use for the payment",
"example": "Arbitrum",
"type": "string"
}
},
"required": [
"address",
"network"
],
"type": "object"
},
"request.RecipientPaymentDetailsFasterPayment": {
"properties": {
"account_number": {
"description": "Account number of the recipient bank account",
"example": "12345678",
"type": "string"
},
"sort_code": {
"description": "Sort code of the recipient bank account",
"example": "123456",
"type": "string"
}
},
"required": [
"account_number",
"sort_code"
],
"type": "object"
},
"request.RecipientPaymentDetailsFpsHk": {
"properties": {
"bank_code": {
"description": "Bank code",
"example": "004",
"type": "string"
},
"fps_id": {
"description": "FPS ID of the recipient",
"example": "1234567890",
"type": "string"
},
"fps_id_type": {
"description": "Type of FPS ID (MOBILE, EMAIL, FPS_ID)",
"example": "MOBILE",
"type": "string"
},
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"required": [
"bank_code",
"fps_id",
"fps_id_type",
"legal_address",
"recipient_name"
],
"type": "object"
},
"request.RecipientPaymentDetailsImps": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"bank_name": {
"description": "Name of the bank",
"example": "HDFC Bank",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "IN",
"type": "string"
},
"ifsc_code": {
"description": "IFSC code of the bank",
"example": "HDFC0001234",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"required": [
"account_number",
"destination_country",
"ifsc_code",
"recipient_name"
],
"type": "object"
},
"request.RecipientPaymentDetailsInstapay": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"bank_code": {
"description": "Bank code",
"example": "BDO",
"type": "string"
},
"bank_name": {
"description": "Name of the bank",
"example": "BDO Unibank",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "PH",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"required": [
"account_number",
"bank_code",
"destination_country",
"recipient_name"
],
"type": "object"
},
"request.RecipientPaymentDetailsIpp": {
"properties": {
"bank_name": {
"description": "Name of the bank",
"example": "Emirates NBD",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "AE",
"type": "string"
},
"iban": {
"description": "IBAN of the recipient",
"example": "AE070331234567890123456",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"required": [
"destination_country",
"iban",
"recipient_name"
],
"type": "object"
},
"request.RecipientPaymentDetailsLegalAddress": {
"properties": {
"city": {
"description": "City of the recipient",
"example": "New York",
"type": "string"
},
"country": {
"description": "Country of the recipient",
"example": "US",
"type": "string"
},
"line1": {
"description": "Street address of the recipient",
"example": "123 Main St",
"type": "string"
},
"line2": {
"description": "Additional arbitrary address line of the recipient",
"example": "Apt 4B",
"type": "string"
},
"state": {
"description": "State or province of the recipient",
"example": "NY",
"type": "string"
},
"zip_code": {
"description": "Postal code of the recipient",
"example": "10001",
"type": "string"
}
},
"required": [
"city",
"country",
"line1",
"zip_code"
],
"type": "object"
},
"request.RecipientPaymentDetailsNip": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"bank_code": {
"description": "Bank code",
"example": "044",
"type": "string"
},
"bank_name": {
"description": "Name of the bank",
"example": "Access Bank",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "NG",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"required": [
"account_number",
"bank_code",
"destination_country",
"recipient_name"
],
"type": "object"
},
"request.RecipientPaymentDetailsPix": {
"properties": {
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
},
"pix_key": {
"description": "PIX key of the recipient",
"example": "email@example.com",
"type": "string"
},
"pix_key_type": {
"description": "Type of PIX key (CPF, CNPJ, EMAIL, PHONE, EVP)",
"example": "EMAIL",
"type": "string"
},
"recipient_id_number": {
"description": "Recipient ID number (CPF or CNPJ)",
"example": "12345678901",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"required": [
"legal_address",
"pix_key",
"pix_key_type",
"recipient_id_number",
"recipient_name"
],
"type": "object"
},
"request.RecipientPaymentDetailsPse": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"account_type": {
"description": "Account type (SAVINGS, CHECKING)",
"example": "SAVINGS",
"type": "string"
},
"bank_code": {
"description": "Bank code",
"example": "007",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "CO",
"type": "string"
},
"document_number": {
"description": "Document number",
"example": "1234567890",
"type": "string"
},
"document_type": {
"description": "Document type (CC, NIT, CE, PASSPORT)",
"example": "CC",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"required": [
"account_number",
"account_type",
"bank_code",
"destination_country",
"document_number",
"document_type",
"recipient_name"
],
"type": "object"
},
"request.RecipientPaymentDetailsSepa": {
"properties": {
"bic": {
"description": "BIC of the recipient bank account",
"example": "COBADEFF",
"type": "string"
},
"iban": {
"description": "IBAN of the recipient bank account",
"example": "DE89370400440532013000",
"type": "string"
}
},
"required": [
"bic",
"iban"
],
"type": "object"
},
"request.RecipientPaymentDetailsSpei": {
"properties": {
"clabe": {
"description": "CLABE of the recipient bank account",
"example": "002123456789012345",
"type": "string"
},
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
},
"recipient_id_number": {
"description": "Recipient ID number (CURP or RFC)",
"example": "GAAR850101HDFRRL09",
"type": "string"
}
},
"required": [
"clabe",
"legal_address",
"recipient_id_number"
],
"type": "object"
},
"request.RecipientPaymentDetailsSwift": {
"properties": {
"bank_country": {
"description": "Country of the recipient's bank",
"example": "DE",
"type": "string"
},
"bank_name": {
"description": "Name of the recipient's bank",
"example": "Deutsche Bank",
"type": "string"
},
"bic": {
"description": "BIC of the recipient bank account",
"example": "COBADEFF",
"type": "string"
},
"iban": {
"description": "IBAN of the recipient bank account",
"example": "DE89370400440532013000",
"type": "string"
},
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
}
},
"required": [
"bank_country",
"bank_name",
"bic",
"iban",
"legal_address"
],
"type": "object"
},
"request.RecipientUpdateDetailsRequestBody": {
"properties": {
"ach": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsAch"
}
],
"description": "Payment details for ACH payments (MUST be provided if the **type** is **Ach**)"
},
"bi_fast": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsBiFast"
}
],
"description": "Payment details for BI-FAST payments (MUST be provided if the **type** is **BiFast**)"
},
"card": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsCard"
}
],
"description": "Payment details for card payments (MUST be provided if the **type** is **Card**)"
},
"crypto": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsCrypto"
}
],
"description": "Payment details for crypto payments (MUST be provided if the **type** is **Crypto**)"
},
"currencies": {
"description": "List of currencies that the recipient can accept",
"example": [
"EUR",
"USDT"
],
"items": {
"type": "string"
},
"type": "array"
},
"faster_payments": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsFasterPayment"
}
],
"description": "Payment details for FasterPayment payments (MUST be provided if the **type** is **FasterPayment**)"
},
"fps_hk": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsFpsHk"
}
],
"description": "Payment details for FPS Hong Kong payments (MUST be provided if the **type** is **FpsHk**)"
},
"imps": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsImps"
}
],
"description": "Payment details for IMPS payments (MUST be provided if the **type** is **Imps**)"
},
"instapay": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsInstapay"
}
],
"description": "Payment details for InstaPay payments (MUST be provided if the **type** is **Instapay**)"
},
"ipp": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsIpp"
}
],
"description": "Payment details for IPP payments (MUST be provided if the **type** is **Ipp**)"
},
"nip": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsNip"
}
],
"description": "Payment details for NIP payments (MUST be provided if the **type** is **Nip**)"
},
"pix": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsPix"
}
],
"description": "Payment details for PIX payments (MUST be provided if the **type** is **Pix**)"
},
"pse": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsPse"
}
],
"description": "Payment details for PSE payments (MUST be provided if the **type** is **Pse**)"
},
"sepa": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsSepa"
}
],
"description": "Payment details for SEPA payments (MUST be provided if **type** recipient is **Sepa**)"
},
"spei": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsSpei"
}
],
"description": "Payment details for SPEI payments (MUST be provided if the **type** is **SPEI**)"
},
"swift": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientPaymentDetailsSwift"
}
],
"description": "Payment details for SWIFT payments (MUST be provided if the **type** is **Swift**)"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/request.RecipientDetailsType"
}
],
"description": "Type of the payment details",
"example": "Sepa"
}
},
"required": [
"currencies",
"type"
],
"type": "object"
},
"response.ErrorCategory": {
"properties": {
"category": {
"type": "string"
},
"grpc_status_code": {
"type": "integer"
},
"http_status_code": {
"type": "integer"
}
},
"type": "object"
},
"response.ErrorDetails": {
"properties": {
"details": {
"type": "string"
},
"key": {
"type": "string"
}
},
"type": "object"
},
"response.ErrorReason": {
"properties": {
"reason": {
"type": "string"
}
},
"type": "object"
},
"response.ErrorResponse": {
"properties": {
"error_category": {
"$ref": "#/components/schemas/response.ErrorCategory"
},
"error_description": {
"type": "string"
},
"error_details": {
"items": {
"$ref": "#/components/schemas/response.ErrorDetails"
},
"type": "array"
},
"error_reason": {
"$ref": "#/components/schemas/response.ErrorReason"
}
},
"type": "object"
},
"response.RecipientDetailsType": {
"enum": [
"Crypto",
"Sepa",
"FasterPayment",
"Ach",
"Swift",
"Spei",
"Card",
"Pix",
"FpsHk",
"Imps",
"Instapay",
"BiFast",
"Nip",
"Ipp",
"Pse"
],
"type": "string",
"x-enum-varnames": [
"RecipientDetailsTypeCrypto",
"RecipientDetailsTypeSepa",
"RecipientDetailsTypeFasterPayment",
"RecipientDetailsTypeAch",
"RecipientDetailsTypeSwift",
"RecipientDetailsTypeSpei",
"RecipientDetailsTypeCard",
"RecipientDetailsTypePix",
"RecipientDetailsTypeFpsHk",
"RecipientDetailsTypeImps",
"RecipientDetailsTypeInstapay",
"RecipientDetailsTypeBiFast",
"RecipientDetailsTypeNip",
"RecipientDetailsTypeIpp",
"RecipientDetailsTypePse"
]
},
"response.RecipientPaymentDetailsAch": {
"properties": {
"account_number": {
"description": "Account number of the recipient bank account",
"example": "123456789",
"type": "string"
},
"bank_name": {
"description": "Name of the bank of the recipient",
"example": "Bank of America",
"type": "string"
},
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
},
"routing_number": {
"description": "Routing number of the recipient bank account",
"example": "123456789",
"type": "string"
}
},
"required": [
"account_number",
"routing_number"
],
"type": "object"
},
"response.RecipientPaymentDetailsBiFast": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"bank_code": {
"description": "Bank code",
"example": "014",
"type": "string"
},
"bank_name": {
"description": "Name of the bank",
"example": "Bank Central Asia",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "ID",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"type": "object"
},
"response.RecipientPaymentDetailsCard": {
"properties": {
"card_id": {
"description": "Card id of the recipient card",
"example": "wirex_123456789",
"type": "string"
},
"card_pan_last": {
"description": "Last 4 digits of recipient's card number",
"example": "1234",
"type": "string"
}
},
"required": [
"card_id",
"card_pan_last"
],
"type": "object"
},
"response.RecipientPaymentDetailsCrypto": {
"properties": {
"address": {
"description": "Address of the recipient crypto wallet",
"example": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"type": "string"
},
"network": {
"description": "Network to use for the payment",
"example": "Arbitrum",
"type": "string"
}
},
"required": [
"address",
"network"
],
"type": "object"
},
"response.RecipientPaymentDetailsFasterPayment": {
"properties": {
"account_number": {
"description": "Account number of the recipient bank account",
"example": "12345678",
"type": "string"
},
"sort_code": {
"description": "Sort code of the recipient bank account",
"example": "123456",
"type": "string"
}
},
"required": [
"account_number",
"sort_code"
],
"type": "object"
},
"response.RecipientPaymentDetailsFpsHk": {
"properties": {
"bank_code": {
"description": "Bank code",
"example": "004",
"type": "string"
},
"fps_id": {
"description": "FPS ID of the recipient",
"example": "1234567890",
"type": "string"
},
"fps_id_type": {
"description": "Type of FPS ID (MOBILE, EMAIL, FPS_ID)",
"example": "MOBILE",
"type": "string"
},
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"type": "object"
},
"response.RecipientPaymentDetailsImps": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"bank_name": {
"description": "Name of the bank",
"example": "HDFC Bank",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "IN",
"type": "string"
},
"ifsc_code": {
"description": "IFSC code of the bank",
"example": "HDFC0001234",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"type": "object"
},
"response.RecipientPaymentDetailsInstapay": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"bank_code": {
"description": "Bank code",
"example": "BDO",
"type": "string"
},
"bank_name": {
"description": "Name of the bank",
"example": "BDO Unibank",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "PH",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"type": "object"
},
"response.RecipientPaymentDetailsIpp": {
"properties": {
"bank_name": {
"description": "Name of the bank",
"example": "Emirates NBD",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "AE",
"type": "string"
},
"iban": {
"description": "IBAN of the recipient",
"example": "AE070331234567890123456",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"type": "object"
},
"response.RecipientPaymentDetailsLegalAddress": {
"properties": {
"city": {
"description": "City of the recipient's legal address",
"example": "Los Angeles",
"type": "string"
},
"country": {
"description": "Country of the recipient's legal address",
"example": "US",
"type": "string"
},
"line1": {
"description": "Street address of the recipient's legal address",
"example": "123 Main St",
"type": "string"
},
"line2": {
"description": "Additional street address information of the recipient's legal address",
"example": "Suite 456",
"type": "string"
},
"state": {
"description": "State of the recipient's legal address",
"example": "CA",
"type": "string"
},
"zip_code": {
"description": "Postal code of the recipient's legal address",
"example": "12345",
"type": "string"
}
},
"required": [
"city",
"country",
"line1",
"zip_code"
],
"type": "object"
},
"response.RecipientPaymentDetailsNip": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"bank_code": {
"description": "Bank code",
"example": "044",
"type": "string"
},
"bank_name": {
"description": "Name of the bank",
"example": "Access Bank",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "NG",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"type": "object"
},
"response.RecipientPaymentDetailsPix": {
"properties": {
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
},
"pix_key": {
"description": "PIX key of the recipient",
"example": "email@example.com",
"type": "string"
},
"pix_key_type": {
"description": "Type of PIX key (CPF, CNPJ, EMAIL, PHONE, EVP)",
"example": "EMAIL",
"type": "string"
},
"recipient_id_number": {
"description": "Recipient ID number (CPF or CNPJ)",
"example": "12345678901",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"type": "object"
},
"response.RecipientPaymentDetailsPse": {
"properties": {
"account_number": {
"description": "Account number of the recipient",
"example": "1234567890",
"type": "string"
},
"account_type": {
"description": "Account type (SAVINGS, CHECKING)",
"example": "SAVINGS",
"type": "string"
},
"bank_code": {
"description": "Bank code",
"example": "007",
"type": "string"
},
"destination_country": {
"description": "Destination country code",
"example": "CO",
"type": "string"
},
"document_number": {
"description": "Document number",
"example": "1234567890",
"type": "string"
},
"document_type": {
"description": "Document type (CC, NIT, CE, PASSPORT)",
"example": "CC",
"type": "string"
},
"recipient_name": {
"description": "Name of the recipient",
"example": "John Doe",
"type": "string"
}
},
"type": "object"
},
"response.RecipientPaymentDetailsResponse": {
"properties": {
"ach": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsAch"
}
],
"description": "Payment details for ACH payments"
},
"bi_fast": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsBiFast"
}
],
"description": "Payment details for BiFast payments"
},
"card": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsCard"
}
],
"description": "Payment details for card payments"
},
"crypto": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsCrypto"
}
],
"description": "Payment details for crypto payments"
},
"currencies": {
"description": "List of currencies that the recipient can accept",
"example": [
"EUR",
"USDT"
],
"items": {
"type": "string"
},
"type": "array"
},
"faster_payment": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsFasterPayment"
}
],
"description": "Payment details for FasterPayment payments"
},
"fps_hk": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsFpsHk"
}
],
"description": "Payment details for FpsHk payments"
},
"id": {
"description": "Unique identifier of the recipient details",
"example": "00000000-0000-0000-0000-000000000001",
"type": "string"
},
"imps": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsImps"
}
],
"description": "Payment details for Imps payments"
},
"instapay": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsInstapay"
}
],
"description": "Payment details for Instapay payments"
},
"ipp": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsIpp"
}
],
"description": "Payment details for Ipp payments"
},
"nip": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsNip"
}
],
"description": "Payment details for Nip payments"
},
"pix": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsPix"
}
],
"description": "Payment details for Pix payments"
},
"pse": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsPse"
}
],
"description": "Payment details for Pse payments"
},
"sepa": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsSepa"
}
],
"description": "Payment details for SEPA payments"
},
"spei": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsSpei"
}
],
"description": "Payment details for SPEI payments"
},
"swift": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsSwift"
}
],
"description": "Payment details for SWIFT payments"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientDetailsType"
}
],
"description": "Type of the payment details",
"example": "Sepa"
}
},
"required": [
"currencies",
"id",
"type"
],
"type": "object"
},
"response.RecipientPaymentDetailsSepa": {
"properties": {
"bic": {
"description": "BIC of the recipient bank account",
"example": "COBADEFF",
"type": "string"
},
"iban": {
"description": "IBAN of the recipient bank account",
"example": "DE89370400440532013000",
"type": "string"
}
},
"required": [
"bic",
"iban"
],
"type": "object"
},
"response.RecipientPaymentDetailsSpei": {
"properties": {
"clabe": {
"description": "CLABE of the recipient bank account",
"example": "002123456789012345",
"type": "string"
},
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
},
"recipient_id_number": {
"description": "Recipient ID number (CURP or RFC)",
"example": "GAAR850101HDFRRL09",
"type": "string"
}
},
"required": [
"clabe"
],
"type": "object"
},
"response.RecipientPaymentDetailsSwift": {
"properties": {
"bank_country": {
"description": "Country of the recipient's bank",
"example": "DE",
"type": "string"
},
"bank_name": {
"description": "Name of the recipient's bank",
"example": "Deutsche Bank",
"type": "string"
},
"bic": {
"description": "BIC of the recipient bank account",
"example": "COBADEFF",
"type": "string"
},
"iban": {
"description": "IBAN of the recipient bank account",
"example": "DE89370400440532013000",
"type": "string"
},
"legal_address": {
"allOf": [
{
"$ref": "#/components/schemas/response.RecipientPaymentDetailsLegalAddress"
}
],
"description": "Legal address of the recipient"
}
},
"required": [
"bic",
"iban"
],
"type": "object"
}
},
"securitySchemes": {
"WirexPayCorpToken": {
"description": "Self-signed JWT token that can be obtained by logging in to the Wirex Corporate platform using its own authorization APIs.",
"in": "header",
"name": "Authorization",
"type": "apiKey"
}
}
},
"info": {
"contact": {
"email": "company@wirexpaychain.com",
"name": "API Support Team"
},
"description": "The **Wirex Corporate API** provides businesses with a seamless way to manage corporate finances using blockchain technology. It supports corporate registration, KYB verification, employee onboarding, corporate card issuance, and SEPA/ACH bank transfers—all without direct fiat interaction. Transactions are executed directly from a **non-custodial crypto account**, ensuring security, transparency, and full control over funds.",
"title": "Wirex Corporate BaaS API",
"version": "1.0"
},
"openapi": "3.0.3",
"paths": {
"/api/v1/recipients/{recipientId}/payment_details/{paymentDetailsId}": {
"put": {
"description": "Updates existing payment details for existing recipient",
"parameters": [
{
"description": "Unique identifier of the payment details on which the operation is to be performed",
"in": "path",
"name": "paymentDetailsId",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Unique identifier of the recipient on which the operation is to be performed",
"in": "path",
"name": "recipientId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/request.RecipientUpdateDetailsRequestBody"
}
}
},
"description": "Body data",
"required": true,
"x-originalParamName": "bodyData"
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/response.RecipientPaymentDetailsResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/response.ErrorResponse"
}
}
},
"description": "Bad Request"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/response.ErrorResponse"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"WirexPayCorpToken": [
"su",
"su:transaction",
"w:transaction"
]
}
],
"summary": "Update payment details",
"tags": [
"Recipients"
]
}
}
},
"servers": [
{
"url": "https://api-business.wirexapp.com"
},
{
"url": "https://api-corporate.wirexpaychain.tech"
}
],
"tags": [
{
"description": "The **Recipient APIs** provide a powerful interface for managing recipients and their payment details within a corporate environment. It enables seamless integration between fiat and crypto payout infrastructures, ensuring precise and compliant value transfers.\n\n### Key Features:\n\n- **Unified Recipient Management**:\n - Create and maintain recipient profiles for individuals and businesses with full support for KYC-aligned data structures.\n - Associate multiple payment methods per recipient to support complex disbursement needs.\n\n- **Multi-Rail Payment Details Support**:\n - Add, update, and manage multiple payment methods per recipient, including SEPA, SWIFT, ACH, Faster Payments, cards, and crypto addresses.\n - Enforces field requirements dynamically based on payment method and recipient type.\n\n- **Searchable & Scalable**:\n - Query recipients by name, currency, type, or catalog ID.\n - Optimized for high-volume use cases such as payroll, treasury, affiliate, and reward payouts.\n\n- **Built-in Format & Compliance Checks**:\n - Enforces formatting and structure rules for IBANs, BICs, sort codes, routing numbers, PANs, and more.\n - Reduces manual QA and ensures readiness for downstream processing.\n\n---\n\nThe Recipient API is designed for fintech platforms that require precision, speed, and flexibility in managing payees. Whether you're sending funds on-chain or off-chain, this section ensures your recipients are always payout-ready.",
"name": "Recipients"
}
],
"x-readme": {}
}
```