POST api/CompraFull?path={path}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
path

string

Required

Body Parameters

CaptureSplitPlayments
NameDescriptionTypeAdditional information
SplitPayments

Collection of SplitPaymentsReq

None.

Request Formats

application/json, text/json

Sample:
{
  "SplitPayments": [
    {
      "SubordinateMerchantId": "sample string 1",
      "Amount": 2,
      "Fares": {
        "Mdr": 1.0,
        "Fee": 1
      }
    },
    {
      "SubordinateMerchantId": "sample string 1",
      "Amount": 2,
      "Fares": {
        "Mdr": 1.0,
        "Fee": 1
      }
    }
  ]
}

application/xml, text/xml

Sample:
<CaptureSplitPlayments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopperREST.Models">
  <SplitPayments>
    <SplitPaymentsReq>
      <Amount>2</Amount>
      <Fares>
        <Fee>1</Fee>
        <Mdr>1</Mdr>
      </Fares>
      <SubordinateMerchantId>sample string 1</SubordinateMerchantId>
    </SplitPaymentsReq>
    <SplitPaymentsReq>
      <Amount>2</Amount>
      <Fares>
        <Fee>1</Fee>
        <Mdr>1</Mdr>
      </Fares>
      <SubordinateMerchantId>sample string 1</SubordinateMerchantId>
    </SplitPaymentsReq>
  </SplitPayments>
</CaptureSplitPlayments>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BraspagCaptureResp
NameDescriptionTypeAdditional information
HTTPstatusCode

integer

None.

Status

integer

None.

ReasonCode

integer

None.

ReasonMessage

string

None.

ProviderReturnCode

string

None.

ProviderReturnMessage

string

None.

ReturnCode

string

None.

ReturnMessage

string

None.

SplitPayments

Collection of SplitPayments

None.

SplitErrors

Collection of SplitError

None.

Links

Collection of Link

None.

Response Formats

application/json, text/json

Sample:
{
  "HTTPstatusCode": 1,
  "Status": 2,
  "ReasonCode": 3,
  "ReasonMessage": "sample string 4",
  "ProviderReturnCode": "sample string 5",
  "ProviderReturnMessage": "sample string 6",
  "ReturnCode": "sample string 7",
  "ReturnMessage": "sample string 8",
  "SplitPayments": [
    {
      "SubordinateMerchantId": "sample string 1",
      "Amount": 2,
      "Fares": {
        "Mdr": 1.0,
        "Fee": 1
      },
      "Splits": [
        {
          "MerchantId": "sample string 1",
          "Amount": 2
        },
        {
          "MerchantId": "sample string 1",
          "Amount": 2
        }
      ]
    },
    {
      "SubordinateMerchantId": "sample string 1",
      "Amount": 2,
      "Fares": {
        "Mdr": 1.0,
        "Fee": 1
      },
      "Splits": [
        {
          "MerchantId": "sample string 1",
          "Amount": 2
        },
        {
          "MerchantId": "sample string 1",
          "Amount": 2
        }
      ]
    }
  ],
  "SplitErrors": [
    {
      "Code": 1,
      "Message": "sample string 2"
    },
    {
      "Code": 1,
      "Message": "sample string 2"
    }
  ],
  "Links": [
    {
      "Method": "sample string 1",
      "Rel": "sample string 2",
      "Href": "sample string 3"
    },
    {
      "Method": "sample string 1",
      "Rel": "sample string 2",
      "Href": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<BraspagCaptureResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopperREST.Models">
  <HTTPstatusCode>1</HTTPstatusCode>
  <Links>
    <Link>
      <Href>sample string 3</Href>
      <Method>sample string 1</Method>
      <Rel>sample string 2</Rel>
    </Link>
    <Link>
      <Href>sample string 3</Href>
      <Method>sample string 1</Method>
      <Rel>sample string 2</Rel>
    </Link>
  </Links>
  <ProviderReturnCode>sample string 5</ProviderReturnCode>
  <ProviderReturnMessage>sample string 6</ProviderReturnMessage>
  <ReasonCode>3</ReasonCode>
  <ReasonMessage>sample string 4</ReasonMessage>
  <ReturnCode>sample string 7</ReturnCode>
  <ReturnMessage>sample string 8</ReturnMessage>
  <SplitErrors>
    <SplitError>
      <Code>1</Code>
      <Message>sample string 2</Message>
    </SplitError>
    <SplitError>
      <Code>1</Code>
      <Message>sample string 2</Message>
    </SplitError>
  </SplitErrors>
  <SplitPayments>
    <SplitPayments>
      <Amount>2</Amount>
      <Fares>
        <Fee>1</Fee>
        <Mdr>1</Mdr>
      </Fares>
      <Splits>
        <Split>
          <Amount>2</Amount>
          <MerchantId>sample string 1</MerchantId>
        </Split>
        <Split>
          <Amount>2</Amount>
          <MerchantId>sample string 1</MerchantId>
        </Split>
      </Splits>
      <SubordinateMerchantId>sample string 1</SubordinateMerchantId>
    </SplitPayments>
    <SplitPayments>
      <Amount>2</Amount>
      <Fares>
        <Fee>1</Fee>
        <Mdr>1</Mdr>
      </Fares>
      <Splits>
        <Split>
          <Amount>2</Amount>
          <MerchantId>sample string 1</MerchantId>
        </Split>
        <Split>
          <Amount>2</Amount>
          <MerchantId>sample string 1</MerchantId>
        </Split>
      </Splits>
      <SubordinateMerchantId>sample string 1</SubordinateMerchantId>
    </SplitPayments>
  </SplitPayments>
  <Status>2</Status>
</BraspagCaptureResp>