FinancialInstitutionPaymentDTO
paymentIdentification object
Unique identification as assigned by the initiating party to be used as transaction identifier. If left empty, Mambu transaction id will be used. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
Unique identification assigned by the payer to identify the transaction. This identification will be returned to the payer and passed on to the beneficiary. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
Universally unique identifier to provide an end-to-end reference of a payment transaction.
Possible values: >= 36 characters and <= 36 characters
Specifies the high level purpose of the payment based on a set of pre-defined categories.
Possible values: non-empty and <= 4 characters
settlementInformation objectrequired
Specifies the details on how the settlement of the transaction(s) between the instructing agent and the instructed agent is completed.
Method used to settle the payment: INDA (instructed agent), INGA (instructing agent), CLRG (clearing system)
settlementAccount object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
Clearing system when settlement method is CLRG.
instructedAgent objectrequired
Agent that is instructed by the previous party in the chain to carry out the (set of) instruction(s).
institutionIdentification objectrequired
Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised identification scheme.
ISO 9362 Business identifier code (BIC) - code allocated to a financial institution. Must be between 8 and 11 characters.
Possible values: >= 8 characters and <= 11 characters
debtorAccount object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
debtor objectrequired
Financial institution servicing an account for the creditor. This field is mandatory when proprietary ('other') creditor account identification is used.
institutionIdentification objectrequired
Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised identification scheme.
ISO 9362 Business identifier code (BIC) - code allocated to a financial institution. Must be between 8 and 11 characters.
Possible values: >= 8 characters and <= 11 characters
account object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
debtorAgent object
Financial institution servicing an account for the creditor. This field is mandatory when proprietary ('other') creditor account identification is used.
institutionIdentification objectrequired
Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised identification scheme.
ISO 9362 Business identifier code (BIC) - code allocated to a financial institution. Must be between 8 and 11 characters.
Possible values: >= 8 characters and <= 11 characters
account object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
The Party that originally ordered goods or services and to whom the seller has sent the invoice. Ultimate Debtor can be used when the acceptor of the invoice is different than the payer. Must not exceed 70 characters.
Possible values: non-empty and <= 70 characters
instructedAmount objectrequired
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
The amount given with fractional digits, where fractions must be compliant to the currency definition. Negative amounts are signed by minus. The decimal separator is a dot.
Possible values: non-empty and <= 12 characters
intermediaryAgent1 object
Financial institution servicing an account for the creditor. This field is mandatory when proprietary ('other') creditor account identification is used.
institutionIdentification objectrequired
Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised identification scheme.
ISO 9362 Business identifier code (BIC) - code allocated to a financial institution. Must be between 8 and 11 characters.
Possible values: >= 8 characters and <= 11 characters
account object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
intermediaryAgent2 object
Financial institution servicing an account for the creditor. This field is mandatory when proprietary ('other') creditor account identification is used.
institutionIdentification objectrequired
Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised identification scheme.
ISO 9362 Business identifier code (BIC) - code allocated to a financial institution. Must be between 8 and 11 characters.
Possible values: >= 8 characters and <= 11 characters
account object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
intermediaryAgent3 object
Financial institution servicing an account for the creditor. This field is mandatory when proprietary ('other') creditor account identification is used.
institutionIdentification objectrequired
Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised identification scheme.
ISO 9362 Business identifier code (BIC) - code allocated to a financial institution. Must be between 8 and 11 characters.
Possible values: >= 8 characters and <= 11 characters
account object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
creditorAccount object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
creditor objectrequired
Financial institution servicing an account for the creditor. This field is mandatory when proprietary ('other') creditor account identification is used.
institutionIdentification objectrequired
Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised identification scheme.
ISO 9362 Business identifier code (BIC) - code allocated to a financial institution. Must be between 8 and 11 characters.
Possible values: >= 8 characters and <= 11 characters
account object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
creditorAgent object
Financial institution servicing an account for the creditor. This field is mandatory when proprietary ('other') creditor account identification is used.
institutionIdentification objectrequired
Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised identification scheme.
ISO 9362 Business identifier code (BIC) - code allocated to a financial institution. Must be between 8 and 11 characters.
Possible values: >= 8 characters and <= 11 characters
account object
Settlement account used when settlement method is INDA/INGA.
identification objectrequired
Unique and unambiguous identification for the account.
International Bank Account Number (IBAN) - identifier used internationally by financial institutions to uniquely identify the account of a customer. Must be between 15 and 34 characters.
Possible values: >= 15 characters and <= 34 characters
other object
Unique identification of an account, as assigned by the account servicer, using any other identification scheme.
Identification assigned by an institution. Must not exceed 34 characters.
Possible values: non-empty and <= 34 characters
Name or code of the identification scheme. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
ISO 4217 Alpha 3 currency code.
Possible values: >= 3 characters and <= 3 characters
Party which is the ultimate beneficiary of the payment. For example, the payment can be credited to an account of a financing company, with the ultimate beneficiary being the customer of the financing company. Must not exceed 70 characters.
Possible values: non-empty and <= 70 characters
The PurposeCode value or a similar explanation is not added to the payer’s Electronic account statement. This value can be shown on both the payers and the beneficiary’s on the Camt.053 account statement. Purpose codes can be taken from an external list, for example the ISO 20022 External Code Set.
Possible values: >= 4 characters and <= 4 characters
Payment details. Free text, one occurrence (max 140 characters). Payment reason (according to current recurrent payment standard) can be given in this element.
Possible values: non-empty and <= 140 characters
remittanceInformationStructured object
Payment details. Structured message. Generally, these fields are used to provide invoice or creditor reference information. References should conform to ISO 11649, international standard of reference information.
The actual reference. Must not exceed 35 characters. If providing a reference number, the referenceType should also be provided.
Possible values: non-empty and <= 35 characters
The type of reference provided. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
The entity which created or generated the reference. Must not exceed 35 characters.
Possible values: non-empty and <= 35 characters
Optional field for recording the date of the transfer. Payments can not be backdated or scheduled for the future.
Possible values: >= 10 characters and <= 10 characters
{
"paymentIdentification": {
"transactionIdentification": "string",
"endToEndIdentification": "string",
"uetr": "string"
},
"categoryPurposeCode": "string",
"settlementInformation": {
"settlementMethod": "string",
"settlementAccount": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
},
"clearingSystem": "string"
},
"instructedAgent": {
"institutionIdentification": {
"bicfi": "string"
}
},
"debtorAccount": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
},
"debtor": {
"institutionIdentification": {
"bicfi": "string"
},
"account": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
}
},
"debtorAgent": {
"institutionIdentification": {
"bicfi": "string"
},
"account": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
}
},
"ultimateDebtor": "string",
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"intermediaryAgent1": {
"institutionIdentification": {
"bicfi": "string"
},
"account": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
}
},
"intermediaryAgent2": {
"institutionIdentification": {
"bicfi": "string"
},
"account": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
}
},
"intermediaryAgent3": {
"institutionIdentification": {
"bicfi": "string"
},
"account": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
}
},
"creditorAccount": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
},
"creditor": {
"institutionIdentification": {
"bicfi": "string"
},
"account": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
}
},
"creditorAgent": {
"institutionIdentification": {
"bicfi": "string"
},
"account": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"scheme": "string"
}
},
"currency": "string"
}
},
"ultimateCreditor": "string",
"purposeCode": "string",
"remittanceInformationUnstructured": "string",
"remittanceInformationStructured": {
"reference": "string",
"referenceType": "string",
"referenceIssuer": "string"
},
"requestedExecutionDate": "string"
}