Skip to main content
Payments API Payments Webhooks Onboarding API Receivables API Receivables Webhooks Codes and messages Transfermate Education Documentation
Overview Payment Actions Payment Pending Payment Paid

Receivables Webhooks

In addition to the TransferMate Receicables service, a webhook service system is available. This is how we keep our Partners updated with the status of their clients and payment requests, and complete the round trip of information back to our users.

Payment Actions

Get Updates on the status of payments

Payment Pending

Once the client book the receivables transaction via the portal, then the Payment pending webhook will fire.

Success response Body Payload Example

The response body includes the following parameters:

Field Description Type
event_id Unique identifier for this specific webhook call Varchar
customer_id Id of customer requesting the webhook Varchar
event_code Identifier for webhook type. Varchar
event_details object which holds further details about the webhook call Varchar
Unique_Record_id Invoice id returned to the client in the Request a Payment call Varchar
description Details about the webhook call Varchar
amount Amount in transaction number
updated_at date field, when the webhook was fired Varchar
status further details about the webhook call Varchar

Example Success Response

{
    "Message": {
        "event_id": "52c62676-e40c-4888-ab6a-40f3a7c8011a",
        "customer_id": "174360",
        "event_code": "12",
        "event_details": {
            "Unique_Record_id": "16206",
            "payer_id": "4766",
            "description": "Payment_Pending",
            "amount": "1000.00",
            "updated_at": "2021-08-05 15:54:14",
            "status": "Booked - Awaiting Funds"
        }
    }
}

Error response Body Payload Example

The error response body includes the following parameters:

Field Description Type
400 Bad Request - will not trigger automatic retry attempts  
401 Unauthorised - will NOT trigger automatic retry attempt  
403 Forbidden - will NOT trigger automatic retry attempts  
404 Not Found - will NOT trigger automatic retry attempts  
500 Bad Request - will trigger automatic retry attempts  
501 Bad Request - will NOT trigger automatic retry attempts  
503 Service Unavailable - will trigger automatic retry attempts  

Payment Paid

Once Transfermate has received the funds, we will fire the Payment_Paid webhook.

Success response Body Payload Example

The response body includes the following parameters:

Field Description Type
event_id Unique identifier for this specific webhook call Varchar
customer_id Id of customer requesting the webhook Varchar
event_code Identifier for webhook type. Varchar
event_details object which holds further details about the webhook call Varchar
Unique_Record_id Invoice id returned to the client in the Request a Payment call Varchar
description Details about the webhook call Varchar
amount Amount in transaction number
updated_at date field, when the webhook was fired Varchar
status further details about the webhook call Varchar

Example Success Response

{
    "Message": {
        "event_id": "510ff2be-85b7-4adc-85c9-471cde3ae6a6",
        "customer_id": "174360",
        "event_code": "1",
        "event_details": {
            "Unique_Record_id": "16008",
            "payer_id": "5289",
            "description": "Payment_Paid",
            "updated_at": "2021-07-21 16:23:34",
            "status": "Paid"
        }
    }
}

Error response Body Payload Example

The error response body includes the following parameters:

Field Description Type
400 Bad Request - will not trigger automatic retry attempts  
401 Unauthorised - will NOT trigger automatic retry attempt  
403 Forbidden - will NOT trigger automatic retry attempts  
404 Not Found - will NOT trigger automatic retry attempts  
500 Bad Request - will trigger automatic retry attempts  
501 Bad Request - will NOT trigger automatic retry attempts  
503 Service Unavailable - will trigger automatic retry attempts