> ## Documentation Index
> Fetch the complete documentation index at: https://docs.etherfuse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update payment account

> Changes the label the organization gave the account. Nothing else on an account changes through this endpoint.



## OpenAPI

````yaml openapi-v2.json PATCH /organization/{organizationId}/payment_account/{id}
openapi: 3.1.0
info:
  title: Etherfuse FX API
  description: >-
    Partner-facing ramp API, version 2: payment accounts, quotes, orders and
    webhooks.
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.sand.etherfuse.com
    description: Sandbox
security:
  - ApiKeyAuth: []
tags:
  - name: Payment Accounts
    description: >-
      Register the bank accounts and wallets that money moves from and to, and
      read their readiness per rail.
  - name: Quotes
    description: Price a transfer between two registered payment accounts.
  - name: Orders
    description: Create orders from quotes and track them.
  - name: Webhook Subscriptions
    description: Subscribe to webhook events.
  - name: Webhook Events
    description: Payloads Etherfuse sends to your webhook subscriptions.
  - name: Sandbox
    description: Endpoints that work only in sandbox, for testing.
  - name: Assets
    description: The markets and tokens a quote can use, and the balances of a wallet.
  - name: Authentication
    description: >-
      Partner JWT authentication: exchange a JWT for an access token, or launch
      a user into the app.
  - name: KYC
    description: >-
      Submit a customer's verification data, documents and questionnaire
      answers, import a verification they already passed elsewhere, and check
      where their KYC stands.
  - name: KYB
    description: Check where a business organization's KYB stands.
  - name: Lookup
    description: >-
      Public reference data: exchange rates, stablebonds, bond costs, country
      codes.
  - name: Organizations
    description: >-
      Your organization, your default partner fee, and the customer
      organizations you create.
  - name: Members
    description: >-
      The people who belong to a customer business organization and complete its
      KYB.
  - name: Statements
    description: >-
      Monthly revenue share statements for closed months, as a list or as a CSV
      or PDF download.
paths:
  /organization/{organizationId}/payment_account/{id}:
    patch:
      tags:
        - Payment Accounts
      summary: Update payment account
      description: >-
        Changes the label the organization gave the account. Nothing else on an
        account changes through this endpoint.
      operationId: v2UpdatePaymentAccount
      parameters:
        - $ref: '#/components/parameters/OrganizationId'
        - $ref: '#/components/parameters/PaymentAccountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePaymentAccountRequest'
      responses:
        '200':
          description: The updated payment account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccount'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    OrganizationId:
      name: organizationId
      in: path
      required: true
      description: >-
        The organization this call acts for: your API key's organization or one
        of its customer organizations. Any other id returns `404` `not-found`.
      schema:
        type: string
        format: uuid
    PaymentAccountId:
      name: id
      in: path
      required: true
      description: The payment account `id`.
      schema:
        type: string
        format: uuid
  schemas:
    UpdatePaymentAccountRequest:
      type: object
      required:
        - label
      properties:
        label:
          type: string
          description: The new label.
    PaymentAccount:
      type: object
      required:
        - id
        - status
        - label
        - rails
        - createdAt
      properties:
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/PaymentAccountStatus'
        label:
          type: string
          description: Your organization's name for the account.
        rails:
          type: object
          description: >-
            The rails this account can move money on, keyed by rail name (a
            `PaymentRail` value such as `spei` or `stellar`). A rail the account
            cannot move money on is absent. The account identifier you
            registered is not returned.
          additionalProperties:
            $ref: '#/components/schemas/AccountRail'
        createdAt:
          type: string
          format: date-time
      example:
        id: 3f9a2c1e-5b7d-4e8f-9a01-2b3c4d5e6f70
        status: pending
        label: Operating account
        rails:
          spei:
            currency: MXN
            source:
              isDefault: true
              status: ready
            destination:
              isDefault: true
              status: pending
        createdAt: '2026-09-28T17:04:11.482Z'
    PaymentAccountStatus:
      type: string
      enum:
        - pending
        - ready
        - rejected
        - disabled
      description: >-
        The account as a whole. `ready` when any rail direction is `ready`.
        `rejected` when every rail direction is `rejected`; register the account
        again with corrected `registrationInfo` to retry. `disabled` when we
        turned the account off; it cannot be registered or quoted. Otherwise
        `pending`. Readiness per rail and direction is in `rails`.
    AccountRail:
      type: object
      required:
        - source
        - destination
      properties:
        currency:
          type: string
          description: The fiat currency of this rail. Absent for a wallet rail.
          example: MXN
        source:
          description: >-
            The account as the source of a transfer on this rail. Null when the
            rail cannot carry money from this account.
          anyOf:
            - $ref: '#/components/schemas/RailTransferDetails'
            - type: 'null'
        destination:
          description: >-
            The account as the destination of a transfer on this rail. Null when
            the rail cannot carry money to this account.
          anyOf:
            - $ref: '#/components/schemas/RailTransferDetails'
            - type: 'null'
    Problem:
      type: object
      description: >-
        RFC 9457 problem details. Every v2 error uses this body with content
        type `application/problem+json`. `errors` is present only on
        `validation-error`. `required` and `missing` are present only on
        `registration-info-required`.
      required:
        - type
        - title
        - status
        - detail
        - instance
      properties:
        type:
          type: string
          format: uri
          description: >-
            `https://docs.etherfuse.com/ramp/v2/errors/` followed by the problem
            slug, for example
            `https://docs.etherfuse.com/ramp/v2/errors/quote-expired`. Switch on
            this value.
          example: https://docs.etherfuse.com/ramp/v2/errors/quote-expired
        title:
          type: string
          description: Short summary of the problem type.
          example: Quote expired
        status:
          type: integer
          description: The HTTP status code.
          example: 400
        detail:
          type: string
          description: Human-readable explanation of this occurrence. Do not parse it.
          example: >-
            quote 5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b has expired or does not
            exist
        instance:
          type: string
          description: Unique identifier for this occurrence. Quote it to support.
          example: >-
            tag:etherfuse.com,2026-08-28:R2-10120/0b1c2d3e-4f50-4a6b-8c7d-9e0f1a2b3c4d
        errors:
          type: array
          description: Present on `validation-error`. One entry per invalid field.
          items:
            $ref: '#/components/schemas/FieldViolation'
        required:
          type: array
          description: >-
            Present on `registration-info-required`. Every registration field
            the route requires, as JSON Pointers into the request, for example
            `#/registrationInfo/taxId`.
          items:
            type: string
        missing:
          type: array
          description: >-
            Present on `registration-info-required`. The required fields you
            must still send, as JSON Pointers into the request.
          items:
            type: string
    RailTransferDetails:
      type: object
      description: What the account can do on this rail in one direction.
      required:
        - isDefault
        - status
      properties:
        isDefault:
          type: boolean
          description: >-
            True when a quote that does not name a rail for this side uses this
            rail.
        status:
          $ref: '#/components/schemas/RouteRegistrationStatus'
        minAmount:
          type: string
          description: >-
            Minimum amount on this rail, as a decimal string in the rail's
            `currency`. Absent when we know of no minimum.
        maxAmount:
          type: string
          description: >-
            Maximum amount on this rail, as a decimal string in the rail's
            `currency`. Absent when we know of no maximum; that does not mean
            unlimited.
    FieldViolation:
      type: object
      required:
        - pointer
        - detail
      properties:
        pointer:
          type: string
          description: >-
            JSON Pointer to the field in the request, for example
            `#/accountDetails/clabe`.
          example: '#/accountDetails/clabe'
        detail:
          type: string
          description: What is wrong with the field.
          example: This field is required.
    RouteRegistrationStatus:
      type: string
      enum:
        - pending
        - ready
        - rejected
        - disabled
      description: >-
        The account's status on one rail in one direction. Only `ready` can be
        quoted.
  responses:
    InvalidRequest:
      description: >-
        `invalid-request`: a path, query or body value is malformed, or
        `pageSize` is 0 or over 100.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: >-
        `unauthorized`: the `Authorization` header is missing, not ASCII, or
        does not hold a valid API key.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    NotFound:
      description: >-
        `not-found`: your API key cannot act for this organization, or no such
        resource belongs to it.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    InternalError:
      description: >-
        `internal-error`: an unexpected error on our side. Retry with backoff,
        and quote `instance` to support if it persists.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key sent in the Authorization header, with no `Bearer` prefix.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.