Skip to content

Bank Transfer

MY Integration option

Bank transfer flow

  1. The customer initiates a payment.
  2. The merchant sends a payment request to Overpay.
  3. Overpay sends a response with the form object containing action parameter with a link to the payment page.
  4. The merchant redirects the customer to the URL specified in the form.action field from Overpay response.
  5. The customer selects the bank on the payment page and makes a payment.
  6. Once the payment is completed, the customer is redirected to the page specified in return_url in the payment request.
  7. Overpay sends a webhook notification with the payment status to the merchant. The merchant may also request the payment status from Overpay with the status query.
  8. The merchant displays the payment status to the customer.

Payment

Request

Send a payment request with the following parameters:
object
amount
required

 bigInteger
A transaction amount in minimal currency units, for example, €32.45 must be sent as 3245.
currency
required

 string
A transaction currency in the ISO-4217 alpha-3 code format. Must be EUR or GBP.
description
required

 string(255)
A short description of the order.
notification_url
required

 string
A URL to get webhook notifications.
return_url
required

 string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method.
type
required

 string
bank_transfer
Request example 
{
    "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"
        }
    }
}
Response

The response section will have parameters copied from a request. Additionally, you'll get the form object with a URL to the payment page. Redirect the customer to the URL specified in form.action.

Response example 
{
    "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": []
        }
    }
}

Payment status query

Request

If needed, send a status query request to get the current transaction status.

Response

The response contains the transaction status, a section of the payment method as well as other details related to the transaction according to the description of a transaction status query.

PF Integration option

Payment flow

  1. The customer initiates a payment.
  2. The merchant sends a payment request to Overpay.
  3. Overpay sends a response with the form object containing action parameter with a link to the payment page.
  4. The merchant redirects the customer to the URL specified in the form.action field from Overpay response.
  5. The customer makes a payment.
  6. Once the payment is completed, the customer is redirected to the page specified in return_url in the payment request.
  7. Overpay sends a webhook notification with the payment status to the merchant. The merchant may also request the payment status from Overpay with the status query.
  8. The merchant displays the payment status to the customer.

Payment

Request

Info

This integration option only supports INR currency.

Send a payment request with the following additional parameters:
object
return_url
required

 string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method.
type
required

 string
bank_transfer
object
A section of information about the customer.
first_name
required
 string
The customer's first name.
last_name
required
 string
The customer's last name.
city
required
 string (100)
The customer's billing city.
state
required
 string (2)
The customer's billing state. Set as the 2 last symbols of the code in the ISO 3166-2 format.
zip
required
 string (6)
The post code of the customer's billing address.
address
required
 string
The customer's address.
country
required
 string (2)
The customer's billing country in the ISO 3166-1 Alpha-2 format. For example, IN.
phone
required
 string (10—14)
The customer's mobile or landline phone number. Examples: 1234567891 or +91-1234567891.
email
required
 string
The customer's email address.
Request example 
{
  "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"
    }
  }
}
Response

The response section will have parameters copied from the request. Additionally, you'll get the form object with a URL to the payment page. Redirect the customer to the URL specified in form.action.

Response example 
{
  "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 Integration option (bank_transfer)

Payment

Info

This integration option supports only EUR currency.

Payment flow

  1. The customer initiates the payment on the merchant's website.
  2. The merchant sends the payment request to Overpay.
  3. Overpay sends a response containing the URL for completing the payment.
  4. The merchant redirects the customer to the provided URL.
  5. The customer submits the required information if necessary, selects the bank application and completes the payment.
  6. Overpay sends a webhook notification with the payment status to the merchant. The merchant may also request the payment status from Overpay with the status query.
Request

Send a payment request with the following additional parameters:
object
return_url
required

 string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method information.
type
required

 string
bank_transfer
object
A section of information about the customer.
email
 string
The customer's email address.
Request example 
{
    "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"
        }
    }
}
Response

Redirect your customer to the URL received as the value of the form.action parameter.

Response example 
{
    "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": []
        }
    }
}

LP Integration option (bank_transfer_revolut)

Payment

Info

This integration option supports only EUR currency.

Payment flow

  1. The customer initiates the payment on the merchant's website.
  2. The merchant sends the payment request to Overpay.
  3. Overpay sends a response containing the URL for completing the payment.
  4. The merchant redirects the customer to the provided URL.
  5. The customer is redirected to the page for making the Revolut payment and completes the payment.
  6. Overpay sends a webhook notification with the payment status to the merchant. The merchant may also request the payment status from Overpay with the status query.
Request

Send a payment request with the following additional parameters:
object
return_url
required

 string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method information.
type
required

 string
bank_transfer_revolut
object
A section of information about the customer.
email
 string
The customer's email address.
Request example 
{
  "request": {
    "amount": 100,
    "currency": "EUR",        
    "description": "Order description",
    "test": false,        
    "ip": "127.0.0.1",        
    "return_url": "https://return_url",        
    "language": "en",
    "customer": {
      "email": "example@example.com"
    },
    "method": {
      "type": "bank_transfer_revolut"
    }
  }
}
Response

Redirect your customer to the URL received as the value of the form.action parameter.

Response example 
{
  "transaction": {
    "uid": "1e1f1878-00ea-4066-bda6-869dd18a7bef",
    "type": "payment",
    "status": "pending",
    "amount": 100,
    "currency": "EUR",
    "description": "Order description",
    "created_at": "2025-09-23T10:37:23Z",
    "updated_at": "2025-09-23T10:37:23Z",
    "method_type": "bank_transfer_revolut",
    "receipt_url": "https://backoffice.overpay.io/customer/transactions/1e1f1878-00ea-4066-bda6-869dd18a7bef/e90926c66ccb3e62fa7bda2a2a701c97319290d62297e779269415a33d03856b?language=en",
    "payment": {
      "status": "pending",
      "gateway_id": 5741,
      "ref_id": "1e1f1878-00ea-4066-bda6-869dd18a7bef",
      "message": "Transaction was initialized."
    },
    "bank_transfer_revolut": {
      "type": "bank_transfer_revolut"
    },
    "customer": {
      "email": "example@example.com",
      "ip": "127.0.0.1"
    },
    "manually_corrected_at": null,
    "version": 1,
    "message": "Transaction was initialized.",
    "test": false,
    "language": "en",
    "billing_address": {
      "email": "example@example.com"
    },
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },
    "gateway": {
      "iframe": false
    },
    "form": {
      "action": "payment_url",
      "fields": [],
      "method": "GET"
    }
  }
}