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

# Update payment

> Update payment fields (CORRECTION_NEEDED only).



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/payment/{id}
openapi: 3.1.0
info:
  title: Nuvera API
  description: Nuvera Payment Platform REST API
  version: '1.0'
  contact: {}
servers:
  - url: http://localhost:45000
security: []
tags: []
paths:
  /api/v1/payment/{id}:
    patch:
      tags:
        - Payments
      summary: Update payment
      description: Update payment fields (CORRECTION_NEEDED only).
      operationId: PaymentController_update
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePaymentDto'
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentOutputDto_Output'
      security:
        - x-api-key: []
          signed-request: []
components:
  schemas:
    UpdatePaymentDto:
      type: object
      properties:
        id:
          type: string
        amount:
          type: string
        currencyCode:
          type: string
          enum:
            - USD
            - BRL
            - MXN
            - COP
            - HKD
            - CNY
            - NGN
            - KES
            - MWK
            - ZAR
            - XOF
            - XAF
            - UGX
            - TZS
            - ZMW
            - BWP
            - SGD
            - USDT
            - USDC
            - DAI
            - BTC
        internalReference:
          anyOf:
            - type: string
            - type: 'null'
        invoiceNumber:
          type: string
        purposeOfPayment:
          type: string
          minLength: 1
        memo:
          anyOf:
            - type: string
              maxLength: 64
            - type: 'null'
        documentIds:
          type: array
          items:
            type: string
      required:
        - id
    PaymentOutputDto_Output:
      type: object
      properties:
        id:
          type: string
        customerId:
          type: string
        beneficiaryId:
          type: string
        amount:
          type: string
        currencyCode:
          type: string
        internalReference:
          anyOf:
            - type: string
            - type: 'null'
        invoiceNumber:
          anyOf:
            - type: string
            - type: 'null'
        purposeOfPayment:
          type: string
        memo:
          anyOf:
            - type: string
            - type: 'null'
        paymentToken:
          anyOf:
            - type: string
            - type: 'null'
        paymentNetwork:
          anyOf:
            - type: string
            - type: 'null'
        paymentQuoteId:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
        customer:
          type: object
          properties:
            companyName:
              type: string
            status:
              type: string
            orgId:
              type: string
          required:
            - companyName
            - status
          additionalProperties: false
        beneficiary:
          type: object
          properties:
            companyName:
              type: string
            bankBic:
              type: string
            status:
              type: string
          required:
            - companyName
            - bankBic
            - status
          additionalProperties: false
        sourceFunding:
          anyOf:
            - oneOf:
                - type: object
                  properties:
                    type:
                      type: string
                      const: BANK_ACCOUNT
                    bankAccountId:
                      type: string
                    bankName:
                      type: string
                    countryCode:
                      type: string
                    currencyCode:
                      type: string
                    accountNumber:
                      anyOf:
                        - type: string
                        - type: 'null'
                    iban:
                      anyOf:
                        - type: string
                        - type: 'null'
                  required:
                    - type
                    - bankAccountId
                    - bankName
                    - countryCode
                    - currencyCode
                    - accountNumber
                    - iban
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      const: CRYPTO
                    symbol:
                      type: string
                    network:
                      anyOf:
                        - type: string
                        - type: 'null'
                    fundingStatus:
                      anyOf:
                        - type: string
                        - type: 'null'
                  required:
                    - type
                    - symbol
                    - network
                    - fundingStatus
                  additionalProperties: false
            - type: 'null'
        rail:
          anyOf:
            - type: object
              properties:
                method:
                  type: string
                countryCode:
                  type: string
              required:
                - method
                - countryCode
              additionalProperties: false
            - type: 'null'
        receiptUrl:
          anyOf:
            - type: string
            - type: 'null'
        paymentQuote:
          oneOf:
            - type: object
              properties:
                id:
                  type: string
                paymentAmount:
                  type: string
                paymentCurrencyCode:
                  type: string
                totalTarget:
                  type: string
                targetCurrencyCode:
                  type: string
                createdAt:
                  type: string
                expiresAt:
                  type: string
                usedAt:
                  anyOf:
                    - type: string
                    - type: 'null'
                priceBreakdown:
                  anyOf:
                    - type: object
                      properties:
                        payout:
                          type: object
                          properties:
                            label:
                              type: string
                              const: Payment amount
                            amountUsd:
                              type: string
                          required:
                            - label
                            - amountUsd
                          additionalProperties: false
                        platformFees:
                          type: object
                          properties:
                            feeProfileId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            feeProfileName:
                              anyOf:
                                - type: string
                                - type: 'null'
                            subtotalUsd:
                              type: string
                            lines:
                              type: array
                              items:
                                type: object
                                properties:
                                  feeRuleId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  name:
                                    type: string
                                  feeType:
                                    type: string
                                    enum:
                                      - PERCENT
                                      - FIXED
                                  feeValue:
                                    type: string
                                  baseAmountUsd:
                                    type: string
                                  rawAmountUsd:
                                    type: string
                                  minAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  maxAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  finalAmountUsd:
                                    type: string
                                  paymentSystemId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                required:
                                  - feeRuleId
                                  - name
                                  - feeType
                                  - feeValue
                                  - baseAmountUsd
                                  - rawAmountUsd
                                  - minAmountUsd
                                  - maxAmountUsd
                                  - finalAmountUsd
                                  - paymentSystemId
                                additionalProperties: false
                          required:
                            - feeProfileId
                            - feeProfileName
                            - subtotalUsd
                            - lines
                          additionalProperties: false
                        partnerFees:
                          type: object
                          properties:
                            feeProfileId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            feeProfileName:
                              anyOf:
                                - type: string
                                - type: 'null'
                            subtotalUsd:
                              type: string
                            lines:
                              type: array
                              items:
                                type: object
                                properties:
                                  feeRuleId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  name:
                                    type: string
                                  feeType:
                                    type: string
                                    enum:
                                      - PERCENT
                                      - FIXED
                                  feeValue:
                                    type: string
                                  baseAmountUsd:
                                    type: string
                                  rawAmountUsd:
                                    type: string
                                  minAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  maxAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  finalAmountUsd:
                                    type: string
                                  paymentSystemId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                required:
                                  - feeRuleId
                                  - name
                                  - feeType
                                  - feeValue
                                  - baseAmountUsd
                                  - rawAmountUsd
                                  - minAmountUsd
                                  - maxAmountUsd
                                  - finalAmountUsd
                                  - paymentSystemId
                                additionalProperties: false
                          required:
                            - feeProfileId
                            - feeProfileName
                            - subtotalUsd
                            - lines
                          additionalProperties: false
                        funding:
                          type: object
                          properties:
                            subtotalUsd:
                              type: string
                            lines:
                              type: array
                              items:
                                type: object
                                properties:
                                  feeRuleId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  name:
                                    type: string
                                  feeType:
                                    type: string
                                    enum:
                                      - PERCENT
                                      - FIXED
                                  feeValue:
                                    type: string
                                  baseAmountUsd:
                                    type: string
                                  rawAmountUsd:
                                    type: string
                                  minAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  maxAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  finalAmountUsd:
                                    type: string
                                  paymentSystemId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                required:
                                  - feeRuleId
                                  - name
                                  - feeType
                                  - feeValue
                                  - baseAmountUsd
                                  - rawAmountUsd
                                  - minAmountUsd
                                  - maxAmountUsd
                                  - finalAmountUsd
                                  - paymentSystemId
                                additionalProperties: false
                          required:
                            - subtotalUsd
                            - lines
                          additionalProperties: false
                        totals:
                          oneOf:
                            - type: object
                              properties:
                                fundingType:
                                  type: string
                                  const: CRYPTO
                                feesUsd:
                                  type: string
                                totalTarget:
                                  type: string
                                targetCurrencyCode:
                                  type: string
                                effectivePriceUsdPerToken:
                                  type: string
                                quotedTokenAmount:
                                  type: string
                              required:
                                - fundingType
                                - feesUsd
                                - totalTarget
                                - targetCurrencyCode
                                - effectivePriceUsdPerToken
                                - quotedTokenAmount
                              additionalProperties: false
                            - type: object
                              properties:
                                fundingType:
                                  type: string
                                  const: BANK_ACCOUNT
                                feesUsd:
                                  type: string
                                totalTarget:
                                  type: string
                                targetCurrencyCode:
                                  type: string
                              required:
                                - fundingType
                                - feesUsd
                                - totalTarget
                                - targetCurrencyCode
                              additionalProperties: false
                      required:
                        - payout
                        - platformFees
                        - partnerFees
                        - funding
                        - totals
                      additionalProperties: false
                    - type: 'null'
                fundingType:
                  type: string
                  const: CRYPTO
                paymentToken:
                  type: string
                  enum:
                    - USDC
                    - USDT
                paymentNetwork:
                  type: string
                  enum:
                    - ETHEREUM
                    - ETHEREUM_SEPOLIA
                    - POLYGON
                    - POLYGON_AMOY
                    - SOLANA
                    - SOLANA_DEVNET
                    - TRON
                    - TRON_NILE
                networkFeeUsd:
                  type: string
                effectivePriceUsdPerToken:
                  type: string
                quotedTokenAmount:
                  type: string
                paymentSystemId:
                  anyOf:
                    - type: string
                    - type: 'null'
              required:
                - id
                - paymentAmount
                - paymentCurrencyCode
                - totalTarget
                - targetCurrencyCode
                - createdAt
                - expiresAt
                - usedAt
                - priceBreakdown
                - fundingType
                - paymentToken
                - paymentNetwork
                - networkFeeUsd
                - effectivePriceUsdPerToken
                - quotedTokenAmount
                - paymentSystemId
              additionalProperties: false
            - type: object
              properties:
                id:
                  type: string
                paymentAmount:
                  type: string
                paymentCurrencyCode:
                  type: string
                totalTarget:
                  type: string
                targetCurrencyCode:
                  type: string
                createdAt:
                  type: string
                expiresAt:
                  type: string
                usedAt:
                  anyOf:
                    - type: string
                    - type: 'null'
                priceBreakdown:
                  anyOf:
                    - type: object
                      properties:
                        payout:
                          type: object
                          properties:
                            label:
                              type: string
                              const: Payment amount
                            amountUsd:
                              type: string
                          required:
                            - label
                            - amountUsd
                          additionalProperties: false
                        platformFees:
                          type: object
                          properties:
                            feeProfileId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            feeProfileName:
                              anyOf:
                                - type: string
                                - type: 'null'
                            subtotalUsd:
                              type: string
                            lines:
                              type: array
                              items:
                                type: object
                                properties:
                                  feeRuleId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  name:
                                    type: string
                                  feeType:
                                    type: string
                                    enum:
                                      - PERCENT
                                      - FIXED
                                  feeValue:
                                    type: string
                                  baseAmountUsd:
                                    type: string
                                  rawAmountUsd:
                                    type: string
                                  minAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  maxAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  finalAmountUsd:
                                    type: string
                                  paymentSystemId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                required:
                                  - feeRuleId
                                  - name
                                  - feeType
                                  - feeValue
                                  - baseAmountUsd
                                  - rawAmountUsd
                                  - minAmountUsd
                                  - maxAmountUsd
                                  - finalAmountUsd
                                  - paymentSystemId
                                additionalProperties: false
                          required:
                            - feeProfileId
                            - feeProfileName
                            - subtotalUsd
                            - lines
                          additionalProperties: false
                        partnerFees:
                          type: object
                          properties:
                            feeProfileId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            feeProfileName:
                              anyOf:
                                - type: string
                                - type: 'null'
                            subtotalUsd:
                              type: string
                            lines:
                              type: array
                              items:
                                type: object
                                properties:
                                  feeRuleId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  name:
                                    type: string
                                  feeType:
                                    type: string
                                    enum:
                                      - PERCENT
                                      - FIXED
                                  feeValue:
                                    type: string
                                  baseAmountUsd:
                                    type: string
                                  rawAmountUsd:
                                    type: string
                                  minAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  maxAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  finalAmountUsd:
                                    type: string
                                  paymentSystemId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                required:
                                  - feeRuleId
                                  - name
                                  - feeType
                                  - feeValue
                                  - baseAmountUsd
                                  - rawAmountUsd
                                  - minAmountUsd
                                  - maxAmountUsd
                                  - finalAmountUsd
                                  - paymentSystemId
                                additionalProperties: false
                          required:
                            - feeProfileId
                            - feeProfileName
                            - subtotalUsd
                            - lines
                          additionalProperties: false
                        funding:
                          type: object
                          properties:
                            subtotalUsd:
                              type: string
                            lines:
                              type: array
                              items:
                                type: object
                                properties:
                                  feeRuleId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  name:
                                    type: string
                                  feeType:
                                    type: string
                                    enum:
                                      - PERCENT
                                      - FIXED
                                  feeValue:
                                    type: string
                                  baseAmountUsd:
                                    type: string
                                  rawAmountUsd:
                                    type: string
                                  minAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  maxAmountUsd:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  finalAmountUsd:
                                    type: string
                                  paymentSystemId:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                required:
                                  - feeRuleId
                                  - name
                                  - feeType
                                  - feeValue
                                  - baseAmountUsd
                                  - rawAmountUsd
                                  - minAmountUsd
                                  - maxAmountUsd
                                  - finalAmountUsd
                                  - paymentSystemId
                                additionalProperties: false
                          required:
                            - subtotalUsd
                            - lines
                          additionalProperties: false
                        totals:
                          oneOf:
                            - type: object
                              properties:
                                fundingType:
                                  type: string
                                  const: CRYPTO
                                feesUsd:
                                  type: string
                                totalTarget:
                                  type: string
                                targetCurrencyCode:
                                  type: string
                                effectivePriceUsdPerToken:
                                  type: string
                                quotedTokenAmount:
                                  type: string
                              required:
                                - fundingType
                                - feesUsd
                                - totalTarget
                                - targetCurrencyCode
                                - effectivePriceUsdPerToken
                                - quotedTokenAmount
                              additionalProperties: false
                            - type: object
                              properties:
                                fundingType:
                                  type: string
                                  const: BANK_ACCOUNT
                                feesUsd:
                                  type: string
                                totalTarget:
                                  type: string
                                targetCurrencyCode:
                                  type: string
                              required:
                                - fundingType
                                - feesUsd
                                - totalTarget
                                - targetCurrencyCode
                              additionalProperties: false
                      required:
                        - payout
                        - platformFees
                        - partnerFees
                        - funding
                        - totals
                      additionalProperties: false
                    - type: 'null'
                fundingType:
                  type: string
                  const: BANK_ACCOUNT
                paymentSystemId:
                  type: string
                sourceBankAccountId:
                  type: string
              required:
                - id
                - paymentAmount
                - paymentCurrencyCode
                - totalTarget
                - targetCurrencyCode
                - createdAt
                - expiresAt
                - usedAt
                - priceBreakdown
                - fundingType
                - paymentSystemId
                - sourceBankAccountId
              additionalProperties: false
      required:
        - id
        - customerId
        - beneficiaryId
        - amount
        - currencyCode
        - internalReference
        - invoiceNumber
        - purposeOfPayment
        - memo
        - paymentToken
        - paymentNetwork
        - paymentQuoteId
        - status
        - createdAt
        - updatedAt
      additionalProperties: false
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: Nuvera API application secret key
    signed-request:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: RS256 per-request signed JWT

````