API Reference

This page will help you get started receiving and processing boarding webhook notifications

Payfactory will send a webhook notification to your receiving application once an account has been approved and boarded. The body of the POST request will contain a JSON object.


🚧

Note: your webhook receiver must accept plain/text as the content-type


PropertyDescription
appIdPayfactory Application Id
typewebhook type: ApplicationApproved
timestampUTC timestamp in yyyyMMddHHmmss format
externalIdPartner supplied External identifier supplied with the application
merchantNameName of the merchant
gateway.nameName of the gateway provisioned
gateway.credentialsobject containing the specific credentials needed for the gateway being used.

Example Payload:

{
  "appId": "R6T-96J",
  "type": "ApplicationApproved",
  "message": "Success!",
  "externalId": "ABC123",
  "timestamp": "20210908163857",
  "merchantName": "test Merchant",
  "gateway": {
    "name": "Test",
    "credentials": {
      "accountId": "123456789",
      "apiAccessKey": "T8KYB4TDVET7PZ3A8V3SP4VR4C7KG07RX7TO4SCL"
    }
  }
}