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.

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

Contact's information.

required
object (RiskMetadata)

Risk metadata used for 3D Secure and risk scoring.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

amount
required
number <double>

Amount to payout.

post
/storefront/ready-to-payout
Request samples
application/json
{ "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "billingAddress": { "firstName": "Benjamin", "lastName": "Franklin", "organization": "Rebilly", "address": "36 Craven St", "address2": "string", "city": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "dob": "1980-04-01", "jobTitle": "CEO" }, "riskMetadata": { "ipAddress": "93.92.91.90", "fingerprint": "pIUt3xbgX3l9g3YDiLbx", }, "currency": "USD", "amount": 0.1 }
Responses

200

Payment methods retrieved.

Response Schema: application/json
method
required
string

Payment method.

brands
Array of strings (PaymentCardBrand) non-empty

List of supported brands.

Items Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"
filters
Array of strings (ReadyToPayoutMethodFilters)

For the method to be applicable, one or more of the following filters must match. If no filters are sent, no restrictions are applied. For more information, see Using filters.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

Response samples
application/json
{ "method": "payment-card", "brands": [ "Visa" ], "filters": [ "string" ] }