# Fetch a Payout Link

Retrieve the details of a previously created .

Endpoint: GET /payout_links/{payout_link_id}
Security: BasicAuth

## Path parameters:

  - `payout_link_id` (string, required)
    The ID of the .

## Header parameters:

  - `Finix-Version` (string)
    Specify the API version of your request. For more details, see Versioning.
    Example: "2022-02-01"

## Response 200 fields (application/json):

  - `id` (string)
    The ID of the  resource.
    Example: "payout_link_caKCWTF8wyp784FEN7fF5"

  - `created_at` (string)
    Timestamp of when the object was created.

  - `updated_at` (string)
    Timestamp of when the object was last updated.

  - `additional_details` (object)
    Object containing additional details about the .

  - `additional_details.expiration_in_minutes` (integer)
    Details how long (in minutes) the  is valid for. The maximum value is subject to risk approvals. Refer to the maximum value in your Finix Dashboard.

  - `additional_details.expired_session_url` (string,null)
    The URL to redirect the recipient to if their session times out.

  - `additional_details.terms_of_service_url` (string,null)
    The URL to the sender's Terms of Service.

  - `additional_details.success_return_url` (string,null)
    A URL to redirect the recipient to after the payout is successful.

  - `additional_details.unsuccessful_return_url` (string,null)
    A URL to redirect the recipient to if the payout was successful.

  - `allowed_payout_operations` (array)
    Defines the types of operations permitted in the payout process when the recipient submits the payout form.

Acceptable values include:
- PUSH_TO_ACH
- PUSH_TO_CARD

  - `amount_details` (object)
    Contains information about the amount paid to the recipient through the .

  - `amount_details.total_amount` (integer)
    The total amount paid to the recipient.

  - `amount_details.currency` (string)
    The 3-letter ISO code designating the currency of the payout (e.g., USD).

  - `application_id` (string)
    The ID of the  that the  was created under.

  - `branding` (object)
    Object containing branding details for the .

  - `branding.brand_color` (string)
    The hexadecimal code of the branding color.
    Example: "#F2F2F2"

  - `branding.accent_color` (string)
    The hexadecimal code of the accent color.
    Example: "#F2F2F2"

  - `branding.logo` (string)
    The URL of the logo for the .

  - `branding.icon` (string)
    The URL for the icon of the  .

  - `items` (array)
    The list of items that will be "paid out". For example, insurance payouts, sales commissions, etc.

  - `link_expires_at` (string)
    Timestamp of when the  will expire.

  - `link_url` (string)
    The URL of the . Recipients can re-visit the link to check the status of their payout.

  - `nickname` (string)
    A human-readable name for the resource.
    Example: "super important thing"

  - `recipient_details` (object,null)
    Details of the recipient.

  - `recipient_details.business_name` (string,null)
    The recipient's legal business name. For a sole proprietorship, pass the owner's legal first name, last name, and middle initial.

  - `recipient_details.doing_business_as` (string,null)
    Alternate names of the business. If there are no other names, pass the same value used for .

  - `recipient_details.email` (string,null)
    Email address of the recipient.

  - `recipient_details.first_name` (string,null)
    First name of the recipient.

  - `recipient_details.last_name` (string,null)
    Last name of the recipient.

  - `recipient_details.merchant_id` (string)
    The  resource linked to the recipient targeted by the .
    Example: "MUcgYZswyRfqSSbvMsxuaHxZ"

  - `state` (string)
    The state of the .
    Enum: "ACTIVE", "AWAITING_PAYOUT", "EXPIRED", "COMPLETED", "DEACTIVATED"

  - `tags` (object,null)
    Include up to 50  pairs to annotate requests with custom metadata.
- Maximum character length for individual  is 40.
- Maximum character length for individual  is 500.
(For example, , , )

  - `_links` (object)
    An object containing link(s) relevant to the request. You can store these links for follow-up requests.

  - `_links.self` (object)

  - `_links.self.href` (string)
    The path to the  resource.

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 404 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 422 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "INVALID_FIELD"

  - `_embedded.errors.field` (string)

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)