Checkout.com API logo

Financial actions

Returns all the processed financial actions associated with your given filter. The results are ordered by processing date in descending order (latest first).

Get financial actions

Returns the list of financial actions and their details.

SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
query Parameters
payment_id
string

The ID of the payment you want to retrieve financial actions for. Required if action_id is not used.

Example: payment_id=pay_qqufsd3rfnqufngwklghlxrzpm
action_id
string

The ID of the action you want to retrieve financial actions for. Required if payment_id is not used.

Example: action_id=act_wsnyzbzmr2huxcekoj7qqhxwuy
limit
integer <int32> [ 1 .. 100 ]
Default: 100

The number of results to retrieve per page.
For example, if the total result count is 50, and you use limit=10, you will need to iterate over 5 pages containing 10 results each to retrieve all of the reports that match your query.

Example: limit=5
pagination_token
string

A token used for pagination when a response contains results across multiple pages.

Responses
200

Financial actions retrieved successfully

401

Unauthorized. Likely cause is that access token is not valid or was not specified.

422

Unprocessable entity

get/financial-actions
Request samples 
curl -i -X GET \
'https://{prefix}.api.sandbox.checkout.com/financial-actions?payment_id=pay_qqufsd3rfnqufngwklghlxrzpm&limit=5' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "count": 1,
  • "limit": 5,
  • "data": [
    ],
  • "_links": {}
}
➔ Next to Card metadata