# 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 webhook event.
    Enum: "payout-request-created", "payout-request-modified", "payout-request-canceled"

  - `_embedded` (object)
    Embedded objects.

  - `_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).

  - `_embedded.payoutRequest.customerId` (string, required)
    ID of the customer who is requesting a payout.

  - `_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 of the payout.

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

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

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

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "payoutRequest"