Skip to main content

Partner Webhooks

This guide explains the webhook events available for TrustistTransfer partners.

If a webhook URL has been configured in the partner dashboard, TrustistTransfer will send an HTTP POST request when a relevant status changes.

Webhook events are available for:

  • Invitation updates
  • Merchant payment updates

Merchant payment updates can be enabled on request.

Invitation Updates​

Invitation update webhooks are sent when a user progresses through the invitation journey.

Invitation Opened​

When a user invited by a partner opens their invitation and creates an account, the invitation status changes to OPENED.

Example Payload​

{
    "eventType": "InvitationStatusChanged",
    "invitationId": "<guid>",
    "updated": "<yyyy-MM-ddTHH:mm:ss.fffffffZ>",
    "status": "OPENED"
}

Invitation Completed​

When the user completes onboarding and becomes a full merchant, the invitation status changes to COMPLETE.

Example Payload​

{
    "eventType": "InvitationStatusChanged",
    "invitationId": "<guid>",
    "merchantId": "<string>",
    "updated": "<yyyy-MM-ddTHH:mm:ss.fffffffZ>",
    "status": "COMPLETE"
}

Merchant Payments​

Merchant payment webhooks are sent when a merchant invited by your partner account places payments.

A webhook is sent when a payment is first created.

Payment Created​

When a payment is first created, the payment status is PENDING.

Example Payload​

{
    "eventType": "PaymentStatusChanged",
    "merchantId": "<string>",
    "paymentId": "<string>",
    "created": "<yyyy-MM-ddTHH:mm:ss.fffffffZ>",
    "amount": <decimal>,
    "status": "PENDING"
}

Payment Completed or Failed​

When a payment later completes or fails, another payment status webhook is sent.

The status field will be one of:

  • COMPLETE
  • FAILED

The payload uses the same event type:

{
    "eventType": "PaymentStatusChanged",
    "merchantId": "<string>",
    "paymentId": "<string>",
    "created": "<yyyy-MM-ddTHH:mm:ss.fffffffZ>",
    "amount": <decimal>,
    "status": "COMPLETE"
}

or:

{
    "eventType": "PaymentStatusChanged",
    "merchantId": "<string>",
    "paymentId": "<string>",
    "created": "<yyyy-MM-ddTHH:mm:ss.fffffffZ>",
    "amount": <decimal>,
    "status": "FAILED"
}

Event Types​

The current webhook event types are:

  • InvitationStatusChanged
  • PaymentStatusChanged

Invitation Statuses​

The current invitation statuses are:

  • OPENED
  • COMPLETE

Payment Statuses​

The current payment statuses are:

  • PENDING
  • COMPLETE
  • FAILED

Notes​

Your webhook endpoint must be able to receive HTTP POST requests from TrustistTransfer.

Use the eventType field to decide how to process the webhook.

Use the IDs in the payload, such as invitationId, merchantId, and paymentId, to match the webhook to records in your own system.

Merchant payment updates are available on request. If you need these enabled, contact the API support team.