Retrieve Mandate Response From Citi System | Citi Docs Demo

{
  "mandate_acceptance": {
    "mandate_request_identification": "string",
    "mandate_identification": "string",
    "status": "RJCT"
  },
  "error_details": [
    {
      "code": "string",
      "issue": "string"
    }
  ],
  "mandate_details": {
    "country": "AU",
    "sequence_type": "RCUR",
    "payment_frequency": "MNTH",
    "tracking_indicator": false,
    "mandate_start_date": "2021-05-21",
    "becs_user_identification": "123456",
    "mandate_description": "DESCRIPTION OF THE MANDATE",
    "count_per_period": "124334143234.34232",
    "point_in_time": "02",
    "mandate_additional_information": "Pay to creditor",
    "payment_execution_not_before_time": "23:59:59.999Z",
    "transfer_arrangement": "Transfer Arrangement",
    "resolution_requested_by": "Resolution requested by",
    "service_id": "bo Service id",
    "instruction_priority": "NORM",
    "mandate_expiry_date": "2030-01-15",
    "mandate_first_collection_date": "2023-01-15",
    "mandate_final_collection_date": "2030-01-15",
    "mandate_type": "DDMC",
    "mandate_scheme": "AUPM",
    "mandate_purpose": "RETL, OTHR",
    "payment_amount_type": "FIXE",
    "debtor_reference_number": "SEAN",
    "debtor_code": "MUN2003A",
    "creditor_reference_number": "313442344",
    "payment_reference_number": "3345235242",
    "currency": "AUD",
    "amount": 1000000,
    "maximum_amount": 1243.23,
    "first_collection_amount": 123.34,
    "final_collection_amount": 123.34,
    "cummulative_amount": 123.34
  },
  "initiating_party": {
    "name": "Citi Bank",
    "account": "12354354354546",
    "other_identification_category": "ORG",
    "other_identification_type": "AUBN",
    "other_identification": "JUNO1552212",
    "bank_routing_code": "CITI4564464"
  },
  "debtor": {
    "name": "Samiel",
    "bank_routing_code": "CITI4564464",
    "address_1": "OlympusA",
    "address_2": "Rodas enclave",
    "address_3": "Ireland",
    "country_code": "AT",
    "postal_code": "12345",
    "town_name": "Linz",
    "mobile_number": "+989-4198941",
    "fax_number": "+989-4198941",
    "email": "sample@sample.com",
    "other_identification_category": "ORG",
    "other_identification_type": "EMPL",
    "other_identification": "JUNO1552212",
    "iban": "ABCD12345AA1234",
    "bank_branch_code": "BSB123456",
    "account": "912345678910",
    "account_type": "AIIN",
    "proxy_id": "9190000001253",
    "proxy_type": "TELE"
  },
  "creditor": {
    "name": "Samiel",
    "address_1": "OlympusA",
    "address_2": "Rodas enclave",
    "address_3": "Ireland",
    "country_code": "IR",
    "postal_code": "12345",
    "town_name": "Dublin",
    "mobile_number": "+989-4198941",
    "fax_number": "+989-4198941",
    "email": "abc@gmail.com",
    "other_identification_category": "ORG",
    "other_identification_type": "BANK",
    "other_identification": "JUNO1552212",
    "iban": "1234567891",
    "bank_routing_code": "CITI4564464",
    "bank_branch_code": "Bank Branch Code",
    "scheme_identification": "scheme identification",
    "account": "account",
    "account_type": "AIIN",
    "proxy_id": "9190000001253",
    "proxy_type": "TELE"
  },
  "ultimate": {
    "ultimate_debtor_name": "Debtor Name",
    "ultimate_creditor_name": "Creditor Name"
  }
}

A Mandate inquiry is used to check the details/status of the mandates.

Authentication

AuthorizationBearer

All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token.

Query parameters

countrystringRequiredformat: "^[A-Z]{2,2}$"

Country

mandate_request_identificationstringOptional1-35 characters

mandate_request_identification

mandate_identificationstringOptional1-35 characters

mandate_identification

Response

mandate_acceptanceobjectOptional

error_detailslist of objectsOptional

mandate_detailsobjectOptional

initiating_partyobjectOptional

debtorobjectOptional

creditorobjectOptional

ultimateobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

405

Method Not Allowed Error

500

Internal Server Error