Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Type

Optional

Description

amount

number

(0.01 - 9999999999)

no

Amount of the payment.

currency

text, valid currency

(min/max 3 chars)

no

Currency of the payment. Must be a valid currency code, e.g. EUR, CZK, PLN.

paymentDate

ISO 8601 datetime

yes

Date when the payment should be executed. Current date of not provided

recipientIban

text, valid iban

(max 50 chars)

no

IBAN account number where the money should be sent to.

recipientName

text

(max 140 chars)

yesno

Name of the payment recipient.

This name will appear in your bank transaction as recipient of the money.

recipientBankBic

text, valid BIC

yes

BIC of the recipient bank

senderIban

text, valid iban

(max 50 chars)

yes

IBAN of sender’s (your) bank account.

variableSymbol

numeric text

(max 10 chars)

yes

Symbol for SK/CZ market. Cannot be combined with reference.

constantSymbol

numeric text

(max 10 4 chars)

yes

Symbol for SK/CZ market. Cannot be combined with reference.

specificSymbol

numeric text

(max 4 10 chars)

yes

Symbol for SK/CZ market. Cannot be combined with reference.

reference

text

(max 35 chars)

yes

Payment reference. Cannot be combined with symbols.

redirectUrl

text

(max 5000 chars)

no

Redirect URL back to your system.

It must be string satisfying URL rules. E.g. hostname must contain at least one dot (for local development URL like this can be used: http://yourapp.local/xyz).
Using of URL like this for local development requires some locally running proxy rerouting to your app running on localhost.

paymentMessage

text

(max 140 chars)

yes

Message to recipient. This message will be visible in bank transaction as description of the transfer.

externalId

Free text, maximum 255 characters

yes

Can be used to match the payment with data in your systems.

counterpartyAddress

Free text, maximum 255 characters

recipientAddress

Object

yes

Object holding information about recipient address. Fields:

  • streetName - free text

  • streetNumber - free text

  • city - free text

  • zip - free text

  • countryCode - ISO alpha-3 code of the country

recipientBankAddress

Object

yes

Object holding information about recipient bank address. Fields:

  • streetName - free text

  • streetNumber - free text

  • city - free text

  • zip - free text

  • countryCode - ISO alpha-3 code of the country

priority

Enum

yes

possible values:

  • NORMAL

  • HIGH

  • INSTANT

...