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

# Update a payment



## OpenAPI

````yaml /api-reference/external/openapi.yaml patch /payments/{payment_id}
openapi: 3.0.3
info:
  title: PCX API
  description: >
    The PCX integration API. Every request requires two headers: `Authorization`
    (Bearer JWT for user-facing flows, or the literal string `NONE`) and
    `X-Api-Key` (your API key for server-to-server calls, or the literal string
    `NONE`). Pass `NONE` for whichever header you are not using.
  version: '1.0'
servers:
  - url: https://prod-api.pcxpay.com/v1
    description: Production
  - url: https://devs.pcxpay.com/v1
    description: Development
security: []
tags:
  - name: Payment Initiation
    description: Initiate payments and poll for status
  - name: API Keys
    description: Create and manage API keys for programmatic access
  - name: Webhooks
    description: Register endpoints and receive transaction notifications
  - name: Beneficiaries
    description: Manage payment recipients
  - name: Payments
    description: Initiate and track payments
  - name: Bank Validation
    description: Validate bank accounts before initiating a payment
  - name: Transactions
    description: Query the financial transaction ledger
  - name: Virtual Accounts
    description: Multi-currency virtual account provisioning and fund operations
  - name: Payment Links
    description: Generate shareable payment links for customer checkout
paths:
  /payments/{payment_id}:
    parameters:
      - $ref: '#/components/parameters/AuthorizationHeader'
      - $ref: '#/components/parameters/XApiKeyHeader'
    patch:
      tags:
        - Payments
      summary: Update a payment
      operationId: updatePayment
      parameters:
        - name: payment_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentUpdate'
      responses:
        '200':
          description: Updated payment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    AuthorizationHeader:
      name: Authorization
      in: header
      required: true
      description: >-
        Bearer JWT for user-facing flows (`Bearer eyJraWQ...`), or the literal
        string `NONE` when authenticating via API key.
      schema:
        type: string
        default: NONE
        example: Bearer eyJraWQ...
    XApiKeyHeader:
      name: X-Api-Key
      in: header
      required: true
      description: >-
        API key for server-to-server flows, or the literal string `NONE` when
        authenticating via JWT.
      schema:
        type: string
        default: NONE
        example: pcx_abc123_xxxx
  schemas:
    PaymentUpdate:
      type: object
      properties:
        metadata:
          type: object
        instructions:
          type: string
          nullable: true
        comments:
          type: string
          nullable: true
    PaymentResponse:
      type: object
      properties:
        payment_id:
          type: string
        amount:
          type: number
          format: float
        currency:
          type: string
        user_id:
          type: string
        status:
          $ref: '#/components/schemas/PaymentStatus'
        direction:
          $ref: '#/components/schemas/PaymentDirection'
        payment_method:
          $ref: '#/components/schemas/PaymentMethod'
        org_id:
          type: string
          nullable: true
        beneficiary_id:
          type: string
        transaction_id:
          type: string
          nullable: true
        target_amount:
          type: number
          format: float
          nullable: true
        target_currency:
          type: string
          nullable: true
        metadata:
          type: object
        instructions:
          type: string
          nullable: true
        comments:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaymentStatus:
      type: string
      enum:
        - initiated
        - reviewed
        - confirmed
        - processing
        - pending
        - completed
        - failed
        - refunded
        - rejected
        - canceled
    PaymentDirection:
      type: string
      enum:
        - inbound
        - outbound
        - external
    PaymentMethod:
      type: string
      enum:
        - bank_transfer
        - card
        - mobile_money
        - crypto
        - wallet
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
        status:
          type: string
          enum:
            - error
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'

````