---
updatedAt: 2025-11-19T15:03:28.000Z
agentTools:
  projectIndex: https://partner.wirexpaychain.com/llms.txt
---

# Update payment details

Updates existing payment details for existing recipient

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Wirex BaaS API",
    "description": "The **Wirex BaaS API** enables partners to deliver non-custodial financial services directly to their retail users. Through a single integration, partners can onboard users, verify identities, issue smart wallet–linked cards, and enable crypto-backed bank transfers—without ever handling fiat or taking custody of user funds.</br>All transactions are powered by **user-owned smart wallets**, ensuring security, transparency, and full user control. Wirex acts as the infrastructure provider, so you can focus on building exceptional user experiences while we handle the heavy lifting.",
    "contact": {
      "name": "API Support Team",
      "email": "company@wirexpaychain.com"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api-baas.wirexapp.tech",
      "description": "Sandbox environment"
    },
    {
      "url": "https://api-baas.wirexapp.com",
      "description": "Production environment"
    }
  ],
  "tags": [
    {
      "name": "Recipients",
      "description": "The **Recipient APIs** provides 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."
    }
  ],
  "paths": {
    "/api/v1/recipients/{recipientId}/payment_details/{paymentDetailsId}": {
      "put": {
        "tags": [
          "Recipients"
        ],
        "summary": "Update payment details",
        "description": "Updates existing payment details for existing recipient",
        "parameters": [
          {
            "name": "paymentDetailsId",
            "in": "path",
            "description": "Unique identifier of the payment details on which the operation is to be performed",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "recipientId",
            "in": "path",
            "description": "Unique identifier of the recipient on which the operation is to be performed",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Body data",
          "content": {
            "*/*": {
              "schema": {
                "$ref": "#/components/schemas/request.RecipientUpdateDetailsRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/response.EmptyResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/response.ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/response.ErrorResponse"
                }
              }
            }
          }
        },
        "x-codegen-request-body-name": "bodyData"
      }
    }
  },
  "components": {
    "schemas": {
      "request.RecipientDetailsType": {
        "type": "string",
        "enum": [
          "Crypto",
          "Sepa",
          "FasterPayment",
          "Ach",
          "Swift",
          "Spei",
          "Card"
        ],
        "x-enum-varnames": [
          "RecipientDetailsTypeCrypto",
          "RecipientDetailsTypeSepa",
          "RecipientDetailsTypeFasterPayment",
          "RecipientDetailsTypeAch",
          "RecipientDetailsTypeSwift",
          "RecipientDetailsTypeSpei",
          "RecipientDetailsTypeCard"
        ]
      },
      "request.RecipientPaymentDetailsAch": {
        "required": [
          "account_number",
          "legal_address",
          "routing_number"
        ],
        "type": "object",
        "properties": {
          "account_number": {
            "type": "string",
            "description": "Account number of the recipient bank account",
            "example": "123456789"
          },
          "bank_name": {
            "type": "string",
            "description": "Bank name of the recipient",
            "example": "Bank of America"
          },
          "legal_address": {
            "type": "object",
            "description": "Legal address of the recipient",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientPaymentDetailsLegalAddress"
              }
            ]
          },
          "routing_number": {
            "type": "string",
            "description": "Routing number of the recipient bank account",
            "example": "123456789"
          }
        }
      },
      "request.RecipientPaymentDetailsCard": {
        "required": [
          "card_number"
        ],
        "type": "object",
        "properties": {
          "card_number": {
            "type": "string",
            "description": "Cards number of the recipient",
            "example": "1234567890123456"
          }
        }
      },
      "request.RecipientPaymentDetailsCrypto": {
        "required": [
          "address",
          "network"
        ],
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "description": "Address of the recipient crypto wallet",
            "example": 9.175510568426712e+47
          },
          "network": {
            "type": "string",
            "description": "Network to use for the payment",
            "example": "Arbitrum"
          }
        }
      },
      "request.RecipientPaymentDetailsFasterPayment": {
        "required": [
          "account_number",
          "sort_code"
        ],
        "type": "object",
        "properties": {
          "account_number": {
            "type": "string",
            "description": "Account number of the recipient bank account",
            "example": "12345678"
          },
          "sort_code": {
            "type": "string",
            "description": "Sort code of the recipient bank account",
            "example": "123456"
          }
        }
      },
      "request.RecipientPaymentDetailsLegalAddress": {
        "required": [
          "city",
          "country",
          "line1",
          "zip_code"
        ],
        "type": "object",
        "properties": {
          "city": {
            "type": "string",
            "description": "City of the recipient",
            "example": "New York"
          },
          "country": {
            "type": "string",
            "description": "Country of the recipient",
            "example": "US"
          },
          "line1": {
            "type": "string",
            "description": "Street address of the recipient",
            "example": "123 Main St"
          },
          "line2": {
            "type": "string",
            "description": "Additional arbitrary address line of the recipient",
            "example": "Apt 4B"
          },
          "state": {
            "type": "string",
            "description": "State or province of the recipient",
            "example": "NY"
          },
          "zip_code": {
            "type": "string",
            "description": "Postal code of the recipient",
            "example": "10001"
          }
        }
      },
      "request.RecipientPaymentDetailsSepa": {
        "required": [
          "bic",
          "iban"
        ],
        "type": "object",
        "properties": {
          "bic": {
            "type": "string",
            "description": "BIC of the recipient bank account",
            "example": "COBADEFF"
          },
          "iban": {
            "type": "string",
            "description": "IBAN of the recipient bank account",
            "example": "DE89370400440532013000"
          }
        }
      },
      "request.RecipientPaymentDetailsSpei": {
        "required": [
          "clabe"
        ],
        "type": "object",
        "properties": {
          "clabe": {
            "type": "string",
            "description": "CLABE of the recipient bank account",
            "example": "002123456789012345"
          }
        }
      },
      "request.RecipientPaymentDetailsSwift": {
        "required": [
          "bic",
          "iban",
          "legal_address"
        ],
        "type": "object",
        "properties": {
          "bic": {
            "type": "string",
            "description": "BIC of the recipient bank account",
            "example": "COBADEFF"
          },
          "iban": {
            "type": "string",
            "description": "IBAN of the recipient bank account",
            "example": "DE89370400440532013000"
          },
          "legal_address": {
            "type": "object",
            "description": "Legal address of the recipient",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientPaymentDetailsLegalAddress"
              }
            ]
          }
        }
      },
      "request.RecipientUpdateDetailsRequestBody": {
        "required": [
          "currencies",
          "type"
        ],
        "type": "object",
        "properties": {
          "ach": {
            "type": "object",
            "description": "Payment details for ACH payments (<span style=\"color:red\">MUST</span> be provided if the **type** is **Ach**)",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientPaymentDetailsAch"
              }
            ]
          },
          "card": {
            "type": "object",
            "description": "Payment details for card payments (<span style=\"color:red\">MUST</span> be provided if the **type** is **Card**)",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientPaymentDetailsCard"
              }
            ]
          },
          "crypto": {
            "type": "object",
            "description": "Payment details for crypto payments (<span style=\"color:red\">MUST</span> be provided if the **type** is **Crypto**)",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientPaymentDetailsCrypto"
              }
            ]
          },
          "currencies": {
            "type": "array",
            "description": "List of currencies that the recipient can accept",
            "example": [
              "EUR",
              "USDT"
            ],
            "items": {
              "type": "string"
            }
          },
          "faster_payments": {
            "type": "object",
            "description": "Payment details for FasterPayment payments (<span style=\"color:red\">MUST</span> be provided if the **type** is **FasterPayment**)",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientPaymentDetailsFasterPayment"
              }
            ]
          },
          "sepa": {
            "type": "object",
            "description": "Payment details for SEPA payments (<span style=\"color:red\">MUST</span> be provided if **type** recipient is **Sepa**)",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientPaymentDetailsSepa"
              }
            ]
          },
          "spei": {
            "type": "object",
            "description": "Payment details for SPEI payments (<span style=\"color:red\">MUST</span> be provided if the **type** is **SPEI**)",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientPaymentDetailsSpei"
              }
            ]
          },
          "swift": {
            "type": "object",
            "description": "Payment details for SWIFT payments (<span style=\"color:red\">MUST</span> be provided if the **type** is **Swift**)",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientPaymentDetailsSwift"
              }
            ]
          },
          "type": {
            "type": "object",
            "description": "Type of the payment details",
            "example": "Sepa",
            "allOf": [
              {
                "$ref": "#/components/schemas/request.RecipientDetailsType"
              }
            ]
          }
        }
      },
      "response.EmptyResponse": {
        "type": "object"
      },
      "response.ErrorCategory": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string"
          },
          "grpc_status_code": {
            "type": "integer"
          },
          "http_status_code": {
            "type": "integer"
          }
        }
      },
      "response.ErrorDetails": {
        "type": "object",
        "properties": {
          "details": {
            "type": "string"
          },
          "key": {
            "type": "string"
          }
        }
      },
      "response.ErrorReason": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string"
          }
        }
      },
      "response.ErrorResponse": {
        "type": "object",
        "properties": {
          "error_category": {
            "$ref": "#/components/schemas/response.ErrorCategory"
          },
          "error_description": {
            "type": "string"
          },
          "error_details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/response.ErrorDetails"
            }
          },
          "error_reason": {
            "$ref": "#/components/schemas/response.ErrorReason"
          }
        }
      }
    },
    "securitySchemes": {
      "Auth0Token": {
        "type": "apiKey",
        "description": "Token obtained using Auth0 client credentials grant flow. Please see [Authorization](#tag/Authorization/Auth0) section",
        "name": "Authorization",
        "in": "header"
      },
      "WirexPayToken": {
        "type": "apiKey",
        "description": "Wirex issued JWT token that can be obtained by using [Login as user](#tag/User/paths/~1user~1authorize/post) endpoint",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "WirexPayToken": []
    },
    {
      "Auth0Token": []
    }
  ],
  "x-readme": {}
}
```