---
title: "Update Payment (Capture or Release)"
method: PUT
path: "/v3/payments/{paymentId}"
tags: ["Payments"]
---

# Update Payment (Capture or Release)

`PUT /v3/payments/{paymentId}`

Used in the Auth & Capture flow to capture full/partial amount or release the authorized amount back to the customer. Only one Capture or Release operation is allowed for each invoice.

## Path parameters

- `paymentId` string, required

## Request body

- object
  - `OperationType` 'CAPTURE' | 'RELEASE', required — Operation type to execute. Use CAPTURE to capture the authorized amount (fully or partially) or RELEASE to return the full amount to the customer.
  - `Amount` number — Amount to be captured. Required only when OperationType is CAPTURE.

## Response `200`

- object
  - `IsSuccess` boolean — Indicates if the request was successful.
  - `Message` string — Response message associated with the request.
  - `ValidationErrors` object[] — A model that contains two keys "Name" and "Error". This is used to indicate the validation result for all parameters you have sent in your request. This can have one or more items based on the invalid parameter count.
  - `Data` object — Payment details
    - `Invoice` object — Invoice information
      - `Id` string — Unique identifier of the invoice.
      - `Status` string — Current invoice status (PAID, PENDING, CANCELED).
      - `Reference` string — Invoice reference that is generated by MyFatoorah.
      - `CreationDate` string, date-time — UTC timestamp when the invoice was created.
      - `ExpirationDate` string, date-time — UTC timestamp when the invoice will expire.
      - `ExternalIdentifier` string, nullable — Optional external reference stored with the invoice.
      - `UserDefinedField` string — Custom field for additional data.
      - `MetaData` object, nullable — Optional metadata associated with the invoice.
    - `Transaction` object — Payment transaction details
      - `Id` string — Unique transaction identifier.
      - `Status` string — Payment transaction status (SUCCESS, FAILED, INPROGRESS, CANCELED, AUTHORIZE).
      - `PaymentMethod` string — Payment method used (VISA/MASTER, KNET, APPLEPAY).
      - `PaymentId` string — The payment ID that is assigned to this transaction.
      - `ReferenceId` string — The reference that is generated by the payment gateway.
      - `TrackId` string — The track number that is used to track the transaction with the gateway.
      - `AuthorizationId` string — Authorization ID from the payment gateway.
      - `TransactionDate` string, date-time — UTC timestamp when the transaction occurred.
      - `ECI` string — The ECI record of the transaction.
      - `IP` object — IP address details of the payer
        - `Address` string — IP address of the payer.
        - `Country` string — Country of the payer based on IP.
      - `Error` object — Error information if transaction failed
        - `Code` string — The MyFatoorah error code.
        - `Message` string — Error message returned by the acquirer bank/platform.
      - `Card` object — Card details used for the transaction
        - `NameOnCard` string — Cardholder name.
        - `Number` string — Masked card number (PAN).
        - `PanHash` string — Hash of the card PAN.
        - `ExpiryMonth` string — Card expiry month.
        - `ExpiryYear` string — Card expiry year.
        - `Brand` string — Card brand (VISA, Mastercard, etc.).
        - `Issuer` string — Card issuer name.
        - `IssuerCountry` string — Issuer country code.
        - `FundingMethod` string — Card funding method (credit/debit).
    - `Customer` object — Customer information
      - `Reference` string — The customer reference associated with the invoice.
      - `Name` string — Customer name.
      - `Mobile` string — Customer mobile number.
      - `Email` string — Customer email.
    - `Amount` object — Amount details of the payment
      - `BaseCurrency` string — Base currency of the invoice.
      - `ValueInBaseCurrency` string — Amount in base currency.
      - `ServiceCharge` string — Service charge applied.
      - `ServiceChargeVAT` string — VAT on the service charge.
      - `ReceivableAmount` string — Amount receivable after deductions.
      - `DisplayCurrency` string — Currency used for display.
      - `ValueInDisplayCurrency` string — Amount in display currency.
      - `PayCurrency` string — Currency used for payment.
      - `ValueInPayCurrency` string — Amount in pay currency.
    - `Suppliers` object[] — List of suppliers in case of multi-vendor transactions

---

[API](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3.md) · [All operations](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myfatoorah/myfatoorah-api-v3/revisions/994a74287a16/schema)