API references
Search documentation... ⌘K
Open merchant dashboard
Merchant API
All our references

List payout activities

Retrieves all activities, events, and payout session information for a given payout.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/list-payout-activities HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
payout_id: string,
}
Returns: array<any>
New to Reservepay? Read our guide on how to call endpoints to get started.
Request arguments
payout_id string

Required. The unique identifier of the payout to retrieve activities.

Response attributes
Attribute Description
created_at
number

Always present. Unix timestamp indicating when the activity was created.
activity
string

Always present. The type of activity that was performed. Supported values:

  • payout_completed: The payout was successfully completed.
  • payout_created: The payout record was created.
Possible values:
  • payout_completed
  • payout_created
path
string

Nullable. The URL path where the activity occurred.
ip_address
string

Nullable. The IP address of the client that initiated the activity.
severity
string

Always present. The severity level of the activity log (INFO, WARN, ERROR).

Possible values:
  • INFO
  • WARN
  • ERROR
request
object

Nullable. Request information for log activities (not events). Contains details about the original request that generated this activity.
response
any

Nullable. Response information for log activities (not events). Contains details about the response that was generated for this activity.
event_deliveries
array<object.event_delivery>

Nullable. Array of event delivery objects containing webhook delivery information. Only present for activities that are events with associated webhook deliveries.
payout_status
string

Nullable. The status of the payout at the time of the activity.
Event delivery attributes
Attribute Description
event_id
string

Always present. The unique identifier of the event.
event_delivery_id
string

Always present. The unique identifier of the event delivery.
status_code
number

Always present. HTTP status code returned by the webhook endpoint during delivery attempt.
failure_code
string

Nullable. Specific failure code if the delivery failed. Null if delivery was successful.
url
string

Nullable. The webhook URL where the event was delivered.
occurrences
number

Always present. Number of delivery attempts made for this event.
created_at
number

Always present. Unix timestamp indicating when the event delivery was created.
payload
object

Always present. The complete event document that was sent to the webhook endpoint. Contains all the event data including payment information and metadata.
Errors specific to this endpoint
NOT_FOUND

This error occurs when no payout with the provided ID exists in your merchant account. Double check that you're using the correct payout ID.

Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

Open in Markdown
CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/list-payout-activities" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{
        "payout_id": "out_01kwbby4c702mbq2htbbwnywhd"
      }'
Learn how to run these code samples in your terminal by reading our guide.