API Reference
  1. Payouts
  2. Payouts

Get payout timing

get
https://api.sandbox.rainforestpay.com/v1/payout_configs//payout_timing

Preview the dates a payout would be scheduled for.

This endpoint requires the platform to be approved for the Payouts integration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique payout config identifier.

Prefix is "pyc" in production and "sbx_pyc" in sandbox.

Query Params
date

The requested date to process the payout, in ISO 8601 format (YYYY-MM-DD). The payout will be scheduled to process on the next available date relative to the requested date. When omitted, the earliest available date is previewed.

string
enum
Defaults to ACH

The payout rail.

Allowed:
Headers
string
enum
Defaults to 2024-10-16
Allowed:
Responses

Updated 21 days ago

Did this page help you?
Language
Credentials
Bearer
APIKey
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago

Did this page help you?