POST api/Merchant/v1/ExampleCallbackEndpoint

Example end point for call back API. Payment provider should iplement this and provide Url for endpoint as CallbackUr paramenter in InitiatePurchaseProces api call. THIS IS JUST AXAMPLE IMPLEMENTATION, DO NOT USE IT AS SUCH.

Request Information

URI Parameters

None.

Body Parameters

CallbackMessage

Name	Description	Type	Additional information
PurchaseId	Id of purchase	globally unique identifier	None.
MerchantPurchaseNumber	Web store identifier of purchase	string	None.
PaymentProviderPurchaseNumber	Payment provider identifier of purchase	string	None.
StatusEnum	Status of purchase	integer	None.
StatusEnumDescription	Status description of purchase	string	None.
Message	Message related to status update	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PurchaseId": "43065195-2ed2-46fd-9a7e-5bbe5ba54991",
  "MerchantPurchaseNumber": "sample string 2",
  "PaymentProviderPurchaseNumber": "sample string 3",
  "StatusEnum": 4,
  "StatusEnumDescription": "sample string 5",
  "Message": "sample string 6"
}

application/xml, text/xml

Sample:

<CallbackMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.Merchant">
  <MerchantPurchaseNumber>sample string 2</MerchantPurchaseNumber>
  <Message>sample string 6</Message>
  <PaymentProviderPurchaseNumber>sample string 3</PaymentProviderPurchaseNumber>
  <PurchaseId>43065195-2ed2-46fd-9a7e-5bbe5ba54991</PurchaseId>
  <StatusEnum>4</StatusEnum>
  <StatusEnumDescription>sample string 5</StatusEnumDescription>
</CallbackMessage>

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

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>