POST /deposit-requests

Creates a deposit request. To complete the deposit, the customer is redirected to the deposit link. After the deposit, the customer is redirected to the redirectUrl. Corresponding transaction webhooks are sent to webhooks subscribers.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`strategyId`	String	No	ID of a deposit amount strategy to be applied for this request for `amounts` and `customAmount`. If this field is not specified, a randomly selected deposit amount strategy with a matching `filter` value is applied for empty `amounts` and `customAmount`. If there is no matching deposit amount strategy, the default strategy with the following parameters is applied for empty `amounts` and `customAmount`: `amounts: calculator: absolute baseAmount: 10 increments: [10, 20] adjustBaseToLastDeposit: true customAmount: minimum: 1 multipleOf: 1 maximum: 10000` For more information, see Create a deposit amount strategy.
`amountLimits`	Object	No	Deposit amount limit information. Set optional minimum and maximum deposit amounts. Limits override `amounts` and `customAmount` values. If this value is `null`, deposit amount limits are not set.
`amountLimits.minimum`	Number	No	Minimum deposit amount. Default value: 0
`amountLimits.maximum`	Number	No	Maximum deposit amount.
`redirectUrl`	String	No	URL to redirect the customer to when a deposit is completed. The default value is the website URL.
`customPropertySetId`	String	No	ID of a custom property set to apply to the request `propertiesSchema`.
`expirationTime`	String	No	Date and time when the deposit request expires. The default expiration time is one hour after the time the request is created.
`currency`	String	Yes	Currency of the payout request allocation.
`notificationUrl`	String	No	URL where a server-to-server `POST` notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction. Do not interpret this notification as a confirmation, complete a `GET` request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a `2xx` HTTP status code. The following placeholders are available to use in this URI: `{id}` and `{result}`. These placeholders are replaced the with the transaction ID and result accordingly.
`websiteId`	String	Yes	ID of the website associated with the deposit.
`customerId`	String	Yes	ID of the customer who is requesting a payout.
`amounts[]`	Array	No	List of available deposit amounts. If `amounts` is not specified when a deposit request is created, amounts are determined from the chosen deposit amount strategy. For more information, see the `strategyId` property.
`customAmount`	Object	No	Custom amount restrictions. If this value is `null`, custom amounts are prohibited. If `customAmount` is not specified when a deposit request is created, amount restrictions are determined from the chosen deposit amount strategy. For more information, see the `strategyId` property.
`customAmount.minimum`	Number	Yes	Minimum custom amount.
`customAmount.multipleOf`	Number	Yes	Multiple by which the custom amount increases. For example, if `minimum` is equal to 5.30, and `multipleOf` is 0.50, the valid custom amount is 5.30, 5.80, 6.30, 6.80 and so on until the `maximum` value is reached. A valid custom amount must be equal to `minimum` + X * `multipleOf`, where X is any non negative integer.
`customAmount.maximum`	Number	Yes	Maximum custom amount. This value must be equal to `minimum` + X * `multipleOf`, where X is any positive integer.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.