получить статус оплаты

GET 
/invoices/:invoice_id/charges/:charge_id

статус оплаты

Request

Path Parameters

invoice_id uuidrequired

внутренний номер инвойса

charge_id uuidrequired

идентификатор списания

Responses

200

Accepted

application/json

Schema

Schema

payment_token_id uuidrequired

идентификатор токена

device

object

required

данные браузера для эмитента

BrowserIP ipv4required

IP адрес клиента

BrowserTimeZone stringrequired

Possible values: Value must match regular expression ^-?\d+$

смещение часового пояса между UTC и местного времени браузера держателя карты. Обратите внимание что смещение положительное, если местное время отстает от UTC, и отрицательное, если время впереди

Например, для MSK: -180

decline_code decline codes (string)

Possible values: [insufficient_funds, unknown_error_code, operation_declined, foreign_card_operation_is_unavailable, payment_is_blocked, payment_is_blocked_as_potential_fraud, payment_declined, 3ds_authorisation_error, limit_exceeded, card_has_expired, invalid_card_number]

message string

описание результата, стоит обращать внимание при ошибке

info string
id uuidrequired

идентификатор сущности

status stringrequired

Possible values: [waiting_3ds, charged, progress, refunded, refund_error, error, blocked]

• waiting_3ds - ожидание прохождения 3DS, в ответ отдаем данные для редиректа на страницу эмитента
• progress - требуется повторный опрос статуса, данный статус говорит о том, что транзакция в работе

терминальные статусы:

• charged - списание прошло успешно, статус инвойса меняется на success
• blocked - средства успешно заблокированы
• error - ошибка оплаты (причина в поле message), инвойс остается в статусе open

методы: GET|POST|PATCH

created_at date-time

дата создания в ISO-8601

acs_url uri

адрес ACS (для 3DS)

acs_data object

данные для ACS (перед 3DS)

Example (from schema)

{
  "payment_token_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "device": {
    "BrowserIP": "198.51.100.42",
    "BrowserTimeZone": "-180"
  },
  "decline_code": "insufficient_funds",
  "message": "string",
  "info": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "waiting_3ds",
  "created_at": "2024-08-06T11:28:58.898Z",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {}
}

Waiting 3DS

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "waiting_3ds",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Charged

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "charged",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Insufficient Funds

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "insufficient_funds",
  "message": "Недостаточно средств на карте, пополните или используйте другую",
  "info": "Not sufficient funds",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Unknown Error Code

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "unknown_error_code",
  "message": "Неизвестный код ошибки, обратитесь в поддержку",
  "info": "Internal error",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Operation Declined

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "operation_declined",
  "message": "Операция отклонена, попробуйте операцию оплату или обратитесь в поддержку",
  "info": "Authentication timeout",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Foreign Card Operation Is Unavailable

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "foreign_card_operation_is_unavailable",
  "message": "Операция по иностранной карте недоступна. Воспользуйтесь картой российского банка или обратитесь в поддержку",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Payment Is Blocked

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "payment_is_blocked",
  "message": "Оплата заблокирована, обратитесь в банк, выпустивший карту.",
  "info": "Transaction not permitted to card",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Payment Is Blocked As Potential Fraud

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "payment_is_blocked_as_potential_fraud",
  "message": "Оплата заблокирована, подозрение на мошенническую транзакцию. Обратитесь в банк, выпустивший карту.",
  "info": "Suspected fraud",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Payment Declined

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "payment_declined",
  "message": "Оплата отклонена, попробуйте повторить оплату или обратитесь в поддержку",
  "info": "Payment not allowed (3DSecure)",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

3DS Authorisation Error

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "3ds_authorisation_error",
  "message": "Ошибка 3DS авторизации",
  "info": "Not found TDS Version by TdsServerTransId and OrderId",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Limit Exceeded

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "limit_exceeded",
  "message": "Превышение лимита на операции по карте, обратитесь в банк, выпустивший карту",
  "info": "Exceeds withdrawal limit",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Card Has Expired

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "card_has_expired",
  "message": "Срок карты истек, обратитесь в банк, выпустивший карту",
  "info": "Expired card",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

Invalid Card Number

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "payment_token_id": "80bcd4f6-0f4b-4ffe-94da-19dee5dcfe20",
  "created_at": "2022-11-10T12:46:53",
  "status": "error",
  "decline_code": "invalid_card_number",
  "message": "Указан несуществующий номер карты",
  "info": "Card number does not exist",
  "acs_url": "https://acs.vendorcert.mirconnect.ru/mdpayacs/creq",
  "acs_data": {
    "creq": "eyJhY3NUcmFuc0lEIjoiOWExNGYxYzctYTY0YS00ZWJiLWFhYTEtNDAxZjYzNTFiYTA5IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1IiwibWVzc2FnZVR5cGUiOiJDUmVxIiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiOTM4NzI3ZWYtNjdiYS00MzFmLThmNzMtNDU5NTM0YjA3NTUzIn0"
  }
}

400

Bad Request

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

BadRequest

{
  "code": "missing_required_request_parameter",
  "message": "Отсутствует обязательный параметр запроса"
}

InvalidParameterValue

{
  "code": "invalid_parameter_value",
  "message": "Некорректный параметр запроса"
}

401

Unauthorized

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

Unauthorized

{
  "code": "unauthorized",
  "message": "Ошибка аутентификации"
}

404

Not Found

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

NotFound

{
  "code": "resource_not_found",
  "message": "Запрашиваемая информация не найдена"
}

429

Too Many Requests

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

Too Many Requests

{
  "code": "too_many_requests",
  "message": "Превышено ограничение на количество запросов в секунду"
}

498

Invalid Token

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

No Service Id

{
  "code": "invalid_token",
  "message": "Ошибка JWT Token. Идентификатор service_id в теле токена не может быть пустым",
  "info": "JWT token must contain service_id"
}

Bad Service Id

{
  "code": "invalid_token",
  "message": "Ошибка JWT Token. Вы не можете проводить операцию для этого service_id",
  "info": "Service_id in JWT token doesn't match service_id from URL"
}

Bad Invoice Id

{
  "code": "invalid_token",
  "message": "Ошибка JWT Token. Вы не можете проводить операцию для этого invoice_id",
  "info": "Invoice in JWT token doesn't match invoice from URL"
}

Loading...