Bank Transfer

MY Integration option

Bank transfer flow

The customer initiates a payment.
The merchant sends a payment request to Overpay.
Overpay sends a response with the form object containing action parameter with a link to the payment page.
The merchant redirects the customer to the URL specified in the form.action field from Overpay response.
The customer selects the bank on the payment page and makes a payment.
Once the payment is completed, the customer is redirected to the page specified in return_url in the payment request.
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.
The merchant displays the payment status to the customer.

Payment

Request

Send a payment request with the following parameters:

Parameter	Type	Description
request	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.
method	object	A section of the payment method information.
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

The customer initiates a payment.
The merchant sends a payment request to Overpay.
Overpay sends a response with the form object containing action parameter with a link to the payment page.
The merchant redirects the customer to the URL specified in the form.action field from Overpay response.
The customer makes a payment.
Once the payment is completed, the customer is redirected to the page specified in return_url in the payment request.
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.
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:

Parameter	Type	Description
request	object
return_url * required	string	A URL to return the customer to when a transaction is completed.
method	object	A section of the payment method information.
type * required	string	`bank_transfer`
customer * required	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": []
    }
  }
}