Citi · Schema
MandateClientDetails
BankingFinancial ServicesOpen BankingPaymentsTreasuryISO 20022Commercial CardsForeign ExchangeCustodyTrade FinanceCorporate BankingAPI Gateway
Properties
| Name | Type | Description |
|---|---|---|
| mandate_details | object | |
| initiating_party | object | |
| debtor | object | |
| creditor | object | |
| ultimate | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-mandate-client-details-schema.json",
"title": "MandateClientDetails",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/citi-mandates-api-openapi.yml#/components/schemas/MandateClientDetails",
"type": "object",
"required": [
"mandate_details"
],
"properties": {
"mandate_details": {
"$ref": "#/$defs/MandateDetails"
},
"initiating_party": {
"$ref": "#/$defs/InitiatingParty"
},
"debtor": {
"$ref": "#/$defs/Debtor"
},
"creditor": {
"$ref": "#/$defs/Creditor"
},
"ultimate": {
"$ref": "#/$defs/Ultimate"
}
},
"$defs": {
"Creditor": {
"title": "Creditor",
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Specify the name by which a party is known and which is used to identify that party. This parameter is mandatory for Australia if creditor `account_number` parameter value is present."
},
"address_1": {
"title": "address_1",
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Specify the address of the party who involves in the payment flow. This parameter is not applicable to Australia."
},
"address_2": {
"title": "address_2",
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Specify the address of the party who involves in the payment flow. This parameter is not applicable to Australia."
},
"address_3": {
"title": "address_3",
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Specify the address of the party who involves in the payment flow. This parameter is not applicable to Australia."
},
"country_code": {
"title": "country_code",
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Specify the country code of the creditor address. This parameter is not applicable to Australia."
},
"postal_code": {
"title": "postal_code",
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "Specify the postal code of the creditor address. This parameter is not applicable to Australia."
},
"town_name": {
"title": "town_name",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the town name of the creditor address. This parameter is not applicable to Australia."
},
"mobile_number": {
"title": "mobile_number",
"type": "string",
"pattern": "^\\+[0-9]{1,3}-[0-9()+\\\\-]{1,30}$",
"description": "Specify the mobile number of the creditor address. This parameter is not applicable to Australia."
},
"fax_number": {
"title": "fax_number",
"type": "string",
"pattern": "^\\+[0-9]{1,3}-[0-9()+\\\\-]{1,30}$",
"description": "Specify the fax number of the creditor address. This parameter is not applicable to Australia."
},
"email": {
"title": "email",
"type": "string",
"format": "email",
"description": "Specify the Address for electronic mail (e-mail). This parameter is not applicable to Australia."
},
"other_identification_category": {
"title": "other_identification_category",
"type": "string",
"enum": [
"ORG",
"PVT"
],
"description": "Specify the unique and unambiguous identification of a party. either the value will be ORG or PVT. This is a mandatory parameter for Australia, if the creditor section is present."
},
"other_identification_type": {
"title": "other_identification_type",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the unique and unambiguous way to identify an organization/private identification. This is a mandatory parameter for Australia if the `other_identification_category` parameter is present."
},
"other_identification": {
"title": "other_identification",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the value of an organization/private identification. This is a mandatory parameter for Australia if the `other_identification_category` parameter is present."
},
"iban": {
"title": "iban",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "An identifier used internationally by financial institutions to uniquely identify the account of a customer at a financial institution, as described in the latest edition of the international standard ISO 13616: 2007 - Banking and related financial services - International Bank Account Number (IBAN). This parameter is not applicable to Australia."
},
"bank_routing_code": {
"title": "bank_routing_code",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC). This is a mandatory parameter for Australia if the 'account' parameter is present."
},
"bank_branch_code": {
"title": "bank_branch_code",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the 6-digit BSB/9-digit account identification assigned by the Entity. This is a mandatory parameter for Australia if the `account` parameter is present."
},
"scheme_identification": {
"title": "scheme_identification",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the originator Creditor Scheme Identifier. This parameter is not applicable for Australia."
},
"account": {
"title": "account",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the unambiguous identification of the account of the creditor to which a debit entry will be posted as a result of the payment transaction."
},
"account_type": {
"title": "account_type",
"type": "string",
"enum": [
"AIIN",
"BBAN",
"CUID",
"UPIC",
"ALIA"
],
"description": "Specify the name of the identification scheme, in a coded form as published in an external list.<br>AIIN -Issuer Identification Number<br>BBAN- BBAN Identifier<br>CUID -CHIPS Universal Identifier<br>UPIC- UPIC Identifier<br>ALIA-Alias (proxy). This is a conditional parameter for Australia if creditor section is present and only BBAN is applicable for Australia and no proxy is allowed. <br>This is a mandatory parameter for Australia if creditor section is present. <br>For Australia, this parameter is allowed to amend unilaterally."
},
"proxy_id": {
"title": "proxy_id",
"type": "string",
"minLength": 1,
"maxLength": 2048,
"description": "Specify the identification used to indicate the account identification under another specified name. This parameter is not applicable to Australia."
},
"proxy_type": {
"title": "proxy_type",
"type": "string",
"enum": [
"TELE",
"EMAL",
"DNAM",
"CINC",
"COTX",
"COID",
"CUST",
"DRLC",
"EIDN",
"EWAL",
"PVTX",
"LEIC",
"MBNO",
"NIDN",
"CCPT",
"SHID",
"SOSE",
"TOKN",
"UBIL",
"VIPN",
"BIID"
],
"description": "Specify the name of the identification scheme, in a coded form as published in an external list. Specify the value only when the mandate request is other than payer (debtor) account number:<br>TELE-TelephoneNumber<br>EMAL-EmailAddress<br>DNAM-DomainName<br>CINC-CertificateOfIncorporationNumber<br>COTX-CorporateTaxIdentification<br>COID-CountryAuthorityIdentification<br>CUST-CustomerIdentificationNumber<br>DRLC-DriverLicenseNumber<br>EIDN-ElectronicIdentification<br>EWAL-EWalletIdentification<br>PVTX-IndividualTaxIdentification<br>LEIC-LegalEntityIdentifierCode<br>MBNO-MobilePhoneNumber<br>NIDN-NationalIdentificationNumber<br>CCPT-PassportNumber<br>SHID-SchemeIdentificationNumber<br>SOSE-SocialSecurityNumber<br>TOKN-TokenIdentification<br>UBIL-UtilitiesSubscriptionIdentification<br>VIPN-VehicleIdentificationPlateNumber<br>BIID-BillerSubscriberIdentification. This parameter is not applicable for Australia."
}
}
},
"Debtor": {
"title": "Debtor",
"type": "object",
"required": [
"name",
"bank_routing_code",
"account type"
],
"properties": {
"name": {
"title": "name",
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Which a party is known and which is used to identify that party. This parameter is mandatory for Australia."
},
"address_1": {
"title": "address_1",
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Specify the address of the party who involves in the payment flow. This parameter is not applicable to Australia."
},
"address_2": {
"title": "address_2",
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Specify the address of the party who involves in the payment flow. This parameter is not applicable to Australia."
},
"address_3": {
"title": "address_3",
"type": "string",
"minLength": 1,
"maxLength": 70,
"description": "Specify the address of the party who involves in the payment flow. This parameter is not applicable to Australia."
},
"country_code": {
"title": "country_code",
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Specify the country code of the debtor address. This parameter is not applicable to Australia."
},
"postal_code": {
"title": "postal_code",
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "Specify the postal code of the debtor address. This parameter is not applicable to Australia."
},
"town_name": {
"title": "town_name",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the town name of the debtor address. This parameter is not applicable to Australia."
},
"mobile_number": {
"title": "mobile_number",
"type": "string",
"pattern": "^\\+[0-9]{1,3}-[0-9()+\\\\-]{1,30}$",
"description": "Specify the mobile number of the debtor address. This parameter is not applicable to Australia."
},
"fax_number": {
"title": "fax_number",
"type": "string",
"pattern": "^\\+[0-9]{1,3}-[0-9()+\\\\-]{1,30}$",
"description": "Specify the fax number of the debtor address. This parameter is not applicable to Australia."
},
"email": {
"title": "email",
"type": "string",
"format": "email",
"description": "Specify the Address for electronic mail (e-mail). This parameter is not applicable to Australia."
},
"other_identification_category": {
"title": "other_identification_category",
"type": "string",
"enum": [
"ORG",
"PVT"
],
"description": "Specify the unique and unambiguous identification of a party. either the value will be ORG or PVT. This parameter is mandatory for Australia."
},
"other_identification_type": {
"title": "other_identification_type",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "specify the unique and unambiguous type to identify an organization/private identification. This parameter is mandatory for Australia."
},
"other_identification": {
"title": "other_identification",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the value of an organization/private identification type. This parameter is mandatory for Australia."
},
"iban": {
"title": "iban",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "An identifier used internationally by financial institutions to uniquely identify the account of a customer at a financial institution, as described in the latest edition of the international standard ISO 13616: 2007 - Banking and related financial services - International Bank Account Number (IBAN). This parameter is not applicable for Australia."
},
"bank_routing_code": {
"title": "bank_routing_code",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)."
},
"bank_branch_code": {
"title": "bank_branch_code",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the 6-digit BSB/9-digit account identification assigned by the Entity. It’s a mandatory parameter for Australia if the account type is = BBAN."
},
"account": {
"title": "account",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the unambiguous identification of the account of the debtor to which a debit entry will be posted as a result of the payment transaction. It’s a Mandatory parameter for Australia if account_type equal to BBAN."
},
"account_type": {
"title": "account_type",
"type": "string",
"enum": [
"AIIN",
"BBAN",
"CUID",
"UPIC",
"ALIA"
],
"description": "Specify the name of the identification scheme, in a coded form as published in an external list.<br>AIIN -Issuer Identification Number<br>BBAN- BBAN Identifier<br>CUID -CHIPS Universal Identifier<br>UPIC- UPIC Identifier<br>ALIA-Alias (proxy). This parameter is mandatory parameter for Australia. ALIA vis not allowed for Citi Creditor Customer."
},
"proxy_id": {
"title": "proxy_id",
"type": "string",
"minLength": 1,
"maxLength": 2048,
"description": "Specify the Identification used to indicate the account identification under another specified name."
},
"proxy_type": {
"title": "proxy_type",
"type": "string",
"enum": [
"TELE",
"EMAL",
"DNAM",
"CINC",
"COTX",
"COID",
"CUST",
"DRLC",
"EIDN",
"EWAL",
"PVTX",
"LEIC",
"MBNO",
"NIDN",
"CCPT",
"SHID",
"SOSE",
"TOKN",
"UBIL",
"VIPN",
"BIID"
],
"description": "Specify the name of the identification scheme, in a coded form as published in an external list. Specify the value only when the mandate request is other than Payer (Debtor) Account Number:<br>TELE-TelephoneNumber<br>EMAL-EmailAddress<br>DNAM-DomainName<br>CINC-CertificateOfIncorporationNumber<br>COTX-CorporateTaxIdentification<br>COID-CountryAuthorityIdentification<br>CUST-CustomerIdentificationNumber<br>DRLC-DriverLicenseNumber<br>EIDN-ElectronicIdentification<br>EWAL-EWalletIdentification<br>PVTX-IndividualTaxIdentification<br>LEIC-LegalEntityIdentifierCode<br>MBNO-MobilePhoneNumber<br>NIDN-NationalIdentificationNumber<br>CCPT-PassportNumber<br>SHID-SchemeIdentificationNumber<br>SOSE-SocialSecurityNumber<br>TOKN-TokenIdentification<br>UBIL-UtilitiesSubscriptionIdentification<br>VIPN-VehicleIdentificationPlateNumber<br>BIID-BillerSubscriberIdentification"
}
}
},
"InitiatingParty": {
"title": "InitiatingParty",
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Specify the name by which a party is known and which is used to identify that party. This parameter is mandatory for Australia."
},
"account": {
"title": "account",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the unique identification of an account, as assigned by the account servicer, using an identification scheme. This parameter is mandatory for Australia."
},
"other_identification_category": {
"title": "other_identification_category",
"type": "string",
"enum": [
"ORG",
"PVT"
],
"description": "Specify the unique and unambiguous identification of a party. the value will be organization/Private. This parameter is mandatory for Australia."
},
"other_identification_type": {
"title": "other_identification_type",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the unique and unambiguous type to identify an organization/private identification. This parameter is mandatory for Australia."
},
"other_identification": {
"title": "other_identification",
"type": "string",
"description": "Specify the value of an organization/private identification type. This parameter is mandatory for Australia.",
"minLength": 1,
"maxLength": 35
},
"bank_routing_code": {
"title": "bank_routing_code",
"type": "string",
"minLength": 8,
"maxLength": 11,
"description": "Specify the unique identification of an organization, as assigned by an institution, using an identification scheme. This parameter is mandatory for Australia."
}
}
},
"MandateDetails": {
"title": "MandateDetails",
"type": "object",
"required": [
"country",
"sequence_type",
"payment_frequency",
"tracking_indicator",
"mandate_start_date"
],
"properties": {
"becs_user_identification": {
"title": "becs_user_identification",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "BECS user ID related to migrated DDR mandate. This parameter is conditional to Australia if mandate_scheme is MGCR."
},
"country": {
"title": "country",
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Specify the country code where the mandate request has been originated.<br>Australia = AU<br>Hongkong = HK<br>Argentina = AR<br>SEPA = UK"
},
"mandate_description": {
"title": "mandate_description",
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Specify the description of the reason for mandate setup as narrative text.<br> This parameter is specific to Australia. Both mandate_description and mandate_additional_ information parameters are expected to be sent by client for Australia. This parameter is eligible to be amended unilaterally."
},
"sequence_type": {
"title": "sequence_type",
"type": "string",
"enum": [
"RCUR",
"OOFF"
],
"description": "Specify the underlying transaction sequence as either recurring or one-off.<br> Only RCUR applicable for AU."
},
"payment_frequency": {
"title": "payment_frequency",
"type": "string",
"enum": [
"ADHO",
"DAIL",
"FRTN",
"INDA",
"MIAN",
"MNTH",
"QURT",
"WEEK",
"YEAR"
],
"description": "Specify the regularity of an event.<br>ADHO = Ad hoc (Event takes place on request or as necessary)<br>DAIL = Daily (Event takes place every day)<br>FRTN = Fortnightly (Event takes place every two weeks)<br>INDA = Intraday (Event takes place several times a day)<br>MIAN = Semiannual (Event takes place every six months or two times a year)<br>MNTH = Monthly (Event takes place every month)<br>QURT = Quarterly (Event takes place every three months)<br>WEEK = Weekly (Event takes place once a week)<br>YEAR = Annual (Event takes place every year or once a year)"
},
"count_per_period": {
"title": "count_per_period",
"type": "string",
"pattern": "^(?=.{1,19}$)[0-9]{0,19}(?:\\.[0-9]{0,18})?$",
"description": "Specify the frequency in terms of the number of instructions to be created and processed during the specified period. count_per_period (or) point_in_time is a mandatory parameter for Australia."
},
"point_in_time": {
"title": "point_in_time",
"type": "string",
"pattern": "^[0-9]{2}$",
"description": "Specify the frequency in terms of an exact point in time or moment within the specified period."
},
"tracking_indicator": {
"title": "tracking_indicator",
"type": "boolean",
"description": "Specify the indicating value either True or False, whether the direct debit instructions should be automatically re-submitted periodically when bilaterally agreed."
},
"mandate_additional_information": {
"title": "mandate_additional_information",
"type": "string",
"minLength": 1,
"maxLength": 140,
"description": "Specify the additional information in free text form to complement the mandate information. This parameter is specific to Australia. Both mandate_description and mandate_additional_information parameters are expected to be sent by client for Australia. This parameter is eligible for amendment unilaterally."
},
"payment_execution_not_before_time": {
"title": "payment_execution_not_before_time",
"type": "string",
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.[0-9]{1,3})?(?:Z)|(-)$",
"description": "Indicates that each execution of the mandate payment should not occur before a given time (hh:mm:ss.sssZ) of that execution day. This parameter is specific to Australia."
},
"transfer_arrangement": {
"title": "transfer_arrangement",
"type": "string",
"description": "Indication of future transfer date, conditions of sale and requirement to hold funds. This parameter is specific to Australia.",
"minLength": 1,
"maxLength": 140
},
"resolution_requested_by": {
"title": "resolution_requested_by",
"type": "string",
"minLength": 1,
"maxLength": 30,
"description": "Time used to indicate by when resolution of a bilateral action is requested from the other party to the mandate. This parameter is specific to Australia."
},
"service_id": {
"title": "service_id",
"type": "string",
"minLength": 1,
"maxLength": 30,
"description": "specify a pre-agreed service or level of service between the parties. This parameter is mandatory for Australia."
},
"instruction_priority": {
"title": "instruction_priority",
"type": "string",
"enum": [
"NORM",
"UNAT"
],
"description": " Specifies the priority level of an event. This parameter is specific to Australia and it is mandatory for Australia. Instruction priority” parameter value will be 'UNAT' or 'NORM'."
},
"mandate_start_date": {
"title": "mandate_start_date",
"type": "string",
"pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$",
"description": "Start date of the validity of the mandate. Calender year expressed in the YYYY-MM-DD format."
},
"mandate_expiry_date": {
"title": "mandate_expiry_date",
"type": "string",
"pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$",
"description": "Specify the End date of the validity of the mandate. Calender year expressed in the YYYY-MM-DD format."
},
"mandate_first_collection_date": {
"title": "mandate_first_collection_date",
"type": "string",
"pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$",
"description": "Specify the Date of the first collection of a direct debit as per the mandate. Calender year expressed in the YYYY-MM-DD format."
},
"mandate_final_collection_date": {
"title": "mandate_final_collection_date",
"type": "string",
"pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$",
"description": "Specify the Date of the final collection of a direct debit as per the mandate. Calender year expressed in the YYYY-MM-DD format."
},
"mandate_type": {
"title": "mandate_type",
"type": "string",
"enum": [
"DDMC",
"DDMP",
"DDMU",
"DDTP",
"SOTP",
"OTHR"
],
"description": "Specify the type of mandate.<br>DDMC-Direct Debit Confirmed Electronic Mandate<br>DDMP-Direct Debit Paper Mandate With Paper Authorization<br>DDMU-Direct Debit Unconfirmed Electronic Mandate<br>DDTP-Mandate type relates to Direct Debit payment instrument<br>SOTP-Mandate type relates to Standing Order payment instrument<br>'OTHR' for Third party mandates"
},
"mandate_scheme": {
"title": "mandate_scheme",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the arrangement (unilateral or bilateral) and party that established the mandate. This parameter is mandatory for Australia."
},
"mandate_purpose": {
"title": "mandate_purpose",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the high-level purpose of the mandate. This parameter is mandatory for Australia."
},
"payment_amount_type": {
"title": "payment_amount_type",
"type": "string",
"enum": [
"FIXE",
"USGB",
"VARI",
"BALN"
],
"description": "Specify the mandate payment arrangement.<br>FIXE -Fixed Direct debit amount is fixed.<br>USGB -Usage Based Direct debit amount is based on usage.<br>VARI -Variable Direct debit amount is variable<br>BALN- Balloon Payment. This parameter is mandatory for Australia"
},
"debtor_reference_number": {
"title": "debtor_reference_number",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the unique and unambiguous identification as assigned by the creditor to the referred document shared with the debtor for its own reference."
},
"debtor_code": {
"title": "debtor_code",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the Proprietary identification of the type of the remittance document."
},
"creditor_reference_number": {
"title": "creditor_reference_number",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the unique and unambiguous identification as assigned by the debtor to the referred document shared with the creditor for its own reference."
},
"payment_reference_number": {
"title": "payment_reference_number",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the proprietary identification of the type of the remittance document. This parameter is not applicable for Australia."
},
"currency": {
"title": "currency",
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "Specify the collection account currency. This parameter is mandatory for Australia"
},
"amount": {
"title": "amount",
"type": "number",
"description": "Specify the Fixed amount to be collected from the debtors account. For Australia if payment_amount_type parameter is equal to FIXE then this parameter is mandatory."
},
"maximum_amount": {
"title": "maximum_amount",
"type": "number",
"description": "Specify the Maximum amount that is collected from the debtors account. For Australia if payment_amount_type parameter is not equal to FIXE then this parameter is mandatory."
},
"first_collection_amount": {
"title": "first_collection_amount",
"type": "number",
"description": "Specify the first collection amount to be collected from the debtors account."
},
"final_collection_amount": {
"title": "final_collection_amount",
"type": "number",
"description": "Specify the final collection amount to be collected from the debtors account."
},
"cummulative_amount": {
"title": "cummulative_amount",
"type": "number",
"description": "Specify the cumulative fixed amount to be collected from the debtors account. This parameter is not applicable for Australia."
}
}
},
"Ultimate": {
"title": "Ultimate",
"type": "object",
"properties": {
"ultimate_debtor_name": {
"title": "ultimate_debtor_name",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the name by which the ultimate debtor is known and which is used to identify that party. This parameter is mandatory for Australia."
},
"ultimate_creditor_name": {
"title": "ultimate_creditor_name",
"type": "string",
"minLength": 1,
"maxLength": 35,
"description": "Specify the name by which the ultimate creditor is known and which is used to identify that party. This parameter is mandatory for Australia. For Australia, this parameter is allowed to amend unilaterally."
}
}
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/citi-mandate-client-details"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.