Перейти к содержанию

Банковский перевод

Вариант интеграции MY

Процесс проведения оплаты

  1. Покупатель инициирует оплату на сайте торговца.
  2. Торговец отправляет запрос оплаты в Overpay.
  3. Overpay присылает в ответе секцию form с полем action, содержащим URL страницы оплаты.
  4. Продавец перенаправляет покупателя на страницу из параметра form.action из ответа Overpay.
  5. Покупатель выбирает банк на странице оплаты и совершает платеж.
  6. После завершения оплаты покупатель перенаправляется на return_url, указанный в запросе на оплату.
  7. Overpay отправляет торговцу автоматическое уведомление со статусом оплаты. Торговец также может запросить статус оплаты у Overpay с помощью запроса получения статуса транзакции.
  8. Торговец отображает покупателю статус оплаты.

Оплата

Запрос

Отправьте запрос оплаты со следующими полями:
object
amount
обязательный
 bigInteger
Сумма в минимальных денежных единицах. Например, €32.45 должна быть отправлена как 3245.
currency
обязательный
 string
Валюта транзакции в формате ISO-4217 alpha-3 code. Допустимые значения: EUR или GBP.
description
обязательный
 string
Описание заказа.
notification_url
обязательный
 string
URL, на который торговец будет получать уведомления об оплате.
return_url
обязательный
 string
URL, на который будет возвращен покупатель после завершения операции в платёжной системе.
object
Секция параметров способа оплаты.
type
обязательный
 string
bank_transfer
Пример запроса 
{
    "request": {
        "amount": 20000,
        "currency": "EUR",
        "description": "description",
        "test": false,
        "return_url": "https://your_return_url.com",
        "notification_url": "https://your_notification_url.com",
        "method": {
            "type": "bank_transfer"
        }
    }
}
Ответ

Ответ на запрос оплаты будет дополнительно содержать секцию form со ссылкой для перехода на страницу оплаты. Направьте покупателя на URL, переданный как значение параметра form.action.

Пример ответа 
{
    "transaction": {
        "uid": "e567af49-da3b-463d-bc73-2514cf353564",
        "type": "payment",
        "status": "pending",
        "amount": 20000,
        "currency": "EUR",
        "description": "description",
        "created_at": "2023-10-06T14:12:36Z",
        "updated_at": "2023-10-06T14:12:36Z",
        "method_type": "bank_transfer",
        "receipt_url": "https://backoffice.overpay.io/customer/transactions/21324-1544a58bfe/c3204e3e0df0bc30d675946b36e061091e19cb5c6e889d8e7ab1508666ff6ff5?language=en",
        "payment": {
            "status": "pending",
            "gateway_id": 3288,
            "ref_id": "tx_AOvyOzQ8x11HN40u1Gt0rkFn",
            "message": "Transaction was initialized"
        },
        "bank_transfer": {
            "type": "bank_transfer"
        },
        "customer": {
            "email": null,
            "ip": null
        },
        "manually_corrected_at": null,
        "message": "Transaction was initialized",
        "test": false,
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        },
        "gateway": {
            "iframe": true
        },
        "form": {
            "action": "https://my-integration-option.com/transactions/tx_AOvyOzQ8x11HN98u1Gt0rkFn",
            "method": "GET",
            "fields": []
        }
    }
}

Запрос статуса операции

Запрос

Если необходимо дополнительно узнать статус транзакции, отправьте запрос получения статуса.

Ответ

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

Вариант интеграции PF

Процесс проведения оплаты

  1. Покупатель инициирует оплату на сайте торговца.
  2. Торговец отправляет запрос оплаты в Overpay.
  3. Overpay присылает в ответе секцию form с полем action, содержащим URL страницы оплаты.
  4. Продавец перенаправляет покупателя на страницу из параметра form.action из ответа Overpay.
  5. Покупатель совершает платеж на странице оплаты.
  6. После завершения оплаты покупатель перенаправляется на return_url, указанный в запросе на оплату.
  7. Overpay отправляет торговцу автоматическое уведомление со статусом оплаты. Торговец также может запросить статус оплаты у Overpay с помощью запроса получения статуса транзакции.
  8. Торговец отображает покупателю статус оплаты.

Оплата

Запрос

Info

Этот вариант интеграции поддерживает только валюту INR.

Отправьте запрос оплаты со следующими дополнительными полями:
object
return_url
обязательный
 string
URL, на который будет возвращен покупатель после завершения операции в платёжной системе.
object
Секция параметров способа оплаты.
type
обязательный
 string
bank_transfer
object
Секция информации о покупателе.
first_name
обязательный
 string
Имя покупателя.
last_name
обязательный
 string
Фамилия покупателя.
city
обязательный
 string
Город покупателя.
state
обязательный
 string (2)
Штат покупателя. Укажите 2 последних символа из геокода формата ISO 3166-2.
zip
обязательный
 string (6)
Почтовый индекс покупателя.
address
обязательный
 string (510)
Адрес покупателя.
country
обязательный
 string
Страна покупателя в формате ISO 3166-1 alpha-2. Например, IN.
phone
обязательный

 string (10—14)
Номер мобильного или стационарного телефона покупателя. Примеры значений: 1234567891 или +91-1234567891
email
обязательный

 string
Адрес электронной почты покупателя.
Пример запроса 
{
  "request": {
    "amount": 20000,
    "currency": "INR",
    "description": "description",        
    "return_url": "return_url",
    "test": true,
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "city": "Bangalore",
      "state": "KA",
      "zip": "560002",
      "phone": "1234567891",
      "country": "IN",
      "email": "john@example.com",
      "address": "10 Sampige Road"
    },
    "method": {
      "type": "bank_transfer"
    }
  }
}
Ответ

Ответ на запрос оплаты будет дополнительно содержать секцию form со ссылкой для перехода на страницу оплаты. Направьте покупателя на URL, переданный как значение параметра form.action.

Пример ответа 
{
  "transaction": {
    "uid": "c4af9ca3-daf3-40cf-a19d-22c501e530d7",
    "type": "payment",
    "status": "pending",
    "amount": 20000,
    "currency": "INR",
    "description": "description",
    "created_at": "2024-02-07T10:04:00Z",
    "updated_at": "2024-02-07T10:04:01Z",
    "method_type": "bank_transfer",
    "receipt_url": "https://backoffice.overpay.io/customer/transactions/c4af9ca3-daf3-40cf-a19d-22c501e530d7/9e63423487284dc87e9104489a86174c07ba08ad4f014fdc10f66d1f85d1a27b",
    "payment": {
      "status": "pending",
      "gateway_id": 3698,
      "ref_id": "1548e1ca-0d7c-4552-8139-728a04ccd6f5",
      "message": "Transaction was initialized"
    },
    "bank_transfer": {
      "type": "bank_transfer"
    },
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com",
      "country": "IN",
      "city": "Bangalore",
      "zip": "560002",
      "address": "10 Sampige Road",
      "phone": "91123456789",
      "state": "KA",
      "ip": null
    },
    "manually_corrected_at": null,
    "message": "Transaction was initialized",
    "test": true,
    "billing_address": {
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com",
      "country": "IN",
      "city": "Bangalore",
      "zip": "560002",
      "address": "10 Sampige Road",
      "phone": "91123456789",
      "state": "KA"
    },
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },
    "gateway": {
      "iframe": false
    },
    "form": {
      "action": "redirect-url",
      "method": "GET",
      "fields": []
    }
  }
}

Вариант интеграции LP

Оплата

Info

Этот вариант интеграции поддерживает только валюту EUR.

Процесс проведения оплаты

  1. Покупатель инициирует оплату на сайте торговца.
  2. Торговец отправляет запрос оплаты в Overpay.
  3. Overpay присылает в ответе секцию form с полем action, содержащим URL страницы оплаты.
  4. Продавец перенаправляет покупателя на страницу из параметра form.action из ответа Overpay.
  5. Покупатель вводит необходимые данные, выбирает банковское приложение и завершает оплату.
  6. Overpay отправляет торговцу автоматическое уведомление со статусом оплаты. Торговец также может запросить статус оплаты у Overpay с помощью запроса получения статуса транзакции.
Запрос

Отправьте запрос оплаты со следующими данными:
object
return_url
обязательный
 string
URL, на который будет возвращен покупатель после завершения оплаты.
object
Секция параметров способа оплаты.
type
обязательный
 string
bank_transfer
object
Секция информации о покупателе.
email
 string
Адрес электронной почты покупателя.
Пример запроса 
{
    "request": {
        "amount": 100,
        "currency": "EUR",
        "description": "description",
        "test": false,
        "tracking_id": "your_uniq_number",
        "language": "en",
        "return_url": "https://your_return_url.com",
        "notification_url": "https://your_notification_url.com",
        "customer": {
            "email": "test@example.com"
        },
        "method": {
            "type": "bank_transfer"
        }
    }
}
Ответ

Отправьте покупателя на URL, указанный в параметре form.action.

Пример ответа 
{
    "transaction": {
        "uid": "facd9b76-4905-417c-a4f2-4035111111",
        "type": "payment",
        "status": "pending",
        "amount": 100,
        "currency": "EUR",
        "description": "description",
        "created_at": "2025-04-26T06:11:09Z",
        "updated_at": "2025-04-26T06:11:09Z",
        "method_type": "bank_transfer",
        "receipt_url": "https://backoffice.overpay.io/customer/transactions/facd9b76-4905-417c-a4f2-40359a21f6f2/c142cc0eabcec7ac95f3ca9c2349d18e2ec5ab2cc079f3d84f69e911111111?language=en",
        "payment": {
            "status": "pending",
            "gateway_id": 5303,
            "ref_id": "facd9b76-4905-417c-a4f21111111111",
            "message": "Transaction was initialized."
        },
        "bank_transfer": {
            "type": "bank_transfer"
        },
        "customer": {
            "email": "test@example.com",
            "ip": "127.0.0.1"
        },
        "manually_corrected_at": null,
        "version": 0,
        "message": "Transaction was initialized.",
        "tracking_id": "your_uniq_number",
        "test": false,
        "language": "en",
        "billing_address": {
            "email": "test@example.com"
        },
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        },        
        "gateway": {
            "iframe": false
        },
        "form": {
            "action": "payment-url",
            "method": "GET",
            "fields": []
        }
    }
}