POST api/paynearme/order-change

Request Information

URI Parameters

None.

Body Parameters

OrderChangeRequest
NameDescriptionTypeAdditional information
timestamp

string

None.

agent

string

None.

origin

string

None.

site_customer_identifier

string

None.

site_order_identifier

string

None.

payee_identifier

string

None.

pnm_order_identifier

string

None.

version

string

None.

site_identifier

string

None.

signature

string

None.

change_event

ChangeEvent

None.

auto_pay_json

AutoPayJson

None.

one_time_pay_json

Collection of AutoPayJson

None.

Request Formats

application/json, text/json

Sample:
{
  "timestamp": "sample string 1",
  "agent": "sample string 2",
  "origin": "sample string 3",
  "site_customer_identifier": "sample string 4",
  "site_order_identifier": "sample string 5",
  "payee_identifier": "sample string 6",
  "pnm_order_identifier": "sample string 7",
  "version": "sample string 8",
  "site_identifier": "sample string 9",
  "signature": "sample string 10",
  "change_event": {
    "name": "sample string 1",
    "context": "sample string 2",
    "change_by_agent_id": "sample string 3",
    "change_by_agent_email": "sample string 4",
    "consumer_email": "sample string 5"
  },
  "auto_pay_json": {
    "date": "sample string 1",
    "end_date": "sample string 2",
    "means": "sample string 3",
    "amount": "sample string 4",
    "status": "sample string 5",
    "created": "sample string 6",
    "canceled": "sample string 7",
    "frequency": "sample string 8",
    "agent_name": "sample string 9",
    "identifier": "sample string 10",
    "payment_type": "sample string 11",
    "duration_type": "sample string 12",
    "number_of_payments_skipped": 13,
    "number_of_payments_completed": 14
  },
  "one_time_pay_json": [
    {
      "date": "sample string 1",
      "end_date": "sample string 2",
      "means": "sample string 3",
      "amount": "sample string 4",
      "status": "sample string 5",
      "created": "sample string 6",
      "canceled": "sample string 7",
      "frequency": "sample string 8",
      "agent_name": "sample string 9",
      "identifier": "sample string 10",
      "payment_type": "sample string 11",
      "duration_type": "sample string 12",
      "number_of_payments_skipped": 13,
      "number_of_payments_completed": 14
    },
    {
      "date": "sample string 1",
      "end_date": "sample string 2",
      "means": "sample string 3",
      "amount": "sample string 4",
      "status": "sample string 5",
      "created": "sample string 6",
      "canceled": "sample string 7",
      "frequency": "sample string 8",
      "agent_name": "sample string 9",
      "identifier": "sample string 10",
      "payment_type": "sample string 11",
      "duration_type": "sample string 12",
      "number_of_payments_skipped": 13,
      "number_of_payments_completed": 14
    }
  ]
}

application/xml, text/xml

Sample:
<OrderChangeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Automatrix.DMS.Business.Entities.Models.PayNearMe.OrderChangeCallback">
  <Agent>sample string 2</Agent>
  <AutoPayJson>
    <AgentName>sample string 9</AgentName>
    <Amount>sample string 4</Amount>
    <Canceled>sample string 7</Canceled>
    <Ceated>sample string 6</Ceated>
    <Date>sample string 1</Date>
    <DurationType>sample string 12</DurationType>
    <EndDate>sample string 2</EndDate>
    <Frequency>sample string 8</Frequency>
    <Identifier>sample string 10</Identifier>
    <Means>sample string 3</Means>
    <NumberOfPaymentsCompleted>14</NumberOfPaymentsCompleted>
    <NumberOfPaymentsSkipped>13</NumberOfPaymentsSkipped>
    <PaymentType>sample string 11</PaymentType>
    <Status>sample string 5</Status>
  </AutoPayJson>
  <ChangeEvent>
    <ChangeByAgentEmail>sample string 4</ChangeByAgentEmail>
    <ChangeByAgentId>sample string 3</ChangeByAgentId>
    <ConsumerEmail>sample string 5</ConsumerEmail>
    <Context>sample string 2</Context>
    <Name>sample string 1</Name>
  </ChangeEvent>
  <OneTimePayJson>
    <AutoPayJson>
      <AgentName>sample string 9</AgentName>
      <Amount>sample string 4</Amount>
      <Canceled>sample string 7</Canceled>
      <Ceated>sample string 6</Ceated>
      <Date>sample string 1</Date>
      <DurationType>sample string 12</DurationType>
      <EndDate>sample string 2</EndDate>
      <Frequency>sample string 8</Frequency>
      <Identifier>sample string 10</Identifier>
      <Means>sample string 3</Means>
      <NumberOfPaymentsCompleted>14</NumberOfPaymentsCompleted>
      <NumberOfPaymentsSkipped>13</NumberOfPaymentsSkipped>
      <PaymentType>sample string 11</PaymentType>
      <Status>sample string 5</Status>
    </AutoPayJson>
    <AutoPayJson>
      <AgentName>sample string 9</AgentName>
      <Amount>sample string 4</Amount>
      <Canceled>sample string 7</Canceled>
      <Ceated>sample string 6</Ceated>
      <Date>sample string 1</Date>
      <DurationType>sample string 12</DurationType>
      <EndDate>sample string 2</EndDate>
      <Frequency>sample string 8</Frequency>
      <Identifier>sample string 10</Identifier>
      <Means>sample string 3</Means>
      <NumberOfPaymentsCompleted>14</NumberOfPaymentsCompleted>
      <NumberOfPaymentsSkipped>13</NumberOfPaymentsSkipped>
      <PaymentType>sample string 11</PaymentType>
      <Status>sample string 5</Status>
    </AutoPayJson>
  </OneTimePayJson>
  <Origin>sample string 3</Origin>
  <PayeeIdentifier>sample string 6</PayeeIdentifier>
  <PnmOrderIdentifier>sample string 7</PnmOrderIdentifier>
  <Signature>sample string 10</Signature>
  <SiteCustomerIdentifier>sample string 4</SiteCustomerIdentifier>
  <SiteIdentifier>sample string 9</SiteIdentifier>
  <SiteOrderIdentifier>sample string 5</SiteOrderIdentifier>
  <Timestamp>sample string 1</Timestamp>
  <Version>sample string 8</Version>
</OrderChangeRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderChangeRequest'

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.