Skip to content

Get payout actions

Last updated: April 29, 2022

Find out all you need to know about history of a payout. This API provides details about each step of the payout lifecycle. To get a detailed view of all required and optional fields, see our API reference.

Use the details below to set up your request.

Endpoints

get

https://api.checkout.com/payments/{id}/actions

Header parameters

HeaderValue

Authorization

required

Bearer {OAuth access token}

Content-Type

required

application/json

Path parameters

PathValue

id

required

The payment identifier (prefixed with pay_) or the session identifier (prefixed with sid_).

Response example

If successful, you should get a 200 Success response returning a list of data relating to the payout.

1
[
2
  {
3
    "id": "act_cvrbczl5llgehjzjqdupeezwt4",
4
    "type": "Return",
5
    "processed_on": "2020-06-12T13:49:19.145592Z",
6
    "amount": 1000,
7
    "approved": true,
8
    "response_code": "30046",
9
    "response_summary": "Bank Account Closed"
10
  },
11
  {
12
    "id": "act_rhpascoezcwuxbez3qhsbtgpd4",
13
    "type": "Payout",
14
    "processed_on": "2020-06-12T13:49:19.1050138Z",
15
    "amount": 1000,
16
    "approved": true,
17
    "response_code": "10000",
18
    "response_summary": "Approved"
19
  }
20
]

Information

If unsuccessful, you may get a 404 – Payment not found error.

Response parameters

Find out what the different fields in your successful response mean.

Field nameDescription

id

string

The unique identifier of the payment action.

type

string

The type of payment action (e.g., Authorization).

processed_on

string

The date and time the action took place.

amount

integer

The action amount.

auth_code

string

The acquirer's authorization code for cards.

response_code

string

The gateway response code.

response_summary

string

The gateway response summary.

reference

string

Your defined reference for the action.

processing

object

Returns information related to the processing of the payment.

metadata

object

A set of key/value pairs that you can attach to an action.

Payout actions

The table below outlines the different payout actions and their meanings.

Payout

The payout request was processed successfully. To check whether the payout itself was successful, check the approved field in the response.

Return

The payout was returned. For example, because the destination account has been closed.