webhooks-api.yaml

openapi: 3.1.0
info:
  title: Two webhooks
  description: |-
    ## Overview and usage

    Two provides webhooks via a [portal](https://www.svix.com) that allows you to self-manage your application's webhook
    subscriptions and related configuration options when receiving these webhooks.
    Please refer to the portal's [Receiving webhooks documentation](https://docs.svix.com/receiving/introduction) for more
    details about using the portal and how to consume webhook events.


    ### Getting started

    1. Login to the [Two Merchant Portal](https://portal.two.inc/auth/merchant/login).
    2. Within the Two Merchant Portal, go to the "Integrations" page and press the "Manage webhook subscriptions" button.
       You should be directed to the webhooks portal.
    3. Once you are logged in to the webhooks portal, please refer to the [webhook portal documentation](https://docs.svix.com/receiving/introduction)
       for details on how to configure your subscriptions.
    4. In the webhooks portal, once you have configured an endpoint to receive webhooks, you can send test/example payloads
       to the endpoint by going to Endpoints, selecting one of your configured endpoints, selecting the Testing tab,
       choosing which event type to send and then hitting the Send Example button.
    5. Alternatively, you can use one of our simulation endpoints to emit webhooks matching one of the event type schemas.
       See details under schemas for each webhook.


    ## Webhooks Postman Collection

    To get started using the simulation endpoints and events that trigger webhooks, we have a downloadable
    [Postman collection](/docs/guides/order-webhooks-api-page/#webhook-postman-collection).


    #¤ Environments

    ### Testing

    `https://api.sandbox.two.inc`


    ### Production
    `TBC`


    ## Pre-requisites

    1. An API key to access our checkout API. You can get an API key (which you should keep protected) for your application
       from the [Two Merchant Portal](https://portal.two.inc/auth/merchant/login).
    2. An email address to receive invoices and similar notifications, such as credit notes (optional).

    The simulation endpoints we provide to trigger certain webhooks are made for testing purposes only and are only
    available in our sandbox environment. There are some limitations with these and may not always provide fully accurate
    data in some edge cases.


    ## Interpreting order reconciliation events

    Order reconciliation events (event types with prefix `order.reconciliation.`) describe financial events related to
    orders that are relevant to the buyer.
    All order reconciliation events have an `amount` field in the payload, which can be summed over multiple events to
    calculate the amount owed by buyers (a.k.a. the outstanding amount).
    The outstanding amount can be calculated on different levels by grouping/filtering on other IDs carried in the order
    reconciliation events, for instance:
    - Grouping the sum by order ID yields outstanding amount for that order.
    - Grouping by billing period ID yields the outstanding amount on a billing statement level.

    Payment allocation events (`order.reconciliation.payment_allocated.v1`) describe the portion of a payment used to cover
    an invoice. The `payment` sub-structure of the payload contains information on the actual payment itself. It may be
    larger than a single allocation, and may show up on multiple allocation events if used to cover more than one invoice.


    ## Event Reference
  version: 0.0.1
paths: {}
webhooks:
  reconciliation-invoiced:
    post:
      tags:
        - Order Reconciliation
      summary: Order Invoiced
      description: |-
        Type: `order.reconciliation.invoiced.v1`

        Occurs when an order has been successfully fulfilled and the corresponding invoice has been created by Two.

        #### Payload

        The `data` object in the payload contains IDs that link the order and the invoice, along with the amount and
        currency of the invoice to be paid back by the buyer.

        #### Example:

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "order.reconciliation.invoiced.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "root_order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "invoice_id": "7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "billing_period_id": "175bda61-c6f2-4b9d-a429-5f31c83ecc10",
                "amount": "150.65",
                "currency": "GBP"
            }
        }

        ```
        #### Triggering in sandbox

        1. [Create](/docs/api/checkout/create-order-handler-post/) an order through
           the checkout API service in your sandbox environment. Capture the order ID from the resulting response.
        2. [Fulfill](/docs/api/checkout/mark-fulfilled-order-handler-post/) the
           order. There may be a short delay while the fulfilment process completes asynchronously.
        3. Once the order state moves from `FULFILLING` to `FULFILLED`, the buyer representative email specified in the order request will receive an invoice. Simultaneously, the `order.reconciliation.invoiced.v1` webhook will be sent by the webhook gateway to any endpoints you have configured to receive it.
      operationId: order_invoicedreconciliation_invoiced_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderReconciliationInvoiced"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  reconciliation-payment-allocated:
    post:
      tags:
        - Order Reconciliation
      summary: Payment Allocation
      description: |-
        Type: `order.reconciliation.payment_allocated.v1`

        Occurs when either:
        1. A payment is made and confirmed as allocated to a specific invoice or statement issued by Two.
        2. A previously matched payment is deallocated, for example when a credit note takes priority over the payment.

        It is important to note these webhooks are sent only once the payment has been matched (or unmatched) in Two's
        system to a specific invoice or statement, so there may be a delay between the buyer making the payment and Two
        being able to match that payment to an invoice/statement.

        As an example, the following sequence of events show when this webhook may be issued:
        * A buyer is issued with an invoice of 1000 GBP (Two issues an Order Invoiced webhook).
        * The buyer later pays 400 GBP to Two using the reference provided on the invoice.
        * Two will match that payment to the invoice: **a Payment Allocation webhook is issued**.
            * The webhook payload will contain the invoice or statement reference Two matched the buyer's payment with
              (in the `matched_reference` attribute) as well as some details of the original payment made by the buyer
              in the `payment` object.
        * The buyer later makes another payment of 600 GBP to Two with the same reference (600 being the remaining
          balance to pay for that invoice).
        * Two matches the second incoming payment of 600 GBP to the same invoice: **another Payment Allocation webhook
          is issued**.
            * This webhook will have the same `matched_reference` value, but the details in the `payment` object will be
              different because it is a distinct payment from the original 400 GBP payment.
        * A credit note is issued against the original invoice of 300 GBP (Two issues a Order Credited webhook).
            * One of the payments Two previously matched will be "unmatched" because the refund of 300 GBP against
              specific invoices has a higher priority than payments. **Two issues another Payment Allocation webhook,
              but the amount will be negative**.

        #### Payload

        The `data` object in the payload contains IDs that indicate the order and invoice the payment has been allocated
        to. Also note the following within the payload:
        * `amount`: The amount for this event represents the amount of the buyer's payment that has been used by this
          allocation. For payments to Two that are allocated to invoices, this amount will be negative.
          For deallocation events (for example, where a credit note has a higher priority than an already-reconciled
          payment and causes us to deallocate an existing allocation), the `amount` will be positive. A deallocation
          event would typically result in a later `payment_allocated` event where all or part of the same payment
          previously allocated is re-allocated against a different invoice; in this situation another
          payment allocation event will be sent.
        * `payment`: Contains data about the actual transaction Two received from the buyer that has been used in this
          payment allocation. See the schema description of this child object for details of each field.

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
                "type": "order.reconciliation.payment_allocated.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "root_order_id": "652a57e2-c2de-437b-96a7-2eeac0a37814",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "invoice_id": "7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "billing_period_id": "175bda61-c6f2-4b9d-a429-5f31c83ecc10",
                "amount": "-123.45",
                "currency": "GBP",
                "matched_reference": "ACB12345",
                "payment": {
                    "payment_id": "1346ef4c-fae1-43a2-b637-24e0c756d4ce",
                    "payment_reference": "ABC12345",
                    "booked_at": "2023-06-21T12:30:12.012345Z",
                    "payment_amount": "500.05",
                    "currency": "GBP"
                }
            }
        }
        ```


        #### Triggering in sandbox

        1. Create and fulfil a new order (see the `order.reconciliation.invoiced.v1` webhook description for how
           to do this) or use an existing order ID for the following steps.
        2. Use the "Simulate pay in" endpoint provided in the [Two webhooks Postman collection](/docs/guides/order-webhooks-api-page/#webhook-postman-collection).
        3. Once the simulated payment to us has been received the payment allocation webhook will be sent to any
           endpoints subscribed to this event.

        Alternatively:
        1. [Refund an order](/docs/api/checkout/refund-order-handler-post/) either
           fully or partially.
        2. A payment allocation webhook will be sent indicating an existing payment has been deallocated for this order
           to any endpoints subscribed to this event.
      operationId: payment_allocationreconciliation_payment_allocated_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderReconciliationPaymentAllocated"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  reconciliation-credited:
    post:
      tags:
        - Order Reconciliation
      summary: Order Credited
      description: |-
        Type: `order.reconciliation.credited.v1`

        Occurs when a credit note is applied against an invoice.

        #### Payload

        The `data` object in the payload contains IDs that indicate the order and invoice the credit note has been
        applied to. Also note the following within the payload:
        * `credit_note`: Contains information about the credit note itself, including its ID, the amount on the credit
          note and when the credit note was applied.

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "order.reconciliation.credited.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "root_order_id": "652a57e2-c2de-437b-96a7-2eeac0a37814",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "invoice_id": "7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "billing_period_id": "175bda61-c6f2-4b9d-a429-5f31c83ecc10",
                "amount": "-101.65",
                "currency": "GBP",
                "credit_note": {
                    "refund_id": "433401fe-76ae-4e10-b091-59788c90a5df",
                    "credited_at": "2023-06-21T12:30:12.012345Z",
                    "credit_note_amount": "101.65"
                }
            }
        }
        ```


        #### Triggering in sandbox

        1. Create and fulfil an order (see the `order.reconciliation.invoiced.v1` webhook for details).
        2. [Refund the order](/docs/api/checkout/refund-order-handler-post/) by
           using the "Refund order" endpoint from the [Two webhooks Postman collection](/docs/guides/order-webhooks-api-page/#webhook-postman-collection).
        3. Once the refund process is completed, the `order.reconciliation.credited.v1` webhook will be sent to any endpoints subscribed to this event.
      operationId: order_creditedreconciliation_credited_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderReconciliationCredited"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  reconciliation-recoursed:
    post:
      tags:
        - Order Reconciliation
      summary: Order Recoursed
      description: |-
        Type: `order.reconciliation.recoursed.v1`

        Occurs when Two applies the option to recourse an invoice back to the merchant. This may not be applicable to
        your contract with Two so you may never see recourse events.

        #### Payload

        The `data` object in the payload contains IDs that indicate the order and invoice that have been recoursed. Also
        note the following child object within the payload:
        * `recourse`: Contains specific information about the recourse event as recorded in the Two system, including
          the specific amount that has been recoursed back to the merchant.

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "order.reconciliation.recoursed.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "root_order_id": "652a57e2-c2de-437b-96a7-2eeac0a37814",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "invoice_id": "7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "billing_period_id": "175bda61-c6f2-4b9d-a429-5f31c83ecc10",
                "amount": "-101.65",
                "currency": "GBP",
                "recourse": {
                    "recourse_id": "4228e51d-45ba-4a7f-a279-0f332bfead9c",
                    "recoursed_at": "2023-06-31T12:34:56.123456",
                    "recourse_amount": "101.65"
                }
            }
        }
        ```


        #### Triggering in sandbox

        1. Create and fulfil an order (see the `order.reconciliation.invoiced.v1` webhook for details).
        2. Recourse the order by using "Recourse order" endpoint from the [Two webhooks Postman collection](/docs/guides/order-webhooks-api-page/#webhook-postman-collection).
        3. Once the recourse simulation is completed, the `order.reconciliation.recoursed.v1` webhook will be sent to any endpoints subscribed to this event.
      operationId: order_recoursedreconciliation_recoursed_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderReconciliationRecoursed"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  reconciliation-collected:
    post:
      tags:
        - Order Reconciliation
      summary: Order Collected
      description: |-
        Type: `order.reconciliation.collected.v1`

        Occurs when Two reverts to using a collection agency for recovering any outstanding amounts owed by a buyer for
        an invoice.

        #### Payload

        The `data` object in the payload contains IDs that indicate the order and invoice that have been sent to the
        collection agency. Also note the following child object within the payload:
        * `collection`: Contains specific information about the collection that caused this event, including the amount
          Two has asked the collection agency to recover.

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "order.reconciliation.collected.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "root_order_id": "652a57e2-c2de-437b-96a7-2eeac0a37814",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "invoice_id": "7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "billing_period_id": "175bda61-c6f2-4b9d-a429-5f31c83ecc10",
                "amount": "-101.65",
                "currency": "GBP",
                "collection": {
                    "collection_id": "8d5f0cf6-0aee-4cb3-9723-ee221cdfc681",
                    "collected_at": "2023-06-30T12:34:56.123456",
                    "collection_amount": "101.65"
                },
            }
        }
        ```


        #### Triggering in sandbox

        1. Create and fulfil an order (see the `order.reconciliation.invoiced.v1` webhook for details).
        2. Send the invoice for this order to collections by using the "Collect order" endpoint from the [Two webhooks Postman collection](/docs/guides/order-webhooks-api-page/#webhook-postman-collection).
        3. Once the collection simulation process is completed, the `order.reconciliation.collected.v1` webhook will be sent to any endpoint subscribed to this event.
      operationId: order_collectedreconciliation_collected_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderReconciliationCollected"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  verified:
    post:
      tags:
        - Order
      summary: Order Verified
      description: |-
        Type: `order.verified.v1`

        Occurs when an order has been successfully verified and is in a fulfillable state.

        #### Payload

        The `data` object in the payload contains order ID, along with the amount and currency.

        #### Example:

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "order.verified.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "root_order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "merchant_order_id": "999999",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "gross_amount": "150.65",
                "invoice_amount": "150.65",
                "payable_amount": "150.65",
                "prepaid_amount": "0.00",
                "currency": "GBP"
                "buyer_company_name": "TWO B2B LTD",
                "status": "APPROVED",
                "state": "VERIFIED",
            }
        }
        ```


        #### Triggering in sandbox

        1. [Create](/docs/api/checkout/create-order-handler-post/) an order through
           the checkout API service in your sandbox environment. Capture the order ID from the resulting response.
        2. Open the `payment_url` in the response body and complete verification (in production, this step would be completed by the buyer).
        3. Once the order state moves from `UNVERIFIED` to `VERIFIED`, the `order.state.verified.v1` webhook will be sent by the webhook gateway to any endpoints you have configured to receive it.
      operationId: order_verifiedverified_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderVerified"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  cancelled:
    post:
      tags:
        - Order
      summary: Order Cancelled
      description: |-
        Type: `order.cancelled.v1`

        Occurs when an order has been cancelled

        #### Payload

        The `data` object in the payload contains order ID, along with the amount and currency.

        #### Example:

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "order.cancelled.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "root_order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "merchant_order_id": "999999",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "gross_amount": "150.65",
                "invoice_amount": "150.65",
                "payable_amount": "150.65",
                "prepaid_amount": "0.00",
                "currency": "GBP"
                "buyer_company_name": "TWO B2B LTD",
                "status": "APPROVED",
                "state": "CANCELLED",
            }
        }
        ```


        #### Triggering in sandbox

        1. [Create](/docs/api/checkout/create-order-handler-post/) an order through
           the checkout API service in your sandbox environment. Capture the order ID from the resulting response.
        2. Using the order ID captured, [Cancel](/docs/api/checkout/cancel-order-handler-post/) the order through the checkout API service in your sandbox environment.
        3. Once the order state moves from to `CANCELLED`, the `order.cancelled.v1` webhook will be sent by the webhook gateway to any endpoints you have configured to receive it.
      operationId: order_cancelledcancelled_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderCancelled"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  fulfilled:
    post:
      tags:
        - Order
      summary: Order Fulfilled
      description: |-
        Type: `order.fulfilled.v1`

        Occurs when an order has been fulfilled

        #### Payload

        The `data` object in the payload contains order ID, along with the amount and currency

        #### Example:

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "order.fulfilled.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "root_order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "merchant_order_id": "999999",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "gross_amount": "150.65",
                "invoice_amount": "150.65",
                "payable_amount": "150.65",
                "prepaid_amount": "0.00",
                "currency": "GBP"
                "buyer_company_name": "TWO B2B LTD",
                "status": "APPROVED",
                "state": "FULFILLED",
            }
        }
        ```


        #### Triggering in sandbox

        1. [Create](/docs/api/checkout/create-order-handler-post/) an order through
           the checkout API service in your sandbox environment. Capture the order ID from the resulting response.
        2. Open the `payment_url` in the response body and complete verification (in production, this step would be completed by the buyer).
        3. Using the order ID captured, [Fulfill](/docs/api/checkout/fulfill-order-handler-post/) the order through
           the checkout API service in your sandbox environment.
        4. Once the order state moves from `Fulfilling` to `Fulfilled`, the `order.fulfilled.v1` webhook will be sent by the webhook gateway to any endpoints you have configured to receive it.
      operationId: order_fulfilledfulfilled_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderFulfilled"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  refunded:
    post:
      tags:
        - Order
      summary: Order Refunded
      description: |-
        Type: `order.refunded.v1`

        Occurs when an order has been refunded

        #### Payload

        The `data` object in the payload contains order ID, along with the amount, currency and the amount refunded

        #### Example:

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "order.refunded.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "refund_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "merchant_refund_reference": "merchant_refund_reference",
                "root_order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "merchant_order_id": "999999",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "gross_amount": "150.65",
                "invoice_amount": "150.65",
                "payable_amount": "150.65",
                "prepaid_amount": "0.00",
                "currency": "GBP"
                "buyer_company_name": "TWO B2B LTD",
                "refunded_gross_amount": "100.65",
                "refunded_payable_amount": "100.65",
                "refunded_prepaid_amount": "0.00"
                "status": "APPROVED",
                "state": "REFUNDED",
            }
        }
        ```


        #### Triggering in sandbox

        1. [Create](/docs/api/checkout/create-order-handler-post/) an order through
           the checkout API service in your sandbox environment. Capture the order ID from the resulting response.
        2. Open the `payment_url` in the response body and complete verification (in production, this step would be completed by the buyer).
        3. Using the order ID captured, [Fulfill](/docs/api/checkout/fulfill-order-handler-post/) the order through
           the checkout API service in your sandbox environment.
        4. Once the order state moves from `Fulfilling` to `Fulfilled`,
           use the order ID captured to [Refund](/docs/api/checkout/refund-order-handler-post/) the order through the checkout API service in your sandbox environment.
        5. Once the order state moves to `REFUNDED`, the `order.refunded.v1` webhook will be sent by the webhook gateway to any endpoints you have configured to receive it.
      operationId: order_refundedrefunded_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderRefunded"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  rejected:
    post:
      tags:
        - Order
      summary: Order Rejected
      description: |-
        Type: `order.rejected.v1`

        Occurs when an order has been rejected

        #### Payload

        The `data` object in the payload contains order ID, along with the amount, currency and the reason for rejection

        #### Example:

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "order.rejected.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "refund_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "merchant_refund_reference": "merchant_refund_reference",
                "root_order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                "merchant_order_id": "999999",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "gross_amount": "150.65",
                "invoice_amount": "150.65",
                "payable_amount": "150.65",
                "prepaid_amount": "0.00",
                "currency": "GBP"
                "buyer_company_name": "TWO B2B LTD",
                "decline_reason": "TOO_HIGH_RISK"
                "status": "REJECTED",
                "state": "UNVERIFIED",
            }
        }
        ```


        #### Triggering in sandbox

        1. [Create](/docs/api/checkout/create-order-handler-post/) an order through
           the checkout API service in your sandbox environment. Two can provide example of buyer company to use in
           sandbox that will be rejected for credit and should result in `order.refunded.v1` webhook being sent.
      operationId: order_rejectedrejected_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderRejected"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  credit-limit-change:
    post:
      tags:
        - Customer Credit Limit
      summary: Credit Limit Updated
      description: |-
        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

        ```json
        {
            "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](/docs/api/checkout/refund-order-handler-post/). You can use the example provided in the [Two webhooks Postman collection](/docs/guides/order-webhooks-api-page/#webhook-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](/docs/guides/order-webhooks-api-page/#webhook-postman-collection).
      operationId: credit_limit_updatedcredit_limit_change_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditLimitUpdatedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  billing-statement-issued:
    post:
      tags:
        - Billing Statement
      summary: Billing Statement Issued
      description: |-
        Type: `billing_statement.created.v1`

        Occurs when a billing statement is issued.

        #### Payload

        The `data` object in the payload contains details of all invoices and credit notes related to the statement.
        These credit notes and invoices will all have the same `billing_period_id` in the credit note issued and invoice
        issued webhooks, respectively.

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "billing_statement.created.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "billing_account/c8b27c7c-3362-4c10-b4e5-7d68c8b554be",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "invoices": [
                    {
                        "root_order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                        "order_id": "a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e",
                        "invoice_id": "7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d",
                        "amount": "190.65",
                    },
                ]
                "credit_notes": [
                    {
                        "refund_id": "433401fe-76ae-4e10-b091-59788c90a5df",
                        "credited_amount": "-40.00"
                    },
                ]

                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "billing_period_id": "175bda61-c6f2-4b9d-a429-5f31c83ecc10",
                "statement_number": "1004",
                "payment_reference": "234234234",
                "gross_amount": "150.65",
                "outstanding_amount": "120.65",
                "currency": "GBP"
                "due_date": "2023-06-21T12:34:56.123456Z",
                "issue_date": "2023-06-05T12:34:56.123456Z",
                "billing_account_id": "c8b27c7c-3362-4c10-b4e5-7d68c8b554be",
            }
        }
        ```


        #### Triggering in sandbox

        1. [Create a billing account](/docs/api/billing-account/create-billing-account-post/) using the billing account API.
           This is also available in the [Two webhooks Postman collection](/docs/guides/order-webhooks-api-page/#webhook-postman-collection).
           Note the ID of the billing account returned in the response to use in the next step.
        2. [Create an order](/docs/api/checkout/create-order-handler-post/) and use the billing account ID returned in the response from step 1 in the `"billing_account_id": "<id>"` field
           in the body of the request.
        3. Fulfil the order (see the `order.reconciliation.invoiced.v1` for details).
        4. (Optional) If you want to include multiple orders in the statement, repeat steps 2 and 3 to create multiple fulfilled orders for the same billing account.
        5. Create a statement by using the "Simulate close billing statement" endpoint from the
           [Two webhooks Postman collection](/docs/guides/order-webhooks-api-page/#webhook-postman-collection).
        6. One the billing statement has been issued, the `billing_statement.created.v1` webhook will be sent to any endpoints subscribed to this event.
      operationId: billing_statement_issuedbilling_statement_issued_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BillingStatementEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  business-registry-approved:
    post:
      tags:
        - Business Registry
      summary: Business Registry Approved
      description: |-
        Type: `business_registry.approved.v1`

        Occurs when a proposal to enroll a new business (e.g. a sole trader) has been approved, the enrollment has
        been completed, and the new business is ready for ordering/trade account creation/etc.

        #### Payload

        The `data` object in the payload contains the following:
        - <merchant_id> is your unique identifier within TWO's system
        - <proposal_id> is the identifier of the proposal that has been approved. You may retrieve this proposal via the
          Business Registration API.
        - <organization_number> is the synthetic organization number generated by TWO for the newly enrolled business.
          Use this organization number when creating trade accounts, orders or other assets on behalf of the buyer.

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "business_registry.approved.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "business_registry",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "proposal_id": "558f57b4-8161-4765-a73e-a67d73f9c245",
                "merchant_id": "1eb39178-c652-4784-9eee-af7e25b28a4c",
                "organization_number": "1234567",
            }
        }
        ```


        #### Triggering in sandbox

        This webhook object is emitted whenever a proposal is approved. In the sandbox environment, proposals are
        automatically approved immediately on submission. To prompt Two to emit an example of this object, simply
        create and then submit a proposal.
      operationId: business_registry_approvedbusiness_registry_approved_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EnrollmentApprovedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  business-registry-rejected:
    post:
      tags:
        - Business Registry
      summary: Business Registry Rejected
      description: |-
        Type: `business_registry.rejected.v1`

        Occurs when a proposal to enroll a new business (e.g. a sole trader) has been rejected or withdrawn.

        #### Payload

        The `data` object in the payload contains the following:
        - <merchant_id> is your unique identifier within TWO's system
        - <proposal_id> is the identifier of the proposal that has been rejected. You may retrieve this proposal via the
          Business Registration API.
        - <rejection_reason> is the detailed reason why this proposal was rejected.

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "business_registry.rejected.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "business_registry",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                 "proposal_id": "558f57b4-8161-4765-a73e-a67d73f9c245",
                 "rejection_reason": "Some reason",
                 "merchant_id": "1eb39178-c652-4784-9eee-af7e25b28a4c",
            }
        }
        ```


        #### Triggering in sandbox


        This webhook object is emitted whenever a proposal is rejected or withdrawn. To prompt Two to emit an example of
        this object, simply create and then withdraw a proposal.
      operationId: business_registry_rejectedbusiness_registry_rejected_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EnrollmentRejectedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  instalments-invoiced:
    post:
      tags:
        - Instalments
      summary: Instalments Invoiced
      description: |-
        Type: `instalments.invoiced.v1`

        Occurs when an invoice including one or more instalments is created.

        ### Payload

        The `data` object in the payload contains IDs that indicate the invoice that has been created and the associated
        merchant and instalment plan. Also note the following child objects within the payload:
        * `tax_subtotals`: Contains specific information about the tax subtotals of the invoice.
        * `instalments`: Contains specific information about the instalments comprising the invoice.

        ### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "instalments.invoiced.v1",
            "time": "2023-06-21T12:34:56.123456",
            "source": "webhooks.two.inc",
            "subject": "instalment_account/044d6cf0-0f51-11ec-82a8-0242ac130003",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "invoice_id": "e39f3206-0f94-4b9d-9f8f-1b2bae1e2bc9",
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "issue_date": "2023-06-05T12:34:56.123456",
                "due_date": "2023-06-05T12:34:56.123456",
                "invoice_number": "90000001",
                "instalment_account_id": "044d6cf0-0f51-11ec-82a8-0242ac130003",
                "gross_amount": "1000.00",
                "tax_subtotals": [
                    {
                        "tax_rate": "0.250000",
                        "taxable_amount": "500.00",
                        "tax_amount": "125.00"
                    },
                    {
                        "tax_rate": "0.000000",
                        "taxable_amount": "500.00",
                        "tax_amount": "0.00"
                    }
                ],
                "instalments": [
                    {
                        "plan_id": "b6c9de3c-5d51-4a9d-89b1-63e1a9f7c5e5",
                        "instalment_id": "a0f4bc40-8c5d-4b80-8c40-7d1f0b5a1f74"
                    },
                    {
                        "plan_id": "ff6b6e3e-5e0e-4d27-bc62-4e5a3a80e7f4",
                        "instalment_id": "d2f5f79b-1e5a-4fe3-9e53-0b3a4b2c1c1b"
                    }
                ]
            }
        }
        ```
      operationId: instalments_invoicedinstalments_invoiced_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/InstalmentsInvoicedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  customer-user-verified:
    post:
      tags:
        - Customer User
      summary: Customer User Verified
      description: |-
        Type: `customer.user.verified.v1`

        Occurs when a customer user successfully completes verification

        #### Payload

        The `data` object in the payload contains IDs that indicate your merchant_user_id that has been verified and your associated
        merchant_customer_id

        #### Example

        ```json
        {
            "specversion":"1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "customer.user.verified.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "customer/user/external-user-id-123",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "merchant_id": "12345678",
                "merchant_customer_id": "external-customer-123",
                "merchant_user_id": "external-user-id-123",
        }
        ```

        #### Triggering in sandbox

        1. Follow docs to [create business customer and business customer user](/docs/api/trade-account-v3/).
        2. Follow the user_verification_url returned from [Create customer user record](/docs/api/trade-account-v3/create-trade-account-customer-user-handler-post/) to verify user.
        3. Once the verification process is completed successfully, the `customer.user.verified.v1` webhook will be sent to any endpoints subscribed to this event.
      operationId: customer_user_verifiedcustomer_user_verified_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerUserVerifiedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  merchant-payee-account-activated:
    post:
      tags:
        - Merchant Payee Account
      summary: Merchant Payee Account Activated
      description: |-
        Type: `merchant.payee_account.activated.v1`

        Occurs when a payee account for a given country and invoice type for a merchant is activated

        #### Payload

        The `data` object in the payload contains data that indicates a merchant has been activated. Payload will
        include merchant_id, merchant_legal_name, merchant_country_code of merchant and country code and invoice type
        of activated payee account.

        #### Example

        ```json
        {
            "specversion":"1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "merchant.payee_account.activated.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "merchant/b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "twomerchantid":"b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "data": {
                "merchant_id": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
                "merchant_legal_name": "Example Merchant Ltd",
                "merchant_country_code": "GB",
                "payee_account_country_code": "GB",
                "payee_account_invoice_type": "FUNDED_INVOICE",
        }
        ```

        #### Triggering in sandbox

        This webhook object is emitted whenever a new active payee account for country code and invoice type for a
        merchant is activated and the country invoice type combination has no other active payee accounts.
        Use case is for merchants activating a new payee account for a country and invoice type
        to inform partner merchant of activation.
      operationId: merchant_payee_account_activatedmerchant_payee_account_activated_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MerchantPayeeAccountActivatedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  in-arrears-block:
    post:
      tags:
        - Customer
      summary: Customer In Arrears
      description: |-
        Type: `customer.in_arrears_block.v1`

        Occurs for the first 7 days when a customer enters into arrears, meaning they have an unpaid invoice
        that is more than 28 days past due and are now unable to place orders until they repay
        their most overdue invoices that meet this past 28 days condition

        #### Payload

        The `data` object in the payload contains data that indicates the customer details who has entered
        into arrears, and further details on the invoices that are most overdue if they belong to this merchant

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "customer.in_arrears_block.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "in_arrears_block",
            "twomerchantid": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "message": (
                "Two B2b LTD (13078389) is now in arrears."
                "Please see the details for the invoice that is due the earliest"
            ),
            "data": {
                "buyer_company_name": "Two B2b LTD",
                "buyer_organization_number": "13078389",
                "days_in_arrears": 5,
                "earliest_invoice_due_belongs_to_merchant": True,
                "earliest_invoice_number": "123123",
                "earliest_invoice_due_date": "2024-05-05",
                "earliest_invoice_gross_amount": 100.0,
                "earliest_invoice_currency": "GBP"
            }
        }
        ```

        #### Triggering in sandbox

        There is no active trigger to send this webhook as it runs as a cronjob on a daily
        schedule if the arrears conditions are met for any customer from this merchant.
        The SVIX portal however allows for test events to be sent to a given endpoint
      operationId: customer_in_arrearsin_arrears_block_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerInArrearsBlock"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  approaching-arrears-block:
    post:
      tags:
        - Customer
      summary: Customer Approaching Arrears
      description: |-
        Type: `customer.approaching_arrears_block.v1`

        Starts occurring 7 days before a customer enters into arrears, meaning they have an unpaid invoice
        that is than 21 days or more past due and are about to be unable to place orders until they repay
        their most overdue invoices that meet this past 28 days condition

        #### Payload

        The `data` object in the payload contains data that indicates the customer details who is about to enter
        into arrears, and further details on the invoices that are most overdue if they belong to this merchant

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "customer.approaching_arrears_block.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "approaching_arrears_block",
            "twomerchantid": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "message": (
                "Two B2b LTD (13078389)  is approaching arrears with another "
                f"merchant in 5 days. Please encourage them to repay any severely "
                "overdue invoices they have to be able to place orders on your website again""
            ),
            "data": {
                "buyer_company_name": "Two B2b LTD",
                "buyer_organization_number": "13078389",
                "days_until_arrears": 5,
                "earliest_invoice_due_belongs_to_merchant": False,
                "earliest_invoice_number": None,
                "earliest_invoice_due_date": None,
                "earliest_invoice_gross_amount": None,
                "earliest_invoice_currency": None
            }
        }
        ```

        #### Triggering in sandbox

        There is no active trigger to send this webhook as it runs as a cronjob on a daily
        schedule if the arrears conditions are met for any customer from this merchant.
        The SVIX portal however allows for test events to be sent to a given endpoint
      operationId: customer_approaching_arrearsapproaching_arrears_block_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerApproachingArrearsBlock"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  exit-arrears-block:
    post:
      tags:
        - Customer
      summary: Customer Exit Arrears
      description: |-
        Type: `customer.exit_arrears_block.v1`

        This webhook occurs when a customer has been in arrears and then exits arrears by paying their
        overdue invoices, meaning they are now unblocked from using two. Merchants will receive the webhook only once

        #### Payload

        The `data` object in the payload contains the buyer company name and organization number
        of the buyer who has exited arrears.

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "customer.exit_arrears_block.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "exit_arrears_block",
            "twomerchantid": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "message": (
                "TWO B2B AS (1307839) have exited arrears and are now able to purchase with Two B2B again"
            ),
            "data": {
                "buyer_company_name": "TWO B2B AS",
                "buyer_organization_number": "13078389",
            }
        }
        ```

        #### Triggering in sandbox

        There is no active trigger to send this webhook as it runs as a cronjob on a daily
        schedule if the exit arrears conditions are met for any customer from this merchant.
        The SVIX portal however allows for test events to be sent to a given endpoint
      operationId: customer_exit_arrearsexit_arrears_block_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerExitArrearsBlock"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  exit-approaching-arrears-block:
    post:
      tags:
        - Customer
      summary: Customer Exit Approaching Arrears
      description: |-
        Type: `customer.exit_approaching_arrears_block.v1`

        This webhook occurs when a customer was approaching arrears, but is now no longer approaching arrears
        nor have entered into arrears as they have paid off their overdue invoice.

        #### Payload

        The `data` object in the payload contains the buyer company name and organization number
        of the buyer who has exited approaching arrears.

        #### Example

        ```json
        {
            "specversion": "1.0",
            "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
            "type": "customer.exit_approaching_arrears_block.v1",
            "time": "2023-06-21T12:34:56.123456Z",
            "source": "https://api.two.inc",
            "subject": "exit_approaching_arrears_block",
            "twomerchantid": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
            "message": ("TWO B2B AS (1307839) are no longer approaching arrears"),
            "data": {
                "buyer_company_name": "TWO B2B AS",
                "buyer_organization_number": "13078389",
            }
        }
        ```

        #### Triggering in sandbox

        There is no active trigger to send this webhook as it runs as a cronjob on a daily
        schedule if the exit approaching arrears conditions are met for any customer from this merchant.
        The SVIX portal however allows for test events to be sent to a given endpoint
      operationId: customer_exit_approaching_arrearsexit_approaching_arrears_block_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomerExitApproachingArrearsBlock"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  credit-line-requested:
    post:
      tags:
        - Buyer Credit Line
      summary: Credit Line Requested
      description: |-
        Type: `credit_line.requested.v1`

        Occurs when a new limit is requested for a credit line or when the credit line is first created.
      operationId: credit_line_requestedcredit_line_requested_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditLineRequestedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  credit-line-request-approved:
    post:
      tags:
        - Buyer Credit Line
      summary: Credit Line Request Approved
      description: |-
        Type: `credit_line.request.approved.v1`

        Occurs when a credit line request is approved.

        #### Payload

        The `data` object in the payload contains details about the approved credit line request, including the
        requested amount and the approved amount.
      operationId: credit_line_request_approvedcredit_line_request_approved_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditLineRequestApprovedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  credit-line-request-rejected:
    post:
      tags:
        - Buyer Credit Line
      summary: Credit Line Request Rejected
      description: |-
        Type: `credit_line.request.rejected.v1`

        Occurs when a credit line request is rejected. Does not automatically mean that the credit line is closed
        as a previous request might still be in effect. The separate `credit_line.closed.v1` event indicates the
        closure of a credit line.

        #### Payload

        The `data` object in the payload contains details about the rejected credit line request.
      operationId: credit_line_request_rejectedcredit_line_request_rejected_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditLineRequestRejected"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  credit-line-opened:
    post:
      tags:
        - Buyer Credit Line
      summary: Credit Line Opened
      description: |-
        Type: `credit_line.opened.v1`

        Occurs when a credit line is opened. This may be the result of a new credit line being created or
        a previously closed credit line being reopened.

        #### Payload

        The `data` object in the payload contains details about the approved credit line request, including the
        requested amount and the approved amount.
      operationId: credit_line_openedcredit_line_opened_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditLineOpenedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  credit-line-closed:
    post:
      tags:
        - Buyer Credit Line
      summary: Credit Line Closed
      description: |-
        Type: `credit_line.closed.v1`

        Occurs when a credit line is closed.

        #### Payload

        The `data` object in the payload contains the credit line ID and merchant ID.
      operationId: credit_line_closedcredit_line_closed_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreditLineClosedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  workflow-created:
    post:
      tags:
        - Workflow
      summary: Workflow Created
      description: |-
        Type: `workflow.created.v1`

        Occurs when a workflow is created.

        #### Payload

        The `data` object in the payload contains details about the workflow, including its ID, reference, template name,
        and the list of activities that are part of the workflow.
      operationId: workflow_createdworkflow_created_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WorkflowCreatedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  workflow-progressed:
    post:
      tags:
        - Workflow
      summary: Workflow Progressed
      description: |-
        Type: `workflow.progressed.v1`

        Occurs when significant changes happen to a workflow while it is in progress. Typically this means that the
        status of one or more activities has changed.

        #### Payload

        The `data` object in the payload contains the updated workflow details, including the current status of all
        activities.
      operationId: workflow_progressedworkflow_progressed_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WorkflowProgressedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  workflow-in-review:
    post:
      tags:
        - Workflow
      summary: Workflow In Review
      description: |-
        Type: `workflow.in_review.v1`

        Occurs when a workflow is queued for review.

        #### Payload

        The `data` object in the payload contains the workflow details at the time it was queued for review.
      operationId: workflow_in_reviewworkflow_in_review_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WorkflowInReviewEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  workflow-completed:
    post:
      tags:
        - Workflow
      summary: Workflow Completed
      description: |-
        Type: `workflow.completed.v1`

        Occurs when a workflow is completed.

        #### Payload

        The `data` object in the payload contains the final workflow details with all activities completed.
      operationId: workflow_completedworkflow_completed_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WorkflowCompletedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
  workflow-failed:
    post:
      tags:
        - Workflow
      summary: Workflow Failed
      description: |-
        Type: `workflow.failed.v1`

        Occurs when a workflow fails permanently, for instance due to expiry.

        #### Payload

        The `data` object in the payload contains the workflow details at the time of failure, including the failure
        reason and final status of all activities.
      operationId: workflow_failedworkflow_failed_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WorkflowFailedEvent"
        required: true
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema: {}
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    ActivityEventData:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the activity
        name:
          type: string
          title: Name
          description: Name of the activity
        status:
          $ref: "#/components/schemas/ActivityStatus"
      type: object
      required:
        - id
        - name
        - status
      title: ActivityEventData
    ActivityStatus:
      type: string
      enum:
        - LOCKED
        - NOT_STARTED
        - STARTED_BY_USER
        - PROCESSING
        - DATA_REJECTED
        - COMPLETED
        - TERMINATED
        - SKIPPED
      title: ActivityStatus
      description: Activity status enum.
    ArrearsBuyerBaseEventData:
      properties:
        buyer_company_name:
          type: string
          title: Buyer Company Name
          description: The legal name of the buyer company
        buyer_organization_number:
          type: string
          title: Buyer Organization Number
          description: National ID of the buyer company
      type: object
      required:
        - buyer_company_name
        - buyer_organization_number
      title: ArrearsBuyerBaseEventData
      description: Base data of the buyer fo arrears event data.
    BillingStatementCreditNote:
      properties:
        refund_id:
          type: string
          title: Refund Id
          description: Unique ID of the credit note.
        credited_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Credited Amount
          description: Amount applied to the statement by this credit note.
      type: object
      required:
        - refund_id
        - credited_amount
      title: BillingStatementCreditNote
    BillingStatementEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: billing_statement.created.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/BillingStatementEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: BillingStatementEvent
      examples:
        - data:
            billing_account_id: c8b27c7c-3362-4c10-b4e5-7d68c8b554be
            billing_period_id: 175bda61-c6f2-4b9d-a429-5f31c83ecc10
            credit_notes:
              - credited_amount: "-40.00"
                refund_id: 433401fe-76ae-4e10-b091-59788c90a5df
            currency: GBP
            due_date: "2023-06-21T12:34:56.123456Z"
            gross_amount: "150.65"
            invoices:
              - amount: "190.65"
                invoice_id: 7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d
                invoice_number: 10000001
                order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
                root_order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            issue_date: "2023-06-05T12:34:56.123456Z"
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            outstanding_amount: "120.65"
            payment_reference: "234234234"
            statement_number: "1004"
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: billing_account/<billing_account_id>
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: billing_statement.created.v1
    BillingStatementEventData:
      properties:
        merchant_id:
          type: string
          title: Merchant Id
          description: The ID of the merchant this statement relates to.
        billing_period_id:
          type: string
          title: Billing Period Id
          description: A unique ID of the statement/grouping this order
            is included in.
        statement_number:
          type: integer
          title: Statement Number
          description: The stateament's document number.
        payment_reference:
          type: string
          title: Payment Reference
          description: Reference the buyer should use to pay this statement.
        gross_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Gross Amount
          description: Balance of the statement, inclusive of tax.
        outstanding_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Outstanding Amount
          description: Remaining balance left on the statement.
        currency:
          type: string
          maxLength: 3
          minLength: 3
          title: Currency
          description: ISO 4217 alphabetic currency code
        due_date:
          type: string
          format: date-time
          title: Due Date
          description: The date by which this statement should be fully
            settled by the buyer.
        issue_date:
          type: string
          format: date-time
          title: Issue Date
          description: The date this statement was issued.
        billing_account_id:
          type: string
          title: Billing Account Id
          description: The billing account this statement has been issued
            for.
        invoices:
          items:
            $ref: "#/components/schemas/BillingStatementInvoice"
          type: array
          title: Invoices
          description: A sequence of objects describing the invoices included
            in this statement.
        credit_notes:
          items:
            $ref: "#/components/schemas/BillingStatementCreditNote"
          type: array
          title: Credit Notes
          description: A sequence of objects describing refunds included
            in this statement.
      type: object
      required:
        - merchant_id
        - billing_period_id
        - statement_number
        - payment_reference
        - gross_amount
        - outstanding_amount
        - currency
        - due_date
        - issue_date
        - billing_account_id
        - invoices
        - credit_notes
      title: BillingStatementEventData
      description: Object describing the details of this billing statement.
    BillingStatementInvoice:
      properties:
        root_order_id:
          anyOf:
            - type: string
            - type: "null"
          title: Root Order Id
          description: The original order ID this order stems from. Relevant
            when an order is partially fulfilled.
        order_id:
          type: string
          title: Order Id
          description: Unique ID of the order.
        invoice_id:
          type: string
          title: Invoice Id
          description: Unique ID of the invoice associated with this order.
        amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Amount
          description: Amount of the invoice inclusive of tax.
        invoice_number:
          anyOf:
            - type: integer
              exclusiveMinimum: 0.0
            - type: "null"
          title: Invoice Number
          description: The invoice's document number.
        invoice_number_string:
          type: string
          title: Invoice Number String
          description: The invoice's document number as a string.
      type: object
      required:
        - root_order_id
        - order_id
        - invoice_id
        - amount
        - invoice_number_string
      title: BillingStatementInvoice
      description: |-
        A list of objects that represent the mappings between orders and invoices, with the fields having the same
        meaning as in the order.reconciliation.invoiced.v1 event.
    CreditLimitUpdatedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: customer.credit_limit.updated.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/CustomerCreditLimitUpdateData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CreditLimitUpdatedEvent
      description: Event emitted when a customer's credit limit is updated.
      examples:
        - data:
            buyer_company_name: Example Ltd
            buyer_is_in_arrears: true
            buyer_organization_number: "12345678"
            country: GB
            credit_approved: false
            credit_limit: "1000.00"
            credit_limit_balance: "800.00"
            currency: GBP
            decline_reason: Buyer is late on existing active invoices that
              need to be cleared before they are able to place more orders.
            max_single_order_value: "100.00"
            previous_credit_limit: "1000.00"
            previous_credit_limit_balance: "1000.00"
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          message: The credit limit for your customer Example Ltd (12345678)
            in GB remains at 1000.00 GBP. Their balance has decreased from
            1000.00 GBP to 800.00 GBP.
          source: https://api.two.inc
          specversion: "1.0"
          subject: customer/GB/12345678
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: customer.credit_limit.updated.v1
    CreditLineClosedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: credit_line.closed.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/CreditLineClosedEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CreditLineClosedEvent
      description: Occurs when a credit line is closed.
      examples:
        - data:
            id: 1a1fbb4a-e067-4117-8689-e281fad7c221
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: /customer/b6d5cbaa-0886-454f-a548-4d2bd8d42467/credit_line/1a1fbb4a-e067-4117-8689-e281fad7c221
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: credit_line.closed.v1
    CreditLineClosedEventData:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the credit line
          examples:
            - 1a1fbb4a-e067-4117-8689-e281fad7c221
        merchant_id:
          type: string
          title: Merchant Id
          description: ID of the merchant that created the credit line
          examples:
            - b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
      type: object
      required:
        - id
        - merchant_id
      title: CreditLineClosedEventData
    CreditLineEventData:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the credit line
          examples:
            - 9240d53e-338e-44c2-8a8c-fe305ee730b1
        reference:
          anyOf:
            - type: string
            - type: "null"
          title: Reference
          description: Reference for the credit line request. Provided by
            the client when the request was created.
        merchant_id:
          type: string
          title: Merchant Id
          description: ID of the merchant that created the credit line
          examples:
            - 701df813-c8e0-43c7-82fe-a8dd60f32c76
        request:
          $ref: "#/components/schemas/CreditLineRequest"
          description: Details of the credit line limit request
        approved_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Approved Amount
          description: Approved credit line amount
          examples:
            - "0.00"
        currency:
          type: string
          maxLength: 3
          minLength: 3
          title: Currency
          description: ISO 4217 alphabetic currency code
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: "null"
          title: Expires At
          description: Replaced by terms_expires_at
          deprecated: true
        terms_expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: "null"
          title: Terms Expires At
          description: ISO 8601 timestamp when the credit line terms expire
      type: object
      required:
        - id
        - merchant_id
        - request
        - approved_amount
        - currency
      title: CreditLineEventData
      description: Data payload of a credit line event.
    CreditLineOpenedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: credit_line.opened.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/CreditLineEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CreditLineOpenedEvent
      description: Occurs when a credit line is opened.
      examples:
        - data:
            approved_amount: "40000.00"
            currency: EUR
            id: 1a1fbb4a-e067-4117-8689-e281fad7c221
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            reference: ref123
            request:
              id: 8167f34e-7804-4bf6-8bcb-1eb96a528b23
              reference: ref456
              requested_amount: "50000.00"
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: /credit-line/1a1fbb4a-e067-4117-8689-e281fad7c221
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: credit_line.opened.v1
    CreditLineRequest:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the credit line request
          examples:
            - 1a1fbb4a-e067-4117-8689-e281fad7c221
        requested_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Requested Amount
          description: Requested limit for the credit line
          examples:
            - "50000.00"
        reference:
          anyOf:
            - type: string
            - type: "null"
          title: Reference
          description: Reference for the credit line request. Provided by
            the client when the request was created.
      type: object
      required:
        - id
        - requested_amount
      title: CreditLineRequest
    CreditLineRequestApprovedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: credit_line.request.approved.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/CreditLineEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CreditLineRequestApprovedEvent
      description: Occurs when a credit line request is approved.
      examples:
        - data:
            approved_amount: "40000.00"
            currency: EUR
            expires_at: "2024-12-31T23:59:59Z"
            id: 1a1fbb4a-e067-4117-8689-e281fad7c221
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            reference: ref123
            request:
              id: 8167f34e-7804-4bf6-8bcb-1eb96a528b23
              reference: ref456
              requested_amount: "50000.00"
            terms_expires_at: "2024-12-31T23:59:59Z"
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: /credit-line/1a1fbb4a-e067-4117-8689-e281fad7c221
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: credit_line.request.approved.v1
    CreditLineRequestRejected:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: credit_line.request.rejected.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/CreditLineEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CreditLineRequestRejected
      description: |-
        Occurs when a credit line request is rejected.

        Does not automatically mean that the credit line is closed as a previous request might still be in effect. The
        separate credit_line.closed.v1 event indicates the closure of a credit line.
      examples:
        - data:
            approved_amount: "40000.00"
            currency: EUR
            id: 1a1fbb4a-e067-4117-8689-e281fad7c221
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            reference: ref123
            request:
              id: 8167f34e-7804-4bf6-8bcb-1eb96a528b23
              reference: ref456
              requested_amount: "50000.00"
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: /credit-line/1a1fbb4a-e067-4117-8689-e281fad7c221
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: credit_line.request.rejected.v1
    CreditLineRequestedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: credit_line.requested.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/CreditLineEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CreditLineRequestedEvent
      description: Occurs when a new limit is requested for a credit line or
        when the credit line is first created.
      examples:
        - data:
            approved_amount: "0.00"
            currency: EUR
            id: 1a1fbb4a-e067-4117-8689-e281fad7c221
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            reference: ref123
            request:
              id: 8167f34e-7804-4bf6-8bcb-1eb96a528b23
              reference: ref456
              requested_amount: "50000.00"
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: /credit-line/1a1fbb4a-e067-4117-8689-e281fad7c221
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: credit_line.requested.v1
    CustomerApproachingArrearsBlock:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: customer.approaching_arrears_block.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/CustomerApproachingArrearsEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CustomerApproachingArrearsBlock
      examples:
        - data:
            buyer_company_name: TWO B2B AS
            buyer_organization_number: "13078389"
            days_until_arrears: 2
            earliest_invoice_due_belongs_to_merchant: false
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          message: TWO B2B AS (1307839) is approaching arrears with another
            merchant in 2 days. Please encourage them to repay any severely
            overdue invoices they have to be able to place orders on your
            website again
          source: https://api.two.inc
          specversion: "1.0"
          subject: approaching_arrears_block
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: customer.approaching_arrears_block.v1
    CustomerApproachingArrearsEventData:
      properties:
        buyer_company_name:
          type: string
          title: Buyer Company Name
          description: The legal name of the buyer company
        buyer_organization_number:
          type: string
          title: Buyer Organization Number
          description: National ID of the buyer company
        earliest_invoice_due_belongs_to_merchant:
          type: boolean
          title: Earliest Invoice Due Belongs To Merchant
          description: Indication of whether the invoice which is due earliest
            belongs to the merchant who receives this arrears event or
            to a different merchant using Two product
        earliest_invoice_number:
          anyOf:
            - type: string
            - type: "null"
          title: Earliest Invoice Number
          description: Invoice number of the invoice
        earliest_invoice_due_date:
          anyOf:
            - type: string
              format: date
            - type: "null"
          title: Earliest Invoice Due Date
          description: Due date of the invoice
        earliest_invoice_gross_amount:
          anyOf:
            - type: string
              pattern: ^-?[0-9]+(\.[0-9]{0,2})?
              format: decimal
            - type: "null"
          title: Earliest Invoice Gross Amount
          description: Gross amount of the invoice
        earliest_invoice_currency:
          anyOf:
            - type: string
            - type: "null"
          title: Earliest Invoice Currency
          description: ISO 4217 3 character currency code
        days_until_arrears:
          type: integer
          title: Days Until Arrears
          description: Number of calendar days until the buyer reaches arrears
            for where they will be unable to able to place new orders
            before they repay most overdue invoice(s)
      type: object
      required:
        - buyer_company_name
        - buyer_organization_number
        - earliest_invoice_due_belongs_to_merchant
        - earliest_invoice_number
        - earliest_invoice_due_date
        - earliest_invoice_gross_amount
        - earliest_invoice_currency
        - days_until_arrears
      title: CustomerApproachingArrearsEventData
      description: Data payload of a customer in arrears event.
    CustomerCreditLimitUpdateData:
      properties:
        buyer_company_name:
          type: string
          title: Buyer Company Name
          description: The name of the buyer company as represented in a
            national organisational register, such as the CRN used by
            Companies House in the UK.
        buyer_organization_number:
          type: string
          title: Buyer Organization Number
          description: The ID of the buyer company as represented in a national
            organisational register, such as the CRN used by Companies
            House in the UK.
        country:
          type: string
          maxLength: 2
          minLength: 2
          title: Country
          description: The country of the buyer company.
        previous_credit_limit:
          anyOf:
            - type: string
              pattern: ^-?[0-9]+(\.[0-9]{0,2})?
              format: decimal
            - type: "null"
          title: Previous Credit Limit
          description: The previous maximum credit limit offered.
        previous_credit_limit_balance:
          anyOf:
            - type: string
              pattern: ^-?[0-9]+(\.[0-9]{0,2})?
              format: decimal
            - type: "null"
          title: Previous Credit Limit Balance
          description: The previous remaining credit available.
        credit_limit:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Credit Limit
          description: The maximum credit limit offered.
        credit_limit_balance:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Credit Limit Balance
          description: The remaining credit available.
        max_single_order_value:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Max Single Order Value
          description: The maximum value of any single order that may be
            placed.
        buyer_is_in_arrears:
          type: boolean
          title: Buyer Is In Arrears
          description: The result of Two's check on whether this business
            customer is in arrears.
        currency:
          type: string
          title: Currency
          description: The currency in which the limits are given.
        credit_approved:
          type: boolean
          title: Credit Approved
        decline_reason:
          anyOf:
            - type: string
            - type: "null"
          title: Decline Reason
          description: Detailed reason to why credit has been declined.
      type: object
      required:
        - buyer_company_name
        - buyer_organization_number
        - country
        - previous_credit_limit
        - previous_credit_limit_balance
        - credit_limit
        - credit_limit_balance
        - max_single_order_value
        - buyer_is_in_arrears
        - currency
        - credit_approved
        - decline_reason
      title: CustomerCreditLimitUpdateData
      description: Web schema for merchant customer credit limit response.
    CustomerExitApproachingArrearsBlock:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: customer.exit_approaching_arrears_block.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/ArrearsBuyerBaseEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CustomerExitApproachingArrearsBlock
      examples:
        - data:
            buyer_company_name: TWO B2B AS
            buyer_organization_number: "13078389"
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          message: TWO B2B AS (1307839) are no longer approaching arrears
          source: https://api.two.inc
          specversion: "1.0"
          subject: exit_approaching_arrears_block
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: customer.exit_approaching_arrears_block.v1
    CustomerExitArrearsBlock:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: customer.exit_arrears_block.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/ArrearsBuyerBaseEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CustomerExitArrearsBlock
      examples:
        - data:
            buyer_company_name: TWO B2B AS
            buyer_organization_number: "13078389"
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          message: TWO B2B AS (1307839) have exited arrears and are now able
            to purchase with Two B2B again
          source: https://api.two.inc
          specversion: "1.0"
          subject: exit_arrears_block
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: customer.exit_arrears_block.v1
    CustomerInArrearsBlock:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: customer.in_arrears_block.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/CustomerInArrearsEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CustomerInArrearsBlock
      examples:
        - data:
            buyer_company_name: Two B2b LTD
            buyer_organization_number: "13078389"
            days_in_arrears: 5
            earliest_invoice_currency: GBP
            earliest_invoice_due_belongs_to_merchant: true
            earliest_invoice_due_date: "2024-05-05"
            earliest_invoice_gross_amount: 100.0
            earliest_invoice_number: "123123"
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          message: Two B2b LTD (13078389) is now in arrears. Please see the
            details for the invoice that is due the earliest
          source: https://api.two.inc
          specversion: "1.0"
          subject: in_arrears_block
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: customer.in_arrears_block.v1
    CustomerInArrearsEventData:
      properties:
        buyer_company_name:
          type: string
          title: Buyer Company Name
          description: The legal name of the buyer company
        buyer_organization_number:
          type: string
          title: Buyer Organization Number
          description: National ID of the buyer company
        earliest_invoice_due_belongs_to_merchant:
          type: boolean
          title: Earliest Invoice Due Belongs To Merchant
          description: Indication of whether the invoice which is due earliest
            belongs to the merchant who receives this arrears event or
            to a different merchant using Two product
        earliest_invoice_number:
          anyOf:
            - type: string
            - type: "null"
          title: Earliest Invoice Number
          description: Invoice number of the invoice
        earliest_invoice_due_date:
          anyOf:
            - type: string
              format: date
            - type: "null"
          title: Earliest Invoice Due Date
          description: Due date of the invoice
        earliest_invoice_gross_amount:
          anyOf:
            - type: string
              pattern: ^-?[0-9]+(\.[0-9]{0,2})?
              format: decimal
            - type: "null"
          title: Earliest Invoice Gross Amount
          description: Gross amount of the invoice
        earliest_invoice_currency:
          anyOf:
            - type: string
            - type: "null"
          title: Earliest Invoice Currency
          description: ISO 4217 3 character currency code
        days_in_arrears:
          type: integer
          title: Days In Arrears
          description: Number of calendar days the buyer has been in arrears
            for where they are unable to able to place new orders before
            they repay most overdue invoice(s)
      type: object
      required:
        - buyer_company_name
        - buyer_organization_number
        - earliest_invoice_due_belongs_to_merchant
        - earliest_invoice_number
        - earliest_invoice_due_date
        - earliest_invoice_gross_amount
        - earliest_invoice_currency
        - days_in_arrears
      title: CustomerInArrearsEventData
      description: Data payload of a customer in arrears event.
    CustomerUserVerifiedData:
      properties:
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            order belongs to.
        merchant_customer_id:
          type: string
          title: Merchant Customer Id
          default: This should correspond to the merchant customer ID that
            was onboarded during trade account creation.
        customer_id:
          type: string
          title: Customer Id
          default: This should correspond to Two's customer ID that was
            returned during customer creation / trade account creation
        merchant_user_id:
          type: string
          title: Merchant User Id
          description: This should correspond to the merchant customer user
            ID that was onboarded during trade account creation.
        user_id:
          type: string
          title: User Id
          description: This should correspond to Two's user ID that was
            returned during customer user creation / trade account creation
        verification_id:
          anyOf:
            - type: string
            - type: "null"
          title: Verification Id
          description: The ID of the verification that was completed
        legal_rep_required:
          anyOf:
            - type: boolean
            - type: "null"
          title: Legal Rep Required
          description: Whether a legal representative was required for this
            verification
        verified_by_different_user:
          anyOf:
            - type: boolean
            - type: "null"
          title: Verified By Different User
          description: Whether the person who completed the verification
            is different from the customer user record
      type: object
      required:
        - merchant_id
        - merchant_user_id
        - user_id
      title: CustomerUserVerifiedData
      description: Web schema for merchant customer user verified response.
    CustomerUserVerifiedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: customer.user.verified.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/CustomerUserVerifiedData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: CustomerUserVerifiedEvent
      description: Event emitted when a customer user is verified.
      examples:
        - data:
            customer_id: 614d1ba5-1b38-4203-b783-2e6a5ecb82d0
            legal_rep_required: false
            merchant_customer_id: external-123545
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            merchant_user_id: external-12345
            user_id: 3fee121e-2f31-40de-97f6-613345fda4e2
            verification_id: 7fee121e-2f31-40de-97f6-613345fda4e2
            verified_by_different_user: false
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: customer/614d1ba5-1b38-4203-b783-2e6a5ecb82d0/user/3fee121e-2f31-40de-97f6-613345fda4e2
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: customer.user.verified.v1
    EnrollmentApprovedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: business_registry.approved.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/EnrollmentApprovedEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: EnrollmentApprovedEvent
      examples:
        - data:
            merchant_id: 1eb39178-c652-4784-9eee-af7e25b28a4c
            organization_number: "1234567"
            proposal_id: 558f57b4-8161-4765-a73e-a67d73f9c245
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: business_registry
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: business_registry.approved.v1
    EnrollmentApprovedEventData:
      properties:
        proposal_id:
          type: string
          title: Proposal Id
          description: Unique identifier of proposal
        merchant_id:
          anyOf:
            - type: string
            - type: "null"
          title: Merchant Id
          description: The ID of the merchant this statement relates to.
        organization_number:
          type: string
          title: Organization Number
          description: The organization number assigned to the newly enrolled
            business.
      type: object
      required:
        - proposal_id
        - merchant_id
        - organization_number
      title: EnrollmentApprovedEventData
    EnrollmentRejectedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: business_registry.rejected.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/EnrollmentRejectedEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: EnrollmentRejectedEvent
      examples:
        - data:
            merchant_id: 1eb39178-c652-4784-9eee-af7e25b28a4c
            proposal_id: 558f57b4-8161-4765-a73e-a67d73f9c245
            rejection_reason: Some reason
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: business_registry
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: business_registry.rejected.v1
    EnrollmentRejectedEventData:
      properties:
        proposal_id:
          type: string
          title: Proposal Id
          description: Unique identifier of proposal
        merchant_id:
          anyOf:
            - type: string
            - type: "null"
          title: Merchant Id
          description: The ID of the merchant this statement relates to.
        rejection_reason:
          type: string
          title: Rejection Reason
          description: The reason why this enrollment proposal was rejected.
      type: object
      required:
        - proposal_id
        - merchant_id
        - rejection_reason
      title: EnrollmentRejectedEventData
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Instalment:
      properties:
        plan_id:
          type: string
          title: Plan Id
          description: A unique identifier for the instalment plan associated
            with the instalment.
        instalment_id:
          type: string
          title: Instalment Id
          description: A unique identifier for the instalment.
      type: object
      required:
        - plan_id
        - instalment_id
      title: Instalment
    InstalmentsInvoicedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: instalments.invoiced.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/InstalmentsInvoicedEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: InstalmentsInvoicedEvent
      examples:
        - data:
            due_date: "2023-06-05"
            gross_amount: "1000.00"
            instalment_account_id: 044d6cf0-0f51-11ec-82a8-0242ac130003
            instalments:
              - instalment_id: a0f4bc40-8c5d-4b80-8c40-7d1f0b5a1f74
                plan_id: b6c9de3c-5d51-4a9d-89b1-63e1a9f7c5e5
              - instalment_id: d2f5f79b-1e5a-4fe3-9e53-0b3a4b2c1c1b
                plan_id: ff6b6e3e-5e0e-4d27-bc62-4e5a3a80e7f4
            invoice_id: e39f3206-0f94-4b9d-9f8f-1b2bae1e2bc9
            invoice_number: "90000001"
            issue_date: "2023-06-05"
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            payment_reference: p123456
            tax_subtotals:
              - tax_amount: "125.00"
                tax_rate: "0.250000"
                taxable_amount: "500.00"
              - tax_amount: "0.00"
                tax_rate: "0.000000"
                taxable_amount: "500.00"
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: webhooks.two.inc
          specversion: "1.0"
          subject: instalment_acccount/044d6cf0-0f51-11ec-82a8-0242ac130003
          time: "2023-06-21T12:34:56.123456"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: instalments.invoiced.v1
    InstalmentsInvoicedEventData:
      properties:
        invoice_id:
          type: string
          title: Invoice Id
          description: A unique identifier for the inoice as represented
            in Two's system.
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            invoice belongs to.
        issue_date:
          type: string
          format: date
          title: Issue Date
          description: The date this invoice was issued.
        due_date:
          type: string
          format: date
          title: Due Date
          description: The date this invoice is due.
        invoice_number:
          type: string
          title: Invoice Number
          description: A number identifying this invoice.
        payment_reference:
          anyOf:
            - type: string
            - type: "null"
          title: Payment Reference
          description: The payment reference that should be used to pay
            the invoice
        instalment_account_id:
          type: string
          title: Instalment Account Id
          description: A unique identifier representing the instalment account
            associated with this invoice.
        gross_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Gross Amount
          description: Amount of the invoice inclusive of tax.
        tax_subtotals:
          items:
            $ref: "#/components/schemas/TaxSubtotal"
          type: array
          title: Tax Subtotals
          description: A sequence of objects containing tax subtotal information
            for the invoice.
        instalments:
          items:
            $ref: "#/components/schemas/Instalment"
          type: array
          title: Instalments
          description: A sequence of objects containing information about
            the instalments comprising the invoice.
      type: object
      required:
        - invoice_id
        - merchant_id
        - issue_date
        - due_date
        - invoice_number
        - payment_reference
        - instalment_account_id
        - gross_amount
        - tax_subtotals
        - instalments
      title: InstalmentsInvoicedEventData
    MerchantPayeeAccountActivatedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: merchant.payee_account.activated.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/MerchantPayeeAccountActivatedEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: MerchantPayeeAccountActivatedEvent
      description: Event emitted when a merchant payee account for a new country
        and invoice type is activated.
      examples:
        - data:
            merchant_country_code: GB
            merchant_id: 614d1ba5-1b38-4203-b783-2e6a5ecb82d0
            merchant_legal_name: Example Merchant Ltd
            payee_account_country_code: GB
            payee_account_invoice_type: FUNDED_INVOICE
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: merchant/614d1ba5-1b38-4203-b783-2e6a5ecb82d0
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: 614d1ba5-1b38-4203-b783-2e6a5ecb82d0
          type: merchant.payee_account.activated.v1
    MerchantPayeeAccountActivatedEventData:
      properties:
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant that
            has been activated.
        merchant_legal_name:
          type: string
          title: Merchant Legal Name
          description: Legal name of the merchant that has been activated.
        merchant_country_code:
          type: string
          maxLength: 2
          minLength: 2
          title: Merchant Country Code
          description: The country of the merchant.
        payee_account_country_code:
          type: string
          maxLength: 2
          minLength: 2
          title: Payee Account Country Code
          description: Payee account country as represented by an ISO 3166
            Alpha-2 code
        payee_account_invoice_type:
          type: string
          title: Payee Account Invoice Type
          description: Invoice type of payee account activated
      type: object
      required:
        - merchant_id
        - merchant_legal_name
        - merchant_country_code
        - payee_account_country_code
        - payee_account_invoice_type
      title: MerchantPayeeAccountActivatedEventData
      description: Web schema for merchant activation response.
    OrderCancelled:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.cancelled.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderDataBase"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderCancelled
      description: Event emitted when order state is CANCELLED.
      examples:
        - data:
            buyer_company_name: TWO B2B LTD
            currency: GBP
            gross_amount: "150.65"
            invoice_amount: "150.65"
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            merchant_order_id: "999999"
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            payable_amount: "150.65"
            prepaid_amount: "0.00"
            root_order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            state: CANCELLED
            status: APPROVED
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.cancelled.v1
    OrderDataBase:
      properties:
        root_order_id:
          anyOf:
            - type: string
            - type: "null"
          title: Root Order Id
          description: The original order ID this order stems from. This
            is only useful for orders that are partially fulfilled, where
            the order_id will be a child or descendant of the root order.
        order_id:
          type: string
          title: Order Id
          description: A unique identifier for the order. For non-partial
            fulfilments this will match the root_order_id. If the event
            relates to a child order arising from partial fulfilment,
            this order_id will be different from the root_order_id.
        merchant_order_id:
          type: string
          title: Merchant Order Id
          description: An identifier for the order in merchant's system
            supplied during order creation.
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            order belongs to.
        gross_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Gross Amount
          description: This field has been replaced by payable_amount.
          deprecated: true
        invoice_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Invoice Amount
          description: Total amount of the invoice. prepaid_amount plus
            payable amount.
        payable_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Payable Amount
          description: Total payable amount of invoice.
        prepaid_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Prepaid Amount
          description: amount paid upfront towards the invoice.
        currency:
          type: string
          title: Currency
          description: An ISO 4217 alphabetic currency code representing
            the currency of the amount.
        buyer_company_name:
          type: string
          title: Buyer Company Name
          description: The name of the buyer company as represented in a
            national organisational register, such as the CRN used by
            Companies House in the UK.
        state:
          anyOf:
            - type: string
            - type: "null"
          title: State
          description: Current state of order
        status:
          anyOf:
            - type: string
            - type: "null"
          title: Status
          description: Current status of order
      type: object
      required:
        - order_id
        - merchant_order_id
        - merchant_id
        - gross_amount
        - invoice_amount
        - payable_amount
        - prepaid_amount
        - currency
        - buyer_company_name
      title: OrderDataBase
      description: Object describing details about order events.
    OrderFulfilled:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.fulfilled.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderDataBase"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderFulfilled
      description: Event emitted when order state is FULFILLED.
      examples:
        - data:
            buyer_company_name: TWO B2B LTD
            currency: GBP
            gross_amount: "150.65"
            invoice_amount: "150.65"
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            merchant_order_id: "999999"
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            payable_amount: "150.65"
            prepaid_amount: "0.00"
            root_order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            state: FULFILLED
            status: APPROVED
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.fulfilled.v1
    OrderReconciliationCollected:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.reconciliation.collected.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderReconciliationCollectedData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderReconciliationCollected
      description: Event emitted when.
      examples:
        - data:
            amount: "-101.65"
            billing_period_id: 175bda61-c6f2-4b9d-a429-5f31c83ecc10
            collection:
              collected_at: "2023-06-30T12:34:56.123456"
              collection_amount: "101.65"
              collection_id: 8d5f0cf6-0aee-4cb3-9723-ee221cdfc681
            currency: GBP
            invoice_id: 7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            root_order_id: 652a57e2-c2de-437b-96a7-2eeac0a37814
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.reconciliation.collected.v1
    OrderReconciliationCollectedData:
      properties:
        root_order_id:
          anyOf:
            - type: string
            - type: "null"
          title: Root Order Id
          description: The original order ID this order stems from. This
            is only useful for orders that are partially fulfilled, where
            the order_id will be a child or descendant of the root order.
        order_id:
          type: string
          title: Order Id
          description: A unique identifier for the order. For non-partial
            fulfilments this will match the root_order_id. If the event
            relates to a child order arising from partial fulfilment,
            this order_id will be different from the root_order_id.
        invoice_id:
          anyOf:
            - type: string
            - type: "null"
          title: Invoice Id
          description: A unique identifier for the invoice as represented
            in Two's system.
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            order belongs to.
        amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Amount
          description: The financial amount associated with this event.
            For invoices this will be negative. For payments to Two or
            other reductions in the amount owed by the buyer this will
            be positive.
        currency:
          type: string
          title: Currency
          description: An ISO 4217 alphabetic currency code representing
            the currency of the amount.
        billing_period_id:
          anyOf:
            - type: string
            - type: "null"
          title: Billing Period Id
          description: A unique identifier for this statement/grouping.
        merchant_user_id:
          anyOf:
            - type: string
            - type: "null"
          title: Merchant User Id
          description: Identifier provided by the merchant on creation of
            the order this reconciliation relates to if using Two'sTrade
            Account API. This should correspond to the merchant customer
            user ID that was onboarded during trade account creation.
        collection:
          $ref: "#/components/schemas/OrderReconciliationCollectedDataCollection"
          description: Object describing details about the collection associated
            with this reconciliation event.
      type: object
      required:
        - root_order_id
        - order_id
        - invoice_id
        - merchant_id
        - amount
        - currency
        - billing_period_id
        - merchant_user_id
        - collection
      title: OrderReconciliationCollectedData
      description: Object describing details about a collection reconciliation
        event.
    OrderReconciliationCollectedDataCollection:
      properties:
        collection_id:
          type: string
          title: Collection Id
          description: A unique identifier for the collection request in
            the Two system.
        collected_at:
          type: string
          format: date-time
          title: Collected At
          description: The date and time that the collection was made.
        collection_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Collection Amount
          description: The amount that has been requested by the collection.
      type: object
      required:
        - collection_id
        - collected_at
        - collection_amount
      title: OrderReconciliationCollectedDataCollection
    OrderReconciliationCredited:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.reconciliation.credited.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderReconciliationCreditedData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderReconciliationCredited
      description: Event emitted when credit will be allocated.
      examples:
        - data:
            amount: "-101.65"
            billing_period_id: 175bda61-c6f2-4b9d-a429-5f31c83ecc10
            credit_note:
              credit_note_amount: "101.65"
              credited_at: "2023-06-21T12:30:12.012345Z"
              refund_id: 433401fe-76ae-4e10-b091-59788c90a5df
            currency: GBP
            invoice_id: 7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            root_order_id: 652a57e2-c2de-437b-96a7-2eeac0a37814
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.reconciliation.credited.v1
    OrderReconciliationCreditedData:
      properties:
        root_order_id:
          anyOf:
            - type: string
            - type: "null"
          title: Root Order Id
          description: The original order ID this order stems from. This
            is only useful for orders that are partially fulfilled, where
            the order_id will be a child or descendant of the root order.
        order_id:
          type: string
          title: Order Id
          description: A unique identifier for the order. For non-partial
            fulfilments this will match the root_order_id. If the event
            relates to a child order arising from partial fulfilment,
            this order_id will be different from the root_order_id.
        invoice_id:
          anyOf:
            - type: string
            - type: "null"
          title: Invoice Id
          description: A unique identifier for the invoice as represented
            in Two's system.
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            order belongs to.
        amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Amount
          description: The financial amount associated with this event.
            For invoices this will be negative. For payments to Two or
            other reductions in the amount owed by the buyer this will
            be positive.
        currency:
          type: string
          title: Currency
          description: An ISO 4217 alphabetic currency code representing
            the currency of the amount.
        billing_period_id:
          anyOf:
            - type: string
            - type: "null"
          title: Billing Period Id
          description: A unique identifier for this statement/grouping.
        merchant_user_id:
          anyOf:
            - type: string
            - type: "null"
          title: Merchant User Id
          description: Identifier provided by the merchant on creation of
            the order this reconciliation relates to if using Two'sTrade
            Account API. This should correspond to the merchant customer
            user ID that was onboarded during trade account creation.
        credit_note:
          $ref: "#/components/schemas/OrderReconciliationCreditedDataCreditNote"
          description:
            Object describing details about the credit note associated
            with this reconciliation.
      type: object
      required:
        - root_order_id
        - order_id
        - invoice_id
        - merchant_id
        - amount
        - currency
        - billing_period_id
        - merchant_user_id
        - credit_note
      title: OrderReconciliationCreditedData
      description: Object describing details about a credit note reconciliation
        event.
    OrderReconciliationCreditedDataCreditNote:
      properties:
        refund_id:
          type: string
          title: Refund Id
          description: A unique identifier of the refund in the Two system.
        credited_at:
          type: string
          format: date-time
          title: Credited At
          description: The date and time that the credit note was issued.
        credit_note_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Credit Note Amount
          description: The full amount of the credit note.
      type: object
      required:
        - refund_id
        - credited_at
        - credit_note_amount
      title: OrderReconciliationCreditedDataCreditNote
    OrderReconciliationDataBase:
      properties:
        root_order_id:
          anyOf:
            - type: string
            - type: "null"
          title: Root Order Id
          description: The original order ID this order stems from. This
            is only useful for orders that are partially fulfilled, where
            the order_id will be a child or descendant of the root order.
        order_id:
          type: string
          title: Order Id
          description: A unique identifier for the order. For non-partial
            fulfilments this will match the root_order_id. If the event
            relates to a child order arising from partial fulfilment,
            this order_id will be different from the root_order_id.
        invoice_id:
          anyOf:
            - type: string
            - type: "null"
          title: Invoice Id
          description: A unique identifier for the invoice as represented
            in Two's system.
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            order belongs to.
        amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Amount
          description: The financial amount associated with this event.
            For invoices this will be negative. For payments to Two or
            other reductions in the amount owed by the buyer this will
            be positive.
        currency:
          type: string
          title: Currency
          description: An ISO 4217 alphabetic currency code representing
            the currency of the amount.
        billing_period_id:
          anyOf:
            - type: string
            - type: "null"
          title: Billing Period Id
          description: A unique identifier for this statement/grouping.
        merchant_user_id:
          anyOf:
            - type: string
            - type: "null"
          title: Merchant User Id
          description: Identifier provided by the merchant on creation of
            the order this reconciliation relates to if using Two'sTrade
            Account API. This should correspond to the merchant customer
            user ID that was onboarded during trade account creation.
      type: object
      required:
        - root_order_id
        - order_id
        - invoice_id
        - merchant_id
        - amount
        - currency
        - billing_period_id
        - merchant_user_id
      title: OrderReconciliationDataBase
      description: Object describing details about the reconciliation event.
    OrderReconciliationInvoiced:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.reconciliation.invoiced.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderReconciliationDataBase"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderReconciliationInvoiced
      description: Event that shows that invoice was created.
      examples:
        - data:
            amount: "150.65"
            billing_period_id: 175bda61-c6f2-4b9d-a429-5f31c83ecc10
            currency: GBP
            invoice_id: 7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            root_order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.reconciliation.invoiced.v1
    OrderReconciliationPaymentAllocated:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.reconciliation.payment_allocated.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderReconciliationPaymentAllocatedData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderReconciliationPaymentAllocated
      description: Event emitted when and payment will be allocated.
      examples:
        - data:
            amount: "-123.45"
            billing_period_id: 175bda61-c6f2-4b9d-a429-5f31c83ecc10
            currency: GBP
            invoice_id: 7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d
            matched_reference: ACB12345
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            payment:
              booked_at: "2023-06-21T12:30:12.012345Z"
              currency: GBP
              payment_amount: "500.05"
              payment_id: 1346ef4c-fae1-43a2-b637-24e0c756d4ce
              payment_reference: ABC12345
            root_order_id: 652a57e2-c2de-437b-96a7-2eeac0a37814
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.reconciliation.payment_allocated.v1
    OrderReconciliationPaymentAllocatedData:
      properties:
        root_order_id:
          anyOf:
            - type: string
            - type: "null"
          title: Root Order Id
          description: The original order ID this order stems from. This
            is only useful for orders that are partially fulfilled, where
            the order_id will be a child or descendant of the root order.
        order_id:
          type: string
          title: Order Id
          description: A unique identifier for the order. For non-partial
            fulfilments this will match the root_order_id. If the event
            relates to a child order arising from partial fulfilment,
            this order_id will be different from the root_order_id.
        invoice_id:
          anyOf:
            - type: string
            - type: "null"
          title: Invoice Id
          description: A unique identifier for the invoice as represented
            in Two's system.
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            order belongs to.
        amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Amount
          description: The financial amount associated with this event.
            For invoices this will be negative. For payments to Two or
            other reductions in the amount owed by the buyer this will
            be positive.
        currency:
          type: string
          title: Currency
          description: An ISO 4217 alphabetic currency code representing
            the currency of the amount.
        billing_period_id:
          anyOf:
            - type: string
            - type: "null"
          title: Billing Period Id
          description: A unique identifier for this statement/grouping.
        merchant_user_id:
          anyOf:
            - type: string
            - type: "null"
          title: Merchant User Id
          description: Identifier provided by the merchant on creation of
            the order this reconciliation relates to if using Two'sTrade
            Account API. This should correspond to the merchant customer
            user ID that was onboarded during trade account creation.
        payment:
          $ref: "#/components/schemas/OrderReconciliationPaymentAllocatedDataPayment"
          description:
            Details about the payment associated with this reconciliation
            event.
        matched_reference:
          type: string
          title: Matched Reference
          description: The payment reference Two has used to match the payment
            against any invoices or statements.
      type: object
      required:
        - root_order_id
        - order_id
        - invoice_id
        - merchant_id
        - amount
        - currency
        - billing_period_id
        - merchant_user_id
        - payment
        - matched_reference
      title: OrderReconciliationPaymentAllocatedData
      description: Object describing details about the payment allocation/deallocation.
    OrderReconciliationPaymentAllocatedDataPayment:
      properties:
        payment_id:
          type: string
          title: Payment Id
          description: A unique identifier of the payment in the Two system.
        payment_reference:
          anyOf:
            - type: string
            - type: "null"
          title: Payment Reference
          description: The reference given by the buyer for the payment,
            as received by Two from our external provider(s). May be null
            if no reference was avaialble from the external provider.
        booked_at:
          type: string
          format: date-time
          title: Booked At
          description: The date and time that Two's external provider registered
            the payment as received.
        payment_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Payment Amount
          description: The actual amount received by Two in the payment.
        currency:
          type: string
          title: Currency
          description: An ISO 4217 alphabetic currency code representing
            the currency of the amount.
      type: object
      required:
        - payment_id
        - payment_reference
        - booked_at
        - payment_amount
        - currency
      title: OrderReconciliationPaymentAllocatedDataPayment
      description: Payment detailed information.
    OrderReconciliationRecoursed:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.reconciliation.recoursed.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderReconciliationRecoursedData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderReconciliationRecoursed
      description: Event emitted when payment is not reconciled, buyer needs
        to recourse payment from Merchant.
      examples:
        - data:
            amount: "-101.65"
            billing_period_id: 175bda61-c6f2-4b9d-a429-5f31c83ecc10
            currency: GBP
            invoice_id: 7a5a7b9b-7d9e-4e9e-b9b1-2d7c658e1a4d
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            recourse:
              recourse_amount: "101.65"
              recourse_id: 4228e51d-45ba-4a7f-a279-0f332bfead9c
              recoursed_at: "2023-06-21T12:34:56.123456Z"
            root_order_id: 652a57e2-c2de-437b-96a7-2eeac0a37814
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.reconciliation.recoursed.v1
    OrderReconciliationRecoursedData:
      properties:
        root_order_id:
          anyOf:
            - type: string
            - type: "null"
          title: Root Order Id
          description: The original order ID this order stems from. This
            is only useful for orders that are partially fulfilled, where
            the order_id will be a child or descendant of the root order.
        order_id:
          type: string
          title: Order Id
          description: A unique identifier for the order. For non-partial
            fulfilments this will match the root_order_id. If the event
            relates to a child order arising from partial fulfilment,
            this order_id will be different from the root_order_id.
        invoice_id:
          anyOf:
            - type: string
            - type: "null"
          title: Invoice Id
          description: A unique identifier for the invoice as represented
            in Two's system.
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            order belongs to.
        amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Amount
          description: The financial amount associated with this event.
            For invoices this will be negative. For payments to Two or
            other reductions in the amount owed by the buyer this will
            be positive.
        currency:
          type: string
          title: Currency
          description: An ISO 4217 alphabetic currency code representing
            the currency of the amount.
        billing_period_id:
          anyOf:
            - type: string
            - type: "null"
          title: Billing Period Id
          description: A unique identifier for this statement/grouping.
        merchant_user_id:
          anyOf:
            - type: string
            - type: "null"
          title: Merchant User Id
          description: Identifier provided by the merchant on creation of
            the order this reconciliation relates to if using Two'sTrade
            Account API. This should correspond to the merchant customer
            user ID that was onboarded during trade account creation.
        recourse:
          $ref: "#/components/schemas/OrderReconciliationRecoursedDataRecourse"
          description: Object describing the recourse associated with this
            reconciliation event.
      type: object
      required:
        - root_order_id
        - order_id
        - invoice_id
        - merchant_id
        - amount
        - currency
        - billing_period_id
        - merchant_user_id
        - recourse
      title: OrderReconciliationRecoursedData
      description: Object describing details about a recourse reconciliation
        event.
    OrderReconciliationRecoursedDataRecourse:
      properties:
        recourse_id:
          type: string
          title: Recourse Id
          description: A unique identifier for the recourse in the Two system.
        recoursed_at:
          type: string
          format: date-time
          title: Recoursed At
          description: The date and time the invoice was recoursed.
        recourse_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Recourse Amount
          description: The amount Two is recoursing back to the merchant.
      type: object
      required:
        - recourse_id
        - recoursed_at
        - recourse_amount
      title: OrderReconciliationRecoursedDataRecourse
    OrderRefundData:
      properties:
        root_order_id:
          anyOf:
            - type: string
            - type: "null"
          title: Root Order Id
          description: The original order ID this order stems from. This
            is only useful for orders that are partially fulfilled, where
            the order_id will be a child or descendant of the root order.
        order_id:
          type: string
          title: Order Id
          description: A unique identifier for the order. For non-partial
            fulfilments this will match the root_order_id. If the event
            relates to a child order arising from partial fulfilment,
            this order_id will be different from the root_order_id.
        merchant_order_id:
          type: string
          title: Merchant Order Id
          description: An identifier for the order in merchant's system
            supplied during order creation.
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            order belongs to.
        gross_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Gross Amount
          description: This field has been replaced by payable_amount.
          deprecated: true
        invoice_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Invoice Amount
          description: Total amount of the invoice. prepaid_amount plus
            payable amount.
        payable_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Payable Amount
          description: Total payable amount of invoice.
        prepaid_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Prepaid Amount
          description: amount paid upfront towards the invoice.
        currency:
          type: string
          title: Currency
          description: An ISO 4217 alphabetic currency code representing
            the currency of the amount.
        buyer_company_name:
          type: string
          title: Buyer Company Name
          description: The name of the buyer company as represented in a
            national organisational register, such as the CRN used by
            Companies House in the UK.
        state:
          anyOf:
            - type: string
            - type: "null"
          title: State
          description: Current state of order
        status:
          anyOf:
            - type: string
            - type: "null"
          title: Status
          description: Current status of order
        refund_id:
          anyOf:
            - type: string
            - type: "null"
          title: Refund Id
          description: A unique identifier of the refund in the Two system.
        merchant_refund_reference:
          anyOf:
            - type: string
            - type: "null"
          title: Merchant Refund Reference
          description: Merchant supplied reference
        refunded_gross_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Refunded Gross Amount
          description: please use refunded_payable_amount
          deprecated: true
        refunded_payable_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Refunded Payable Amount
          description: The credited/refunded payable amount from the order
            event.
        refunded_prepaid_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Refunded Prepaid Amount
          description: The credited/refunded prepaid amount from the order
            event.
      type: object
      required:
        - order_id
        - merchant_order_id
        - merchant_id
        - gross_amount
        - invoice_amount
        - payable_amount
        - prepaid_amount
        - currency
        - buyer_company_name
        - refunded_gross_amount
        - refunded_payable_amount
        - refunded_prepaid_amount
      title: OrderRefundData
      description: Object describing details about order refunded events.
    OrderRefunded:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.refunded.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderRefundData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderRefunded
      description: Event emitted when order state is REFUNDED.
      examples:
        - data:
            buyer_company_name: TWO B2B LTD
            currency: GBP
            gross_amount: "150.65"
            invoice_amount: "150.65"
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            merchant_order_id: "999999"
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            payable_amount: "150.65"
            prepaid_amount: "0.00"
            refunded_gross_amount: "100.00"
            refunded_payable_amount: "100.00"
            refunded_prepaid_amount: "100.00"
            root_order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            state: REFUNDED
            status: APPROVED
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.refunded.v1
    OrderRejected:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.rejected.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderRejectedData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderRejected
      description: Event emitted when order state is FULFILLED.
      examples:
        - data:
            buyer_company_name: TWO B2B LTD
            currency: GBP
            decline_reason: TOO_HIGH_RISK
            gross_amount: "150.65"
            invoice_amount: "150.65"
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            merchant_order_id: "999999"
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            payable_amount: "150.65"
            prepaid_amount: "0.00"
            root_order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            state: UNVERIFIED
            status: REJECTED
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.rejected.v1
    OrderRejectedData:
      properties:
        root_order_id:
          anyOf:
            - type: string
            - type: "null"
          title: Root Order Id
          description: The original order ID this order stems from. This
            is only useful for orders that are partially fulfilled, where
            the order_id will be a child or descendant of the root order.
        order_id:
          type: string
          title: Order Id
          description: A unique identifier for the order. For non-partial
            fulfilments this will match the root_order_id. If the event
            relates to a child order arising from partial fulfilment,
            this order_id will be different from the root_order_id.
        merchant_order_id:
          type: string
          title: Merchant Order Id
          description: An identifier for the order in merchant's system
            supplied during order creation.
        merchant_id:
          type: string
          title: Merchant Id
          description: A unique identifier representing the merchant this
            order belongs to.
        gross_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Gross Amount
          description: This field has been replaced by payable_amount.
          deprecated: true
        invoice_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Invoice Amount
          description: Total amount of the invoice. prepaid_amount plus
            payable amount.
        payable_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Payable Amount
          description: Total payable amount of invoice.
        prepaid_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Prepaid Amount
          description: amount paid upfront towards the invoice.
        currency:
          type: string
          title: Currency
          description: An ISO 4217 alphabetic currency code representing
            the currency of the amount.
        buyer_company_name:
          type: string
          title: Buyer Company Name
          description: The name of the buyer company as represented in a
            national organisational register, such as the CRN used by
            Companies House in the UK.
        state:
          anyOf:
            - type: string
            - type: "null"
          title: State
          description: Current state of order
        status:
          anyOf:
            - type: string
            - type: "null"
          title: Status
          description: Current status of order
        decline_reason:
          anyOf:
            - type: string
            - type: "null"
          title: Decline Reason
          description: The decline reason associated with order rejection.
      type: object
      required:
        - order_id
        - merchant_order_id
        - merchant_id
        - gross_amount
        - invoice_amount
        - payable_amount
        - prepaid_amount
        - currency
        - buyer_company_name
      title: OrderRejectedData
      description: Object describing details about order refunded events.
    OrderVerified:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: order.verified.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/OrderDataBase"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: OrderVerified
      description: Event emitted when order state is VERIFIED, ready to fulfill.
      examples:
        - data:
            buyer_company_name: TWO B2B LTD
            currency: GBP
            gross_amount: "150.65"
            invoice_amount: "150.65"
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            merchant_order_id: "999999"
            merchant_refund_reference: merchant-ref
            order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            payable_amount: "150.65"
            prepaid_amount: "0.00"
            refund_id: 2934d2r3-f6b7-4e2a-a4b4-6c7f8a9d0f1e
            root_order_id: a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
            state: VERIFIED
            status: APPROVED
          datacontenttype: application/json
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: order/a9f5d2d3-5d6d-4e2a-a4b4-6c7f8a9d0f1e
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: order.verified.v1
    TaxSubtotal:
      properties:
        tax_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Tax Amount
          description: The amount of tax paid at the given tax rate.
        taxable_amount:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,2})?
          format: decimal
          title: Taxable Amount
          description: The total amount on the invoice to be taxed at the
            given rate.
        tax_rate:
          type: string
          pattern: ^-?[0-9]+(\.[0-9]{0,6})?
          format: decimal
          title: Tax Rate
          description: The tax rate.
      type: object
      required:
        - tax_amount
        - taxable_amount
        - tax_rate
      title: TaxSubtotal
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    WorkflowCompletedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: workflow.completed.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/WorkflowEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: WorkflowCompletedEvent
      description: Occurs when a workflow is completed.
      examples:
        - data:
            activities:
              - id: ca2e0141-c670-4668-ba4f-06048870840f
                name: my-activity/v1
                status: COMPLETED
              - id: 8f5a4a4a-7753-4b54-85b7-777fe11306e1
                name: other-activity/v1
                status: COMPLETED
            id: a1f52956-481c-486b-9333-341c4bf6e0ea
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            reference: ref123
            template_name: example-template/v1
          id: 04FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: workflow/a1f52956-481c-486b-9333-341c4bf6e0ea
          time: "2023-06-21T16:00:00.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: workflow.completed.v1
    WorkflowCreatedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: workflow.created.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/WorkflowEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: WorkflowCreatedEvent
      description: Occurs when a workflow is created.
      examples:
        - data:
            activities:
              - id: ca2e0141-c670-4668-ba4f-06048870840f
                name: my-activity/v1
                status: NOT_STARTED
              - id: 8f5a4a4a-7753-4b54-85b7-777fe11306e1
                name: other-activity/v1
                status: LOCKED
            id: a1f52956-481c-486b-9333-341c4bf6e0ea
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            reference: ref123
            template_name: example-template/v1
          id: 01FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: workflow/a1f52956-481c-486b-9333-341c4bf6e0ea
          time: "2023-06-21T12:34:56.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: workflow.created.v1
    WorkflowEventData:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the workflow
        merchant_id:
          type: string
          title: Merchant Id
          description: Unique identifier of the merchant that the workflow
            belongs to
        reference:
          type: string
          title: Reference
          description: The reference that was passed on workflow creation
        template_name:
          type: string
          title: Template Name
          description: Name of the template that was ued to create the workflow
        activities:
          items:
            $ref: "#/components/schemas/ActivityEventData"
          type: array
          title: Activities
          description: List of activities that are part of the workflow
      type: object
      required:
        - id
        - merchant_id
        - reference
        - template_name
        - activities
      title: WorkflowEventData
    WorkflowFailedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: workflow.failed.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/WorkflowFailedEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: WorkflowFailedEvent
      description: Occurs when a workflow fails permanently, for instance due
        to expiry.
      examples:
        - data:
            activities:
              - id: ca2e0141-c670-4668-ba4f-06048870840f
                name: my-activity/v1
                status: COMPLETED
              - id: 8f5a4a4a-7753-4b54-85b7-777fe11306e1
                name: other-activity/v1
                status: TERMINATED
            failed_reason: EXPIRED
            id: a1f52956-481c-486b-9333-341c4bf6e0ea
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            reference: ref123
            template_name: example-template/v1
          id: 05FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: workflow/a1f52956-481c-486b-9333-341c4bf6e0ea
          time: "2023-06-21T17:00:00.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: workflow.failed.v1
    WorkflowFailedEventData:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the workflow
        merchant_id:
          type: string
          title: Merchant Id
          description: Unique identifier of the merchant that the workflow
            belongs to
        reference:
          type: string
          title: Reference
          description: The reference that was passed on workflow creation
        template_name:
          type: string
          title: Template Name
          description: Name of the template that was ued to create the workflow
        activities:
          items:
            $ref: "#/components/schemas/ActivityEventData"
          type: array
          title: Activities
          description: List of activities that are part of the workflow
        failed_reason:
          $ref: "#/components/schemas/WorkflowFailureReason"
          description: |-
            Reason why the workflow failed

                Reason for workflow failure.
                Explaination:

                - EXPIRED: The workflow was not completed within the allowed time frame.
                - REJECTED: The workflow was rejected during a review step.
                - ABANDONED: The workflow was abandoned by the user.
                - CANCELLED: The workflow was cancelled by the client
                - TECHNICAL_ERROR: The workflow failed due to a technical error in the system.
                - OTHER: The workflow failed for another reason not listed above. Default reason.
                    For forwards compatibility with adding more reasons, parsers should default to
                    this status if they don't recongnize the value.
      type: object
      required:
        - id
        - merchant_id
        - reference
        - template_name
        - activities
        - failed_reason
      title: WorkflowFailedEventData
    WorkflowFailureReason:
      type: string
      enum:
        - EXPIRED
        - REJECTED
        - ABANDONED
        - CANCELLED
        - TECHNICAL_ERROR
        - OTHER
      title: WorkflowFailureReason
      description: |-
        Reason for workflow failure.
        Explaination:

        - EXPIRED: The workflow was not completed within the allowed time frame.
        - REJECTED: The workflow was rejected during a review step.
        - ABANDONED: The workflow was abandoned by the user.
        - CANCELLED: The workflow was cancelled by the client
        - TECHNICAL_ERROR: The workflow failed due to a technical error in the system.
        - OTHER: The workflow failed for another reason not listed above. Default reason.
            For forwards compatibility with adding more reasons, parsers should default to
            this status if they don't recongnize the value.
    WorkflowInReviewEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: workflow.in_review.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/WorkflowEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: WorkflowInReviewEvent
      description: Occurs when a workflow is queued for review.
      examples:
        - data:
            activities:
              - id: ca2e0141-c670-4668-ba4f-06048870840f
                name: my-activity/v1
                status: COMPLETED
              - id: 8f5a4a4a-7753-4b54-85b7-777fe11306e1
                name: other-activity/v1
                status: COMPLETED
            id: a1f52956-481c-486b-9333-341c4bf6e0ea
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            reference: ref123
            template_name: example-template/v1
          id: 03FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: workflow/a1f52956-481c-486b-9333-341c4bf6e0ea
          time: "2023-06-21T15:00:00.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: workflow.in_review.v1
    WorkflowProgressedEvent:
      properties:
        id:
          type: string
          title: Id
          description: The event ID. Unique within the source. Can be used
            to deduplicate events.
        specversion:
          type: string
          title: Specversion
          description: The version of the CloudEvents specification.
          default: "1.0"
        source:
          type: string
          title: Source
          description: A representation of the event's originating system.
        subject:
          anyOf:
            - type: string
            - type: "null"
          title: Subject
          description: Identifies the entity that the event relates to.
        type:
          type: string
          const: workflow.progressed.v1
          title: Type
        time:
          type: string
          format: date-time
          title: Time
          description: The event timestamp.
        twomerchantid:
          anyOf:
            - type: string
            - type: "null"
          title: Twomerchantid
          description: The ID of the merchant that this event relates to.
        message:
          anyOf:
            - type: string
            - type: "null"
          title: Message
          description: Webhook notification human-friendly message.
        data:
          $ref: "#/components/schemas/WorkflowEventData"
      type: object
      required:
        - id
        - source
        - type
        - time
        - data
      title: WorkflowProgressedEvent
      description: |-
        Occurs when significat changes happen to a workflow while is in progress.

        Typically this means that the status of one or more activities has changed.
      examples:
        - data:
            activities:
              - id: ca2e0141-c670-4668-ba4f-06048870840f
                name: my-activity/v1
                status: COMPLETED
              - id: 8f5a4a4a-7753-4b54-85b7-777fe11306e1
                name: other-activity/v1
                status: NOT_STARTED
            id: a1f52956-481c-486b-9333-341c4bf6e0ea
            merchant_id: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
            reference: ref123
            template_name: example-template/v1
          id: 02FBJ0PYJ7931K0CJ6GMP8N3WG
          source: https://api.two.inc
          specversion: "1.0"
          subject: workflow/a1f52956-481c-486b-9333-341c4bf6e0ea
          time: "2023-06-21T14:30:00.123456Z"
          twomerchantid: b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2
          type: workflow.progressed.v1