GoCardless

GoCardless payouts API

The payouts API from GoCardless — 2 operation(s) for payouts.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.gocardless.com/api-reference/
📖
GettingStarted
https://developer.gocardless.com/getting-started/set-up/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gocardless/refs/heads/main/openapi/gocardless-payouts-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/gocardless/refs/heads/main/asyncapi/gocardless-asyncapi.yml

Other Resources

🔗
Sandbox
https://api-sandbox.gocardless.com
🔗
PostmanCollection
https://www.postman.com/gocardlessapi/gocardless-api/overview

OpenAPI Specification

gocardless-payouts-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: GoCardless REST billing_request_flows payouts API
  version: '2015-07-06'
  description: 'Subset of the public GoCardless REST API for collecting bank debit and

    open-banking payments. Authentication uses a Bearer access token issued

    from the dashboard. Every request must include the

    `GoCardless-Version` header.

    '
  contact:
    name: GoCardless Developers
    url: https://developer.gocardless.com/
servers:
- url: https://api.gocardless.com
  description: Live
- url: https://api-sandbox.gocardless.com
  description: Sandbox
security:
- bearerAuth: []
tags:
- name: payouts
paths:
  /payouts:
    get:
      tags:
      - payouts
      summary: List payouts
      operationId: listPayouts
      responses:
        '200':
          description: OK
  /payouts/{id}:
    get:
      tags:
      - payouts
      summary: Get a payout
      operationId: getPayout
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: GoCardless access token from the dashboard