# List Payout Links Retrieve a list of resources. For details on how to query endpoints using the available parameters, see Query Parameters. Endpoint: GET /payout_links Version: 2022-02-01 Security: BasicAuth ## Header parameters: - `Finix-Version` (string) Specify the API version of your request. For more details, see Versioning. Example: "2022-02-01" ## Query parameters: - `limit` (integer) The numbers of items to return. Example: 3 - `after_cursor` (string) Return every resource created after the cursor value. - `before_cursor` (string) Return every resource created before the cursor value. ## Response 200 fields (application/json): - `_embedded` (object) List of objects. - `_embedded.payout_links` (array) objects. - `_embedded.payout_links.id` (string) The ID of the resource. Example: "payout_link_caKCWTF8wyp784FEN7fF5" - `_embedded.payout_links.created_at` (string) Timestamp of when the object was created. - `_embedded.payout_links.updated_at` (string) Timestamp of when the object was last updated. - `_embedded.payout_links.additional_details` (object) Object containing additional details about the . - `_embedded.payout_links.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. - `_embedded.payout_links.additional_details.expired_session_url` (string,null) The URL to redirect the recipient to if their session times out. - `_embedded.payout_links.additional_details.terms_of_service_url` (string,null) The URL to the sender's Terms of Service. - `_embedded.payout_links.additional_details.success_return_url` (string,null) A URL to redirect the recipient to after the payout is successful. - `_embedded.payout_links.additional_details.unsuccessful_return_url` (string,null) A URL to redirect the recipient to if the payout was successful. - `_embedded.payout_links.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 - `_embedded.payout_links.amount_details` (object) Contains information about the amount paid to the recipient through the . - `_embedded.payout_links.amount_details.total_amount` (integer) The total amount paid to the recipient. - `_embedded.payout_links.amount_details.currency` (string) The 3-letter ISO code designating the currency of the payout (e.g., USD). - `_embedded.payout_links.application_id` (string) The ID of the that the was created under. - `_embedded.payout_links.branding` (object) Object containing branding details for the . - `_embedded.payout_links.branding.brand_color` (string) The hexadecimal code of the branding color. Example: "#F2F2F2" - `_embedded.payout_links.branding.accent_color` (string) The hexadecimal code of the accent color. Example: "#F2F2F2" - `_embedded.payout_links.branding.logo` (string) The URL of the logo for the . - `_embedded.payout_links.branding.icon` (string) The URL for the icon of the . - `_embedded.payout_links.items` (array) The list of items that will be "paid out". For example, insurance payouts, sales commissions, etc. - `_embedded.payout_links.link_expires_at` (string) Timestamp of when the will expire. - `_embedded.payout_links.link_url` (string) The URL of the . Recipients can re-visit the link to check the status of their payout. - `_embedded.payout_links.nickname` (string) A human-readable name for the resource. Example: "super important thing" - `_embedded.payout_links.recipient_details` (object,null) Details of the recipient. - `_embedded.payout_links.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. - `_embedded.payout_links.recipient_details.doing_business_as` (string,null) Alternate names of the business. If there are no other names, pass the same value used for . - `_embedded.payout_links.recipient_details.email` (string,null) Email address of the recipient. - `_embedded.payout_links.recipient_details.first_name` (string,null) First name of the recipient. - `_embedded.payout_links.recipient_details.last_name` (string,null) Last name of the recipient. - `_embedded.payout_links.recipient_details.merchant_id` (string) The resource linked to the recipient targeted by the . Example: "MUcgYZswyRfqSSbvMsxuaHxZ" - `_embedded.payout_links.state` (string) The state of the . Enum: "ACTIVE", "AWAITING_PAYOUT", "EXPIRED", "COMPLETED", "DEACTIVATED" - `_embedded.payout_links.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, , , ) - `_embedded.payout_links._links` (object) An object containing link(s) relevant to the request. You can store these links for follow-up requests. - `_embedded.payout_links._links.self` (object) - `_embedded.payout_links._links.self.href` (string) The path to the resource. - `_links` (object) For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these to make your follow-up requests and quickly access relevant IDs. - `_links.next` (object) Link to the next page of entries. - `_links.next.href` (string) - `_links.self` (object) Link to the resource that was used in the request. - `page` (object) Details the page that's returned. - `page.limit` (integer) The number of entries to return. - `page.next_cursor` (string,null) The cursor to use for the next page of results. ## 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)