GET payment/get-order/{secretKey}?OrderId={OrderId}&LanguageId={LanguageId}&IsWriteLogSQL={IsWriteLogSQL}

Get Payment order

Request Information

URI Parameters

NameDescriptionTypeAdditional information
secretKey

The secret key.

string

Required

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.

Body Parameters

None.

Response Information

Resource Description

Return order info.

ReturnResultOfPayments
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.

Payments

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Code": 2,
  "Message": "sample string 3",
  "Value": {
    "Id": 1,
    "OrderId": "sample string 2",
    "StatusId": 3,
    "StatusName": "sample string 4",
    "Value": 5.0,
    "Description": "sample string 6",
    "CreateAt": "sample string 7",
    "PaidAt": "sample string 8",
    "ExpiresAt": "sample string 9",
    "PersonId": 10,
    "PropertyId": 11,
    "PersonIdent": "sample string 12",
    "PropertyIdent": "sample string 13"
  }
}

application/xml, text/xml

Sample:
<ReturnResultOfPaymentsOpzxWdDH 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>
    <CreateAt>sample string 7</CreateAt>
    <Description>sample string 6</Description>
    <ExpiresAt>sample string 9</ExpiresAt>
    <Id>1</Id>
    <OrderId>sample string 2</OrderId>
    <PaidAt>sample string 8</PaidAt>
    <PersonId>10</PersonId>
    <PersonIdent>sample string 12</PersonIdent>
    <PropertyId>11</PropertyId>
    <PropertyIdent>sample string 13</PropertyIdent>
    <StatusId>3</StatusId>
    <StatusName>sample string 4</StatusName>
    <Value>5</Value>
  </Value>
</ReturnResultOfPaymentsOpzxWdDH>