PPppro
Merchants

Merchant Status Updated

Sent when a merchant's status changes. Delivered to the endpoint configured via webhooksUrl on the merchant (see CreateMerchantRequest/ UpdateMerchantRequest); subscription/registration of that endpoint is out of scope for this page.

postWebhookmerchantStatusUpdated

Payload

specversion'1.0.2' required

The CloudEvents specification version.

idstring required

Unique event id (idempotency key for consumers).

sourcestring required
subjectstring required

The resource this event is about, e.g. the merchantId or enrollmentId.

timestring date-time required
datacontenttype'application/json' required

The event content type.

type'MERCHANT_STATUS_UPDATED' required

Discriminator selecting the shape of data.

Example payload

{
  "specversion": "1.0.2",
  "id": "evt_abcdefghijklmno123456",
  "source": "https://www.ppro.com",
  "subject": "MIDNITH123",
  "datacontenttype": "application/json",
  "data": {
    "merchantId": "MERCHANTID456",
    "externalMerchantReference": "ENTITY1234567890",
    "currentStatus": {
      "status": "ACTIVE",
      "statusReason": {
        "reasonCode": "RISK_CHECK",
        "reasonMessage": "The merchant has been flagged for risk and is under review"
      },
      "capabilities": {
        "canPay": true,
        "canRefund": true
      }
    },
    "previousStatus": {
      "status": "ACTIVE",
      "statusReason": {
        "reasonCode": "RISK_CHECK",
        "reasonMessage": "The merchant has been flagged for risk and is under review"
      }
    }
  }
}

Response

Webhook received.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.