# Retrieve a payout request allocation

Retrieves a payout request allocation with a specified ID.

Endpoint: GET /payout-request-allocations/{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: "pra_0YVDMDE2BMC6KBB5MX76RF6T80"

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

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

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

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

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

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

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

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

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

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

  - `_links` (array)
    Related links.

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

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

## 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.