Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
payouts
/
{payoutId}
/
tags
Fetch payout tags
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/payouts/{payoutId}/tags \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "ExampleTagKey",
    "dimension_display_name": "<string>",
    "value": "ExampleTagValue",
    "value_display_name": "<string>",
    "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "archived_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json

Path Parameters

businessId
string
required

The UUID of the business that the payout to fetch tags for belongs to

payoutId
string
required

The UUID of the payout to fetch tags for

Response

id
string<uuid>
required

ID for the tag

key
string
required

Key for the tag

Example:

"ExampleTagKey"

value
string
required

Value for the tag

Example:

"ExampleTagValue"

dimension_id
string<uuid>
required

ID of the tag dimension this tag belongs to

definition_id
string<uuid>
required

ID of the tag value definition

dimension_display_name
string | null

Display name for the tag dimension

value_display_name
string | null

Display name for the tag value definition

archived_at
string<date-time> | null

When the tag was archived