Payment processing

The user selects an operation type and payment method. Depending on the selected operation, the Cashier sends a request to the gaming server:

• check_deposit

• request_payout

Deposit possibility check (check_deposit)

The request is sent by the Cashier to the gaming server (Merchant).

Parameter	Required	Type	Format	Description	Example
action	Yes	string	varchar(64)	Must be check deposit	check_deposit
site_id	Yes	integer	—	Project identifier	332
site_login	Yes	string	varchar(128)	User login	user_test
amount	Yes	integer	—	Amount in minor units (e.g., cents for USD)	10000
currency	Yes	string	alpha-3 ISO 4217	Transaction currency	USD
payment_group_id	Yes	integer	—	Payment group identifier	6
payment_type_id	Yes	integer	—	Payment type identifier	18
signature	Yes	string	SHA-1	Request signature (see Signature generation rules)	d9f5713990de5c6e32169dba1f0102f540018975
customer_purse	No	string	—	User's wallet/account identifier	555555...4444
customer_ip	No	string	inet (IPv4 or IPv6)	User IP address	127.0.0.1
source_type	No	integer	integer	Client interface type	4
transaction_id	No	string	string	Internal transaction identifier.	1234567890
merchant_purse	No	string	string	Merchant wallet/account identifier	0x12312412541251

Response handling

The merchant server must respond to the Cashier by approving or declining the deposit request.

Response code	Description
0	Deposit is allowed. Payment must be created using external_id
500	Error. Description must be provided in error_description field

Response parameters

Parameter	Required	Type	Format	Description	Example
code	Yes	integer	—	Response code	0
external_id	Yes (if code = 0)	string	varchar(256)	Merchant order identifier	order_123456
error_description	Yes (if code = 500)	string	varchar(1024)	Error message	User not found

Pay-out possibility check (request_payout)

Request is sent by the Cashier to the Merchant's server.

Parameter	Required	Type	Format	Description	Example
action	Yes	string	varchar(64)	Must be request_payout	request_payout
site_id	Yes	integer	—	Project identifier	332
site_login	Yes	string	varchar(128)	User login	user_test
amount	Yes	integer	—	Amount in minor units (e.g., cents for USD)	10000
currency	Yes	string	alpha-3 ISO 4217	Transaction currency	GBP
payment_group_id	Yes	integer	—	Payment group identifier	6
customer_purse	Yes	string	—	User wallet/account identifier	555555...4444
remember_customer_purse	Yes	boolean	—	Save wallet for future use (0 = no, 1 = yes)	0
signature	Yes	string	SHA-1	Request signature (see Signature generation rules)	d9f5713990de5c6e32169dba1f0102f540018975
payment_type_id	No	integer	—	Payment type identifier	18
customer_ip	No	string	inet (ipv4 or ipv6)	User IP address	127.0.0.1
transaction_id	No	string	—	Internal transaction identifier	1234567890

Response handling

The merchant server must respond by approving or declining the payout request.

Response code	Description
50	Withdrawal approved and will be carried out by the Merchant's manager after processing
402	Insufficient funds
500	Error. Description must be provided in error_description field

Successful payout confirmation is indicated by response code 50.

Response parameters

Parameter	Required	Type	Format	Description	Example
code	Yes	integer	—	Response code	50
external_id	Yes (if code = 0)	string	varchar(256)	Merchant order identifier	order_123456
error_description	Yes (if code = 500)	string	varchar(1024)	Error message	User not found

Pay-out initiation request

After a payout request has been approved, the merchant must send a pay-out initiation request to the Cashier.

Request address

POST

https://a.papaya.ninja/api/payout/

Request example

{
    "site_id": "2",
    "external_id": "704224078",
    "amount": "400000",
    "currency": "USD",
    "comment": "#704224078",
    "action": "payout",
    "site_login": "6336914",
    "customer_email": "[email protected]",
    "user_preset_id": "100",
    "first_name": "John",
    "last_name": "Doe",
    "customer_ip": "213.87.129.172",
    "billing_phone": "7574803170",
    "owner_email": "[email protected]",
    "owner_phone": "7574803170",
    "owner_name": "JOHN DOE",
    "invoice_id": "9050976",
    "display_payment_group_id": "3003",
    "signature": "417ec93d367ff66798a6447c500e715d78fb27fa"
}

Request parameters

Parameter	Required	Type	Format	Description	Example
display_payment_group_id	Yes	integer	–	Payment group identifier (see Payment method IDs)	3003
signature	Yes	string	SHA-1	Request signature	417ec93d367ff66798a6447c500e715d78fb27fa
amount	Yes	integer	–	Amount in minor units (e.g., cents for USD)	400000
site_id	Yes	integer	–	Project identifier	2
currency	Yes	string	alpha-3 ISO 4217	Transaction currency	USD
site_login	Yes	string	varchar(128)	User login	6336914
external_id	Yes	string	varchar(256)	Merchant order identifier	704224078
action	No	string	varchar(64)	Operation type	payout
customer_purse	No	string	–	User wallet/account identifier	555555...4444
remember_customer_purse	No	string	–	Save wallet for future use (0 = no, 1 = yes)	0
invoice_id	No	string	–	Invoice identifier	9050976
comment	No	string	–	Additional comment	#704224078
customer_email	No	string	email	User email address	[email protected]
first_name	No	string	–	User first name	John
last_name	No	string	–	User last name	Doe
user_preset_id	No	string	–	User preset identifier	100
customer_ip	No	string	inet (IPv4 or IPv6)	User IP address	213.87.129.172
country_code	No	string	ISO 3166-1 alpha-2	User country code	US
billing_phone	No	string	–	User phone number	7574803170
owner_name	No	string	–	Account owner name	John Doe
owner_email	No	string	email	Account owner email	[email protected]
owner_phone	No	string	–	Account owner phone	7574803170
owner_address	No	string	–	Account owner address	Street 1, City
bank	No	string	–	Bank name or identifier	Bank Name
document_id	No	string	–	User document identifier	AB1234567
birthdate	No	string	DD-MM-YYYY	User date of birth	01-02-1989
external_value1	No	string	–	Additional external parameter

Response example

{
  "success": true,
  "errors": null,
  "transaction": null,
  "code": 0,
  "message_for_user": "Success",
  "transaction_id": 117580048,
  "order_id": "217742619264065507927945843197"
}

Response parameters

Parameter	Type	Format	Description	Example
success	boolean	–	Indicates whether the request was successfully processed	true
errors	string	–	Error details (if any)	true
transaction	object	–	Transaction data (if applicable)	null
code	integer	–	Response code	0
message_for_user	string	–	Message intended for the end user	Success
transaction_id	integer	–	Internal transaction identifier	117580048
order_id	string	string	Cashier order identifier	217742619264065507927945843197

Next steps

After receiving a successful response, wait for a webhook notification from the Cashier.

More detailed information:

Webhooks