Skip to main content
GET
/
businesses
/
{id}
/
payouts
List payouts for the given business
curl --request GET \
  --url https://api.guile.app/businesses/{id}/payouts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "occuredAt": "2023-11-07T05:31:56Z",
      "amount": "456.78",
      "currencyCode": "USD",
      "method": "standard",
      "state": "pending",
      "destination": {
        "routingNumber": "<string>",
        "type": "checking",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "maskedAccountNumber": "<string>",
        "eligiblePayoutMethods": [
          "standard"
        ],
        "financialInstitutionName": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "fee": "456.78",
      "referenceId": "<string>",
      "failureCode": "<string>",
      "failureReason": "<string>"
    }
  ],
  "count": 1,
  "offset": 1,
  "limit": 1
}

Path Parameters

​
id
string<uuid>
required

The identifier of the business to list payouts for. The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Query Parameters

​
date
string

Limit payouts based on this date range. A date range, supporting inclusive or exclusive endpoints. Dates ranges use dates expressed in YYYY-MM-DD RFC 3339 date format. The value may have the following forms:

  • YYYY-MM-DD match the date exactly; equivalent to matching dates in the range [YYYY-MM-DD,YYYY-MM-DD]
  • [YYYY-MM-DD,YYYY-MM-DD] between two dates, inclusive of the endpoints
  • (YYYY-MM-DD,YYYY-MM-DD) between two dates, exclusive of the endpoints
  • [YYYY-MM-DD,] on or after the date
  • (YYYY-MM-DD,) after the date
  • [,YYYY-MM-DD] before or on the date
  • (,YYYY-MM-DD) before the date

Examples:

  • '2022-05-19'
  • '[2022-05-01,2022-05-31]'
  • '[2022-05-01,2022-06-01)'
  • '[2022-05-19,]'
  • '(2022-05-19,)'
  • '[,2022-05-19]'
  • '(,2022-05-19)'
Maximum string length: 24
​
state
enum<string>[]

Limit payouts to the given payout states.

The processing state for a payout.

Available options:
pending,
paid,
failed,
canceled
​
method
enum<string>

Limit payouts to the given payout methods. The method used for the payout. Standard typically means T+2 days through ACH batch processing. Instant expediates payments for an additional processing fee. Instant payouts be be limited based on availability and other factors.

Available options:
standard,
instant

Response

Ok. The operation succeeded.

A list response for paginated resources.

​
items
object[]
required
​
count
integer<int16>
required
Required range: x >= 0
​
offset
integer<int16>
required

The offset of list results for the current page.

Required range: x >= 0
​
limit
integer<int16>
required

The maximum number of results included in items.

Required range: x >= 0