Payout

This section outlines the procedures for processing payouts, including creating and tracking payout requests. It includes detailed steps and the required data to ensure smooth disbursements to users.

Request address

https://api.carouseller.com/v1/payments/payout/

Headers

{“Content-Type: “application/json”}

Request example

{
    "session_key": "eyJybmQiOiAiNjEwMjk4YjQtMTNiYy00ZTFkLWJmMDYtOTQxOTBlNzY1ZjMwIn0.ZNT0BQ.b4yavFYV_A-Z1dptn53ZJsMl8MY",
    "order_ref": "1234565776",
    "group": 501,
    "amount": 10, 
    "card_number": "4111111111111111",
    "valid_thru_month": "04",
    "valid_thru_year": "2027",
    "card_holder": "Good Fella",
    "site_id": 24,
    "site_login": "15616161"    
}

Main request parameters

Parameter	Mandatory	Format	Description	Example
session_key	Yes	String	From /api/v1/get_session_key/
order_ref	Yes	String	Client side order id	“1234512123124”
group	Yes	Int	Groups list	501
amount	Yes	Float	Amount	20.5, 20.55, 20
card_number	Yes	String	Card number	4111111111111111
valid_thru_month	Yes	String(2)	Expire month	“02”, “12”
valid_thru_year	Yes	String(4)	Expire year	“2024”
card_holder	Yes	String	Card holder name	“Good Fella”
site_login	Yes	String	User id	12345678
site_id	Yes	Int	Client id provided by support with documentation	24
signature	Yes	String	Request signature, see Request signature generating rules	d9f5713990de5c6e32169dba1f0102f540018975

Response examples

200: Response example

{
    "success": true,
    "order_id": "116917635696534467074739258862",
    "order_ref": "1234565776"
}

400: Response example

403: Response example