GET api/DecodedOrder?superaffiliate={superaffiliate}&reference={reference}&amountincents={amountincents}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
superaffiliate

globally unique identifier

Required

reference

string

Required

amountincents

integer

Required

Body Parameters

None.

Response Information

Resource Description

DecodedOrder
NameDescriptionTypeAdditional information
Customer

Customer

None.

Product

Product

None.

CustomerMeter

CustomerMeter

None.

CustomerMsisdn

CustomerMsisdn

None.

ProductTarget

string

None.

Response Formats

application/json, text/json

Sample:
{
  "customer": {
    "id": "c73d3add-c8ce-45ca-92cc-18c8478f7b14",
    "full-name": "sample string 2",
    "email": "sample string 3",
    "msisdn": "sample string 4",
    "password-md5": "sample string 5",
    "deliver-token-email": true,
    "deliver-token-text": true,
    "bank": 8,
    "register-date-utc": "2026-02-20T11:37:44.7672611+00:00",
    "management-affiliate-id": "628766f2-39e6-472c-985f-466999ab390d",
    "super-affiliate-collection": {
      "7c4ec92a-6303-441a-a4df-bc14a37cb3aa": "8eb1b53a-af78-4e8b-b6bf-38d5828196af",
      "f9c37ae1-561a-4ef7-8f3b-09f700f92b72": "caca6fd8-5a44-4635-a38c-dc253c4a6b58"
    },
    "administrative-affiliate-id": "921e22fd-1a08-4ae9-863a-db29a72c6135",
    "otk": "sample string 11",
    "otp": "sample string 12",
    "time-stamp": "QEA="
  },
  "product": {
    "id": "3436bbc1-8738-4019-a014-4f9abbd57700",
    "product-code-msisdn": "sample string 2",
    "product-code-suffix": "sample string 3",
    "product-code-amount-in-cents-start": 4,
    "product-code-amount-in-cents-end": 5,
    "product-code-suffix-regex": "sample string 6",
    "category-id": 7,
    "description": "sample string 8",
    "supplier-id": 9,
    "supplier-product-id": "sample string 10",
    "supplier-product-sub-id": "sample string 11",
    "supplier-commission-type-code": 12,
    "supplier-commission-factor": 13.0,
    "is-blocked": true,
    "is-blocked-reason": "sample string 15",
    "expire-date-time-utc": "2026-02-20T11:37:44.7672611+00:00",
    "order-by-index": 17
  },
  "customer-meter": {
    "id": "0e11b00f-1e9d-4b62-b1ab-56d1c290a8d7",
    "customer-id": "f6e3f79d-85be-45bb-b75f-9f3e2114030a",
    "payment-code": "sample string 3",
    "meter-number": "sample string 4",
    "description": "sample string 5",
    "status": 6,
    "receiver-id": 7,
    "time-stamp": "QEA="
  },
  "customer-msisdn": {
    "id": "8d15ddcf-0be0-4836-a0fc-1cfa321cdd97",
    "customer-id": "026462ff-bf62-48d3-9b4b-48855603b7fc",
    "msisdn": "sample string 3",
    "product-id": "97d64ff1-337d-4d32-8864-605f66e292e5",
    "status": 5,
    "time-stamp": "QEA="
  },
  "product-target": "sample string 1"
}

application/xml, text/xml

Sample:
<DecodedOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Caprica.Models">
  <Customer>
    <AdministrativeAffiliateID>921e22fd-1a08-4ae9-863a-db29a72c6135</AdministrativeAffiliateID>
    <Bank>8</Bank>
    <DeliverTokenEmail>true</DeliverTokenEmail>
    <DeliverTokenText>true</DeliverTokenText>
    <Email>sample string 3</Email>
    <FullName>sample string 2</FullName>
    <Id>c73d3add-c8ce-45ca-92cc-18c8478f7b14</Id>
    <ManagementAffiliateID>628766f2-39e6-472c-985f-466999ab390d</ManagementAffiliateID>
    <Msisdn>sample string 4</Msisdn>
    <Otk>sample string 11</Otk>
    <Otp>sample string 12</Otp>
    <PasswordMD5>sample string 5</PasswordMD5>
    <RegisterDateUtc>2026-02-20T11:37:44.7672611+00:00</RegisterDateUtc>
    <SuperAffiliateCollection xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfguidguid>
        <d3p1:Key>7c4ec92a-6303-441a-a4df-bc14a37cb3aa</d3p1:Key>
        <d3p1:Value>8eb1b53a-af78-4e8b-b6bf-38d5828196af</d3p1:Value>
      </d3p1:KeyValueOfguidguid>
      <d3p1:KeyValueOfguidguid>
        <d3p1:Key>f9c37ae1-561a-4ef7-8f3b-09f700f92b72</d3p1:Key>
        <d3p1:Value>caca6fd8-5a44-4635-a38c-dc253c4a6b58</d3p1:Value>
      </d3p1:KeyValueOfguidguid>
    </SuperAffiliateCollection>
    <TimeStamp>QEA=</TimeStamp>
  </Customer>
  <CustomerMeter>
    <CustomerId>f6e3f79d-85be-45bb-b75f-9f3e2114030a</CustomerId>
    <Description>sample string 5</Description>
    <Id>0e11b00f-1e9d-4b62-b1ab-56d1c290a8d7</Id>
    <MeterNumber>sample string 4</MeterNumber>
    <PaymentCode>sample string 3</PaymentCode>
    <ReceiverId>7</ReceiverId>
    <Status>6</Status>
    <TimeStamp>QEA=</TimeStamp>
  </CustomerMeter>
  <CustomerMsisdn>
    <CustomerId>026462ff-bf62-48d3-9b4b-48855603b7fc</CustomerId>
    <Id>8d15ddcf-0be0-4836-a0fc-1cfa321cdd97</Id>
    <Msisdn>sample string 3</Msisdn>
    <ProductId>97d64ff1-337d-4d32-8864-605f66e292e5</ProductId>
    <Status>5</Status>
    <TimeStamp>QEA=</TimeStamp>
  </CustomerMsisdn>
  <Product>
    <CategoryId>7</CategoryId>
    <Description>sample string 8</Description>
    <ExpireDateTimeUtc>2026-02-20T11:37:44.7672611+00:00</ExpireDateTimeUtc>
    <Id>3436bbc1-8738-4019-a014-4f9abbd57700</Id>
    <IsBlocked>true</IsBlocked>
    <IsBlockedReason>sample string 15</IsBlockedReason>
    <OrderByIndex>17</OrderByIndex>
    <ProductCodeAmountInCentsEnd>5</ProductCodeAmountInCentsEnd>
    <ProductCodeAmountInCentsStart>4</ProductCodeAmountInCentsStart>
    <ProductCodeMsisdn>sample string 2</ProductCodeMsisdn>
    <ProductCodeSuffix>sample string 3</ProductCodeSuffix>
    <ProductCodeSuffixRegex>sample string 6</ProductCodeSuffixRegex>
    <SupplierCommissionFactor>13</SupplierCommissionFactor>
    <SupplierCommissionTypeCode>12</SupplierCommissionTypeCode>
    <SupplierId>9</SupplierId>
    <SupplierProductId>sample string 10</SupplierProductId>
    <SupplierProductSubId>sample string 11</SupplierProductSubId>
  </Product>
  <ProductTarget>sample string 1</ProductTarget>
</DecodedOrder>