Skip to main content

Методы API

Session​

Авторизоваться​

curl --location --request POST 'https://4pay.online/api/v1/session' \
--header 'Content-Type: application/json' \
--data-raw '{
    "login": "test@heth.io",
    "password": "test"
}'

Получить текущую сессиию​

curl --location --request GET 'https://4pay.online/api/v1/session' \
--header 'Authorization: Bearer 9d986b61-fe65-4b7e-ad9a-b1242b7daadf'

Обновить сессиию​

curl --location --request PUT 'https://4pay.online/api/v1/session' \
--header 'Content-Type: application/json' \
--data-raw '{
    "refresh_token": "1acdd2f3-299a-4213-a2df-39b6fae4d165"
}'

Выйти из системы​

curl --location --request DELETE 'https://4pay.online/api/v1/session' \
--header 'Authorization: Bearer 9d986b61-fe65-4b7e-ad9a-b1242b7daadf'

Ссылки для оплаты​

Создать ссылку для оплаты​

curl --location --request POST 'https://4pay.online/api/v1/links' \
--header 'Authorization: Bearer 9d986b61-fe65-4b7e-ad9a-b1242b7daadf' \
--header 'Content-Type: application/json' \
--data-raw '{ 
	"link": {
		"amount": {
			"default" : 1200
		},
		"amount_type" : "static",
		"card_url" : "https://helptogether.ru/simple_card/13/villages",
		"notify_url" : "https://alerter.heth.io/api/v1/channels/3ds_b131/alerts",
		"pay_config" : {
			"heth_pay_params": {"store_card":true,"description":"Villages"},
			"apple_pay_params":{"display_name":"Villages"}
		}
	}
}'

Получить ссылку для оплаты​

curl --location --request GET 'https://4pay.online/api/v1/links/0b6621ab-364e-45fe-81bc-05b4386ad461'

Отредактировать ссылку для оплаты​

curl --location --request PUT 'https://4pay.online/api/v1/links/96f3d155-b0f4-46ab-9e51-db685f1cca6e' \
--header 'Authorization: Bearer 9d986b61-fe65-4b7e-ad9a-b1242b7daadf' \
--header 'Content-Type: application/json' \
--data-raw '{ 
	"link": {
		"pay_config" : {
			"apple_pay_params" : {
				"display_name" : "Villages"
			},
			"heth_pay_params" : {
				"description" : "Villages",
				"store_card" : true
			}
		}
	}
}'

Платежи​

Получить ссылку на виджет​

curl --location --request POST 'https://4pay.online/api/v1/widget' \
--header 'Authorization: Bearer 9d986b61-fe65-4b7e-ad9a-b1242b7daadf' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payment": {
        "amount": 30000,
        "type": "widget",
        "description": "Описание платежа",
        "txid": "Уникальный идентификатор транзакции",
        "money_storage":{
        	"add": true,
        	"customer" : "Имя плательщика"
        }
    }
}'

Оплатить по привязанной карте​

curl --location --request POST 'https://4pay.online/api/v1/payments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 9d986b61-fe65-4b7e-ad9a-b1242b7daadf' \
--data-raw '{
    "payment": {
        "amount": 1000,
        "type": "saved_card",
        "money_storage": {
        	"card_uid" : "6bPdy72RasQn0eOOaNDP2PqeEDX",
        	"add": true,
        	"customer" : "test@test.com"
        },
        "description": "Описание платежа",
        "txid": "Уникальный идентификатор транзакции"
    }
}'

Получить список платежей​

curl --location --request GET 'https://4pay.online/api/v1/payments' \
--header 'Authorization: Bearer 9d986b61-fe65-4b7e-ad9a-b1242b7daadf'

Получить статус платежа​

curl --location --request GET 'https://4pay.online/api/v1/payments/228' \
--header 'Authorization: Bearer 9d986b61-fe65-4b7e-ad9a-b1242b7daadf'

Сделать возврат​

curl --location --request PUT 'https://4pay.online/api/v1/payments/182' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 9d986b61-fe65-4b7e-ad9a-b1242b7daadf' \
--data-raw '{
    "payment": {
        "amount": 2000
    }
}'