digitaluapi

<back to all web services

PayFastWebHook

The following routes are available for this service:
POST/payfast/webhook/{PublicAccessGuid}
"use strict";
export class PayFastWebHook {
    /** @param {{m_payment_id?:string,pf_payment_id?:string,payment_status?:string,item_name?:string,item_description?:string,amount_gross?:number,amount_fee?:number,amount_net?:number,custom_str1?:string,custom_str2?:string,custom_str3?:string,custom_str4?:string,custom_str5?:string,custom_int1?:number,custom_int2?:number,custom_int3?:number,custom_int4?:number,custom_int5?:number,name_first?:string,name_last?:string,email_address?:string,merchant_id?:string,signature?:string,token?:string,billing_date?:string,PublicAccessGuid?:string,Sandbox?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    m_payment_id;
    /** @type {string} */
    pf_payment_id;
    /** @type {string} */
    payment_status;
    /** @type {string} */
    item_name;
    /** @type {string} */
    item_description;
    /** @type {number} */
    amount_gross;
    /** @type {number} */
    amount_fee;
    /** @type {number} */
    amount_net;
    /** @type {string} */
    custom_str1;
    /** @type {string} */
    custom_str2;
    /** @type {string} */
    custom_str3;
    /** @type {string} */
    custom_str4;
    /** @type {string} */
    custom_str5;
    /** @type {number} */
    custom_int1;
    /** @type {number} */
    custom_int2;
    /** @type {number} */
    custom_int3;
    /** @type {number} */
    custom_int4;
    /** @type {number} */
    custom_int5;
    /** @type {string} */
    name_first;
    /** @type {string} */
    name_last;
    /** @type {string} */
    email_address;
    /** @type {string} */
    merchant_id;
    /** @type {string} */
    signature;
    /** @type {string} */
    token;
    /** @type {string} */
    billing_date;
    /** @type {string} */
    PublicAccessGuid;
    /** @type {boolean} */
    Sandbox;
}

JavaScript 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

{}