IMimis
Payment

Updates a Payment by id

Updates an instance of 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

Path parameters

PaymentIdstring required

Id of Payment to be Updated

Request body

$type'Asi.Soa.Commerce.DataContracts.PaymentData, Asi.Contracts' required

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

BatchIdstring
CurrencyCodestring
DataVaultPaymentBatchDetailIdstring
Descriptionstring
FinancialEntityIdstring
GatewayReferencestring
IsReversibleboolean
Notestring
OriginalPaymentIdstring
PaymentCategory'Standard' | 'Reversal' | 'Refund' | 'Void'
PaymentDatestring date-time
PaymentIdstring
PaymentMethodIdstring
PaymentReferencestring
ReversedOnstring date-time
Status'Pending' | 'Voided' | 'Paid' | 'Processed' | 'Reversed' | 'PartiallyRefunded' | 'Refunded'

Response

The request was successful.

Changes

No recorded changes to this operation across all 1 revision of this API.