POST /storefront/ready-to-payout
Retrieves available payment methods for a specific payout amount and currency.
The order in which the payment methods are displayed to the customer must be the same as the order in the response.
The list of payment methods is generated from available gateway accounts and the last matched adjust-ready-to-payout action on the ready-to-payout-requested event.
If no rules match for the specific request, all methods supported by the gateway accounts are sent.
To invert this behavior, place all matching rules at the end of the ready-to-payout-requested event in the rules engine,
and include an empty paymentMethods property for the adjust-ready-to-payout action.
For more information, see Update event rules and Gateway accounts.
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 |
|---|---|---|---|
amount |
Number | Yes |
Amount to payout. |
riskMetadata |
Object | Yes |
Risk metadata used for 3D Secure and risk scoring. |
riskMetadata.hasMismatchedHolderName |
Boolean | No |
Specifies if the customer's billing address name and primary address name are not the same. |
riskMetadata.score |
Integer | No |
Computed risk score based on IP risk data,
such as: |
riskMetadata.emailVelocity |
Integer | No |
Number of transactions for this email address in the last 24 hours. |
riskMetadata.httpHeaders |
Object | No | |
riskMetadata.hasMismatchedBillingAddressCountry |
Boolean | No |
Specifies if the customer's billing address country and geo-IP address are not the same. |
riskMetadata.declinedPaymentInstrumentVelocity |
Integer | No |
Number of declined transactions for this payment instrument fingerprint in the last 24 hours. |
riskMetadata.accuracyRadius |
Integer | No |
Accuracy radius of the specified IP address, in kilometers. |
riskMetadata.latitude |
Number | No |
Latitude of the specified IP address. |
riskMetadata.isHosting |
Boolean | No |
Specifies if the customer's IP address is related to hosting. |
riskMetadata.city |
String | No |
City of the specified IP address. |
riskMetadata.extraData |
Object | No |
Third-party data used for risk scoring. |
riskMetadata.extraData.payPalMerchantSessionId |
String | No |
PayPal |
riskMetadata.extraData.threatMetrixSessionId |
String | No |
Temporary identifier that is unique to the visitor session and passed to ThreatMetrix. |
riskMetadata.extraData.kountFraudSessionId |
String | No |
Alpha-numeric |
riskMetadata.isProxy |
Boolean | No |
Specifies if the customer's IP address is related to a proxy. |
riskMetadata.postalCode |
String | No |
Postal code of the specified IP address. |
riskMetadata.paymentInstrumentApprovedTransactionCount |
Integer | No |
Number of approved transactions for this payment instrument. |
riskMetadata.longitude |
Number | No |
Longitude of the specified IP address. |
riskMetadata.hasMismatchedTimeZone |
Boolean | No |
Specifies if the customer's browser time zone and the IP address associated time zone are not the same. |
riskMetadata.distance |
Integer | No |
Distance between the customer's IP address and the billing address geolocation, in kilometers. |
riskMetadata.country |
String | No |
Country ISO Alpha-2 code of the specified IP address. |
riskMetadata.paymentInstrumentVelocity |
Integer | No |
Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours. |
riskMetadata.hostingName |
String | No |
Name of the data center or hosting provider, if available. |
riskMetadata.region |
String | No |
Region of the specified IP address. |
riskMetadata.hasMismatchedBankCountry |
Boolean | No |
Specifies if the customer's bank country and geo-IP address are not the same. |
riskMetadata.browserData |
Object | No |
Browser data used for 3D Secure and risk scoring. |
riskMetadata.browserData.isJavaEnabled |
Boolean | Yes |
Specifies if Java is enabled in a browser.
This value is obtained from the |
riskMetadata.browserData.isAdBlockEnabled |
Boolean | No |
Specifies if the usage of ad block has been detected in the browser. |
riskMetadata.browserData.screenWidth |
Integer | Yes |
Width of the browser screen.
This value is obtained from the |
riskMetadata.browserData.timeZoneOffset |
Integer | Yes |
Browser time zone offset in minutes from UTC.
A positive offset indicates that the local time is behind UTC.
A negative offset indicates that the local time is ahead of UTC.
You can find this value using the |
riskMetadata.browserData.screenHeight |
Integer | Yes |
Height of the browser screen.
This value is obtained from the |
riskMetadata.browserData.colorDepth |
Integer | Yes |
Browser color depth in bits per pixel.
This value is obtained using the |
riskMetadata.browserData.language |
String | Yes |
Browser language settings.
This value is obtained from the |
riskMetadata.isVpn |
Boolean | No |
Specifies if the customer's IP address is related to a VPN. |
riskMetadata.fingerprint |
String | No |
Customer's device fingerprint. A device fingerprint is a unique token that is used to identify the customer. The device fingerprint is generated based on device attributes, such as: hardware, software, IP address, language, browser, and more. |
riskMetadata.ipAddress |
String | No |
Customer's IP address. |
riskMetadata.billingAddressVelocity |
Integer | No |
Number of transactions for this billing address in the last 24 hours. |
riskMetadata.deviceVelocity |
Integer | No |
Number of transactions for this device, based on fingerprint, in the last 24 hours. |
riskMetadata.ipVelocity |
Integer | No |
Number of transactions for this IP address in the last 24 hours. |
riskMetadata.isp |
String | No |
Internet Service Provider (ISP) name, if available. |
riskMetadata.hasFakeName |
Boolean | No |
Specifies if the holder name seems fake. |
riskMetadata.timeZone |
String | No |
Time zone of the specified IP address. |
riskMetadata.isTor |
Boolean | No |
Specifies if the customer's IP address is related to TOR. |
riskMetadata.isHighRiskCountry |
Boolean | No |
Specifies if the geo-IP country, or the customer's billing country, is considered a high risk country. |
billingAddress |
Object | No |
Billing address. |
currency |
String | Yes |
Currency of the payout request allocation. |
websiteId |
String | Yes |
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID. |
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.