Payouts - BETA

These endpoints allow you to make payouts.

Initiate a payout

The POST /payouts endpoint initiates a payout.

SecurityBearer or BasicAuth
Request
Request Body schema: application/json
required
required
object (PayoutInitiation)

The initiation payload for the payout.

Responses
200

Successful response

400

The client specified an invalid argument

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

404

The requested entity, such as a payment, was not found

429

Too many requests

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

post/payouts
Request samples
application/json
{
  • "initiation": {
    }
}
Response samples
application/json
{
  • "payout": {
    }
}

Get payouts

The GET /payouts endpoint retrieves a complete or filtered list of payouts.

SecurityBearer or BasicAuth
Request
query Parameters
limit
required
integer <int32> [ 1 .. 200 ]

The maximum number of records to return.

Example: limit=10
offset
string

The offset from the previous page.

Example: offset=LerV6Jmex
startDate
string

Lower bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or after the given date will be returned.

Example: startDate=2010-01-01
endDate
string

Upper bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or before the given date will be returned.

Example: endDate=2010-01-01
ids
Array of strings

Filters payouts by their ids - returns only payouts with ids listed in this parameter.

Example: ids=po:28oivvd3iFhBrcbNj4tmtLEhxRTk:2gFUX1NE1T6&ids=po:3ZfdHxbpXmRZ1TVmiYNPgcwEocBy:2gFUX1NDdqr
invertIds
boolean

Invert ids query - returns only payouts with ids not listed in the ids parameter.

statuses
Array of strings (PayoutStatus)

Filters payouts by their statuses - returns only payouts with statuses listed in this parameter.

Items Enum: "INITIATION_PENDING" "INITIATION_PROCESSING" "INITIATION_COMPLETED" "INITIATION_REJECTED" "INITIATION_FAILED"
Example: statuses=INITIATION_COMPLETED&statuses=INITIATION_REJECTED
invertStatuses
boolean

Invert statuses query - returns only payouts with statuses not listed in the statuses parameter.

Example: invertStatuses=true
refIds
Array of strings

Filters payouts by their refId values - returns only payouts with refIds listed in this parameter.

Example: refIds=ShBdcTeqFabqJJhUF&refIds=N5cJDFsQzVca3Q
onBehalfOfId
string

Filters payouts by their onBehalfOfId value - returns only payouts with the onBehalfOfId value specified in this parameter. This field is mandatory for unregulated TPPs.

Example: onBehalfOfId=c5a863bc-86f2-4418-a26f-25b24c7983c7
Responses
200

Successful response

400

The client specified an invalid argument

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

404

The requested entity, such as a payment, was not found

429

Too many requests

500

An unexpected or internal server error

501

The operation was not implemented

503

Service is unavailable

504

Gateway has timed out

get/payouts
Request samples 
Response samples 
application/json
{
  • "payouts": [
    ],
  • "paging": {
    }
}
Get a payout
The GET /payouts/{id} endpoint retrieves a given payout.


SecurityBearer or BasicAuth 
Request 
path Parameters
id
required
string
The payout id.


 
 Example:  your payout id
Responses 
200
Successful response


400
The client specified an invalid argument


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
The requested entity, such as a payment, was not found


429
Too many requests


500
An unexpected or internal server error


501
The operation was not implemented


503
Service is unavailable


504
Gateway has timed out


get/payouts/{id}
Request samples 
Response samples 
application/json
{
  • "payout": {
    }
}
➔ Next to Virtual Accounts - BETA