POST api/package/FawryWebhookNotification

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserId	integer	None.
PackageId	integer	None.
TransactionId	string	None.
header	FawryHeaderDto	None.
body	FawryBodyDto	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "PackageId": 2,
  "TransactionId": "sample string 3",
  "header": {
    "requestUuid": "sample string 1",
    "messageCode": "sample string 2",
    "userName": "sample string 3",
    "password": "sample string 4",
    "serverTimestamp": "sample string 5",
    "type": "sample string 6",
    "status": {
      "statusCode": 1,
      "statusDesc": "sample string 2",
      "hostStatusCode": 3,
      "hostStatusDesc": "sample string 4"
    }
  },
  "body": {
    "fawryReference": "sample string 1",
    "amount": 2.0,
    "currency": "sample string 3",
    "fees": 4.1,
    "btc": "sample string 5",
    "serviceProvider": "sample string 6",
    "paymentOption": "sample string 7",
    "clientTerminalSequenceID": "sample string 8",
    "signature": "sample string 9",
    "transactionType": "sample string 10",
    "printReceipt": true,
    "balance": 12.1,
    "receiptInfo": {
      "authId": "sample string 1",
      "effDt": "sample string 2",
      "receiptNumber": "sample string 3",
      "rrn": "sample string 4",
      "merchantId": "sample string 5",
      "terminalId": "sample string 6",
      "acquirerBankId": "sample string 7",
      "pinMode": "sample string 8",
      "authMethod": "sample string 9",
      "paymentNetwork": "sample string 10",
      "senderNumber": "sample string 11",
      "tips": 12.1,
      "convenienceFees": 13.1,
      "cardInfo": {
        "cardHolderName": "sample string 1",
        "cardAcctId": "sample string 2",
        "issuerBankId": "sample string 3",
        "cardScheme": "sample string 4",
        "appID": "sample string 5",
        "appName": "sample string 6"
      },
      "installmentPlan": {}
    },
    "discount": {
      "amount": "sample string 1",
      "usedCode": "sample string 2",
      "description": "sample string 3"
    },
    "promo": {}
  }
}

application/xml, text/xml

Sample:

<FawryWebhookNotificationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MYLERZ.Base.DTO.PaymentGatewayDto.Fawry">
  <PackageId>2</PackageId>
  <TransactionId>sample string 3</TransactionId>
  <UserId>1</UserId>
  <body>
    <amount>2</amount>
    <balance>12.1</balance>
    <btc>sample string 5</btc>
    <clientTerminalSequenceID>sample string 8</clientTerminalSequenceID>
    <currency>sample string 3</currency>
    <discount>
      <amount>sample string 1</amount>
      <description>sample string 3</description>
      <usedCode>sample string 2</usedCode>
    </discount>
    <fawryReference>sample string 1</fawryReference>
    <fees>4.1</fees>
    <paymentOption>sample string 7</paymentOption>
    <printReceipt>true</printReceipt>
    <promo />
    <receiptInfo>
      <acquirerBankId>sample string 7</acquirerBankId>
      <authId>sample string 1</authId>
      <authMethod>sample string 9</authMethod>
      <cardInfo>
        <appID>sample string 5</appID>
        <appName>sample string 6</appName>
        <cardAcctId>sample string 2</cardAcctId>
        <cardHolderName>sample string 1</cardHolderName>
        <cardScheme>sample string 4</cardScheme>
        <issuerBankId>sample string 3</issuerBankId>
      </cardInfo>
      <convenienceFees>13.1</convenienceFees>
      <effDt>sample string 2</effDt>
      <installmentPlan />
      <merchantId>sample string 5</merchantId>
      <paymentNetwork>sample string 10</paymentNetwork>
      <pinMode>sample string 8</pinMode>
      <receiptNumber>sample string 3</receiptNumber>
      <rrn>sample string 4</rrn>
      <senderNumber>sample string 11</senderNumber>
      <terminalId>sample string 6</terminalId>
      <tips>12.1</tips>
    </receiptInfo>
    <serviceProvider>sample string 6</serviceProvider>
    <signature>sample string 9</signature>
    <transactionType>sample string 10</transactionType>
  </body>
  <header>
    <messageCode>sample string 2</messageCode>
    <password>sample string 4</password>
    <requestUuid>sample string 1</requestUuid>
    <serverTimestamp>sample string 5</serverTimestamp>
    <status>
      <hostStatusCode>3</hostStatusCode>
      <hostStatusDesc>sample string 4</hostStatusDesc>
      <statusCode>1</statusCode>
      <statusDesc>sample string 2</statusDesc>
    </status>
    <type>sample string 6</type>
    <userName>sample string 3</userName>
  </header>
</FawryWebhookNotificationDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DescriptiveResponseOfMobilePaymentOrderDto

Name	Type	Additional information
Value	MobilePaymentOrderDto	None.
CoreValue	string	None.
IsErrorState	boolean	None.
ErrorDescription	string	None.
ErrorMetadata	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Value": {
    "PackageId": 1,
    "CustomerPhone": "sample string 2",
    "CODAmount": 3.0,
    "PaymentLink": "sample string 4",
    "UpdatedDate": "2025-12-15T20:27:43.1020366+02:00",
    "Status": "sample string 6",
    "NotifiyMessage": "sample string 7",
    "ArNotifiyMessage": "sample string 8"
  },
  "CoreValue": "sample string 1",
  "IsErrorState": true,
  "ErrorDescription": "sample string 3",
  "ErrorMetadata": {}
}

application/xml, text/xml

Sample:

<DescriptiveResponseOfMobilePaymentOrderDtos_SlrnjSQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MYLERZ.Base.Entities">
  <CoreValue>sample string 1</CoreValue>
  <ErrorDescription>sample string 3</ErrorDescription>
  <ErrorMetadata />
  <IsErrorState>true</IsErrorState>
  <Value xmlns:d2p1="http://schemas.datacontract.org/2004/07/MYLERZ.Base.DTO.MobileDTO">
    <d2p1:ArNotifiyMessage>sample string 8</d2p1:ArNotifiyMessage>
    <d2p1:CODAmount>3</d2p1:CODAmount>
    <d2p1:CustomerPhone>sample string 2</d2p1:CustomerPhone>
    <d2p1:NotifiyMessage>sample string 7</d2p1:NotifiyMessage>
    <d2p1:PackageId>1</d2p1:PackageId>
    <d2p1:PaymentLink>sample string 4</d2p1:PaymentLink>
    <d2p1:Status>sample string 6</d2p1:Status>
    <d2p1:UpdatedDate>2025-12-15T20:27:43.1020366+02:00</d2p1:UpdatedDate>
  </Value>
</DescriptiveResponseOfMobilePaymentOrderDtos_SlrnjSQ>