Retrieve payout requests

Retrieve payout requests
Experimental

Request

Retrieves a list of payout requests.

Filter by: id, customerId, websiteId, batchId, status, blocked, blockReason, splitReason, createdTime, updatedTime, currency, amount.

Security

SecretApiKey or JWT

Query

limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/payout-requests?limit=1000&offset=1000&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of payout requests retrieved.

Headers

Pagination-Totalinteger

Total number of items.

Example:332

Pagination-Limitinteger

Maximum number of items per page.

Example:100

Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2

Bodyapplication/json

Array [

idstring, <= 50 charactersread-only

Unique resource ID.

Example:"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

websiteIdstring, <= 50 characters(WebsiteId)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.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"

customerIdstring, <= 50 characters(CustomerId)required

ID of the customer who is requesting a payout.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"

paymentInstrumentIdstring or null, <= 50 characters

ID of the requested payment instrument to offer for the payout.

Example:"inst_0YVB8KPKNXCBR9EDX7JHSED75N"

splitFromPayoutRequestIdstring or null, <= 50 charactersread-only

ID of the payout request from which this request is split, or null if this request is not created by a split operation.

Example:"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

mergedIntoPayoutRequestIdstring or null, <= 50 charactersread-only

ID of the payout request that this request is merged into, or null if it is not merged into another request.

Example:"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

currencystring, = 3 characters(CurrencyCode)required

Currency of the payout.

Example:"USD"

amountnumber, (double)required

Amount of the payout.

availableAmountnumber, (double)read-only

Available payout request amount that has not been allocated.

descriptionstring or null

Description of payout request.

statusstringread-only

Status of the request.

Enum Value	Description
pending	Request was created by the customer and is in a pending state for the configured pending period, unless it is marked as ready by a member of your organization. When automatic readiness is enabled, the payout request transitions to the `ready` state after the pending period elapses and the configured transition time is reached. Depending on the configured `automaticReadinessEnabled` setting, this may be the initial status assigned to new payout requests, or this status may not be used.
ready	Request was created by the customer and is ready for review. Depending on the configured `automaticReadinessEnabled` setting, this may be the initial status assigned to new payout requests.
approved	Request was reviewed, approved, and is ready for processing.
in-progress	Request has allocations and is being processed.
fulfilled	Request is fully paid out.
canceled	Request is canceled by merchant or customer.
split	Request was split into two or more payout requests.
merged	Request was merged into another payout request.

blockedboolean

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

blockReasonPayoutRequestBlockReason (string) or null

One of:

Reason for blocking the payout request.

string(PayoutRequestBlockReason)

Enum:"fraud-suspected""kyc-verification-required""aml-review""account-verification""duplicate-request""insufficient-documentation""risk-review""other"

splitReasonPayoutRequestSplitReason (string) or null

One of:

Reason for splitting the payout request.

string(PayoutRequestSplitReason)

Enum:"payment-instrument-limit""processor-limit""risk-review""compliance-review""partial-processing""operational-reconciliation""other"

batchIdstring or null, <= 50 charactersread-only

ID of the payout request batch that contains this request.

Example:"preq_batch_0YVDMDE2BMC6KBB5MX76RF6T80"

selectPaymentInstrumentUrlstring, (uri)read-only

URL for the customer to select a preferred payment instrument.

allocationsArray of objects(PayoutRequestAllocation)read-only

List of payout request allocations for the payout request.

selectedPaymentInstrumentRedirectUrlstring, (uri), <= 2083 characters

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"

cancellationReasonobject or null(PayoutRequestCancellation)read-only

Reason the payout request is canceled.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the payout request is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the payout request is updated.

_linksArray of objectsread-only

Our Solutions

Products

Features

Solutions

About