digitaluapi

<back to all web services

PayFastWebHook

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

export class PayFastWebHook
{
    // @DataMember(Name="m_payment_id")
    public m_payment_id: string;

    // @DataMember(Name="pf_payment_id")
    public pf_payment_id: string;

    // @DataMember(Name="payment_status")
    public payment_status: string;

    // @DataMember(Name="item_name")
    public item_name: string;

    // @DataMember(Name="item_description")
    public item_description: string;

    // @DataMember(Name="amount_gross")
    public amount_gross: number;

    // @DataMember(Name="amount_fee")
    public amount_fee: number;

    // @DataMember(Name="amount_net")
    public amount_net: number;

    // @DataMember(Name="custom_str1")
    public custom_str1: string;

    // @DataMember(Name="custom_str2")
    public custom_str2: string;

    // @DataMember(Name="custom_str3")
    public custom_str3: string;

    // @DataMember(Name="custom_str4")
    public custom_str4: string;

    // @DataMember(Name="custom_str5")
    public custom_str5: string;

    // @DataMember(Name="custom_int1")
    public custom_int1: number;

    // @DataMember(Name="custom_int2")
    public custom_int2: number;

    // @DataMember(Name="custom_int3")
    public custom_int3: number;

    // @DataMember(Name="custom_int4")
    public custom_int4: number;

    // @DataMember(Name="custom_int5")
    public custom_int5: number;

    // @DataMember(Name="name_first")
    public name_first: string;

    // @DataMember(Name="name_last")
    public name_last: string;

    // @DataMember(Name="email_address")
    public email_address: string;

    // @DataMember(Name="merchant_id")
    public merchant_id: string;

    // @DataMember(Name="signature")
    public signature: string;

    // @DataMember(Name="token")
    public token: string;

    // @DataMember(Name="billing_date")
    public billing_date: string;

    public PublicAccessGuid: string;
    public Sandbox: boolean;

    public constructor(init?: Partial<PayFastWebHook>) { (Object as any).assign(this, init); }
}

TypeScript 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/" />