Updates a Payment by id

put https://yourorgsite.com/api/Payment/{PaymentId}

Updates an instance of Payment by id

Path Params

PaymentId

string

required

Id of Payment to be Updated

Body Params

Payment to be Updated

$type

string

required

Defaults to Asi.Soa.Commerce.DataContracts.PaymentData, Asi.Contracts

The DataType must be "Asi.Soa.Commerce.DataContracts.PaymentData, Asi.Contracts"

AdjustedAmount

object

Amount

object

BatchId

string

CashFinancialAccount

object

CurrencyCode

string

DataVaultPaymentBatchDetailId

string

Description

string

FinancialEntityId

string

GatewayReference

string

IsReversible

boolean

Defaults to false

OriginalPaymentId

string

PaymentApplications

object

PaymentCategory

string

Defaults to Standard

PaymentDate

date-time

PaymentId

string

PaymentMethodId

string

PaymentReference

string

PayorParty

object

ReversedOn

date-time

Status

string

Defaults to Pending

UpdateInformation

object

Response

200

The request was successful.

Language

Credentials

OAuth2


xxxxxxxxxx
73
    UpdateInformation: {$type: 'Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts'}
1
const options = {
2
  method: 'PUT',
3
  headers: {accept: 'application/json', 'content-type': 'application/json'},
4
  body: JSON.stringify({
5
    $type: 'Asi.Soa.Commerce.DataContracts.PaymentData, Asi.Contracts',
6
    AdjustedAmount: {
7
      $type: 'Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts',
8
      Currency: {$type: 'Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts'},
9
      IsAmountDefined: false
10
    },
11
    Amount: {
12
      $type: 'Asi.Soa.Core.DataContracts.MonetaryAmountData, Asi.Contracts',
13
      Currency: {$type: 'Asi.Soa.Core.DataContracts.CurrencyData, Asi.Contracts'},
14
      IsAmountDefined: false
15
    },
16
    CashFinancialAccount: {
17
      $type: 'Asi.Soa.Commerce.DataContracts.FinancialAccountData, Asi.Contracts',
18
      GLAccount: {
19
        $type: 'Asi.Soa.Commerce.DataContracts.GLAccountData, Asi.Contracts',
20
        FinancialEntity: {
21
          $type: 'Asi.Soa.Commerce.DataContracts.FinancialEntitySummaryData, Asi.Contracts',
22
          InstituteParty: {
23
            $type: 'Asi.Soa.Membership.DataContracts.PartyReferenceData, Asi.Contracts',
24
            IsMarkedForDelete: false,
25
            Status: {
26
              $type: 'Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts',
27
              ActiveStatus: 'Active'
28
            }
29
          },

Click Try It! to start a request and see the response here!