Deposit

Request address

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

Headers

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

Main request parameters

Parameter	Mandatory	Format	Description	Example
session_key	Yes	String	From /api/v1/get_session_key/
external_id	Yes	String	Client side order id	“1234512123124”
group	Yes	int	Groups list	501
amount	Yes	float	Amount	20.5, 20.55, 20
minor_amount	No	int	Minor Amount	2050
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”
cvv	Yes	String(3-4)	Security code	“123”, “1234”
card_holder	Yes	String	Card holder name	“Good Fella”

Either 'amount' or 'minor_amount' is required.

Please, note when sending minor_amount - some of the currencies on our side have no coins: KRW, VND, JPY. In this cases - minor_amount: 1000 will be treated as 1000 and not 10.00

Additional request parameters

Parameter	Mandatory	Format	Description	Example
screen_width	No	int	Window screen width	2880
screen_height	No	int	Window screen height	1620
color_depth	No	int	Window screen color depth	24
time_zone_offset	No	int	new Date().getTimezoneOffset()	-180
browser_language	No	String	Browsers language	'en-US'
redirect_success_url	No	String	Redirect of a successful deposit
redirect_fail_url	No	String	Redirect of a failed deposit

Deposit request example

Request example

{
    "session_key": "eyJybmQiOiAiNjEwMjk4YjQtMTNiYy00ZTFkLWJmMDYtOTQxOTBlNzY1ZjMwIn0.ZNT0BQ.b4yavFYV_A-Z1dptn53ZJsMl8MY",
    "group": 1019, 
    "order_ref": "123454567",
    "amount": 10,
    "card_number": "4111111111111111",
    "valid_thru_month": "04",
    "valid_thru_year": "2027",
    "cvv": "123",
    "card_holder": "SOME GUY",
    "screen_width": 2880,
    "screen_height": 1620,
    "color_depth": 24,
    "time_zone_offset": "-180",
    "browser_language": "en-US",
}

200:Response example

3ds_redirect_url

{
    "engine_override": "json",
    "success": true,
    "status": 2,
    "order_id": "116969823919035896812729766638",
    "data": {
        "3ds_flow": true,
        "3ds version": "1",
        "redirect_url": "https://example.com/ClientHandler?trans_ir",
        "url": "https: //example.com/ClientHandler",
        "method": "GET",
        "redirect_params": {
            "trans_id": "hmcShOj8bUvtcKBOIENw15pfb58="
        }
    }
}

400:Response example

{
    "success": false,
    "error_message": "Transaction processing error",
    "status": 6,
    "order_id": "116917627430559094626428046325"
}

403:Response example

{
    "success": false,
    "errors": {
        "signature": ["Signature is invalid"]
    }
}

Request examples for specific payment methods

Korea - Virtual Accounts

Deposit request

Initial deposit request

{
    "session_key": "eyJybmi0iAiMTUyMDM10WItOTM1NCOOYZU3LWIzOGUtY2JmMWI20DU2NWQ3In0.Zqtgjg.THXMbbUbyhqYryAyaEOi1-2p-f8",
    "group": 1207,
    "account_number": "12345678910",
    "Owner_name": "John Dow",
    "bank_name" : "산업은행"
}

Deposit request after the initial request

{
    "session_key": "eyJybmQiOiAiNDlhYmMyY2YtNmFhYi00OTk3LThlMjYtZDNhYTc2YmE3ZTg3In0.ZqpNaA.Xo--4Ef4P49Ag-ceX4vViy9Ybzg",
    "group": 1207,
    "external_id": "eur3791",
    "amount": 10000,
    "bank_name": "국민은행",
    "account_number": "12987676788",
    "owner_name": "John Dow",
    "signature": "otakoi"
}