POST payment/update-order/{secretKey}

Update Payment order

Request Information

URI Parameters

NameDescriptionTypeAdditional information
secretKey

The secret key.

 string

Required

Body Parameters

The parameter.

UpdatePaymentOrderParameter
NameDescriptionTypeAdditional information
StatusId

Status Id of the Payment (1 = Open, 2 = Paid, 3 = Pending, 4 = Failed, 5 = Expired, 6 = Canceled, 7 = HasRefunds, 8 = HasChargebacks)

 integer

None.
PaidAt

Payment time of the Order. Input format: yyyy-MM-dd HH:mm:ss. Eg: 2020-11-25 14:30:00

 date

None.
OrderId

Order Id of the Payment

 string

None.
LanguageId

1: NL, 2: FR, 3: EN, Default value = 1

 integer

None.
IsWriteLogSQL

Write sql query for debug

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "StatusId": 1,
  "PaidAt": "2025-12-11T02:03:02.5364112+01:00",
  "OrderId": "sample string 3",
  "LanguageId": 4,
  "IsWriteLogSQL": true
}

application/xml, text/xml

Sample: 
<UpdatePaymentOrderParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmnicasaApiv3.Parameters">
  <IsWriteLogSQL>true</IsWriteLogSQL>
  <LanguageId>4</LanguageId>
  <OrderId>sample string 3</OrderId>
  <PaidAt>2025-12-11T02:03:02.5364112+01:00</PaidAt>
  <StatusId>1</StatusId>
</UpdatePaymentOrderParameter>

Response Information

Resource Description

The number of affected rows.

ReturnResultOfInt32
NameDescriptionTypeAdditional information
Success

Value = true is successful (If this value = false, then we should see Code and Message to have more info about error.)

 boolean

None.
Code

It's error code (If value = 0, it's successful)

 integer

None.
Message

It's error message (If value = empty, it's successful).

 string

None.
Value

Data which you need to get.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Code": 2,
  "Message": "sample string 3",
  "Value": 4
}

application/xml, text/xml

Sample: 
<ReturnResultOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmnicasaApiv3.Models">
  <Code>2</Code>
  <Message>sample string 3</Message>
  <Success>true</Success>
  <Value>4</Value>
</ReturnResultOfint>