{
  "opencollection": "1.0.0",
  "info": {
    "name": "TrueLayer Payments API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.truelayer.com/v3/payments",
            "headers": [
              {
                "name": "Tl-Signature",
                "value": ""
              },
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a new payment via open banking. Supports closed-loop pay-ins to merchant accounts, single payments to external accounts, and mandate-based VRP payments. All POST requests must include a Tl-Signature header and Idempotency-Key."
        },
        {
          "info": {
            "name": "Get Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.truelayer.com/v3/payments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Payment UUID"
              }
            ]
          },
          "docs": "Retrieve the current status and details of a payment."
        },
        {
          "info": {
            "name": "Start Authorization Flow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.truelayer.com/v3/payments/:id/authorization-flow",
            "headers": [
              {
                "name": "Tl-Signature",
                "value": ""
              },
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Start or continue the payment authorization flow. Used when implementing a custom authorization journey."
        }
      ]
    },
    {
      "info": {
        "name": "Refunds",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Payment Refunds",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.truelayer.com/v3/payments/:id/refunds",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns all refunds for a specific payment."
        },
        {
          "info": {
            "name": "Create Refund",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.truelayer.com/v3/payments/:id/refunds",
            "headers": [
              {
                "name": "Tl-Signature",
                "value": ""
              },
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Payment UUID to refund"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a refund for a completed payment."
        }
      ]
    },
    {
      "info": {
        "name": "Mandates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Mandate",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.truelayer.com/v3/mandates",
            "headers": [
              {
                "name": "Tl-Signature",
                "value": ""
              },
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Variable Recurring Payment (VRP) mandate. A mandate authorizes the payee to initiate future payments within defined parameters."
        },
        {
          "info": {
            "name": "Get Mandate",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.truelayer.com/v3/mandates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a mandate by ID."
        },
        {
          "info": {
            "name": "Revoke Mandate",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.truelayer.com/v3/mandates/:id",
            "headers": [
              {
                "name": "Tl-Signature",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Revoke an active VRP mandate."
        }
      ]
    },
    {
      "info": {
        "name": "Payouts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create Payout",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.truelayer.com/v3/payouts",
            "headers": [
              {
                "name": "Tl-Signature",
                "value": ""
              },
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a payout from a merchant account to a user or external account. Used for refunds, withdrawals, and disbursements."
        },
        {
          "info": {
            "name": "Get Payout",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.truelayer.com/v3/payouts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the status of a payout."
        }
      ]
    },
    {
      "info": {
        "name": "Merchant Accounts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Merchant Accounts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.truelayer.com/v3/merchant-accounts"
          },
          "docs": "Returns all merchant accounts for the integration."
        },
        {
          "info": {
            "name": "Get Merchant Account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.truelayer.com/v3/merchant-accounts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a merchant account and its current balance."
        },
        {
          "info": {
            "name": "List Merchant Account Transactions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.truelayer.com/v3/merchant-accounts/:id/transactions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Start date-time filter (ISO 8601)"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "End date-time filter (ISO 8601)"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor"
              }
            ]
          },
          "docs": "Returns transactions for a merchant account."
        }
      ]
    }
  ],
  "bundled": true
}