| POST | /payfast/webhook/{PublicAccessGuid} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MPaymentId | body | string | No | |
| PfPaymentId | body | string | No | |
| PaymentStatus | body | string | No | |
| ItemName | body | string | No | |
| ItemDescription | body | string | No | |
| AmountGross | body | double | No | |
| AmountFee | body | double | No | |
| AmountNet | body | double | No | |
| CustomStr1 | body | string | No | |
| CustomStr2 | body | string | No | |
| CustomStr3 | body | string | No | |
| CustomStr4 | body | string | No | |
| CustomStr5 | body | string | No | |
| CustomInt1 | body | int | No | |
| CustomInt2 | body | int | No | |
| CustomInt3 | body | int | No | |
| CustomInt4 | body | int | No | |
| CustomInt5 | body | int | No | |
| NameFirst | body | string | No | |
| NameLast | body | string | No | |
| EmailAddress | body | string | No | |
| MerchantId | body | string | No | |
| Signature | body | string | No | |
| Token | body | string | No | |
| BillingDate | body | DateTime | No | |
| PublicAccessGuid | path | Guid | No | |
| Sandbox | body | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /payfast/webhook/{PublicAccessGuid} HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PayFastWebHook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<AmountFee>0</AmountFee>
<AmountGross>0</AmountGross>
<AmountNet>0</AmountNet>
<BillingDate>0001-01-01T00:00:00</BillingDate>
<CustomInt1>0</CustomInt1>
<CustomInt2>0</CustomInt2>
<CustomInt3>0</CustomInt3>
<CustomInt4>0</CustomInt4>
<CustomInt5>0</CustomInt5>
<CustomStr1>String</CustomStr1>
<CustomStr2>String</CustomStr2>
<CustomStr3>String</CustomStr3>
<CustomStr4>String</CustomStr4>
<CustomStr5>String</CustomStr5>
<EmailAddress>String</EmailAddress>
<ItemDescription>String</ItemDescription>
<ItemName>String</ItemName>
<MPaymentId>String</MPaymentId>
<MerchantId>String</MerchantId>
<NameFirst>String</NameFirst>
<NameLast>String</NameLast>
<PaymentStatus>String</PaymentStatus>
<PfPaymentId>String</PfPaymentId>
<PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
<Sandbox>false</Sandbox>
<Signature>String</Signature>
<Token>String</Token>
</PayFastWebHook>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />