/
Create a payout request

Create a payout request
Experimental

Request

Creates a payout request.

Security
CustomerJWT
Bodyapplication/jsonrequired
cashierIdstring, <= 50 charactersrequired

ID of the cashier resource that sends the payout request.

Example:"cashier_0YV7DE4Z26DQSA1AC92FBJ7SEG"
paymentInstrumentIdstring, <= 50 charactersrequired

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

Example:"inst_0YVB8KPKNXCBR9EDX7JHSED75N"
amountnumber, (double)required

Amount of the payout.

curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/storefront/payout-requests \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cashierId": "cashier_0YV7DE4Z26DQSA1AC92FBJ7SEG",
    "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
    "amount": 0.1
  }'

Responses

Payout request created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
Bodyapplication/json
idstring, <= 50 charactersread-only

Unique resource ID.

Example:"pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"
websiteIdstring, <= 50 characters(WebsiteId)

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"
paymentInstrumentIdstring, <= 50 characters

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

Example:"inst_0YVB8KPKNXCBR9EDX7JHSED75N"
currencystring, = 3 characters(CurrencyCode)

Currency of the payout.

Example:"USD"
amountnumber, (double)

Amount of the payout.

statusstringread-only

Status of the request.

Enum ValueDescription
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.

createdTimestring, (date-time)(ServerTimestamp)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.

Response
{
  "id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80",
  "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
  "currency": "USD",
  "amount": 0.1,
  "status": "pending",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}