POST api/Merchant/v1/GetPurchase

Method returns purchase information with details.

Request Information

URI Parameters

None.

Body Parameters

GetPurchaseRequest
NameDescriptionTypeAdditional information
purchaseId

Id of purchase (M)

 globally unique identifier

None.
OrganizationCode

string

None.
UserName

string

None.
Password

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "purchaseId": "a0840fc3-cada-440e-a7bb-74ac564d8159",
  "OrganizationCode": "sample string 2",
  "UserName": "sample string 3",
  "Password": "sample string 4"
}

application/xml, text/xml

Sample: 
<GetPurchaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.Merchant">
  <OrganizationCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</OrganizationCode>
  <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Password>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</UserName>
  <purchaseId>a0840fc3-cada-440e-a7bb-74ac564d8159</purchaseId>
</GetPurchaseRequest>

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 'GetPurchaseRequest'.

Response Information

Resource Description

GetPurchaseReply
NameDescriptionTypeAdditional information
Reply

Purchase

None.
Ok

boolean

None.
ErrorMessage

string

None.
ErrorCode

string

None.
Message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Reply": {
    "Id": "86785ad3-e001-430f-85e1-e151b8d5eaa3",
    "Description": "sample string 2",
    "PurchaseDate": "2025-10-24T08:55:05.1701124+00:00",
    "PurchaseTotal": 4.0,
    "InvoicingFee": 5.0,
    "PaymentProviderPurchaseNumber": "sample string 6",
    "MerchantPurchaseNumber": "sample string 7",
    "PaymentReference": "sample string 8",
    "CustomerId": "28c899e1-4c70-4ed3-8b89-b127e3aa5ab9",
    "MerchantId": "b39be211-37c8-459e-8837-808712d64f44",
    "Merchant": {
      "Ssn": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Email": "sample string 4",
      "Phone": "sample string 5",
      "DeliveryAddressStreet": "sample string 6",
      "DeliveryAddressZip": "sample string 7",
      "DeliveryAddressCity": "sample string 8",
      "DeliveryAddressCountry": "sample string 9",
      "InvoiceAddressStreet": "sample string 10",
      "InvoiceAddressZip": "sample string 11",
      "InvoiceAddressCity": "sample string 12",
      "InvoiceAddressCountry": "sample string 13",
      "CompanyBusinessId": "sample string 14",
      "CompanyName": "sample string 15",
      "CompanyEInvoicingAddress": "sample string 16",
      "CompanyEInvoicingIntermediatorCode": "sample string 17",
      "CompanyInvoicingEmail": "sample string 18"
    },
    "PaymentProviderId": "8c522f4f-ce54-4e1c-ad3f-bfda1b5898fa",
    "PaymentProviderAccountTransactionId": "a6d7ff4a-fbc2-4d50-81b5-0f306343d04d",
    "StatusEnum": 100000000,
    "RegistrationTime": "2025-10-24T08:55:05.1701124+00:00",
    "PaymentTime": "2025-10-24T08:55:05.1701124+00:00",
    "CancelTime": "2025-10-24T08:55:05.1701124+00:00",
    "ReverseTime": "2025-10-24T08:55:05.1701124+00:00",
    "DeliveryTime": "2025-10-24T08:55:05.1701124+00:00",
    "SettlementTime": "2025-10-24T08:55:05.1701124+00:00",
    "DeliveryAddressStreet": "sample string 13",
    "DeliveryAddressZip": "sample string 14",
    "DeliveryAddressCity": "sample string 15",
    "DeliveryAddressCountry": "sample string 16",
    "InvoiceAddressStreet": "sample string 17",
    "InvoiceAddressZip": "sample string 18",
    "InvoiceAddressCity": "sample string 19",
    "InvoiceAddressCountry": "sample string 20",
    "CompanyBic": "sample string 21",
    "CompanyName": "sample string 22",
    "CompanyEInvoicingAddress": "sample string 23",
    "CompanyEInvoicingIntermediatorCode": "sample string 24",
    "InvoicingEmail": "sample string 25",
    "InvoiceReferenceNumber": "sample string 26",
    "CostPoolCode": "sample string 27",
    "BuyerNote": "sample string 28",
    "SellerNote": "sample string 29",
    "BuyerReference": "sample string 30",
    "SellerReference": "sample string 31",
    "IsLimitPurchase": true,
    "ReversedTotal": 33.0,
    "PurchaseItems": [
      {
        "Description": "sample string 1",
        "Amount": 2.0,
        "MerchantPurchaseItemNumber": "sample string 3",
        "GrossPrice": 4.0,
        "NetPrice": 5.0,
        "TaxPercentage": 6.0,
        "GrossTotal": 7.0,
        "NetTotal": 8.0,
        "ReversedTotal": 9.0,
        "CostPoolCode": "sample string 10",
        "TaxCode": "sample string 11",
        "BuyerReference": "sample string 12",
        "SellerReference": "sample string 13",
        "StatusEnum": 100000000
      },
      {
        "Description": "sample string 1",
        "Amount": 2.0,
        "MerchantPurchaseItemNumber": "sample string 3",
        "GrossPrice": 4.0,
        "NetPrice": 5.0,
        "TaxPercentage": 6.0,
        "GrossTotal": 7.0,
        "NetTotal": 8.0,
        "ReversedTotal": 9.0,
        "CostPoolCode": "sample string 10",
        "TaxCode": "sample string 11",
        "BuyerReference": "sample string 12",
        "SellerReference": "sample string 13",
        "StatusEnum": 100000000
      }
    ]
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample: 
<GetPurchaseReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.Merchant">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Message>
  <Ok xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">true</Ok>
  <Reply>
    <BuyerNote>sample string 28</BuyerNote>
    <BuyerReference>sample string 30</BuyerReference>
    <CancelTime>2025-10-24T08:55:05.1701124+00:00</CancelTime>
    <CompanyBic>sample string 21</CompanyBic>
    <CompanyEInvoicingAddress>sample string 23</CompanyEInvoicingAddress>
    <CompanyEInvoicingIntermediatorCode>sample string 24</CompanyEInvoicingIntermediatorCode>
    <CompanyName>sample string 22</CompanyName>
    <CostPoolCode>sample string 27</CostPoolCode>
    <CustomerId>28c899e1-4c70-4ed3-8b89-b127e3aa5ab9</CustomerId>
    <DeliveryAddressCity>sample string 15</DeliveryAddressCity>
    <DeliveryAddressCountry>sample string 16</DeliveryAddressCountry>
    <DeliveryAddressStreet>sample string 13</DeliveryAddressStreet>
    <DeliveryAddressZip>sample string 14</DeliveryAddressZip>
    <DeliveryTime>2025-10-24T08:55:05.1701124+00:00</DeliveryTime>
    <Description>sample string 2</Description>
    <Id>86785ad3-e001-430f-85e1-e151b8d5eaa3</Id>
    <InvoiceAddressCity>sample string 19</InvoiceAddressCity>
    <InvoiceAddressCountry>sample string 20</InvoiceAddressCountry>
    <InvoiceAddressStreet>sample string 17</InvoiceAddressStreet>
    <InvoiceAddressZip>sample string 18</InvoiceAddressZip>
    <InvoiceReferenceNumber>sample string 26</InvoiceReferenceNumber>
    <InvoicingEmail>sample string 25</InvoicingEmail>
    <InvoicingFee>5</InvoicingFee>
    <IsLimitPurchase>true</IsLimitPurchase>
    <Merchant>
      <CompanyBusinessId>sample string 14</CompanyBusinessId>
      <CompanyEInvoicingAddress>sample string 16</CompanyEInvoicingAddress>
      <CompanyEInvoicingIntermediatorCode>sample string 17</CompanyEInvoicingIntermediatorCode>
      <CompanyInvoicingEmail>sample string 18</CompanyInvoicingEmail>
      <CompanyName>sample string 15</CompanyName>
      <DeliveryAddressCity>sample string 8</DeliveryAddressCity>
      <DeliveryAddressCountry>sample string 9</DeliveryAddressCountry>
      <DeliveryAddressStreet>sample string 6</DeliveryAddressStreet>
      <DeliveryAddressZip>sample string 7</DeliveryAddressZip>
      <Email>sample string 4</Email>
      <FirstName>sample string 2</FirstName>
      <InvoiceAddressCity>sample string 12</InvoiceAddressCity>
      <InvoiceAddressCountry>sample string 13</InvoiceAddressCountry>
      <InvoiceAddressStreet>sample string 10</InvoiceAddressStreet>
      <InvoiceAddressZip>sample string 11</InvoiceAddressZip>
      <LastName>sample string 3</LastName>
      <Phone>sample string 5</Phone>
      <Ssn>sample string 1</Ssn>
    </Merchant>
    <MerchantId>b39be211-37c8-459e-8837-808712d64f44</MerchantId>
    <MerchantPurchaseNumber>sample string 7</MerchantPurchaseNumber>
    <PaymentProviderAccountTransactionId>a6d7ff4a-fbc2-4d50-81b5-0f306343d04d</PaymentProviderAccountTransactionId>
    <PaymentProviderId>8c522f4f-ce54-4e1c-ad3f-bfda1b5898fa</PaymentProviderId>
    <PaymentProviderPurchaseNumber>sample string 6</PaymentProviderPurchaseNumber>
    <PaymentReference>sample string 8</PaymentReference>
    <PaymentTime>2025-10-24T08:55:05.1701124+00:00</PaymentTime>
    <PurchaseDate>2025-10-24T08:55:05.1701124+00:00</PurchaseDate>
    <PurchaseItems>
      <PurchaseItem>
        <Amount>2</Amount>
        <BuyerReference>sample string 12</BuyerReference>
        <CostPoolCode>sample string 10</CostPoolCode>
        <Description>sample string 1</Description>
        <GrossPrice>4</GrossPrice>
        <GrossTotal>7</GrossTotal>
        <MerchantPurchaseItemNumber>sample string 3</MerchantPurchaseItemNumber>
        <NetPrice>5</NetPrice>
        <NetTotal>8</NetTotal>
        <ReversedTotal>9</ReversedTotal>
        <SellerReference>sample string 13</SellerReference>
        <StatusEnum>WaitingForPayment</StatusEnum>
        <TaxCode>sample string 11</TaxCode>
        <TaxPercentage>6</TaxPercentage>
      </PurchaseItem>
      <PurchaseItem>
        <Amount>2</Amount>
        <BuyerReference>sample string 12</BuyerReference>
        <CostPoolCode>sample string 10</CostPoolCode>
        <Description>sample string 1</Description>
        <GrossPrice>4</GrossPrice>
        <GrossTotal>7</GrossTotal>
        <MerchantPurchaseItemNumber>sample string 3</MerchantPurchaseItemNumber>
        <NetPrice>5</NetPrice>
        <NetTotal>8</NetTotal>
        <ReversedTotal>9</ReversedTotal>
        <SellerReference>sample string 13</SellerReference>
        <StatusEnum>WaitingForPayment</StatusEnum>
        <TaxCode>sample string 11</TaxCode>
        <TaxPercentage>6</TaxPercentage>
      </PurchaseItem>
    </PurchaseItems>
    <PurchaseTotal>4</PurchaseTotal>
    <RegistrationTime>2025-10-24T08:55:05.1701124+00:00</RegistrationTime>
    <ReverseTime>2025-10-24T08:55:05.1701124+00:00</ReverseTime>
    <ReversedTotal>33</ReversedTotal>
    <SellerNote>sample string 29</SellerNote>
    <SellerReference>sample string 31</SellerReference>
    <SettlementTime>2025-10-24T08:55:05.1701124+00:00</SettlementTime>
    <StatusEnum>WaitingForPayment</StatusEnum>
  </Reply>
</GetPurchaseReply>