Payment API Data Content
| Field name | Content | Description |
|---|---|---|
consentList | List of consent requests | |
paymentData | Transfer data | |
debtorAccount | Transferor account | Unique identifier of the account to be debited in the transfer operation. |
iban | Transferor account in IBAN format | International bank account number of the transferor. In Hungary, a 28-character number series always starting with HU, and the last 24 characters correspond to the payment account number; if it is 3×8 characters, the last 8 digits of the IBAN are zero for a 2×8 character account number. |
debtorIdentification | Transferor identifier | |
identificationType | Transferor identifier type | Transferor identifier type, possible values: ORG-BIC: Organisation identifier BIC. ORG-OTHR: Organisation unique identifier other. PRV-OTHR: Private individual unique identifier other. One of these can be provided. When provided, the transferor identifier value must also be given. |
identification | Transferor identifier value | Transferor identifier value; when provided, the transferor identifier type must also be given. For ORG-BIC, BIC format must be used: [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} |
requestedExecutionDate | Requested execution date of transfer | The execution date requested by the transferor; the day on which the transferor's account is to be debited. If the payment is made by cheque, this is the day when the bank produces the cheque. |
paymentInformationId | Payment information block identifier | Unique identifier provided by the sending party to unambiguously identify the payment information block within the message. Uniqueness must be ensured. |
categoryPurpose | Category purpose | |
categoryPurposeCode | Category purpose code | The high-level purpose of the instruction, according to predefined categories. In this message element, the party initiating the transfer can provide information regarding the processing of the payment, which is expected to trigger special processing at one of the banks in the payment chain. Values published by the standard maintainer in the ExternalCategoryPurpose1Code list can be provided. Category purpose codes |
payments | Transfer transaction information | Group of message elements containing the data of individual transactions in the message. |
instructionIdentification | Instruction identifier | Point-to-point reference between the instructing and instructed party to identify the specific individual transaction. The instruction identifier can appear in multiple messages relating to the instruction. Uniqueness must be ensured. |
endToEndIdentification | End-to-end identifier / Unique identifier between parties | Reference provided by the initiating party to unambiguously identify the transaction, which must be passed unchanged through the entire transfer chain from end to end. The end-to-end identifier enables reconciliation and allows tasks to be assigned to the transaction. The end-to-end identifier can appear in other messages related to the transaction. |
instructedAmount | Instructed amount | The amount of the transfer, in the currency specified by the initiating party. |
currency | Currency | Currency code according to ISO 4217 standard. |
amount | Amount | The amount to be transferred between the instructing and beneficiary parties, in the currency specified by the initiating party. The number of decimal places can only be two, with a mandatory value of 00, or the amount can be stated without a decimal point and without fillér. |
ultimateDebtorName | Actual payer name | Name of the ultimate party who owes the given amount to the (actual) beneficiary. ISO guideline states that data about the ultimate payer may only appear in the message if it differs from the transferor. |
ultimateDebtorIdentification | Actual payer identifier | |
identificationType | Actual payer identifier type | Actual payer identifier type, possible values: ORG-BIC: Organisation identifier BIC. ORG-OTHR: Organisation unique identifier other. PRV-OTHR: Private individual unique identifier other. One of these can be provided. When provided, the actual payer identifier value must also be given. |
identification | Actual payer identifier value | Actual payer identifier value; when provided, the actual payer identifier type must also be given. For ORG-BIC, BIC format must be used: [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} |
creditorName | Beneficiary name | |
creditorAddress | Beneficiary address | |
country | Beneficiary address country code | Country code of the beneficiary's address. |
address | Beneficiary unstructured address | Beneficiary's unstructured address; postcode, city, street, street type, house number, staircase, floor, door can be entered concatenated. |
creditorIdentification | Beneficiary identifier | |
identificationType | Beneficiary identifier type | Beneficiary identifier type, possible values: ORG-BIC: Organisation identifier BIC. ORG-OTHR: Organisation unique identifier other. PRV-OTHR: Private individual unique identifier other. One of these can be provided. When provided, the beneficiary identifier value must also be given. |
identification | Beneficiary identifier value | Beneficiary identifier value; when provided, the beneficiary identifier type must also be given. For ORG-BIC, BIC format must be used: [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} |
creditorAccount | Beneficiary account | Unique identifier of the beneficiary's account to be credited. Only one of IBAN or secondary identifier can be provided. |
iban | Beneficiary account in IBAN format | International bank account number of the beneficiary. In Hungary, a 28-character number series always starting with HU, and the last 24 characters correspond to the payment account number; if it is 3×8 characters, the last 8 digits of the IBAN are zero for a 2×8 character account number. When provided, the beneficiary name must also be given, and none of the secondary identifier fields may be filled. |
proxy | Beneficiary account with secondary identifier | When provided, the beneficiary name and IBAN account number cannot be given. |
proxyType | Beneficiary account secondary identifier type | Beneficiary account secondary identifier type, possible values: TELE: Mobile phone number EMAL: Email address TXID: Hungarian tax identification number or foreign tax ID/number TXNB: Hungarian tax number. Only 'TELE', 'EMAL', 'TXID' or 'TXNB' can be provided. When provided, the beneficiary name and IBAN cannot be given; the beneficiary account secondary identifier value must be given. |
proxyId | Beneficiary account secondary identifier value | Format must be provided depending on the beneficiary account secondary identifier type: TELE: format is Plus, CountryCode-hyphen-areacode-phonenumber i.e. +[0-9]3-[0-9]25 e.g.: +36-7012345678 EMAL: email address max. 70 characters long TXID: Hungarian tax ID with country code e.g.: TXID:HU8123456789 or TXID:CZ123456789 TXNB: Hungarian/foreign tax number with country code e.g.: TXNB:HU12345678 When provided, the beneficiary name and IBAN cannot be given; beneficiary account secondary identifier type must be given. |
ultimateCreditorName | Actual beneficiary name | Name of the ultimate party to whom the amount is actually due. ISO guideline states that actual beneficiary data may only appear in the message if it differs from the beneficiary. |
ultimateCreditorIdentification | Actual beneficiary identifier | |
identificationType | Actual beneficiary identifier type | Actual beneficiary identifier type, possible values: ORG-BIC: Organisation identifier BIC ORG-OTHR: Organisation unique identifier other PRV-OTHR: Private individual unique identifier other. One of these can be provided. When provided, the actual beneficiary identifier value must also be given. |
identification | Actual beneficiary identifier value | Actual beneficiary identifier value; when provided, the actual beneficiary identifier type must also be given. For ORG-BIC, BIC format must be used: [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} |
purposeCode | Purpose code | In transfer and payment request messages, service providers can indicate in which payment scenario the given transaction occurred. Using the purpose code, the ultimate parties – initiating party, transferor/(actual) payer, and (actual) beneficiary – can communicate information about the nature of the transfer. The purpose code is a content element that is not used by any intermediary in the payment chain for processing the instruction. Values published by the standard maintainer in the ExternalPurpose1Code list can be provided. Purpose codes |
remittanceInformationUnstructured | Unstructured remittance information | Information agreed between the transferor and the beneficiary can be provided in this data field. Information provided in unstructured form to enable reconciliation of the incoming transfer and the item to be settled with it, e.g. the commercial invoice recorded on the buyer's current account. |