digitaluapi

<back to all web services

PayFastWebHook

The following routes are available for this service:
POST/payfast/webhook/{PublicAccessGuid}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PayFastWebHook:
    m_payment_id: Optional[str] = None
    pf_payment_id: Optional[str] = None
    payment_status: Optional[str] = None
    item_name: Optional[str] = None
    item_description: Optional[str] = None
    amount_gross: float = 0.0
    amount_fee: float = 0.0
    amount_net: float = 0.0
    custom_str1: Optional[str] = None
    custom_str2: Optional[str] = None
    custom_str3: Optional[str] = None
    custom_str4: Optional[str] = None
    custom_str5: Optional[str] = None
    custom_int1: int = 0
    custom_int2: int = 0
    custom_int3: int = 0
    custom_int4: int = 0
    custom_int5: int = 0
    name_first: Optional[str] = None
    name_last: Optional[str] = None
    email_address: Optional[str] = None
    merchant_id: Optional[str] = None
    signature: Optional[str] = None
    token: Optional[str] = None
    billing_date: datetime.datetime = datetime.datetime(1, 1, 1)
    public_access_guid: Optional[str] = None
    sandbox: bool = False

Python PayFastWebHook DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"m_payment_id":"String","pf_payment_id":"String","payment_status":"String","item_name":"String","item_description":"String","amount_gross":0,"amount_fee":0,"amount_net":0,"custom_str1":"String","custom_str2":"String","custom_str3":"String","custom_str4":"String","custom_str5":"String","custom_int1":0,"custom_int2":0,"custom_int3":0,"custom_int4":0,"custom_int5":0,"name_first":"String","name_last":"String","email_address":"String","merchant_id":"String","signature":"String","token":"String","billing_date":"0001-01-01T00:00:00.0000000","PublicAccessGuid":"00000000000000000000000000000000","Sandbox":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}