API 2.0

2.0 version of the Carouseller API

Request address

Deposits

https://api.carouseller.com/v2/payment/deposit/

Payouts

https://api.carouseller.com/v2/payment/payout/

Headers

{
    "Content-Type": "application/json",
    "MERCHANT-KEY": "***"
}

Merchant key will be provided to you by your Carouseller manager

Main request parameters

Request example

{
   "payment_system": "",
    "external_id": "{{external_id}}",
    "customer": {
        "customer_id": "test",
        "country": "**",
        "first_name": "Test",
        "last_name": "Test"
    },
    "amount": 1100000,
    "currency": "USD",
    "signature": "signature"
}

Parameter	Mandatory	Format	Description	Example
payment_system	Yes	string	Unique ID of the payment method, is provided by your Carouseller manager.	***
external_id	Yes	String	Client side order id	“1234512123124”
amount	Yes	Integer	Amount	20
currency	Yes	alpha-3 ISO 4217	Purchase currency	USD
customer	Yes	Object	Object containing client information	“customer”: { “customer_id”: “JohnDoe”, “country”: “LV”, “first_name”: “Ivan”, “last_name”: “Ivan” }

Additional parameters depending on the payment method

Bank Cards

Deposits

"payment_data": {
        "card_number": "4111111111111111",
        "card_holder": "Good Fella",
        "exp_year": "2028",
        "exp_month": "06",
        "cvv": "123"
    }

Parameter	Mandatory	Format	Description	Example
card_number	Yes	String	Card number	4111111111111111
card_holder	Yes	String	Name of the card holder	Good Fella
exp_year	Yes	String	Expiration year	2028
exp_month	Yes	String	Expiration month	06
cvv	Yes	String	Card security code	123

Payouts

"payment_data": {
        "card_number": "4111111111111111",
        "card_holder": "Good Fella",
        "exp_year": "2028",
        "exp_month": "06"
    }

Parameter	Mandatory	Format	Description	Example
card_number	Yes	String	Card number	4111111111111111
card_holder	Yes	String	Name of the card holder	Good Fella
exp_year	Yes	String	Expiration year	2028
exp_month	Yes	String	Expiration month	06

200: Successful response

{
  "display_data": {
    "card": "4111111111111111",
    "card_holder": "Good Fella",
    "bank_name": "American Express"
  },
  "status": 1,
  "type": 1,
  "external_id": "BoUQswzcmH",
  "order_id": "172284927627647225983547588979",
  "track": "c886225b3be64da981d2b9a1951438af"
}

400: Unsuccessful response

{
    "error_code": "default",
    "error_message": "Declined. Please contact support for more details.",
    "status": 5,
    "type": 1,
    "external_id": "SzOQVzA724",
    "order_id": "172285043660926720456112753953",
    "track": "1791dc4dfd7b486aa5f707d9ec17b53a"
}

List of available bank names for AZN customers

• AccessBank

• AFB Bank

• AGBank

• Amrahbank

• AtaBank

• Azer Turk Bank

• Bank Avrasiya

• Bank BTB

• Bank of Baku

• Bank Respublika

• Expressbank

• Xalq Bank

• Kapital bank

• NBCBank

• Bank Silk Way

• Rabitebank

• TuranBank

• Yapi Kredi Bank

• Ziraat Bank

• ИКБ NIKOIL BANK

• Bank VTB

• ABB Bank

• ATB bank

P2P Bank Cards

Payouts

"payment_data": {
    "bank_name": "Sberbank",
    "card_number": "4111111111111111",
    "card_holder": "Ivan Ivan"
}

Parameter	Mandatory	Format	Description	Example
bank_name	Yes	String	Name of the bank	Sberbank
card_number	Yes	String	Card number	4111111111111111
card_holder	Yes	String	Name of the card holder	Ivan Ivan

Japanese Banks

Payouts

"payment_data": {
        "account_number": "6858629",
        "owner_name": "Some Guy",
        "owner_native_name": "シゲキ コムロ",
        "bank_name": "Some Bank",
        "bank_code": "0125",
        "branch_name": "BB-24",
        "branch_code": "279"
    }

Parameter	Mandatory	Format	Description	Example
account_number	Yes	String	Account number	6858629
owner_name	Yes	String	Name of the owner of the account	Good Fella
owner_native_name	Yes	String	Name of the owner of the account in native Japanese	シゲキ コムロ
bank_name	Yes	String	Name of the bank	Some Bank
bank_code	Yes	String	Code assigned by a central bank	0125
branch_name	Yes	String	Name of the branch	BB-24
branch_code	Yes	String	Code of the branch	279

VegaWallet

Deposits

"payment_data": {
        "wallet": "U000060",
        "password": "jDgBvkukPAPJXiAg"
    }

Parameter	Mandatory	Format	Description	Example
wallet	Yes	String	Wallet id	U000060
password	Yes	String	Password of the wallet	jDgBvkukPAPJXiAg

Payouts

"payment_data": {
        "wallet": "U000060",
        "password": "jDgBvkukPAPJXiAg"
    }

Parameter	Mandatory	Format	Description	Example
wallet	Yes	String	Wallet id	U000060
password	Yes	String	Password of the wallet	jDgBvkukPAPJXiAg

JetonWallet

Deposits

"payment_data": {
        "wallet": "12345678"
    }

Parameter	Mandatory	Format	Description	Example
wallet	Yes	String	Wallet id	12345678

Payouts

"payment_data": {
        "wallet": "12345678"
    }

Parameter	Mandatory	Format	Description	Example
wallet	Yes	String	Wallet id	12345678

EcoPayz

Payouts

"payment_data": {
        "wallet": "1100383615"
    }

Parameter	Mandatory	Format	Description	Example
wallet	Yes	String	Wallet id	1100383615

SticPay

Payouts

"payment_data": {
        "wallet": "[e-mail]"
    }

Parameter	Mandatory	Format	Description	Example
wallet	Yes	String	Wallet id	[e-mail]

Emanat

Payouts

"payment_data": {
        "phone_number": "994934331504"
    }

Parameter	Mandatory	Format	Description	Example
phone_number	Yes	String	Phone number	994934331504

M10Wallet

Payouts

"payment_data": {
        "phone": "994934331504"
    }

Parameter	Mandatory	Format	Description	Example
phone	Yes	String	Phone number	994934331504

For the Emanat and M10Wallet there is validation for the phone parameter: ^994\d{9}$

Cash

Deposits

"payment_data": {
        "address": "Street 12",
        "messenger": "Telegram",
        "username": "test",
        "asap": "true",
        "delivery_time": "2025-01-11 12:28:28"
    }

Parameter	Mandatory	Format	Description	Example
address	Yes	String	Address	Street 12
messenger	Yes	String	The messenger app	Telegram, WhatsApp
username	Yes	String	The username of the user	test
asap	Yes	String	Flag to indicate urgency	true
delivery_time	Yes	String	TIme of the delivery	2025-01-11 12:28:28

Payouts

"payment_data": {
        "address": "Street 12",
        "messenger": "Telegram",
        "username": "test",
        "asap": "true",
        "delivery_time": "2025-01-11 12:28:28"
    }

Parameter	Mandatory	Format	Description	Example
address	Yes	String	Address	Street 12
messenger	Yes	String	The messenger app	Telegram, WhatsApp
username	Yes	String	The username of the user	test
asap	Yes	String	Flag to indicate urgency	true
delivery_time	Yes	String	TIme of the delivery	2025-01-11 12:28:28

CIS Transfers

No additional payment data is required, but integration type can only be redirect.

Request example

{
   "payment_system": "***",
    "external_id": "{{external_id}}",
    "customer": {
        "customer_id": "test",
        "country": "US",
        "first_name": "Test",
        "last_name": "Test"
    },
    "amount": 11000,
    "currency": "USD",
    "signature": "***"
}

Payment method IDs

A list of payment method IDs within Carouseller.

Payment method	ID
Bank Card	1
Bank Card Voucher	2
P2P Bank Card	3
SWIFT	10
SEPA	11
Wire Transfer	12
Local Bank Transfer	13
RTGS	14
ACH	15
Redirect Transfer	16
Japan Banks	17
Jeton Wallet	18
VegaWallet	19
EcoPayz	20
SticPayz	21
M10Wallet	22
SBP	23
Emanat	24