Create Sepa payment

curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/gateway/createSepaPmt \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "cr_acc": "string",
  "cr_amount": 1,
  "cr_ccy_isocode": "string",
  "cr_name": "string",
  "dr_acc": "string",
  "dr_amount": 1,
  "dr_ccy_isocode": "string",
  "dr_name": "string",
  "inst": false,
  "trx_purpose": "string"
}
'

{
  "result": {
    "cr_amount": 123,
    "dr_amount": 123,
    "cr_acc": "<string>",
    "cr_address": "<string>",
    "cr_address_city": "<string>",
    "cr_address_country": "<string>",
    "cr_alt_code_company": "<string>",
    "cr_alt_code_company_issuer": "<string>",
    "cr_bank_bic": "<string>",
    "cr_ccy_isocode": "<string>",
    "cr_code_issuer": "<string>",
    "cr_code_person": "<string>",
    "cr_name": "<string>",
    "ctgy_purp_cd": "BONU",
    "ctgy_purp_prtry": "<string>",
    "dr_acc": "<string>",
    "dr_address": "<string>",
    "dr_address_city": "<string>",
    "dr_address_country": "<string>",
    "dr_alt_code_company": "<string>",
    "dr_alt_code_company_issuer": "<string>",
    "dr_bank_bic": "<string>",
    "dr_ccy_isocode": "<string>",
    "dr_code_company": "<string>",
    "dr_code_issuer": "<string>",
    "dr_code_person": "<string>",
    "dr_name": "<string>",
    "id": 123,
    "method": "SEPA",
    "trx_purpose": "<string>",
    "trx_purpose_information": "<string>",
    "trx_purpose_structured_issuer": "<string>",
    "trx_purpose_structured_ref": "<string>",
    "trx_settlement_date": "2023-12-25",
    "ucr_address": "<string>",
    "ucr_address_city": "<string>",
    "ucr_address_country": "<string>",
    "ucr_id_type": 123,
    "ucr_identification": "<string>",
    "ucr_issuer": "<string>",
    "ucr_name": "<string>",
    "ucr_organisation_bic": "<string>",
    "ucr_private_birth": "2023-12-25",
    "ucr_private_birth_city": "<string>",
    "ucr_private_birth_country": "<string>",
    "ucr_private_birth_province": "<string>",
    "ucr_scheme_code": "<string>",
    "ucr_scheme_proprietary": "<string>",
    "udr_address": "<string>",
    "udr_address_city": "<string>",
    "udr_address_country": "<string>",
    "udr_id_type": 123,
    "udr_identification": "<string>",
    "udr_issuer": "<string>",
    "udr_name": "<string>",
    "udr_organisation_bic": "<string>",
    "udr_private_birth": "2023-12-25",
    "udr_private_birth_city": "<string>",
    "udr_private_birth_country": "<string>",
    "udr_private_birth_province": "<string>",
    "udr_scheme_code": "<string>",
    "udr_scheme_proprietary": "<string>"
  }
}

POST

gateway

createSepaPmt

Create Sepa payment

curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/gateway/createSepaPmt \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "cr_acc": "string",
  "cr_amount": 1,
  "cr_ccy_isocode": "string",
  "cr_name": "string",
  "dr_acc": "string",
  "dr_amount": 1,
  "dr_ccy_isocode": "string",
  "dr_name": "string",
  "inst": false,
  "trx_purpose": "string"
}
'

{
  "result": {
    "cr_amount": 123,
    "dr_amount": 123,
    "cr_acc": "<string>",
    "cr_address": "<string>",
    "cr_address_city": "<string>",
    "cr_address_country": "<string>",
    "cr_alt_code_company": "<string>",
    "cr_alt_code_company_issuer": "<string>",
    "cr_bank_bic": "<string>",
    "cr_ccy_isocode": "<string>",
    "cr_code_issuer": "<string>",
    "cr_code_person": "<string>",
    "cr_name": "<string>",
    "ctgy_purp_cd": "BONU",
    "ctgy_purp_prtry": "<string>",
    "dr_acc": "<string>",
    "dr_address": "<string>",
    "dr_address_city": "<string>",
    "dr_address_country": "<string>",
    "dr_alt_code_company": "<string>",
    "dr_alt_code_company_issuer": "<string>",
    "dr_bank_bic": "<string>",
    "dr_ccy_isocode": "<string>",
    "dr_code_company": "<string>",
    "dr_code_issuer": "<string>",
    "dr_code_person": "<string>",
    "dr_name": "<string>",
    "id": 123,
    "method": "SEPA",
    "trx_purpose": "<string>",
    "trx_purpose_information": "<string>",
    "trx_purpose_structured_issuer": "<string>",
    "trx_purpose_structured_ref": "<string>",
    "trx_settlement_date": "2023-12-25",
    "ucr_address": "<string>",
    "ucr_address_city": "<string>",
    "ucr_address_country": "<string>",
    "ucr_id_type": 123,
    "ucr_identification": "<string>",
    "ucr_issuer": "<string>",
    "ucr_name": "<string>",
    "ucr_organisation_bic": "<string>",
    "ucr_private_birth": "2023-12-25",
    "ucr_private_birth_city": "<string>",
    "ucr_private_birth_country": "<string>",
    "ucr_private_birth_province": "<string>",
    "ucr_scheme_code": "<string>",
    "ucr_scheme_proprietary": "<string>",
    "udr_address": "<string>",
    "udr_address_city": "<string>",
    "udr_address_country": "<string>",
    "udr_id_type": 123,
    "udr_identification": "<string>",
    "udr_issuer": "<string>",
    "udr_name": "<string>",
    "udr_organisation_bic": "<string>",
    "udr_private_birth": "2023-12-25",
    "udr_private_birth_city": "<string>",
    "udr_private_birth_country": "<string>",
    "udr_private_birth_province": "<string>",
    "udr_scheme_code": "<string>",
    "udr_scheme_proprietary": "<string>"
  }
}

Idempotent Endpoint

This endpoint supports idempotency to prevent duplicate transactions.

How to Use

Include an Idempotency-Key header with a unique value (UUID recommended)
The API returns the existing transaction when you reuse the same key
Retry requests safely without creating duplicates

Headers

Idempotency-Key

string

required

Unique identifier in scope of payment creation endpoints required to prevent unintended duplicate payments

Body

application/json

Basic SEPA payment request example

cr_acc

string

required

Creditor (Recipient) Account (IBAN)

Required string length: 1 - 100

cr_amount

integer

required

Amount in minor currency units (cents), 'cr_amount' must be equal to 'dr_amount'

cr_ccy_isocode

string

required

For SEPA payments, only allowed value is 'EUR', 'cr_ccy_isocode' must be equal to 'dr_ccy_isocode'

cr_name

string

required

Creditor (Recipient) Name

Required string length: 1 - 70

dr_acc

string

required

Debtor (Sender) Account (IBAN)

dr_amount

integer

required

Amount in minor currency units (cents), 'dr_amount' must be equal to 'cr_amount'

dr_ccy_isocode

string

required

For SEPA payments, only allowed value is 'EUR', 'dr_ccy_isocode' must be equal to 'cr_ccy_isocode'

dr_name

string

required

Debtor (Sender) Name

Required string length: 1 - 70

inst

boolean

required

Default value false. Should be set as true when payment needs to be processed though SEPA INST scheme.
Note: if recipient bank does not support SEPA INST, error 'Bank XXX doesn't support Instant payments' will be returned, and payment should be reprocessed with 'inst'=false flag

cr_address

string

Creditor address

Maximum string length: 140

cr_address_city

string

Creditor city

Maximum string length: 35

cr_address_country

string

2 characters ISO code of Creditor country

cr_alt_code_company

string

Alternative Creditor company code

Required string length: 1 - 35

cr_alt_code_company_issuer

string

Alternative Creditor company code issuer

Required string length: 1 - 35

cr_bank_bic

string

Creditor (Recipient) Bank Code - BIC.
If not provided, system will try to resolve it automatically, in cases where system failed to find BIC automatically and there was no BIC provided error will be thrown

cr_code_company

string

Creditor company code

cr_code_issuer

string

Issuer of Creditor company/person code

Required string length: 1 - 35

cr_code_person

string

Creditor Personal code

ctgy_purp_cd

enum<string>

Category purpose code. Indicates the high-level purpose of the payment at a business level for accounting inside the payer/beneficiary company and for interbank and regulatory interpretation. Mutually exclusive with ctgy_purp_prtry.

Available options:

BONU,

CASH,

CBLK,

CCRD,

CORT,

DCRD,

DIVI,

DVPM,

EPAY,

FCIN,

FCOL,

GOVT,

HEDG,

ICCP,

IDCP,

INTC,

INTE,

LOAN,

MP2B,

MP2P,

OTHR,

PENS,

RPRE,

RRCT,

RVPM,

SALA,

SECU,

SSBE,

SUPP,

TAXS,

TRAD,

TREA,

VATX,

WHLD

ctgy_purp_prtry

string

Category purpose proprietary value. Free text alternative to ctgy_purp_cd for non-standard category purposes. Mutually exclusive with ctgy_purp_cd. Must contain at least one non-whitespace character. Maximum length is 35 characters.

Maximum string length: 35

dr_address

string

Debtor address

Maximum string length: 140

dr_address_city

string

Debtor city

Maximum string length: 35

dr_address_country

string

2 characters ISO code of Debtor country

dr_alt_code_company

string

Alternative Debtor company code

Required string length: 1 - 35

dr_alt_code_company_issuer

string

Alternative Debtor company code issuer

Required string length: 1 - 35

dr_code_company

string

Debtor company code

dr_code_issuer

string

Issuer of Debtor company/person code

Required string length: 1 - 35

dr_code_person

string

Debtor Personal code

Required string length: 1 - 35

end_to_end_id

string

End to end ID assigned for payment.
If a client is TIPS participant it can only contain alphanumeric (0-9, a-z, A-Z) and the following special characters: ()+-:',.?
Otherwise all characters are accepted.

Maximum string length: 35

trx_purpose

string

Unstructured payment purpose (free text).
One of the values should be present 'trx_purpose' or 'trx_purpose_structured_ref' + 'trx_purpose_structured_ref_issuer'

Required string length: 1 - 140

trx_purpose_information

enum<string>

Category purpose code, one of following values should be used: 'ADVA' - Advance Payment, 'TAXS' - Tax Payment

Available options:

ADVA,

TAXS

Required string length: 1 - 4

trx_purpose_structured_issuer

string

Structured reference code issuer. Ex. Taxpayer code.
One of the values should be present 'trx_purpose' or 'trx_purpose_structured_ref' + 'trx_purpose_structured_ref_issuer'

Required string length: 1 - 35

trx_purpose_structured_ref

string

Structured reference code. Ex. Tax institution.
One of the values should be present 'trx_purpose' or 'trx_purpose_structured_ref' + 'trx_purpose_structured_ref_issuer'

Required string length: 1 - 35

trx_settlement_date

string<date>

Date when payment should be executed.
If specified date is not a valid business day, or is in the past system will automatically select next available business day

ucr_id_type

integer

Use '1' for Company clients, Use '2' for Person clients

ucr_identification

string

Other identification code for company or person

Required string length: 1 - 35

ucr_issuer

string

Identification code issuer

ucr_name

string

Ultimate Creditor Name

Required string length: 1 - 70

ucr_organisation_bic

string

BIC or BEI identification code

ucr_private_birth

string<date>

Persons date of birth

ucr_private_birth_city

string

Persons birth city

ucr_private_birth_country

string

2 characters ISO code of persons birth country

ucr_private_birth_province

string

Persons birth province

ucr_scheme_code

enum<string>

Identification code type, one of following values are allowed: 'ARNU' - Alien registration number, 'CCPT' - Passport number

Available options:

ARNU,

CCPT

ucr_scheme_proprietary

string

Identification code type as free text

udr_id_type

integer

Use '1' for Company clients, Use '2' for Person clients

udr_identification

string

Other identification code for company or person

Required string length: 1 - 35

udr_issuer

string

Identification code issuer

udr_name

string

Ultimate Debtor Name

Required string length: 1 - 70

udr_organisation_bic

string

BIC or BEI identification code

udr_private_birth

string<date>

Persons date of birth

udr_private_birth_city

string

Persons birth city

udr_private_birth_country

string

2 characters ISO code of persons birth country

udr_private_birth_province

string

Persons birth province

udr_scheme_code

enum<string>

Identification code type, one of following values are allowed: 'ARNU' - Alien registration number, 'CCPT' - Passport number

Available options:

ARNU,

CCPT

udr_scheme_proprietary

string

Identification code type as free text

Response

A new SEPA payment has been created

result

object

required

Result of sepa payment creation

Show child attributes

result.cr_amount

integer

required

Amount in minor currency units (cents)

result.dr_amount

integer

required

Amount in minor currency units (cents)

result.cr_acc

string

Creditor (Recipient) Account (IBAN)

result.cr_address

string

Creditor address

result.cr_address_city

string

Creditor city

result.cr_address_country

string

Creditor country

result.cr_alt_code_company

string

Alternative Creditor company code

result.cr_alt_code_company_issuer

string

Alternative Creditor company code issuer

result.cr_bank_bic

string

Creditor (Recipient) Bank Code - BIC

result.cr_ccy_isocode

string

SEPA payment currency code

result.cr_code_issuer

string

Issuer of Creditor company/person code

result.cr_code_person

string

Creditor Personal code

result.cr_name

string

Creditor (Recipient) Name

result.ctgy_purp_cd

enum<string>

Category purpose code

Available options:

BONU,

CASH,

CBLK,

CCRD,

CORT,

DCRD,

DIVI,

DVPM,

EPAY,

FCIN,

FCOL,

GOVT,

HEDG,

ICCP,

IDCP,

INTC,

INTE,

LOAN,

MP2B,

MP2P,

OTHR,

PENS,

RPRE,

RRCT,

RVPM,

SALA,

SECU,

SSBE,

SUPP,

TAXS,

TRAD,

TREA,

VATX,

WHLD

result.ctgy_purp_prtry

string

Category purpose proprietary

result.dr_acc

string

Debtor (Sender) Account (IBAN)

result.dr_address

string

Debtor address

result.dr_address_city

string

Debtor city

result.dr_address_country

string

Debtor country

result.dr_alt_code_company

string

Alternative Debtor company code

result.dr_alt_code_company_issuer

string

Alternative Debtor company code issuer

result.dr_bank_bic

string

Debtor (Sender) Bank Code - BIC

result.dr_ccy_isocode

string

SEPA payment currency code

result.dr_code_company

string

Debtor company code

result.dr_code_issuer

string

Issuer of Debtor company/person code

result.dr_code_person

string

Debtor Personal code

result.dr_name

string

Debtor (Sender) Name

result.id

integer<int64>

Transaction ID

result.method

enum<string>

Transaction method

Available options:

SEPA,

INST,

SDD,

SWIFT

result.trx_purpose

string

Unstructured payment purpose (free text)

result.trx_purpose_information

string

Category purpose Code, 'ADVA' - Advance Payment, 'TAXS' - Tax Payment

result.trx_purpose_structured_issuer

string

Structured reference code issuer

result.trx_purpose_structured_ref

string

Structured reference code

result.trx_settlement_date

string<date>

Payment execution date

result.ucr_address

string

Ultimate Creditor Address

result.ucr_address_city

string

Ultimate Creditor City

result.ucr_address_country

string

Ultimate Creditor Country

result.ucr_id_type

integer

Ultimate Creditor Identification type, '1' for Company clients, '2' for Person clients

result.ucr_identification

string

Other identification code for company or person

result.ucr_issuer

string

Identification code issuer

result.ucr_name

string

Ultimate Creditor Name

result.ucr_organisation_bic

string

BIC or BEI identification code

result.ucr_private_birth

string<date>

Persons date of birth

result.ucr_private_birth_city

string

Persons birth city

result.ucr_private_birth_country

string

Persons birth country

result.ucr_private_birth_province

string

Persons birth province

result.ucr_scheme_code

string

Identification code type, 'ARNU' - Alien registration number, 'CCPT' - Passport number

result.ucr_scheme_proprietary

string

Identification code type as free text

result.udr_address

string

Ultimate Debtor Address

result.udr_address_city

string

Ultimate Debtor City

result.udr_address_country

string

Ultimate Debtor Country

result.udr_id_type

integer

Ultimate Debtor Identification type, '1' for Company clients, '2' for Person clients

result.udr_identification

string

Other identification code for company or person

result.udr_issuer

string

Identification code issuer

result.udr_name

string

Ultimate Debtor Name

result.udr_organisation_bic

string

BIC or BEI identification code

result.udr_private_birth

string<date>

Persons date of birth

result.udr_private_birth_city

string

Persons birth city

result.udr_private_birth_country

string

Persons birth country

result.udr_private_birth_province

string

Persons birth province

result.udr_scheme_code

string

Identification code type, 'ARNU' - Alien registration number, 'CCPT' - Passport number

result.udr_scheme_proprietary

string

Identification code type as free text

Change status Cancel transaction

⌘I

Getting Started

Account Management

SEPA Instant

SEPA Direct Debit

SWIFT Payments

Payment Information

Nostro Accounts

Bank Information

Webhooks

Create Sepa payment

Idempotent Endpoint

How to Use

Headers

Body

Response

Getting Started

Account Management

SEPA Instant

SEPA Direct Debit

SWIFT Payments

Payment Information

Nostro Accounts

Bank Information

Webhooks

​Idempotent Endpoint

​How to Use

Headers

Body

Response

Idempotent Endpoint

How to Use