Payscrow Docs

Получение ордера по client_order_id ​

Возвращает информацию об ордерах, client_order_id которых указан в параметре запроса

Особенности поиска

Так как нет строгого условия на уникальность client_order_id при создании ордера, ответ возвращается в виде списка

http
GET /api/v1/order/search-by-client-order-id?id={client_order_id}

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

bash
curl -X GET "https://api.payscrow-cascade.io/api/v1/order/search-by-client-order-id?id=test_order_123" \
-H "Content-Type: application/json" \
-H "X-API-Key: your_api_key"

Параметры строки запроса (query) ​

ПараметрТипОписание
client_order_idstringID ордера в системе клиента

Пример ответа 200 ​

json
{
	"success": true,
	"message": "Request processed successfully",
	"orders": {
		"total": 1,
		"page": 1,
		"size": 1,
		"pages": 1,
		"items": [
			{
				"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
				"client_order_id": "1234",
				"currency": "RUB",
				"method_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
				"method_name": "Сбербанк",
				"initial_method_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
				"order_side": "Buy",
				"amount": "10000.00",
				"fee": "15.0",
				"status": "Completed",
				"holder_name": "Иванов Иван Иванович",
				"holder_account": "4627100101654724",
				"customer_name": "Петров Петр Петрович",
				"customer_account": null,
				"payment_link": null,
				"created_at": "2024-07-04T15:40:20.569613Z",
				"updated_at": "2024-07-06T13:27:56.717Z",
				"expires_at": "2024-07-08T15:40:20.569613Z"
			}
		]
	}
}