---
title: "Updates a Payment by id"
method: PUT
path: "/Payment/{PaymentId}"
tags: ["Payment"]
---

# Updates a Payment by id

`PUT /Payment/{PaymentId}`

## Request

- Base URL: `https://yourorgsite.com/api`
- URL: `https://yourorgsite.com/api/Payment/{PaymentId}`
- Auth: OAuth 2
  - Implicit: `https://yourorgsite.com`

Updates an instance of Payment by id

## Path parameters

- `PaymentId` string, required

## Request body

- PaymentData
  - `$type` 'Asi.Soa.Commerce.DataContracts.PaymentData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.PaymentData, Asi.Contracts"
  - `AdjustedAmount` MonetaryAmountData
    - `$type` 'Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"
    - `Amount` object
    - `Currency` CurrencyData
      - `$type` 'Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"
      - `CurrencyCode` string
      - `DecimalPositions` integer
    - `IsAmountDefined` boolean
  - `Amount` MonetaryAmountData
    - `$type` 'Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"
    - `Amount` object
    - `Currency` CurrencyData
      - `$type` 'Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"
      - `CurrencyCode` string
      - `DecimalPositions` integer
    - `IsAmountDefined` boolean
  - `BatchId` string
  - `CashFinancialAccount` FinancialAccountData
    - `$type` 'Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts"
    - `GLAccount` GLAccountData
      - `$type` 'Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts"
      - `FinancialEntity` FinancialEntitySummaryData
        - `$type` 'Asi.Soa.Commerce.DataContracts.FinancialEntitySummaryData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialEntitySummaryData, Asi.Contracts"
        - `EntityCode` string
        - `FinancialEntityId` string
        - `InstituteParty` PartyReferenceData
          - `$type` 'Asi.Soa.Membership.DataContracts.PartyReferenceData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.PartyReferenceData, Asi.Contracts"
          - `Id` string
          - `IsMarkedForDelete` boolean
          - `Name` string
          - `PartyId` string
          - `Sort` string
          - `Status` PartyStatusData
            - `$type` 'Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts"
            - `ActiveStatus` 'Active' | 'Inactive' | 'Suspended' | 'Delete'
            - `Description` string
            - `Name` string
            - `PartyStatusId` string
          - `UniformId` string
        - `IsDefault` boolean
        - `Name` string
        - `UsesVatTaxation` boolean
      - `GLAccountCode` string
      - `GLAccountId` string
      - `Name` string
      - `Project` ProjectData
        - `$type` 'Asi.Soa.Commerce.DataContracts.ProjectData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.ProjectData, Asi.Contracts"
        - `Code` string
        - `FinancialEntity` FinancialEntitySummaryData
          - `$type` 'Asi.Soa.Commerce.DataContracts.FinancialEntitySummaryData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.FinancialEntitySummaryData, Asi.Contracts"
          - `EntityCode` string
          - `FinancialEntityId` string
          - `InstituteParty` PartyReferenceData
            - `$type` 'Asi.Soa.Membership.DataContracts.PartyReferenceData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.PartyReferenceData, Asi.Contracts"
            - `Id` string
            - `IsMarkedForDelete` boolean
            - `Name` string
            - `PartyId` string
            - `Sort` string
            - `Status` PartyStatusData
              - …
            - `UniformId` string
          - `IsDefault` boolean
          - `Name` string
          - `UsesVatTaxation` boolean
        - `Name` string
        - `ProjectId` string
  - `CurrencyCode` string
  - `DataVaultPaymentBatchDetailId` string
  - `Description` string
  - `FinancialEntityId` string
  - `GatewayReference` string
  - `IsReversible` boolean
  - `Note` string
  - `OriginalPaymentId` string
  - `PaymentApplications` PaymentApplicationDataCollection
    - `$type` 'Asi.Soa.Commerce.DataContracts.PaymentApplicationDataCollection, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.PaymentApplicationDataCollection, Asi.Contracts"
    - `$values` PaymentApplicationData[], required: The values for the collection
      - `$type` 'Asi.Soa.Commerce.DataContracts.PaymentApplicationData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.PaymentApplicationData, Asi.Contracts"
      - `AdjustedAmount` MonetaryAmountData
        - `$type` 'Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"
        - `Amount` object
        - `Currency` CurrencyData
          - `$type` 'Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"
          - `CurrencyCode` string
          - `DecimalPositions` integer
        - `IsAmountDefined` boolean
      - `ApplicationAmount` MonetaryAmountData
        - `$type` 'Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts"
        - `Amount` object
        - `Currency` CurrencyData
          - `$type` 'Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts"
          - `CurrencyCode` string
          - `DecimalPositions` integer
        - `IsAmountDefined` boolean
      - `Description` string
      - `InvoiceId` string
      - `InvoiceLineNumber` integer
      - `InvoiceNumber` string
      - `PaymentApplicationId` string
  - `PaymentCategory` 'Standard' | 'Reversal' | 'Refund' | 'Void'
  - `PaymentDate` string, date-time
  - `PaymentId` string
  - `PaymentMethodId` string
  - `PaymentReference` string
  - `PayorParty` PartySummaryData
    - `$type` 'Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.PartySummaryData, Asi.Contracts"
    - `CityName` string
    - `CountryName` string
    - `CountrySubEntityName` string
    - `Email` string
    - `Id` string
    - `IsMarkedForDelete` boolean
    - `IsOrganization` boolean
    - `Name` string
    - `PartyId` string
    - `Phone` string
    - `Sort` string
    - `Status` PartyStatusData
      - `$type` 'Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts"
      - `ActiveStatus` 'Active' | 'Inactive' | 'Suspended' | 'Delete'
      - `Description` string
      - `Name` string
      - `PartyStatusId` string
    - `UniformId` string
  - `ReversedOn` string, date-time
  - `Status` 'Pending' | 'Voided' | 'Paid' | 'Processed' | 'Reversed' | 'PartiallyRefunded' | 'Refunded'
  - `UpdateInformation` EntityUpdateInformationData
    - `$type` 'Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts"
    - `CreatedBy` string
    - `CreatedOn` string, date-time
    - `UpdatedBy` string
    - `UpdatedOn` string, date-time

## Response `200`

The request was successful.

---

[API](https://skmtc.dev/imis/apis/payments.md) - [All operations](https://skmtc.dev/imis/apis/payments/llms.txt) - [OpenAPI document](https://skmtc.dev/imis/apis/payments/revisions/e0669f9d110b?raw)