> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tilta.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# List payout instructions
> Retrieve the bank accounts registered for payouts across your platform, filtered by merchant where needed.
Use this endpoint to review the payout bank accounts registered on your platform and check where each one stands in verification.
On multi-merchant platforms, filter by merchant rather than paging through every payout instruction on the platform.
## OpenAPI
````yaml GET /v1/payout_instructions
openapi: 3.0.0
info:
version: 0.0.1
title: Tilta API
description: Tilta API documentation
servers:
- url: https://api.tilta.io
description: Tilta Production API
- url: https://api.tilta-sandbox.io
description: Tilta Sandbox API
security: []
paths:
/v1/payout_instructions:
get:
tags:
- Payout Instructions
summary: Get payout instructions
description: >-
Retrieves payout instructions for the authenticated platform. Optionally
filter by merchant via `?merchant_external_id=` and/or by scheme via
`?type=`. Pagination is controlled via `?limit=` and `?offset=`.
parameters:
- schema:
type: string
description: Filter payout instructions by merchant external_id.
example: merchant_id1
required: false
name: merchant_external_id
in: query
- schema:
type: string
enum:
- SEPA
- SWIFT
- FPS
description: Filter payout instructions by scheme type.
example: SEPA
required: false
name: type
in: query
- schema:
$ref: '#/components/schemas/limit'
required: false
description: The number of records to be taken.
name: limit
in: query
- schema:
allOf:
- $ref: '#/components/schemas/offset'
- nullable: true
required: false
description: The number of records to be skipped.
name: offset
in: query
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
limit:
type: integer
minimum: 0
description: The number of taken records.
example: 100
offset:
type: integer
minimum: 0
description: The number of skipped records.
example: 0
total:
type: integer
minimum: 0
description: Total number of records
example: 140
items:
type: array
items:
oneOf:
- type: object
properties:
external_id:
type: string
description: Unique identifier of a payout instruction.
example: 8b9f1f4c-2e2a-4a8c-9d51-1b3a3a2c8e9d
beneficiary_name:
type: string
is_verified:
type: boolean
description: >-
Whether this payout instruction has been
verified by Tilta and is therefore eligible for
use in actual payouts. Newly created or replaced
payout instructions are unverified and must be
verified by Tilta out-of-band before they can be
used operationally.
example: false
created_at:
type: number
description: Timestamp in unix time (seconds).
example: 1582896122
updated_at:
type: number
description: Timestamp in unix time (seconds).
example: 1582896122
type:
type: string
enum:
- SEPA
iban:
type: string
example: DE03500105177178979259
bic:
type: string
example: DEUTDEFF
required:
- external_id
- beneficiary_name
- is_verified
- created_at
- updated_at
- type
- iban
- bic
description: A SEPA payout instruction.
- type: object
properties:
external_id:
type: string
description: Unique identifier of a payout instruction.
example: 8b9f1f4c-2e2a-4a8c-9d51-1b3a3a2c8e9d
beneficiary_name:
type: string
is_verified:
type: boolean
description: >-
Whether this payout instruction has been
verified by Tilta and is therefore eligible for
use in actual payouts. Newly created or replaced
payout instructions are unverified and must be
verified by Tilta out-of-band before they can be
used operationally.
example: false
created_at:
type: number
description: Timestamp in unix time (seconds).
example: 1582896122
updated_at:
type: number
description: Timestamp in unix time (seconds).
example: 1582896122
type:
type: string
enum:
- FPS
sort_code:
type: string
pattern: ^\d{6}$
account_number:
type: string
pattern: ^\d{8}$
required:
- external_id
- beneficiary_name
- is_verified
- created_at
- updated_at
- type
- sort_code
- account_number
description: A Faster Payments (FPS) payout instruction.
- type: object
properties:
external_id:
type: string
description: Unique identifier of a payout instruction.
example: 8b9f1f4c-2e2a-4a8c-9d51-1b3a3a2c8e9d
beneficiary_name:
type: string
is_verified:
type: boolean
description: >-
Whether this payout instruction has been
verified by Tilta and is therefore eligible for
use in actual payouts. Newly created or replaced
payout instructions are unverified and must be
verified by Tilta out-of-band before they can be
used operationally.
example: false
created_at:
type: number
description: Timestamp in unix time (seconds).
example: 1582896122
updated_at:
type: number
description: Timestamp in unix time (seconds).
example: 1582896122
type:
type: string
enum:
- SWIFT
account_number:
type: string
bic:
type: string
example: DEUTDEFF
bank_name:
type: string
bank_address:
type: string
required:
- external_id
- beneficiary_name
- is_verified
- created_at
- updated_at
- type
- account_number
- bic
- bank_name
- bank_address
description: A SWIFT payout instruction.
required:
- limit
- offset
- total
- items
additionalProperties: false
description: A paginated list of payout instructions.
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestSchema'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedRequestSchema'
security:
- bearerAuth: []
components:
schemas:
limit:
type: integer
description: The number of records to be taken.
example: 100
default: 100
maximum: 100
offset:
type: integer
description: The number of records to be skipped.
example: 0
default: 0
badRequestSchema:
type: object
properties:
code:
type: string
description: Error code
example: BAD_REQUEST
error:
type: string
description: Error message for debugging purposes
example: Request validation failed. 1 issue found.
issues:
type: array
items:
type: object
properties:
code:
type: string
description: Issue code
example: INVALID_TYPE
path:
type: string
description: Issue path starting with body, params, querystring, or headers
example: body.registered_at
message:
type: string
description: Issue message for debugging purposes
example: Invalid type
required:
- code
- path
- message
description: List of issues
example:
- code: INVALID_TYPE
path: body.registered_at
message: Invalid type
required:
- code
- error
- issues
description: Bad Request, see error message for details.
example:
code: BAD_REQUEST
error: Request validation failed. 1 issue found.
issues:
- code: INVALID_TYPE
path: body.registered_at
message: Invalid type
unauthorizedRequestSchema:
type: object
properties:
error:
type: string
description: Error details.
example: Unauthorized
code:
type: string
description: Error code.
example: UNAUTHORIZED
required:
- error
- code
description: Unauthorized Request.
example:
error: Unauthorized
code: UNAUTHORIZED
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Your Tilta API key, sent as `Bearer `.
````