{
  "opencollection": "1.0.0",
  "info": {
    "name": "Tabby API Reference Checkout Payments API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tabby.ai/api/v2/payments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the payment."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieves the specified payment. Returns the entire payment object, including the payment Status, Captures and Refunds objects."
        },
        {
          "info": {
            "name": "Update a payment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.tabby.ai/api/v2/payments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the payment."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates the reference_id. You can only use this endpoint to update this 1 field. If you send other fields in the request, they will simply be ignored by tabby. The payment to be updated can have a status of AUTHORIZED or CLOSED."
        },
        {
          "info": {
            "name": "Capture a payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.tabby.ai/api/v2/payments/:id/captures",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the payment."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Send a Capture requests for Authorized payments only. If you capture the full payment amount, the payment will be automatically closed with full capture. If you capture partial amount, the payment will remain Authorized until the rest of the amount is captured or Close request sent."
        },
        {
          "info": {
            "name": "Refund a payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.tabby.ai/api/v2/payments/:id/refunds",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the payment."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Send a full or partial refund amount request. You can only refund the payment that has Closed status. By default refunds reflect instantly, which means Tabby initiates a refund through payment gateway."
        },
        {
          "info": {
            "name": "Close a payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.tabby.ai/api/v2/payments/:id/close",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the payment."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Closed is the final status of the payment. Your payment is going to be closed automatically if you capture the full amount of the payment. If an order is fully cancelled, please close the payment without capturing it - the customer will be refunded for all paid amount. If only a part of the order is delivered, please capture this part and close the payment – it will mean that another part of the order is not going to be delivered to the customer."
        },
        {
          "info": {
            "name": "List of all payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tabby.ai/api/v2/payments",
            "params": [
              {
                "name": "created_at__gte",
                "value": "",
                "type": "query",
                "description": "This is a filter for the payment creation date, use it to get the list of payments where creation date >= created_at__gte. ISO 8601 date time format (greater than or equal to). No time should be provided, it starts at 00:00:00 be default. For example 2020-01-23 -> 2020-01-23T00:00:00Z."
              },
              {
                "name": "created_at__lte",
                "value": "",
                "type": "query",
                "description": "This is a filter for the payment creation date, use it to get the list of payments where creation date <= created_at__lte. ISO 8601 date time format (less than or equal to). No time should be provided, it starts at 00:00:00 be default. For example 2020-01-23 -> 2020-01-23T00:00:00Z."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limits the number of returned results."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter the orders by specific statuses:\n  - `authorized`, `closed` and `rejected` belong to the API payment statuses;\n  - `new`, `captured`, `refunded` and `cancelled`` refer to the statuses on Tabby Merchant Dashboard;\n  - If absent, all `AUTHORIZED` and `CLOSED` payments are returned.\n"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of records into a dataset that you want to start, indexed at 0."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of success payments (`AUTHORIZED` or `CLOSED`) you’ve previously created. The payments are returned in sorted order, with the most recent payments appearing first. Each entry in the array is a separate payments object, including the status, any captures and any refunds. If no more payments are available, the resulting array will be empty. Payments might be filtered by creation date."
        }
      ]
    }
  ],
  "bundled": true
}