POST api/Merchant/v1/InitiatePurchaseProcess

Method initiates the payment process and returns URL to forward end customer.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
purchaseData	Purchase data (M)	PurchaseData	None.
OrganizationCode		string	None.
UserName		string	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

{
  "purchaseData": {
    "PurchaseType": 0,
    "PaymentProviderId": "ed15c8c5-394f-484c-aa4d-e2be44e12578",
    "PaymentProviderPurchaseNumber": "sample string 2",
    "MerchantPurchaseNumber": "sample string 3",
    "Merchant": {
      "CompanyId": "sample string 1",
      "Name": "sample string 2",
      "WebSite": "sample string 3",
      "DisplayName": "sample string 4",
      "SupportPhone": "sample string 5",
      "SupportEmail": "sample string 6",
      "ContactFirstName": "sample string 7",
      "ContactName": "sample string 8"
    },
    "Customer": {
      "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"
    },
    "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
      }
    ],
    "ReturnUrls": {
      "SuccessUrl": "sample string 1",
      "UpdateUrl": "sample string 2",
      "FailureUrl": "sample string 3",
      "ErrorUrl": "sample string 4",
      "CancelUrl": "sample string 5",
      "CallbackUrl": "sample string 6"
    },
    "Description": "sample string 4",
    "PaymentReference": "sample string 5",
    "IsInstantDelivery": true,
    "DeliveredAutomaticallyAfterDays": 7,
    "InvoiceReferenceNumber": "sample string 8",
    "CostPoolCode": "sample string 9",
    "BuyerNote": "sample string 10",
    "SellerNote": "sample string 11",
    "BuyerReference": "sample string 12",
    "SellerReference": "sample string 13",
    "InvoicingMetod": 0
  },
  "OrganizationCode": "sample string 1",
  "UserName": "sample string 2",
  "Password": "sample string 3"
}

application/xml, text/xml

Sample:

<InitiatePurchaseProcessRequest 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 1</OrganizationCode>
  <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</Password>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</UserName>
  <purchaseData>
    <BuyerNote>sample string 10</BuyerNote>
    <BuyerReference>sample string 12</BuyerReference>
    <CostPoolCode>sample string 9</CostPoolCode>
    <Customer>
      <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>
    </Customer>
    <DeliveredAutomaticallyAfterDays>7</DeliveredAutomaticallyAfterDays>
    <Description>sample string 4</Description>
    <InvoiceReferenceNumber>sample string 8</InvoiceReferenceNumber>
    <InvoicingMetod>Default</InvoicingMetod>
    <IsInstantDelivery>true</IsInstantDelivery>
    <Merchant>
      <CompanyId>sample string 1</CompanyId>
      <ContactFirstName>sample string 7</ContactFirstName>
      <ContactName>sample string 8</ContactName>
      <DisplayName>sample string 4</DisplayName>
      <Name>sample string 2</Name>
      <SupportEmail>sample string 6</SupportEmail>
      <SupportPhone>sample string 5</SupportPhone>
      <WebSite>sample string 3</WebSite>
    </Merchant>
    <MerchantPurchaseNumber>sample string 3</MerchantPurchaseNumber>
    <PaymentProviderId>ed15c8c5-394f-484c-aa4d-e2be44e12578</PaymentProviderId>
    <PaymentProviderPurchaseNumber>sample string 2</PaymentProviderPurchaseNumber>
    <PaymentReference>sample string 5</PaymentReference>
    <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>
    <PurchaseType>Consumer</PurchaseType>
    <ReturnUrls>
      <CallbackUrl>sample string 6</CallbackUrl>
      <CancelUrl>sample string 5</CancelUrl>
      <ErrorUrl>sample string 4</ErrorUrl>
      <FailureUrl>sample string 3</FailureUrl>
      <SuccessUrl>sample string 1</SuccessUrl>
      <UpdateUrl>sample string 2</UpdateUrl>
    </ReturnUrls>
    <SellerNote>sample string 11</SellerNote>
    <SellerReference>sample string 13</SellerReference>
  </purchaseData>
</InitiatePurchaseProcessRequest>

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

Response Information

Resource Description

InitiatePurchaseProcessReply

Name	Type	Additional information
Reply	PurchaseReply	None.
Ok	boolean	None.
ErrorMessage	string	None.
ErrorCode	string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Reply": {
    "Id": "5499d633-0f13-4dac-818b-7cd601b0c9c3",
    "PurchaseProcessUrl": "sample string 2",
    "Status": 0
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<InitiatePurchaseProcessReply 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>
    <Id>5499d633-0f13-4dac-818b-7cd601b0c9c3</Id>
    <PurchaseProcessUrl>sample string 2</PurchaseProcessUrl>
    <Status>Ok</Status>
  </Reply>
</InitiatePurchaseProcessReply>