---
title: "Set Payout Response"
source_url: https://docs.rapyd.net/en/set-payout-response.html
lang: en
---

# Set Payout Response

Accept or decline a payout to a Rapyd Wallet.

If the beneficiary accepts the payout, this method triggers the [Payout Completed Webhook](https://docs.rapyd.net/en/payout-completed-webhook.md "Payout Completed Webhook").

If the beneficiary declines the payout, this method triggers the [Payout Failed Webhook](https://docs.rapyd.net/en/payout-failed-webhook.md "Payout Failed Webhook").

> **Note:**
>
> Relevant to payout to a Rapyd wallet. This method can be used only one time per payout.

Prerequisites

- Create a payout to a Rapyd Wallet. See [Create Payout](https://docs.rapyd.net/en/create-payout.md "Create Payout").
- In the `beneficiary` object, `confirmation_required` must be set to **true**. Do one of the following:

  - In the payout request, include the `beneficiary` object and set `confirmation_required` to **true**.
  - Create a beneficiary and set `confirmation_required` to **true**. See [Create Beneficiary](https://docs.rapyd.net/en/create-beneficiary.md "Create Beneficiary"). Then create the payout.

> **Note:**
>
> - The code samples include successful requests (200) and bad requests (400).
>
>   - For error messages that appear due to bad requests (400), see:
>
>     - [General Errors](https://docs.rapyd.net/en/general-errors.md "General Errors")
>     - [Payout Errors](https://docs.rapyd.net/en/payout-errors.md "Payout Errors")
>   - For information about unauthorized request (401) and other authentication errors, see [Troubleshooting Authentication and Authorization Errors](https://docs.rapyd.net/en/troubleshooting-authentication-and-authorization-errors.md "Troubleshooting Authentication and Authorization Errors").

### Parameters

### Request Body Parameters

- - id
  - ID of the `payout` object in the [Create Payout](https://docs.rapyd.net/en/create-payout.md "Create Payout") response. String starting with **payout_**.
- - status
  - Determines how to handle the payout. One of the following values:

    - **accept**
    - **decline**
- - metadata
  - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata").

### Request Header Parameters

- - access_key
  - Unique access key provided by Rapyd for each authorized user.

    See [Developers](https://docs.rapyd.net/en/developers.md "Developers").
- - Content-Type
  - Indicates that the data appears in JSON format. Set to **application/json**.
- - idempotency
  - A unique key that prevents the platform from creating the same object twice.

    See [Idempotency](https://docs.rapyd.net/en/idempotency.md "Idempotency").
- - salt
  - Random string. Recommended length: 8-16 characters.
- - signature
  - Signature calculated for each request individually.

    See [Request Signatures](https://docs.rapyd.net/en/request-signatures.md "Request Signatures").
- - timestamp
  - Timestamp for the request, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds).

### Response Parameters

The `status` object is returned and it includes a **SUCCESS** value.

- /v1/payouts/response

- Accept
- ```curl
  curl -X post
  'https://sandboxapi.rapyd.net/v1/payouts/response' \
  -H 'access_key: your-access-key-here' \
  -H 'Content-Type: application/json' \
  -H 'idempotency: your-idempotency-parameter-here' \
  -H 'salt: your-random-string-here' \
  -H 'signature: your-calculated-signature-here' \
  -H 'timestamp: your-unix-timestamp-here' \
  --data-raw '{
      "id": "payout_b380ca556ac03259d5d2b83dd4b5eaff",
      "status": "accept"
  }'
  ```
- ```json
  {
      "status": {
          "error_code": "",
          "status": "SUCCESS",
          "message": "",
          "response_code": "",
          "operation_id": "821a9341-3757-409d-875c-69c43a4c8eb0"
      }
  }
  ```

- Decline
- ```curl
  curl -X post
  'https://sandboxapi.rapyd.net/v1/payouts/response' \
  -H 'access_key: your-access-key-here' \
  -H 'Content-Type: application/json' \
  -H 'idempotency: your-idempotency-parameter-here' \
  -H 'salt: your-random-string-here' \
  -H 'signature: your-calculated-signature-here' \
  -H 'timestamp: your-unix-timestamp-here' \
  --data-raw '{
      "id": "payout_04d506aff2489474bd75533b528474f5",
      "status": "decline"
  }'
  ```
- ```json
  {
      "status": {
          "error_code": "",
          "status": "SUCCESS",
          "message": "",
          "response_code": "",
          "operation_id": "953cdaef-00ed-46ba-9fac-fe4452916c5f"
      }
  }
  ```

- Bad Request - Invalid Status Value
- ```curl
  curl -X post
  'https://sandboxapi.rapyd.net/v1/payouts/response' \
  -H 'access_key: your-access-key-here' \
  -H 'Content-Type: application/json' \
  -H 'idempotency: your-idempotency-parameter-here' \
  -H 'salt: your-random-string-here' \
  -H 'signature: your-calculated-signature-here' \
  -H 'timestamp: your-unix-timestamp-here' \
  --data-raw '{
      "id": "payout_9f07b29ce0217b80268d49ccb0458267",
      "status": "confirm"
  }'
  ```
- ```json
  {
      "status": {
          "error_code": "INVALID_TRANSFER_STATUS",
          "status": "ERROR",
          "message": "The request tried to set a response to a transfer between wallets, but the status was not recognized. The request was rejected. Corrective action: Set 'status' to one of the following values: 'accept', 'decline', 'cancel'.",
          "response_code": "INVALID_TRANSFER_STATUS",
          "operation_id": "fabbe3a2-effa-4cbf-b815-387b2a3a23cf"
      }
  }
  ```

- Bad Request - Payout Not Found
- ```curl
  curl -X post
  'https://sandboxapi.rapyd.net/v1/payouts/response' \
  -H 'access_key: your-access-key-here' \
  -H 'Content-Type: application/json' \
  -H 'idempotency: your-idempotency-parameter-here' \
  -H 'salt: your-random-string-here' \
  -H 'signature: your-calculated-signature-here' \
  -H 'timestamp: your-unix-timestamp-here' \
  --data-raw '{
      "id": "payout_4362c213f2b5d9b12e5d52cce3a33a43",
      "status": "accept"
  }'
  ```
- ```json
  {
      "status": {
          "error_code": "ERROR_GET_PAYOUT",
          "status": "ERROR",
          "message": "The request tried to retrieve a payout, but the payout was not found. The request was rejected. Corrective action: Use the ID of a valid payout.",
          "response_code": "ERROR_GET_PAYOUT",
          "operation_id": "dad4f05d-63b7-4728-8639-0fd4da7c9222"
      }
  }
  ```