Skip to main content

InitiationPaymentDTO

paymentIdentification object

Payment instruction reference.

transactionIdentificationstring

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

endToEndIdentificationstring

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

debtorIdentification object

Beneficiary’s identification.

privateIdentificationstringrequired

Unique and unambiguous identification of a person, eg, passport. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

proprietarystring

A proprietary type of identification for the party to the transaction. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

codestring

A four-letter code specifying the type of identification being used. For valid codes an external catalogue should be consulted such as the one provided in the ISO 20022 External Code Sets.

Possible values: non-empty and <= 4 characters

issuerstring

The official body who provided the identification. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

debtorAccount objectrequired

Settlement account used when settlement method is INDA/INGA.

identification objectrequired

Unique and unambiguous identification for the account.

ibanstring

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.

identificationstringrequired

Identification assigned by an institution. Must not exceed 34 characters.

Possible values: non-empty and <= 34 characters

schemestringrequired

Name or code of the identification scheme. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

currencystring

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.

bicfistringrequired

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.

ibanstring

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.

identificationstringrequired

Identification assigned by an institution. Must not exceed 34 characters.

Possible values: non-empty and <= 34 characters

schemestringrequired

Name or code of the identification scheme. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

currencystring

ISO 4217 Alpha 3 currency code.

Possible values: >= 3 characters and <= 3 characters

ultimateDebtorstring

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

debtorNamestringrequired

The full name of the debtor. Must not exceed 70 characters.

Possible values: non-empty and <= 70 characters

debtorAddress object
streetstring

The street name of the adress. Must not exceed 70 characters.

Possible values: non-empty and <= 70 characters

buildingNumberstring

The building or street number of the address. Must not exceed 16 characters.

Possible values: non-empty and <= 16 characters

citystring

The city of the address. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

postalCodestring

The postal code of the address. Must not exceed 16 characters.

Possible values: non-empty and <= 16 characters

countryCodestringrequired

Two characters as defined by ISO 3166. For example DE for Germany, TZ for Tanzania.

Possible values: >= 2 characters and <= 2 characters

serviceLevelstring

Agreement under which or rules under which the transaction should be processed. Must be SEPA for SEPA Credit Transfers and Direct Debits.

localInstrumentstring

User community specific instrument. Used to specify a local instrument, local clearing option and/or further qualify the service or service level. For example, whether a Direct Debit uses the business to customer CORE, business to business B2B ruleset or whether a Credit Transfer is of type Instant INST.

instructedAmount objectrequired
currencystringrequired

ISO 4217 Alpha 3 currency code.

Possible values: >= 3 characters and <= 3 characters

amountstringrequired

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

creditorIdentification object

Beneficiary’s identification.

privateIdentificationstringrequired

Unique and unambiguous identification of a person, eg, passport. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

proprietarystring

A proprietary type of identification for the party to the transaction. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

codestring

A four-letter code specifying the type of identification being used. For valid codes an external catalogue should be consulted such as the one provided in the ISO 20022 External Code Sets.

Possible values: non-empty and <= 4 characters

issuerstring

The official body who provided the identification. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

creditorAccount objectrequired

Settlement account used when settlement method is INDA/INGA.

identification objectrequired

Unique and unambiguous identification for the account.

ibanstring

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.

identificationstringrequired

Identification assigned by an institution. Must not exceed 34 characters.

Possible values: non-empty and <= 34 characters

schemestringrequired

Name or code of the identification scheme. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

currencystring

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.

bicfistringrequired

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.

ibanstring

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.

identificationstringrequired

Identification assigned by an institution. Must not exceed 34 characters.

Possible values: non-empty and <= 34 characters

schemestringrequired

Name or code of the identification scheme. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

currencystring

ISO 4217 Alpha 3 currency code.

Possible values: >= 3 characters and <= 3 characters

creditorNamestringrequired

The Party whose account is credited with the payment. Must not exceed 70 characters.

Possible values: non-empty and <= 70 characters

creditorAddress object
streetstring

The street name of the adress. Must not exceed 70 characters.

Possible values: non-empty and <= 70 characters

buildingNumberstring

The building or street number of the address. Must not exceed 16 characters.

Possible values: non-empty and <= 16 characters

citystring

The city of the address. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

postalCodestring

The postal code of the address. Must not exceed 16 characters.

Possible values: non-empty and <= 16 characters

countryCodestringrequired

Two characters as defined by ISO 3166. For example DE for Germany, TZ for Tanzania.

Possible values: >= 2 characters and <= 2 characters

ultimateCreditorstring

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

purposeCodestring

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

remittanceInformationUnstructuredstring

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.

referencestringrequired

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

referenceTypestring

The type of reference provided. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

referenceIssuerstring

The entity which created or generated the reference. Must not exceed 35 characters.

Possible values: non-empty and <= 35 characters

requestedExecutionDatestring

Optional field for recording the date of the transfer. For SEPA Credit Transfers only the current date can be provided. Payments can not be backdated or scheduled for the future.

Possible values: >= 10 characters and <= 10 characters

requestedExecutionTimestring

Optional field for recording the date and time of the payment initiation. For SEPACredit Transfers, only the current date and time can be provided. Payments can not be backdated or scheduled for the future.

Possible values: >= 17 characters and <= 35 characters

categoryPurposeCodestring

Specifies the high level purpose of the payment based on a set of pre-defined categories.

Possible values: non-empty and <= 4 characters

InitiationPaymentDTO
{
"paymentIdentification": {
"transactionIdentification": "string",
"endToEndIdentification": "string"
},
"debtorIdentification": {
"privateIdentification": "string",
"proprietary": "string",
"code": "string",
"issuer": "string"
},
"debtorAccount": {
"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",
"debtorName": "string",
"debtorAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
},
"serviceLevel": "string",
"localInstrument": "string",
"instructedAmount": {
"currency": "string",
"amount": "string"
},
"creditorIdentification": {
"privateIdentification": "string",
"proprietary": "string",
"code": "string",
"issuer": "string"
},
"creditorAccount": {
"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"
}
},
"creditorName": "string",
"creditorAddress": {
"street": "string",
"buildingNumber": "string",
"city": "string",
"postalCode": "string",
"countryCode": "string"
},
"ultimateCreditor": "string",
"purposeCode": "string",
"remittanceInformationUnstructured": "string",
"remittanceInformationStructured": {
"reference": "string",
"referenceType": "string",
"referenceIssuer": "string"
},
"requestedExecutionDate": "string",
"requestedExecutionTime": "string",
"categoryPurposeCode": "string"
}