Отмена авторизации

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

Запрос

Для отмены авторизации отправьте POST запрос на https://gateway.freepayment.online/transactions/voids со следующими параметрами:

object

parent_uid

обязательный

string
UID транзакции авторизации.

amount

обязательный

bigInteger
Сумма списания в минимальных денежных единицах, например, 1000 для $10.00

tracking_id

string (255)
ID транзакции или заказа в вашей системе. Пожалуйста, используйте уникальное значение для того, чтобы при запросе статуса транзакции получить актуальную информацию. В противном случае вы получите массив данных по 10 последним транзакциям, найденным по указанному tracking_id. В параметре может быть отправлено несколько значений, разделенных символом ;. Например: "cbe59142-90af-4aea-b5a5-5bf3f66cf3da;f7883cb9-0e26-43a7-beb7-4027cb55d1a6;4a6a89d5-6950-400f". Если в запросе было передано более одного значения tracking_id, поиск транзакции в личном кабинете может быть осуществлен по любому из них. Если tracking_id не передан, в ответе возвращается tracking_id соответствующей транзакции авторизации при условии, что параметр был передан в запросе на авторизацию.

object
Секция, содержащая дополнительную информацию о транзакции.

referer

string
URL ресурса, с которого осуществляется запрос на проведение транзакции. Уточните у службы технической поддержки, является ли этот параметр обязательным для вашего эквайера.

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

{
  "request": {
    "parent_uid": "1-310b0da80b",
    "amount": 50,
    "tracking_id": "tracking_id_1",
    "additional_data": {
      "referer": "https://example.com/server/cs_post/post.php?order_id=5304380&security=949247&currency=USD"
    }
  }
}

Ответ

object

uid

обязательный

string
UID обработанной транзакции.

tracking_id

обязательный

string
Значение параметра tracking_id из запроса. Если tracking_id не был передан в запросе отмены авторизации, но был передан в соответствующем запросе авторизации, в ответе возвращается tracking_id соответствующей транзакции авторизации.

status

обязательный

string
Статус обработанной транзакции.

code

обязательный

string
Код обработки транзакции.

message

обязательный

string
Сообщение о результате обработки запроса, соответствующее коду результата обработки транзакции (code). Для отдельных вариантов интеграции данный параметр содержит сообщение от системы эквайера.

type

обязательный

string
Тип транзакции.

object
Секция с данными о прохождении проверок транзакции сервисом Умная Маршрутизация.

status

string
Статус обработки транзакции сервисом.

receipt_url

обязательный

string
Ссылка на квитанцию обработанной транзакции.

object

message	string Сообщение от системы банка.
ref_id	string Номер транзакции в системе банка.
rrn	string Номер транзакции в международной платёжной системе. ID транзакции, выданный сетью обработки карт.
auth_code	string Код авторизации.
gateway_id	string Идентификатор платёжного шлюза, который обработал транзакцию, в системе Freepayment.
status	string Статус обработанной транзакции.

object
Секция, содержащая дополнительную информацию о транзакции.

referer

string
URL ресурса, с которого осуществляется запрос на проведение транзакции.

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

{
  "transaction": {
    "uid": "22e47158-6b75-4098-9fc1-6a2e60521002",
    "code": "S.0000",
    "status": "successful",
    "amount": 460,
    "currency": "EUR",
    "type": "void",
    "message": "Successfully processed",
    "test": true,
    "created_at": "2024-04-02T12:38:02.775Z",
    "updated_at": "2024-04-02T12:38:10.892Z",
    "paid_at": "2024-04-02T12:38:10.698Z",
    "manually_corrected_at": null,
    "parent_uid": "295b9b6d-444d-4636-b31c-a7e8b374805c",
    "receipt_url": "https://account.freepayment.online/customer/transactions/22e47158-6b75-4098-9fc1-6a2e60521002/a203afa8029b646de18985b933b5dce75178c77b8d09a7e975ade07d5cab9e16?language=en",
    "status_code": null,
    "mute_notifications": null,
    "tracking_id": "tracking_id_1",
    "id": "22e47158-6b75-4098-9fc1-6a2e60521002",
    "smart_routing_verification": {
      "status": "successful"
    },
    "void": {
      "message": "Void was approved",
      "ref_id": "8889913",
      "rrn": null,
      "auth_code": null,
      "bank_code": null,
      "gateway_id": 3208,
      "status": "successful"
    },
    "additional_data": {
      "referer": "https://example.com/server/cs_post/post.php?order_id=5304380&security=949247&currency=USD"
    }
  }
}