Payment Status Webhook

In order to receive real-time notifications about your ongoing payments, you must subscribe to the payment status webhook.

Theis webhook allow you to receive all updates regarding any payments that is ongoing on your account with us. Currently, there is only one event type supported to receive all payment status notifications:

• PaymentStatusChanged

Request

Use the Create Webhook endpoint to setup the new webhook connection.

Method Type: POST

• url: The URL where you want StoneX to send your payment status updates to.
• isActive: Set to either true or false

Example Request

{
  "eventType": "PaymentStatusChanged",
  "url": "https://webhook.site/d1d51d03-9af7-4d9e-9d18-77037831a99999",
  "isActive": true
}

Response

A successful response with a HTTP 201 status confirms the creation of the new Payment Status webhook connection.

Http Status: 201 Created

Example Response

{
    "clientId": "TEST CLIENT",
    "isActive": true,
    "webhookEventType": "PaymentStatusChanged",
    "url": "https://webhook.site/d1d51d03-9af7-4d9e-9d18-77037831a99999",
    "id": "678f866e853c889d0d449d87",
    "createdDate": "2025-01-21T11:35:10.9736021Z",
    "modifiedDate": "2025-01-21T11:35:10.9736433Z",
    "createdBy": "StoneX Payments",
    "modifiedBy": "StoneX Payments",
    "optimisticVersion": 1
}

Once this is created, whenever there is any change to a status an ongoing payment with us, you will receive a push notification on the configured endpoint.