POST api/Collection/PurchasePayment

Request Information

URI Parameters

None.

Body Parameters

RqPurchasePayment
NameDescriptionTypeAdditional information
rqUUID

string

None.

operationDate

string

None.

operationNumber

string

None.

financialEntity

string

None.

channel

string

None.

serviceId

string

None.

customerId

string

None.

paymentType

string

None.

amountTotal

string

None.

check

Rq_Checks

None.

documents

Collection of Rq_Documents

None.

Request Formats

application/json, text/json

Sample:
{
  "rqUUID": "sample string 1",
  "operationDate": "sample string 2",
  "operationNumber": "sample string 3",
  "financialEntity": "sample string 4",
  "channel": "sample string 5",
  "serviceId": "sample string 6",
  "customerId": "sample string 7",
  "paymentType": "sample string 8",
  "amountTotal": "sample string 9",
  "check": {
    "checkNumber": "sample string 1",
    "financialEntity": "sample string 2"
  },
  "documents": [
    {
      "documentId": "sample string 1",
      "expirationDate": "sample string 2",
      "documentReference": "sample string 3",
      "amounts": [
        {
          "amountType": "sample string 1",
          "amount": "sample string 2"
        },
        {
          "amountType": "sample string 1",
          "amount": "sample string 2"
        }
      ]
    },
    {
      "documentId": "sample string 1",
      "expirationDate": "sample string 2",
      "documentReference": "sample string 3",
      "amounts": [
        {
          "amountType": "sample string 1",
          "amount": "sample string 2"
        },
        {
          "amountType": "sample string 1",
          "amount": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<RqPurchasePayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API_MVC.Models.WS.Request">
  <amountTotal>sample string 9</amountTotal>
  <channel>sample string 5</channel>
  <check>
    <checkNumber>sample string 1</checkNumber>
    <financialEntity>sample string 2</financialEntity>
  </check>
  <customerId>sample string 7</customerId>
  <documents>
    <Rq_Documents>
      <amounts>
        <Rq_Amount>
          <amount>sample string 2</amount>
          <amountType>sample string 1</amountType>
        </Rq_Amount>
        <Rq_Amount>
          <amount>sample string 2</amount>
          <amountType>sample string 1</amountType>
        </Rq_Amount>
      </amounts>
      <documentId>sample string 1</documentId>
      <documentReference>sample string 3</documentReference>
      <expirationDate>sample string 2</expirationDate>
    </Rq_Documents>
    <Rq_Documents>
      <amounts>
        <Rq_Amount>
          <amount>sample string 2</amount>
          <amountType>sample string 1</amountType>
        </Rq_Amount>
        <Rq_Amount>
          <amount>sample string 2</amount>
          <amountType>sample string 1</amountType>
        </Rq_Amount>
      </amounts>
      <documentId>sample string 1</documentId>
      <documentReference>sample string 3</documentReference>
      <expirationDate>sample string 2</expirationDate>
    </Rq_Documents>
  </documents>
  <financialEntity>sample string 4</financialEntity>
  <operationDate>sample string 2</operationDate>
  <operationNumber>sample string 3</operationNumber>
  <paymentType>sample string 8</paymentType>
  <rqUUID>sample string 1</rqUUID>
  <serviceId>sample string 6</serviceId>
</RqPurchasePayment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />