POST api/Compra?path={path}&paymentId={paymentId}

Request Information

URI Parameters

Name	Description	Type	Additional information
path		string	Required
paymentId		string	Required

Body Parameters

None.

Response Information

Resource Description

BraspagCancelarResp

Name	Type	Additional 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.
Tid	string	None.
ProofOfSale	string	None.
AuthorizationCode	string	None.
Links	Collection of Link	None.
VoidSplitPayments	Collection of VoidSplitPayment	None.
Errors	Collection of CompraObject	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",
  "Tid": "sample string 9",
  "ProofOfSale": "sample string 10",
  "AuthorizationCode": "sample string 11",
  "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"
    }
  ],
  "VoidSplitPayments": [
    {
      "SubordinateMerchantId": "sample string 1",
      "VoidedAmount": 2,
      "VoidedSplits": [
        {
          "MerchantId": "sample string 1",
          "VoidedAmount": 2
        },
        {
          "MerchantId": "sample string 1",
          "VoidedAmount": 2
        }
      ]
    },
    {
      "SubordinateMerchantId": "sample string 1",
      "VoidedAmount": 2,
      "VoidedSplits": [
        {
          "MerchantId": "sample string 1",
          "VoidedAmount": 2
        },
        {
          "MerchantId": "sample string 1",
          "VoidedAmount": 2
        }
      ]
    }
  ],
  "Errors": [
    {
      "Code": 1,
      "Message": "sample string 1"
    },
    {
      "Code": 1,
      "Message": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<BraspagCancelarResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopperREST.Models">
  <AuthorizationCode>sample string 11</AuthorizationCode>
  <Errors>
    <CompraObject>
      <Code>1</Code>
      <Message>sample string 1</Message>
    </CompraObject>
    <CompraObject>
      <Code>1</Code>
      <Message>sample string 1</Message>
    </CompraObject>
  </Errors>
  <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>
  <ProofOfSale>sample string 10</ProofOfSale>
  <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>
  <Status>2</Status>
  <Tid>sample string 9</Tid>
  <VoidSplitPayments>
    <VoidSplitPayment>
      <SubordinateMerchantId>sample string 1</SubordinateMerchantId>
      <VoidedAmount>2</VoidedAmount>
      <VoidedSplits>
        <VoidedSplit>
          <MerchantId>sample string 1</MerchantId>
          <VoidedAmount>2</VoidedAmount>
        </VoidedSplit>
        <VoidedSplit>
          <MerchantId>sample string 1</MerchantId>
          <VoidedAmount>2</VoidedAmount>
        </VoidedSplit>
      </VoidedSplits>
    </VoidSplitPayment>
    <VoidSplitPayment>
      <SubordinateMerchantId>sample string 1</SubordinateMerchantId>
      <VoidedAmount>2</VoidedAmount>
      <VoidedSplits>
        <VoidedSplit>
          <MerchantId>sample string 1</MerchantId>
          <VoidedAmount>2</VoidedAmount>
        </VoidedSplit>
        <VoidedSplit>
          <MerchantId>sample string 1</MerchantId>
          <VoidedAmount>2</VoidedAmount>
        </VoidedSplit>
      </VoidedSplits>
    </VoidSplitPayment>
  </VoidSplitPayments>
</BraspagCancelarResp>