GET /balanceAccounts/{balanceAccountId}/payoutSchedules/{id}/executions

View information about the executions of a managed payout schedule on the specified balance account. An execution is an attempt to make a payout according to the payout schedule.

Servers

https://balanceplatform-api-test.adyen.com/bcl/v2

Path parameters

Name	Type	Required	Description
`id`	String	Yes	The unique identifier of the payout schedule on the balance account.
`balanceAccountId`	String	Yes	The unique identifier of the balance account.

Query parameters

Name Type Required Description

Name	Type	Required	Description
`results[]`	Array	No	Contains a list of payout statuses. If included, the response returns only executed payouts that currently have one of the specified statuses. Possible statuses: succeeded: The payout was sent successfully. failed: The payout was not sent due to an error. skipped: The payout was not triggered as expected.
`limit`	Integer	No	The number of items returned per page. Default: 10
`offset`	Integer	Yes	The page number to be returned. Default: 1

results[]

Array

Contains a list of payout statuses. If included, the response returns only executed payouts that currently have one of the specified statuses.

Possible statuses:

succeeded: The payout was sent successfully.
failed: The payout was not sent due to an error.
skipped: The payout was not triggered as expected.

limit

Integer

The number of items returned per page.

Default: 10

offset

Integer

Yes

The page number to be returned.

Default: 1

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.