digitaluapi

<back to all web services

PayFastWebHook

The following routes are available for this service:
POST/payfast/webhook/{PublicAccessGuid}
namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PayFastWebHook() = 
        [<DataMember(Name="m_payment_id")>]
        member val MPaymentId:String = null with get,set

        [<DataMember(Name="pf_payment_id")>]
        member val PfPaymentId:String = null with get,set

        [<DataMember(Name="payment_status")>]
        member val PaymentStatus:String = null with get,set

        [<DataMember(Name="item_name")>]
        member val ItemName:String = null with get,set

        [<DataMember(Name="item_description")>]
        member val ItemDescription:String = null with get,set

        [<DataMember(Name="amount_gross")>]
        member val AmountGross:Double = new Double() with get,set

        [<DataMember(Name="amount_fee")>]
        member val AmountFee:Double = new Double() with get,set

        [<DataMember(Name="amount_net")>]
        member val AmountNet:Double = new Double() with get,set

        [<DataMember(Name="custom_str1")>]
        member val CustomStr1:String = null with get,set

        [<DataMember(Name="custom_str2")>]
        member val CustomStr2:String = null with get,set

        [<DataMember(Name="custom_str3")>]
        member val CustomStr3:String = null with get,set

        [<DataMember(Name="custom_str4")>]
        member val CustomStr4:String = null with get,set

        [<DataMember(Name="custom_str5")>]
        member val CustomStr5:String = null with get,set

        [<DataMember(Name="custom_int1")>]
        member val CustomInt1:Int32 = new Int32() with get,set

        [<DataMember(Name="custom_int2")>]
        member val CustomInt2:Int32 = new Int32() with get,set

        [<DataMember(Name="custom_int3")>]
        member val CustomInt3:Int32 = new Int32() with get,set

        [<DataMember(Name="custom_int4")>]
        member val CustomInt4:Int32 = new Int32() with get,set

        [<DataMember(Name="custom_int5")>]
        member val CustomInt5:Int32 = new Int32() with get,set

        [<DataMember(Name="name_first")>]
        member val NameFirst:String = null with get,set

        [<DataMember(Name="name_last")>]
        member val NameLast:String = null with get,set

        [<DataMember(Name="email_address")>]
        member val EmailAddress:String = null with get,set

        [<DataMember(Name="merchant_id")>]
        member val MerchantId:String = null with get,set

        [<DataMember(Name="signature")>]
        member val Signature:String = null with get,set

        [<DataMember(Name="token")>]
        member val Token:String = null with get,set

        [<DataMember(Name="billing_date")>]
        member val BillingDate:DateTime = new DateTime() with get,set

        member val PublicAccessGuid:Guid = new Guid() with get,set
        member val Sandbox:Boolean = new Boolean() with get,set

F# PayFastWebHook DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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/" />