Developer

API для интеграции CrocoPAY на вашем проекте.

Описание

Документ описывает примеры вызовов CrocoPAY API по выполнению ордера от его создания до завершения.
Для теста вызова или получения ссылки оплаты, используйте Postman. Файл для импорта настроек можно скачать тут!

ВХОД ЧЕРЕЗ API

URL: https://crocopay.tech/api/login
Method Type: POST
Sample Request: BODY PARAMETER (form-data)

                        
                            {"email":"exemple@exemple.com","password":"123456"}

Параметр	Описание	Статус	Тип	Пример
электронная почта	Должен быть email	Обязательно	Строка	david.luca@gmail.com
пароль	Пароль пользователя	Обязательно	Строка	123456

ПРИМЕР ОТВЕТА

Успешный вход

                        
                            {"response":{"user_id":4,"first_name":"David","last_name":"Luca","email":"david.luca@gmail.com","formattedPhone":null,"picture":"","defaultCountry":"US","TOKEN":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6Ijg0OGU2NjhhZDdjMWRmYzhjODA1NGE0NjY5ZTM0OGYyND","STATUS":200,"USER-STATUS":"ACTIVE"}}

Ошибка входа

                        
                            {"response":{"status":401,"message":"Invalid email & credentials"}}

N.B: You have to use this genereted TOKEN on all other steps as Authorization-token in the header section.

End Point 1: Access Token

URL-адрес: https://crocopay.tech/api/v2/access-token
систему, на свой сайт: POST
Описание: Перейти к учетной записи мерчанта, https://crocopay.tech/merchants Click gear icon of approved express merchant.
From the modal copy client_id, client_secret. This method is used to generate an access token.
N.B: If the merchant is approved by the admin, only then the gear icon will be available for that merchant.

SAMPLE REQUEST

BODY PARAMETER (form-data)

                        
                            {" client_id":" yMKqAvC2dILUyhwdIbryh4rsl784kF"," client_secret":" ZubitDCg2QyxuoSu0l6pJkNB5lOrcl1Ivy0qZlhlu8QhWHDYOelkVSNC8B0ybunOb3i832W3FC2SUuXw04Rj8kRHduMx7pdD4a48"}

Параметр	Описание	Статус	Тип	Пример
client_id	Merchant client_id	Обязательно	Строка	yMKqAvC2dILUyhwdIbryh4rsl784kF
client_secret	Merchant client_secret	Обязательно	Строка	ZubitDCg2QyxuoSu0l6pJkNB5lOrcl1Ivy0qZlhlu8QhWHDYOe...

ПРИМЕР ОТВЕТА

Мерчант существует

                        
                            {"access_token": "nJyp8O01Hv2bqkKthOjnw0mcte", "expires_in": 86400, "token_type": "Bearer"}

Мерчант не существует

                        
                            {"status": "error", "message": "Failed to process the request."}

N.B: You have to use this genereted access_token on next step as Authorization

End Point - 1. Инициировать платеж

URL-адрес: https://crocopay.tech/api/v2/initiate-payment
систему, на свой сайт: POST

Описание: Мы используем эту конечную точку для хранения информации о платеже. Получите токен доступа, который генерируется при проверке мерчанта на предыдущем шаге. Используйте “Authorization” как заголовки. https://crocopay.tech/api/login
N.B: You will need to set the Authorization: Bearer followed by the token value. Add successUrl and cancelUrl as you need.

Пример запроса

Параметры BODY (form-data)

                        
                            {"Client_id":"GnH...R7m","Client_secret":"vpB...58Z","amount":"10","currency":"RUB","successUrl":"https://crocopay.tech/dashboard","cancelUrl":"https://crocopay.tech","callbackUrl":"https://crocopay.tech/dashboard?user_id={user_id}"}

                        
                            {"Authorization":"Bearer nJyp8O01Hv2bqkKthOjnw0mcte"}

Параметр	Описание	Статус	Тип	Пример
client_id	В разделе "Кассы", значек шестерни в списке Ваших мерчантов. (Ссылка)	Обязательно	Строка	GnHAFAZsT1ktFYqauUVtB8sECR7m
client_secret	В разделе "Кассы", значек шестерни в списке Ваших мерчантов. (Ссылка)	Обязательно	Строка	vpBpXN40yaWQWicAoblXe7QTJOaaho7REyApkDnLIOpMR3lk1ndaLmY2qoZptV9cHOtjJLUDsW26GBSe2kda1IVQIMR758Z
amount	Сумма, которую пользователь должен заплатить.	Обязательно	Двойной	10
currency	Платеж производится в какой валюте, это должен быть код ISO.	Обязательно	Строка	RUB
successUrl	URL для редиректа после успешной оплаты	Обязательно	Строка	https://crocopay.tech/dashboard
cancelUrl	URL для редиректа после безуспешной оплаты	Обязательно	Строка	https://crocopay.tech
callbackUrl	URL, на который придет уведомление о платеже.	Обязательно	Строка	https://crocopay.tech/api/payment?user_id={user_id}

ПРИМЕР ОТВЕТА

Успех

                        
                            {"status": "success","message": "Initiated payment successfully.","redirect_url": "http://localhost/pay_v4.1/restapi/payment?grant_id=78784424&token=DuMJThhEimrrdiCKrW2A"}

Недопустимая валюта

                        
                            {"status": "error","message": "Currency UAH is not supported by this merchant."}

Сумма равна нулю

                        
                            {"status": "error","message": "Amount cannot be 0 or less than 0."}

End Point - 3. Payment Verify

URL-адрес: https://crocopay.tech/api/v2/payment-verify
систему, на свой сайт: POST
Описание: В этой конечной точке платеж будет успешным, проверяются все виды валидации ввода и перенаправляются на страницу платежа (если пользователь не вошел в систему, то ему нужно войти в систему), если пройдена вся валидация. Пользователь должен решить отменить или принять платеж. Пользователь grant_id и token в качестве параметра тела, который генерируется на предыдущем шаге.

SAMPLE REQUEST

BODY PARAMETER (form-data)

                        
                            {"transaction_id":"8479E89BD4192"}

HEADER PARAMETER

                        
                            {"Authorization":"Bearer C49L8XNLz84PiE4I4HYEsOBlog"}

Параметр	Описание	Статус	Тип	Пример
Transaction Id	Получить из точки окончания-2	Обязательно	Строка	8479E89BD4192
Authorization	Must be given in header.	Обязательно	Строка	Bearer nJyp8O01Hv2bqkKthOjnw0mcte

ПРИМЕР ОТВЕТА

Успех платежа

                        
                            {"user_id": 1,"currency_id": 1,"payment_method_id": 1,"merchant_id": 1,"uuid": "2997108A5FD15","transaction_type_id": 10,"user_type": "registered","subtotal": "138","percentage": "2","charge_percentage": "2","charge_fixed": "0","total": "140","status": "Success"}

Мерчант и пользователь одинаковы

                        
                            {"success":{"status":801,"message":"Merchant cannot make payment to himself!"}}

Несоответствие Grant Id или Token

                        
                            {"success":{"status":401,"message":"Grant Id or Token does not Match!"}}

Недостаточный баланс

                        
                            {"success":{"status":401,"message":"User doesn't have sufficient balance!"}}