Skip to content

SEPA

This alternative payment method supports the following operations:


Payment

Request

Send a payment request with the following parameters into the method section:

Parameter Type Description
type * required string sepa
bank_transfer * required object
applicant_party_id * required string Applicant party ID in the system (who is using account). One of the representatives of the customer.
end_to_end_id string End to end identification (appears in the statement)
payer * required object
account_number * required string Payer account number (IBAN)
fees object
account_number                       string Who will pay a fee.
beneficiary * required object
account_number * required string Beneficiary account number.
name * required string Beneficiary name.
unstructured_remittance_information * conditionally required string Unstructured payment details (don't pass structured_remittance_information)
structured_remittance_information conditionally required object Structured payment details (don't pass unstructured_remittance_info)
code string Document type.
send_payer_address boolean Indication if payer’s address has to be sent
instant_payment boolean Instant payment sign.

In some cases you would like to send additional data. You can place the data into the additional_data section.

Response

The sepa section from a response will have the same parameters that are sent in your request


Balance query

Request

Send a GET request to https://api.overpay.io/bank_transfer/balance/{account_number}, where {account_number} stands for your account number, for example LT9535***594 (case-sensitive).

Example of the balance response
{
    "availableFunds": {
        "EUR": 299902.81
    },
    "balances": {
        "EUR": 299963.53
    },
    "reservations": {
        "EUR": 60.72
    },
    "holds": {},
    "fundBlocksList": [],
    "blocked": false,
    "blockedForCredit": false,
    "blockedForDebit": false
}

Statement query

Request

Send a POST request to https://api.overpay.io/bank_transfer/statements with the following parameters:

Parameter Type Description
account_number* required string Account number.
currency* required string Account currency
date_from string Start date in the YYYY-MM-DD format.
date_till string End date in the YYYY-MM-DD format.
entry_type string CREDIT/DEBIT
operation_type string Operation type.
limit integer Records amount
skip integer Skipped records amount
Example of the statement response
{
  "entries": [
    {
      "accountCurrency": "EUR",
      "paymentId": "01446481",
      "type": "DEBIT",
      "operationType": "OUTGOING_PAYMENT.FEE",
      "date": "2021-07-13T18:24:55.000",
      "amount": "0.12",
      "runningBalance": "299963.53"
    },
    {
      "accountCurrency": "EUR",
      "paymentId": "01446481",
      "type": "DEBIT",
      "operationType": "OUTGOING_PAYMENT.TRANSFER",
      "date": "2021-07-13T18:24:55.000",
      "amount": "10",
      "runningBalance": "299963.65",
      "otherAccountHolderName": "beneficiaryname",
      "otherAccountNumber": "LT884010051003656294",
      "details": "test"
    },
    {
      "accountCurrency": "EUR",
      "paymentId": "01446196",
      "type": "DEBIT",
      "operationType": "OUTGOING_PAYMENT.FEE",
      "date": "2021-07-05T10:19:07.000",
      "amount": "0.12",
      "runningBalance": "299973.65"
    },
    {
      "accountCurrency": "EUR",
      "paymentId": "01446196",
      "type": "DEBIT",
      "operationType": "OUTGOING_PAYMENT.TRANSFER",
      "date": "2021-07-05T10:19:06.000",
      "amount": "10",
      "runningBalance": "299973.77",
      "otherAccountHolderName": "beneficiaryname",
      "otherAccountNumber": "LT487300010001460206",
      "details": "test"
    },
    {
      "accountCurrency": "EUR",
      "paymentId": "01446080",
      "type": "DEBIT",
      "operationType": "CURRENT_ACCOUNT_SERVICE_CHARGE.FEE",
      "date": "2021-07-01T23:30:37.000",
      "amount": "1.11",
      "runningBalance": "299983.77"
    },
    {
      "accountCurrency": "EUR",
      "paymentId": "01445019",
      "type": "DEBIT",
      "operationType": "OUTGOING_PAYMENT.FEE",
      "date": "2021-06-28T11:32:17.000",
      "amount": "0.12",
      "runningBalance": "299984.88"
    },
    {
      "accountCurrency": "EUR",
      "paymentId": "01445019",
      "type": "DEBIT",
      "operationType": "OUTGOING_PAYMENT.TRANSFER",
      "date": "2021-06-28T11:32:17.000",
      "amount": "10",
      "runningBalance": "299985",
      "otherAccountHolderName": "beneficiaryname",
      "otherAccountNumber": "LT487300010001460206",
      "details": "test"
    },
    {
      "accountCurrency": "EUR",
      "paymentId": "01444851",
      "type": "DEBIT",
      "operationType": "CURRENT_ACCOUNT_DEBT_COVERAGE.DEBT_COVERAGE",
      "date": "2021-06-23T15:20:17.000",
      "amount": "5",
      "runningBalance": "299995"
    },
    {
      "accountCurrency": "EUR",
      "paymentId": "01444849",
      "type": "CREDIT",
      "operationType": "PMNT/CNTR/CAJT",
      "date": "2021-06-23T15:20:16.000",
      "amount": "300000",
      "runningBalance": "300000"
    }
  ]
}