Skip to main content

Credit Limit Updated

Webhook

Type: customer.credit_limit.updated.v1

Occurs when the available credit for a merchant's buyer changes.

Payload​

The data object in the payload contains identifiers for the buyer organisation, as well as the new available credit limit information. If the credit limit changes such that Two no longer accepts the buyer, the payload may include a reason for the change.

Example​

{
    "specversion":"1.0",
    "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
    "type": "customer.credit_limit.updated.v1",
    "time": "2023-06-21T12:34:56.123456Z",
    "source": "https://api.two.inc",
    "subject": "customer/GB/12345678",
    "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
    "data": {
        "buyer_organization_number": "12345678",
        "country": "GB",
        "credit_limit": "1000.00",
        "credit_limit_balance": "800.00",
        "max_single_order_value": "100.00",
        "buyer_is_in_arrears": true,
        "currency": "GBP",
        "credit_approved": false,
        "decline_reason": "Buyer is late on existing active invoices that need to be cleared before they are able to place more orders."
    }
}

Triggering in sandbox​

  1. Create and fulfil an order (see the order.reconciliation.invoiced.v1 webhook for details).
  2. Refund the order. You can use the example provided in the Two webhooks Postman collection.
  3. Once the refund is processed, the customer.credit_limit.updated.v1 webhook will be sent to any endpoints subscribed to this event.

Alternatively, you can trigger a simulated credit limit update for a given combination of buyer organisation number, country code and currency using the "Simulate credit limit update" endpoint in the Two webhooks Postman collection.

Request​

Responses​

Successful Response