Upsert a payout request

Creates or updates (upserts) a payout request with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json
websiteId
required
string (WebsiteId) <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

customerId
required
string <= 50 characters

ID of the customer who is requesting a payout.

paymentInstrumentId
string <= 50 characters

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

currency
required
string = 3 characters

Currency of the payout.

amount
required
number <double>

Amount of the payout.

selectedPaymentInstrumentRedirectUrl
string <uri>

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.

Responses
200

Payout request updated.

Response Schema: application/json
id
string <= 50 characters

Unique resource ID.

websiteId
required
string (WebsiteId) <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

customerId
required
string <= 50 characters

ID of the customer who is requesting a payout.

paymentInstrumentId
string <= 50 characters

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

currency
required
string = 3 characters

Currency of the payout.

amount
required
number <double>

Amount of the payout.

unallocatedAmount
number <double>

Available payout request amount that has not been allocated.

status
string

Status of the request.

Enum: Description
pending

Request is awaiting customer's selection of the payment instrument or fulfillment.

instrument-selected

Request has a selected payment instrument and is awaiting fulfillment.

partially-fulfilled

Request is partially paid out when availableAmount is less than amount.

fulfilled

Request is fully paid out when availableAmount reaches zero.

selectPaymentInstrumentUrl
string <uri>

URL for the customer to select a preferred payment instrument.

Array of objects

List of credit transactions that are allocated to reduce the available amount of a payout request.

selectedPaymentInstrumentRedirectUrl
string <uri>

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.

createdTime
string <date-time>

Date and time when the payout request is created.

updatedTime
string <date-time>

Date and time when the payout request is updated.

Array of objects (SelfLink)

Related links.

201

Payout request created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
id
string <= 50 characters

Unique resource ID.

websiteId
required
string (WebsiteId) <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

customerId
required
string <= 50 characters

ID of the customer who is requesting a payout.

paymentInstrumentId
string <= 50 characters

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

currency
required
string = 3 characters

Currency of the payout.

amount
required
number <double>

Amount of the payout.

unallocatedAmount
number <double>

Available payout request amount that has not been allocated.

status
string

Status of the request.

Enum: Description
pending

Request is awaiting customer's selection of the payment instrument or fulfillment.

instrument-selected

Request has a selected payment instrument and is awaiting fulfillment.

partially-fulfilled

Request is partially paid out when availableAmount is less than amount.

fulfilled

Request is fully paid out when availableAmount reaches zero.

selectPaymentInstrumentUrl
string <uri>

URL for the customer to select a preferred payment instrument.

Array of objects

List of credit transactions that are allocated to reduce the available amount of a payout request.

selectedPaymentInstrumentRedirectUrl
string <uri>

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.

createdTime
string <date-time>

Date and time when the payout request is created.

updatedTime
string <date-time>

Date and time when the payout request is updated.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

put/payout-requests/{id}
Request samples
application/json
{
  • "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  • "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  • "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
  • "currency": "USD",
  • "amount": 0,
  • "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}"
}
Response samples
application/json
{
  • "id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80",
  • "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  • "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  • "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
  • "currency": "USD",
  • "amount": 0,
  • "unallocatedAmount": 0,
  • "status": "pending",
  • "selectPaymentInstrumentUrl": "http://example.com",
  • "allocations": [
    ],
  • "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}