# Retrieve a payout request (v2 temporary endpoint) (deprecated)

Retrieves a payout request with a specified ID.

Endpoint: GET /payout-requests-v2/{id}
Version: latest
Security: SecretApiKey, JWT

## Path parameters:

  - `id` (string, required)
    ID of the resource.

## Response 200 fields (application/json):

  - `id` (string)
    ID of the resource.
    Example: "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

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

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

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

  - `currency` (string, required)
    Currency of the payout.

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

  - `availableAmount` (number)
    Amount of the payout request that is unallocated and available.

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

  - `status` (string)
    Status of the request.
    Enum: "pending", "flushed", "approved", "in-progress", "instrument-selected", "partially-fulfilled", "fulfilled", "canceled", "customer-reversed", "system-reversed", "admin-reversed"

  - `blocked` (boolean)
    Specifies whether the payout request is blocked or unblocked.

  - `selectPaymentInstrumentUrl` (string)
    URL where the customer can select a preferred payment instrument.

  - `allocations` (array)
    List of payout request allocations for the payout request.

  - `allocations.payoutRequestId` (string, required)
    ID of the payout request associated with this allocation.
    Example: "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `allocations.paymentInstrumentId` (string, required)
    ID of the payment instrument allocated to the payout request.
    Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `allocations.gatewayAccountId` (string, required)
    ID of the gateway account to use for processing this allocation.
    Example: "gateway_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `allocations.gatewayName` (string)
    Name of the gateway account to use for processing this allocation.
    Example: "TestProcessor"

  - `allocations.amount` (number, required)
    Amount allocated to this payment instrument.

  - `allocations.currency` (string, required)
    Currency of the payout request allocation.

  - `allocations.status` (string)
    Status of this payout request allocation.
    Enum: "pending", "processing", "completed", "failed", "canceled"

  - `allocations.transactionId` (string,null)
    ID of the transaction that is created when processing this allocation, if applicable.
    Example: "txn_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `allocations.createdTime` (string)
    Date and time when the allocation for the payout request was created.

  - `allocations.updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `allocations._links` (array)
    Related links.

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

  - `allocations._links.rel` (string)
    Type of link.
    Enum: "self", "transaction", "gatewayAccount", "payoutRequest", "paymentInstrument"

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

  - `cancellationReason` (object,null)
    Reason the payout request is canceled.

  - `cancellationReason.canceledBy` (string)
    Specifies who initiated the cancellation.
    Enum: "merchant", "customer"

  - `cancellationReason.description` (string)
    Description of the cancellation reason in free form.

  - `createdTime` (string)
    Date and time when the payout request is created.

  - `updatedTime` (string)
    Date and time when the payout request is updated.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 404 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.