# Update Payout Link

Update the details of a Payout Link. 

The state must be ACTIVE to update allowed_payout_operations and recipient_details.

Endpoint: PUT /payout_links/{payout_link_id}
Version: 2022-02-01
Security: BasicAuth

## Path parameters:

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

## Request fields (application/json):

  - `allowed_payout_operations` (array)
    Defines the types of operations permitted in the payout process when the recipient submits the payout form.
    Enum: "PUSH_TO_ACH", "PUSH_TO_CARD"

  - `recipient_details` (object)
    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 business_name.

  - `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 Merchant resource linked to the recipient targeted by the Payout Link.
    Example: "MUcgYZswyRfqSSbvMsxuaHxZ"

  - `nickname` (string)
    A human-readable name for the resource.

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

  - `tags` (object,null)
    Include up to 50 key: value pairs to annotate requests with custom metadata.
- Maximum character length for individual keys is 40.
- Maximum character length for individual values is 500.
(For example, order_number: 25, item_type: produce, department: sales)

## Response 200 fields (application/json):

  - `id` (string)
    The ID of the resource.

  - `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 Payout Link.

  - `additional_details.expiration_in_minutes` (integer)
    Details how long (in minutes) the Payout Link is valid for. The max 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.success_return_url` (string,null)
    A URL to redirect the recipient to after the payout is successful.

  - `additional_details.terms_of_service_url` (string, required)
    Your Terms of Service URL.

  - `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.
    Enum: "PUSH_TO_ACH", "PUSH_TO_CARD"

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

  - `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)
    ID of the Application the resource was created under.

  - `branding` (object)

  - `branding.accent_color` (string, required)
    Hex code of the accent color.
    Example: "#F2F2F2"

  - `branding.brand_color` (string, required)
    Hex code of branding color.
    Example: "#F2F2F2"

  - `branding.button_font_color` (string,null)
    Hex code of the button font color.

  - `branding.icon` (string, required)
    URL for the icon of the payment link.

  - `branding.logo` (string, required)
    URL of the logo for the payment link.

  - `branding.logo_alternative_text` (string,null)
    Alternate text displayed if the logo image cannot display.

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

  - `items.name` (string)
    The payout item name.

  - `items.description` (string)
    A payout item description.
    Example: "Car damage"

  - `items.image_details` (object)
    Payout item image locations.

  - `items.image_details.primary_image_url` (string)
    The location of a payout item's image.

  - `items.image_details.alternative_image_urls` (array)
    The locations of backup images if there is an issue with the primary image.

  - `items.price_details` (object)
    Additional details about the price.

  - `items.price_details.amount` (integer)
    The total amount to be paid to the recipient for the payout item.

  - `items.price_details.currency` (string)
    ISO 4217 3-letter currency code.
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL"

  - `items.quantity` (integer)
    The payout item quantity.

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

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

  - `nickname` (string)
    A human-readable name for the resource.

  - `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 business_name.

  - `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 Merchant resource linked to the recipient targeted by the Payout Link.
    Example: "MUcgYZswyRfqSSbvMsxuaHxZ"

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

  - `tags` (object,null)
    Include up to 50 key: value pairs to annotate requests with custom metadata.
- Maximum character length for individual keys is 40.
- Maximum character length for individual values is 500.
(For example, order_number: 25, item_type: produce, department: sales)

  - `_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 Payout Link resource.

## Response 400 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 401 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 403 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 404 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 406 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.

## Response 422 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (string)
    A log reference identifier for the error, useful for debugging and support purposes.

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.self` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.self.href` (string)
    URL of the related resource.