{
  "opencollection": "1.0.0",
  "info": {
    "name": "Root Applications Payments API",
    "version": "1.0.1"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Update a payment batch",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://sandbox.uk.rootplatform.com/v1/insurance/payment-batches/:payment_batch_id",
            "params": [
              {
                "name": "payment_batch_id",
                "value": "",
                "type": "path",
                "description": "Must be a UUID. The unique identifier of the payment batch."
              },
              {
                "name": "idempotency_key",
                "value": "",
                "type": "query",
                "description": "To perform an idempotent request, provide the `idempotency_key` query parameter with the request. An idempotency key is a unique value generated by the client which the platform uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using a V4 UUID, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a payment batch"
        },
        {
          "info": {
            "name": "Create payments async",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sandbox.uk.rootplatform.com/v1/insurance/payments/async-create",
            "params": [
              {
                "name": "idempotency_key",
                "value": "",
                "type": "query",
                "description": "To perform an idempotent request, provide the `idempotency_key` query parameter with the request. An idempotency key is a unique value generated by the client which the platform uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using a V4 UUID, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is deprecated in favour of [create payment](ref:createpolicypayment). This endpoint validates the input and queues payments to be processed asynchronously. A response of `200 OK` is sent if the payments are valid and have been successfully queued. This endpoint allows for up to 5000 payments to be created at a time. To use this endpoint you'll need the `Payments Create` permission.\n"
        },
        {
          "info": {
            "name": "Update payments async",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sandbox.uk.rootplatform.com/v1/insurance/payments/async-update",
            "params": [
              {
                "name": "idempotency_key",
                "value": "",
                "type": "query",
                "description": "To perform an idempotent request, provide the `idempotency_key` query parameter with the request. An idempotency key is a unique value generated by the client which the platform uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using a V4 UUID, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint validates the input and queues [payment updates](ref:payment-update) to be processed asynchronously, which will result in a `200 OK` successful response. **Note:** Despite a successful response, queued updates can nevertheless fail. To receive the update failure / success status, subscribe to the `payment_updates_succeeded` and `payment_updates_failed` [webhooks](ref:create-webhook)."
        },
        {
          "info": {
            "name": "Update payment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://sandbox.uk.rootplatform.com/v1/insurance/payments/:payment_id",
            "params": [
              {
                "name": "payment_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [payment](ref:payment)."
              },
              {
                "name": "idempotency_key",
                "value": "",
                "type": "query",
                "description": "To perform an idempotent request, provide the `idempotency_key` query parameter with the request. An idempotency key is a unique value generated by the client which the platform uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using a V4 UUID, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint validates the input and updates a payment, which will result in a `200 OK` successful response, with the updated payment in the response."
        },
        {
          "info": {
            "name": "Reschedule a scheduled payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sandbox.uk.rootplatform.com/v1/insurance/scheduled-payments/:scheduled_payment_id/reschedule",
            "params": [
              {
                "name": "scheduled_payment_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the scheduled payment."
              },
              {
                "name": "idempotency_key",
                "value": "",
                "type": "query",
                "description": "To perform an idempotent request, provide the `idempotency_key` query parameter with the request. An idempotency key is a unique value generated by the client which the platform uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using a V4 UUID, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves a pending scheduled payment to a new date. The caller must pass the schedule's current `version` for optimistic-locking; a stale version returns `409 Conflict`. Only pending schedules can be rescheduled. Returns `200 OK` with the scheduled payment id on success."
        },
        {
          "info": {
            "name": "Unschedule a scheduled payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sandbox.uk.rootplatform.com/v1/insurance/scheduled-payments/:scheduled_payment_id/unschedule",
            "params": [
              {
                "name": "scheduled_payment_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the scheduled payment."
              },
              {
                "name": "idempotency_key",
                "value": "",
                "type": "query",
                "description": "To perform an idempotent request, provide the `idempotency_key` query parameter with the request. An idempotency key is a unique value generated by the client which the platform uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using a V4 UUID, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancels a pending scheduled payment so it will not be collected. The caller must pass the schedule's current `version` for optimistic-locking; a stale version returns `409 Conflict`. Only pending schedules can be unscheduled. Returns `200 OK` with the scheduled payment id on success."
        }
      ]
    }
  ],
  "bundled": true
}