digitaluapi

<back to all web services

PayFastWebHook

The following routes are available for this service:
POST/payfast/webhook/{PublicAccessGuid}
PayFastWebHook Parameters:
NameParameterData TypeRequiredDescription
MPaymentIdbodystringNo
PfPaymentIdbodystringNo
PaymentStatusbodystringNo
ItemNamebodystringNo
ItemDescriptionbodystringNo
AmountGrossbodydoubleNo
AmountFeebodydoubleNo
AmountNetbodydoubleNo
CustomStr1bodystringNo
CustomStr2bodystringNo
CustomStr3bodystringNo
CustomStr4bodystringNo
CustomStr5bodystringNo
CustomInt1bodyintNo
CustomInt2bodyintNo
CustomInt3bodyintNo
CustomInt4bodyintNo
CustomInt5bodyintNo
NameFirstbodystringNo
NameLastbodystringNo
EmailAddressbodystringNo
MerchantIdbodystringNo
SignaturebodystringNo
TokenbodystringNo
BillingDatebodyDateTimeNo
PublicAccessGuidpathGuidNo
SandboxbodyboolNo

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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-01,
	PublicAccessGuid: 00000000000000000000000000000000,
	Sandbox: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}