# Payout request canceled

Endpoint: POST payout-request-canceled
Version: latest
Security: SecretApiKey, JWT

## Request fields (application/json):

  - `payoutRequestId` (string)
    ID of the payout request.

  - `eventType` (string)
    Type of event that triggered the webhook.
    Enum: "payout-request-created", "payout-request-modified", "payout-request-canceled", "payout-request-fulfilled"

  - `_embedded` (object)
    Embedded objects related to the payout request event.

  - `_embedded.payoutRequest` (object)

  - `_embedded.payoutRequest.websiteId` (string, required)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: web_0YV7DE4Z26DQSA1AC92FBJ7SEG

  - `_embedded.payoutRequest.customerId` (string, required)
    ID of the customer resource.
    Example: cus_0YV7DDSDD1C8DA64KHH2W33CPF

  - `_embedded.payoutRequest.paymentInstrumentId` (string | null)
    ID of the requested payment instrument to offer for the payout.
    Example: inst_0YVB8KPKNXCBR9EDX7JHSED75N

  - `_embedded.payoutRequest.currency` (string, required)
    Currency code in ISO 4217 format.
    Example: USD

  - `_embedded.payoutRequest.amount` (number, required)
    Amount of the payout.

  - `_embedded.payoutRequest.description` (string | null)
    Description of payout request.

  - `_embedded.payoutRequest.blocked` (boolean)
    Specifies whether the payout request is blocked or unblocked.
When blocked, the payout request cannot transition to `ready`, `approved`, `in-progress`, `merged`, `split`, or `canceled`.
Allocation creation, allocation processing, and cancellation of pending allocations are also prevented.
A blocked payout request can still transition to the `fulfilled` status if allocation processing starts before the payout request is blocked.
    Example: false

  - `_embedded.payoutRequest.blockReason` (any)

  - `_embedded.payoutRequest.splitReason` (any)

  - `_embedded.payoutRequest.selectedPaymentInstrumentRedirectUrl` (string)
    URL where the customer is redirected when a payment instrument is selected. The default value is the website URL.
Use `{{id}}` as a placeholder for the payout request ID.
    Example: https://example.com/payout-request-success

  - `_links` (array)
    Links to related resources.

  - `_links.href` (string)
    URL of the link.

  - `_links.rel` (string)
    Relationship type of the link.
    Enum: "payoutRequest"