...
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) | yes | Your name in case you don’t want to use the registered name no | Name of the payment recipient. This name will appear in payer’s your bank transaction as recipient of the money. | |
recipientBankBic | text, valid BIC | yes | BIC of the integrator's recipient bank account | ||
senderIban | text, valid iban (max 50 chars) | yes | IBAN of sender’s (your) bank account. if known at the time of order creation | ||
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). | ||
paymentMessage | text (max 140 chars) | yes | Message to for recipient. This message will be visible in his 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:
| ||
recipientBankAddress | Object | yes | Object holding information about recipient bank address. Fields:
| ||
priority | Enum | yes | possible values:
|
...