{
  "info": {
    "name": "MyTPE External API",
    "description": "Server-to-server API for one MyTPE account. Limits are provisional defaults set in configuration, not capacity guarantees.\n\nGenerated from the published API contract; regenerated with every change to it.\n\nSet `clientId`, `clientSecret` and `scope` (the scopes your integration was granted, space-separated) in the collection's variables. Requests get their token through the collection's OAuth 2.0 authorization (client credentials).",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "oauth2",
    "oauth2": [
      {
        "key": "grant_type",
        "value": "client_credentials",
        "type": "string"
      },
      {
        "key": "accessTokenUrl",
        "value": "{{tokenUrl}}",
        "type": "string"
      },
      {
        "key": "clientId",
        "value": "{{clientId}}",
        "type": "string"
      },
      {
        "key": "clientSecret",
        "value": "{{clientSecret}}",
        "type": "string"
      },
      {
        "key": "scope",
        "value": "{{scope}}",
        "type": "string"
      },
      {
        "key": "client_authentication",
        "value": "body",
        "type": "string"
      },
      {
        "key": "addTokenTo",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.mytpe.app/api/ext"
    },
    {
      "key": "tokenUrl",
      "value": "https://api.mytpe.app/oauth/token"
    },
    {
      "key": "clientId",
      "value": ""
    },
    {
      "key": "clientSecret",
      "value": ""
    },
    {
      "key": "scope",
      "value": ""
    }
  ],
  "item": [
    {
      "name": "Authentication",
      "description": "Exchange your client credentials for an access token.",
      "item": [
        {
          "name": "Get an access token",
          "request": {
            "auth": {
              "type": "noauth"
            },
            "method": "POST",
            "header": [],
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "grant_type",
                  "value": "client_credentials"
                },
                {
                  "key": "client_id",
                  "value": "{{clientId}}"
                },
                {
                  "key": "client_secret",
                  "value": "{{clientSecret}}"
                },
                {
                  "key": "scope",
                  "value": "{{scope}}"
                }
              ]
            },
            "url": {
              "raw": "{{tokenUrl}}",
              "host": [
                "{{tokenUrl}}"
              ]
            },
            "description": "OAuth 2.0 client credentials. The token acts on the one account the integration is installed on."
          }
        }
      ]
    },
    {
      "name": "Current user",
      "description": "Read the owner of the account the request acts in.",
      "item": [
        {
          "name": "Get the account owner",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/me",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "me"
              ],
              "variable": []
            },
            "description": "Scope: `account:read`."
          }
        }
      ]
    },
    {
      "name": "Workspaces",
      "description": "Read the account the integration is installed on.",
      "item": [
        {
          "name": "Get the workspace",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/workspaces",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "workspaces"
              ],
              "variable": []
            },
            "description": "Scope: `account:read`."
          }
        }
      ]
    },
    {
      "name": "Identifications",
      "description": "Manage the legal entities of the account.",
      "item": [
        {
          "name": "List identifications",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/identifications",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "identifications"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "per_page",
                  "value": "0",
                  "description": "At most 100.",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "description": "Text to look for.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "pending",
                  "description": "Filter by review status.",
                  "disabled": true
                },
                {
                  "key": "establishment_type_id",
                  "value": "",
                  "description": "Filter by establishment type.",
                  "disabled": true
                },
                {
                  "key": "sort_by",
                  "value": "created_at",
                  "description": "Field to sort by.",
                  "disabled": true
                },
                {
                  "key": "sort_dir",
                  "value": "asc",
                  "description": "Sort direction.",
                  "disabled": true
                }
              ],
              "variable": []
            },
            "description": "Scope: `kyc:read`."
          }
        },
        {
          "name": "Create an identification",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "name",
                  "type": "text",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "establishment_type_id",
                  "type": "text",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "authorization_type_id",
                  "type": "text",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "activity_id",
                  "type": "text",
                  "value": "",
                  "description": "Required unless the establishment type is `profession_liberale`."
                },
                {
                  "key": "identification_file",
                  "type": "file",
                  "src": [],
                  "description": "The registration document. PDF, JPEG or PNG, at most 5 MB."
                }
              ]
            },
            "url": {
              "raw": "{{baseUrl}}/identifications",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "identifications"
              ],
              "variable": []
            },
            "description": "Scope: `kyc:write`."
          }
        },
        {
          "name": "Get an identification",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/identifications/:identification",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "identifications",
                ":identification"
              ],
              "variable": [
                {
                  "key": "identification",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `kyc:read`."
          }
        },
        {
          "name": "Update an identification",
          "request": {
            "method": "PUT",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/identifications/:identification",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "identifications",
                ":identification"
              ],
              "variable": [
                {
                  "key": "identification",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "To replace a file, send `POST` with `multipart/form-data` and the field `_method=PUT`. A `PUT` body in `multipart/form-data` is not read.\n\nScope: `kyc:write`."
          }
        },
        {
          "name": "Delete an identification",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/identifications/:identification",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "identifications",
                ":identification"
              ],
              "variable": [
                {
                  "key": "identification",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `kyc:write`."
          }
        }
      ]
    },
    {
      "name": "Brands",
      "description": "Manage the brands under an identification.",
      "item": [
        {
          "name": "List brands",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/brands",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "brands"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "per_page",
                  "value": "0",
                  "description": "At most 100.",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "description": "Text to look for.",
                  "disabled": true
                },
                {
                  "key": "identification_id",
                  "value": "",
                  "description": "Filter by identification.",
                  "disabled": true
                },
                {
                  "key": "sort_by",
                  "value": "created_at",
                  "description": "Field to sort by.",
                  "disabled": true
                },
                {
                  "key": "sort_dir",
                  "value": "asc",
                  "description": "Sort direction.",
                  "disabled": true
                }
              ],
              "variable": []
            },
            "description": "Scope: `kyc:read`."
          }
        },
        {
          "name": "Create a brand",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "name",
                  "type": "text",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "identification_id",
                  "type": "text",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "file",
                  "type": "file",
                  "src": [],
                  "description": "The brand document. JPEG, PNG or GIF, at most 5 MB."
                },
                {
                  "key": "logo",
                  "type": "file",
                  "src": [],
                  "description": "JPEG, PNG or GIF, at most 5 MB."
                }
              ]
            },
            "url": {
              "raw": "{{baseUrl}}/brands",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "brands"
              ],
              "variable": []
            },
            "description": "Scope: `kyc:write`."
          }
        },
        {
          "name": "Get a brand",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/brands/:brand",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "brands",
                ":brand"
              ],
              "variable": [
                {
                  "key": "brand",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `kyc:read`."
          }
        },
        {
          "name": "Update a brand",
          "request": {
            "method": "PUT",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/brands/:brand",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "brands",
                ":brand"
              ],
              "variable": [
                {
                  "key": "brand",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "To replace a file, send `POST` with `multipart/form-data` and the field `_method=PUT`. A `PUT` body in `multipart/form-data` is not read.\n\nScope: `kyc:write`."
          }
        },
        {
          "name": "Delete a brand",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/brands/:brand",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "brands",
                ":brand"
              ],
              "variable": [
                {
                  "key": "brand",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `kyc:write`."
          }
        }
      ]
    },
    {
      "name": "Bank accounts",
      "description": "Manage the bank accounts under an identification.",
      "item": [
        {
          "name": "List bank accounts",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/bank-accounts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "bank-accounts"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "per_page",
                  "value": "0",
                  "description": "At most 100.",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "description": "Text to look for.",
                  "disabled": true
                },
                {
                  "key": "sort_by",
                  "value": "created_at",
                  "description": "Field to sort by.",
                  "disabled": true
                },
                {
                  "key": "sort_dir",
                  "value": "asc",
                  "description": "Sort direction.",
                  "disabled": true
                }
              ],
              "variable": []
            },
            "description": "Scope: `kyc:read`."
          }
        },
        {
          "name": "Create a bank account",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"account_number\": \"\",\n  \"identification_id\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/bank-accounts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "bank-accounts"
              ],
              "variable": []
            },
            "description": "Scope: `kyc:write`."
          }
        },
        {
          "name": "Get a bank account",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/bank-accounts/:bankAccount",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "bank-accounts",
                ":bankAccount"
              ],
              "variable": [
                {
                  "key": "bankAccount",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `kyc:read`."
          }
        },
        {
          "name": "Update a bank account",
          "request": {
            "method": "PUT",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/bank-accounts/:bankAccount",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "bank-accounts",
                ":bankAccount"
              ],
              "variable": [
                {
                  "key": "bankAccount",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `kyc:write`."
          }
        },
        {
          "name": "Delete a bank account",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/bank-accounts/:bankAccount",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "bank-accounts",
                ":bankAccount"
              ],
              "variable": [
                {
                  "key": "bankAccount",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `kyc:write`."
          }
        }
      ]
    },
    {
      "name": "Payment instances",
      "description": "Request and manage virtual TPEs.",
      "item": [
        {
          "name": "List payment instances",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/instances",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "instances"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "per_page",
                  "value": "0",
                  "description": "At most 100.",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "description": "Text to look for.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "active",
                  "description": "Filter by operational status.",
                  "disabled": true
                },
                {
                  "key": "acceptance_status",
                  "value": "pending_documents",
                  "description": "Filter by acceptance status.",
                  "disabled": true
                },
                {
                  "key": "identification_id",
                  "value": "",
                  "description": "Filter by identification.",
                  "disabled": true
                },
                {
                  "key": "brand_id",
                  "value": "",
                  "description": "Filter by brand.",
                  "disabled": true
                },
                {
                  "key": "bank_account_id",
                  "value": "",
                  "description": "Filter by bank account.",
                  "disabled": true
                },
                {
                  "key": "sort_by",
                  "value": "created_at",
                  "description": "Field to sort by.",
                  "disabled": true
                },
                {
                  "key": "sort_dir",
                  "value": "asc",
                  "description": "Sort direction.",
                  "disabled": true
                }
              ],
              "variable": []
            },
            "description": "Scope: `instances:read`."
          }
        },
        {
          "name": "Request a payment instance",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "8 to 128 characters, unique per operation within the account. Repeating it returns the first response with `Idempotent-Replayed: true`.",
                "disabled": false
              }
            ],
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "title",
                  "type": "text",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "identification_id",
                  "type": "text",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "brand_id",
                  "type": "text",
                  "value": "",
                  "description": "A brand of the identification."
                },
                {
                  "key": "bank_account_id",
                  "type": "text",
                  "value": "",
                  "description": "A bank account of the identification."
                },
                {
                  "key": "payment_method",
                  "type": "text",
                  "value": "online",
                  "description": ""
                },
                {
                  "key": "payment_proof",
                  "type": "file",
                  "src": [],
                  "description": "Required for `bank_transfer` and `cheque`. PDF, JPEG or PNG."
                },
                {
                  "key": "promo_code",
                  "type": "text",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "logo",
                  "type": "file",
                  "src": [],
                  "description": "Attached to the instance once the payment clears. Image, at most 5 MB."
                }
              ]
            },
            "url": {
              "raw": "{{baseUrl}}/instances",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "instances"
              ],
              "variable": []
            },
            "description": "Starts a paid activation. Send `Idempotency-Key` so a retry can't start a second one; without it, a retry returns the activation still pending for the same details.\n\nScope: `instances:write`."
          }
        },
        {
          "name": "Get a payment instance",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/instances/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "instances",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `instances:read`."
          }
        },
        {
          "name": "Update a payment instance",
          "request": {
            "method": "PUT",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/instances/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "instances",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `instances:write`."
          }
        },
        {
          "name": "Delete a payment instance",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/instances/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "instances",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `instances:write`."
          }
        }
      ]
    },
    {
      "name": "Payment links",
      "description": "Create and manage shareable payment URLs.",
      "item": [
        {
          "name": "List payment links",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/links",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "links"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "per_page",
                  "value": "0",
                  "description": "At most 100.",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "description": "Text to look for.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "draft",
                  "description": "Filter by status.",
                  "disabled": true
                },
                {
                  "key": "usage_mode",
                  "value": "one_shot",
                  "description": "Filter by usage mode.",
                  "disabled": true
                },
                {
                  "key": "payment_instance_id",
                  "value": "",
                  "description": "Filter by payment instance.",
                  "disabled": true
                },
                {
                  "key": "sort_by",
                  "value": "created_at",
                  "description": "Field to sort by.",
                  "disabled": true
                },
                {
                  "key": "sort_dir",
                  "value": "asc",
                  "description": "Sort direction.",
                  "disabled": true
                }
              ],
              "variable": []
            },
            "description": "Scope: `links:read`."
          }
        },
        {
          "name": "Create a payment link",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "8 to 128 characters, unique per operation within the account. Repeating it returns the first response with `Idempotent-Replayed: true`.",
                "disabled": false
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"payment_instance_id\": \"\",\n  \"title\": \"\",\n  \"amount_mode\": \"fixed\",\n  \"usage_mode\": \"one_shot\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/links",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "links"
              ],
              "variable": []
            },
            "description": "Send `Idempotency-Key` so a retry can't create a second link. Without it, each retry creates another link.\n\nScope: `links:write`."
          }
        },
        {
          "name": "Get a payment link",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/links/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "links",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `links:read`."
          }
        },
        {
          "name": "Update a payment link",
          "request": {
            "method": "PUT",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/links/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "links",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `links:write`."
          }
        },
        {
          "name": "Archive a payment link",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/links/:id/archive",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "links",
                ":id",
                "archive"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `links:write`."
          }
        },
        {
          "name": "Pause a payment link",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/links/:id/pause",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "links",
                ":id",
                "pause"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `links:write`."
          }
        },
        {
          "name": "Publish a payment link",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/links/:id/publish",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "links",
                ":id",
                "publish"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `links:write`."
          }
        },
        {
          "name": "Resume a payment link",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/links/:id/resume",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "links",
                ":id",
                "resume"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `links:write`."
          }
        }
      ]
    },
    {
      "name": "Payment plans",
      "description": "Agree a schedule of instalments with one customer (paiement par facilité).",
      "item": [
        {
          "name": "List payment plans",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/plans",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "plans"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "per_page",
                  "value": "0",
                  "description": "At most 100.",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "description": "Text to look for in the title, the customer's name and email, and the reference.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "active",
                  "description": "Filter by status. `late` is an active plan with an unpaid instalment past its due date.",
                  "disabled": true
                },
                {
                  "key": "payment_instance_id",
                  "value": "",
                  "description": "Filter by payment instance.",
                  "disabled": true
                }
              ],
              "variable": []
            },
            "description": "Scope: `plans:read`."
          }
        },
        {
          "name": "Create a payment plan",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "8 to 128 characters, unique per operation within the account. Repeating it returns the first response with `Idempotent-Replayed: true`.",
                "disabled": false
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"payment_instance_id\": \"\",\n  \"title\": \"\",\n  \"total_amount\": 0,\n  \"customer_name\": \"\",\n  \"customer_email\": \"\",\n  \"installments\": []\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/plans",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "plans"
              ],
              "variable": []
            },
            "description": "The plan is active at once. MyTPE opens an account for the customer if their email address has none, and emails them an invitation. Send `Idempotency-Key` so a retry can't create a second plan and a second invitation. An instance that can't collect payments yet answers `422` with `PAYMENT_PLAN_INSTANCE_CANNOT_COLLECT`, and an address this account can't write to answers `422` with `PAYMENT_PLAN_RECIPIENT_SUPPRESSED`. Daily limits per integration, account, recipient and new customer accounts answer `429` with `Retry-After`. In each case nothing is created or sent.\n\nScope: `plans:write`."
          }
        },
        {
          "name": "Preview a schedule",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"total_amount\": 0,\n  \"count\": 0,\n  \"first_due_on\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/plans/preview",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "plans",
                "preview"
              ],
              "variable": []
            },
            "description": "Proposes a schedule that adds up to the total. Nothing is saved. Change it if you need to, then send it to `POST /plans`.\n\nScope: `plans:write`."
          }
        },
        {
          "name": "Get a payment plan",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/plans/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "plans",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `plans:read`."
          }
        },
        {
          "name": "Cancel a payment plan",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/plans/:id/cancel",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "plans",
                ":id",
                "cancel"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Ends an active plan. What was paid stays recorded, and nothing more can be paid.\n\nScope: `plans:write`."
          }
        },
        {
          "name": "Send a reminder",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/plans/:id/remind",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "plans",
                ":id",
                "remind"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Emails the customer about the next unpaid instalment. Limited to 10 calls a minute. While the customer can't pay, this answers `422` with `PAYMENT_PLAN_INSTANCE_CANNOT_COLLECT`.\n\nScope: `plans:write`."
          }
        }
      ]
    },
    {
      "name": "Forms",
      "description": "Manage the forms payers fill in at checkout.",
      "item": [
        {
          "name": "List forms",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/forms",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "per_page",
                  "value": "0",
                  "description": "At most 100.",
                  "disabled": true
                },
                {
                  "key": "search",
                  "value": "",
                  "description": "Text to look for.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "draft",
                  "description": "Filter by status.",
                  "disabled": true
                },
                {
                  "key": "sort_by",
                  "value": "created_at",
                  "description": "Field to sort by.",
                  "disabled": true
                },
                {
                  "key": "sort_dir",
                  "value": "asc",
                  "description": "Sort direction.",
                  "disabled": true
                }
              ],
              "variable": []
            },
            "description": "Scope: `forms:read`."
          }
        },
        {
          "name": "Create a form",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/forms",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms"
              ],
              "variable": []
            },
            "description": "Scope: `forms:write`."
          }
        },
        {
          "name": "Get a form",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/forms/:form",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:read`."
          }
        },
        {
          "name": "Update a form",
          "request": {
            "method": "PATCH",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/forms/:form",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:write`."
          }
        },
        {
          "name": "Delete a form",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/forms/:form",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:write`."
          }
        },
        {
          "name": "Add a field",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"input_name\": \"\",\n  \"data_type\": \"string\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/forms/:form/fields",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form",
                "fields"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:write`."
          }
        },
        {
          "name": "Update a field",
          "request": {
            "method": "PATCH",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/forms/:form/fields/:field",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form",
                "fields",
                ":field"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "field",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:write`."
          }
        },
        {
          "name": "Remove a field",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/forms/:form/fields/:field",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form",
                "fields",
                ":field"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "field",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:write`."
          }
        },
        {
          "name": "Publish a form",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/forms/:form/publish",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form",
                "publish"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:write`."
          }
        },
        {
          "name": "Add a section",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"title\": {}\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/forms/:form/sections",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form",
                "sections"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:write`."
          }
        },
        {
          "name": "Update a section",
          "request": {
            "method": "PATCH",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/forms/:form/sections/:section",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form",
                "sections",
                ":section"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "section",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:write`."
          }
        },
        {
          "name": "Remove a section",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/forms/:form/sections/:section",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "forms",
                ":form",
                "sections",
                ":section"
              ],
              "variable": [
                {
                  "key": "form",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "section",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `forms:write`."
          }
        }
      ]
    },
    {
      "name": "Webhooks",
      "description": "Manage the endpoints that receive MyTPE events.",
      "item": [
        {
          "name": "List webhooks",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "webhooks"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "per_page",
                  "value": "0",
                  "description": "At most 100.",
                  "disabled": true
                }
              ],
              "variable": []
            },
            "description": "Scope: `webhooks:read`."
          }
        },
        {
          "name": "Create a webhook",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "webhooks"
              ],
              "variable": []
            },
            "description": "Scope: `webhooks:write`."
          }
        },
        {
          "name": "List webhook events",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/webhooks/events",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "webhooks",
                "events"
              ],
              "variable": []
            },
            "description": "Scope: `webhooks:read`."
          }
        },
        {
          "name": "Get a webhook",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "webhooks",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `webhooks:read`."
          }
        },
        {
          "name": "Update a webhook",
          "request": {
            "method": "PATCH",
            "header": [],
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "webhooks",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `webhooks:write`."
          }
        },
        {
          "name": "Delete a webhook",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/webhooks/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "webhooks",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `webhooks:write`."
          }
        },
        {
          "name": "List deliveries",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/webhooks/:id/deliveries",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "webhooks",
                ":id",
                "deliveries"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "0",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "per_page",
                  "value": "0",
                  "description": "At most 100.",
                  "disabled": true
                },
                {
                  "key": "event_type",
                  "value": "",
                  "description": "Filter by event type.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `webhooks:read`."
          }
        },
        {
          "name": "Redeliver an event",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/webhooks/:id/deliveries/:did/redeliver",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "webhooks",
                ":id",
                "deliveries",
                ":did",
                "redeliver"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                },
                {
                  "key": "did",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "Scope: `webhooks:write`."
          }
        },
        {
          "name": "Rotate the signing secret",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/webhooks/:id/regenerate-secret",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "webhooks",
                ":id",
                "regenerate-secret"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": ""
                }
              ]
            },
            "description": "The old secret stops working immediately.\n\nScope: `webhooks:write`."
          }
        }
      ]
    }
  ]
}