Citi Mandates API

The Mandates API from Citi — 4 operation(s) for mandates.

Operations 5

POST /v1/mandates Initiate and Create A Mandate #
GET /v1/mandates Retrieve Mandate Response From Citi System #
PATCH /v1/mandates/status Change the Status of a Mandate #
PATCH /v1/mandates/amend Amend Specific Information In An Existing Mandate #
PATCH /v1/mandates/recall Recall Existing Mandate by Initiator #

Documentation

📖
Documentation
https://developer.citi.com/apidocs/authentication/authentication-only-guide
📖
APIReference
https://developer.citi.com/apidocs/authentication/authentication-api-reference
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/authentication/citi-authentication.yml
📖
Documentation
https://developer.citi.com/apidocs/account-reporting/balances/balances-overview
📖
APIReference
https://developer.citi.com/apidocs/account-reporting/balances/balances-api-reference
📖
Documentation
https://developer.citi.com/apidocs/outgoing-payments/payments/payments-overview
📖
APIReference
https://developer.citi.com/apidocs/outgoing-payments/payments/payments-api-reference
📖
Documentation
https://developer.citi.com/apidocs/accept-payments/online-payment-acceptance/online-payment-acceptance-overview
📖
APIReference
https://developer.citi.com/apidocs/accept-payments/online-payment-acceptance/online-payment-acceptance-api-reference
📖
Documentation
https://developer.citi.com/apidocs/commercial-cards/virtual-cards/commercial-cards-overview
📖
APIReference
https://developer.citi.com/apidocs/commercial-cards/virtual-cards/virtual-cards-api-reference
📖
Documentation
https://developer.citi.com/apidocs/fx/gateway/citifx-gateway-overview
📖
APIReference
https://developer.citi.com/apidocs/fx/instant-fx/instant-fx-overview
📖
Documentation
https://developer.citi.com/apidocs/custody/accounts/accounts-overview
📖
APIReference
https://developer.citi.com/apidocs/custody/safekeeping-positions/safekeeping-positions-api-reference
📖
Documentation
https://developer.citi.com/apidocs/transfer-agency/accounts/accounts-overview
📖
APIReference
https://developer.citi.com/apidocs/transfer-agency/accounts/accounts-api-reference
📖
Documentation
https://developer.citi.com/apidocs/open-banking/ukraine-open-banking/ukraine-open-banking-overview
📖
APIReference
https://developer.citi.com/apidocs/open-banking/ukraine-open-banking/ukraine-bank-data-sharing-api-reference
📖
Documentation
https://developer.citi.com/apidocs/trade/standby-letters-of-credit/trade-overview
📖
APIReference
https://developer.citi.com/apidocs/trade/standby-letters-of-credit/trade-api-reference
📖
Documentation
https://developer.citi.com/apidocs/gateway-services/gateway-services-user-guide
📖
APIReference
https://developer.citi.com/apidocs/gateway-services/gateway-services-api-reference
📖
Documentation
https://developer.citi.com/apidocs/additional-payment-services/additional-payment-services/additional-payment-services-overview
📖
APIReference
https://developer.citi.com/apidocs/additional-payment-services/additional-payment-services/additional-payment-services-api-reference

Specifications

Other Resources

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/citi-mandates-api"
All apis
curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

citi-mandates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'This API supports the Mandate Initiation Request, Inquiry, Amendment, Cancellation, Suspension/Release, and Recall


    The Mandate Initiation Request message is used to request the set-up of an instruction that allows the debtor agent to accept instructions from the creditor, through the creditor agent, to debit the account of the debtor (mandate).'
  version: 1.0.0
  title: eMandate Service Mandates API
servers:
- url: https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices
  description: dev gateway url
- url: https://tts.sit.apib2b.citi.com/citiconnect/uat1/recievablesservices
  description: uat gateway url
- url: https://tts.apib2b.citi.com/citiconnect/prod/recievablesservices
  description: production gateway url
- url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb/recievablesservices
  description: sandbox gateway url
security:
- clientCredentials: []
tags:
- name: Mandates
paths:
  /v1/mandates:
    post:
      summary: Initiate and Create A Mandate
      description: This endpoint allows the merchant to initiate the mandate creation process from client's ERP to Citi's system in a secure manner.
      operationId: createMandate
      parameters:
      - name: client_id
        in: query
        description: Unique reference which was shared during CitiConnect API Onboarding (`client_id` which is used during OAuth token generation).
        required: true
        schema:
          type: string
          example: 4683fd9f-03fe-4268-b5da-93bf8203fd91
      - name: Idempotency-Id
        in: header
        required: true
        schema:
          type: string
          maxLength: 128
          example: a44cbb60123414bba3bb
        description: Your unique identification for a POST request for CitiConnect API to perform idempotency check. Same `client_id` is to be maintained by the client if client wants to retry request within 48 hours.
      requestBody:
        description: Mandate client details required
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MandateClientDetails'
      callbacks:
        asynchronous-mandatecreation-push-notification:
          $ref: '#/components/callbacks/CreationPushNotification'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MandateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: VC00001
                  issue: Invalid value provided for property `mandateDetails.paymentExecutionNotBeforeTime`
                  action: Please provide valid value for property `mandateDetails.paymentExecutionNotBeforeTime`
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00007
                  issue: Authorization failed
                  action: Please try again with valid credentials.
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00001
                  issue: Method not supported
                  action: Please use valid HTTP verb.
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00002
                  issue: Media type not supported
                  action: Resend the request with content-type as application/JSON in header
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00004
                  issue: Unable to serve your request at this moment
                  action: Please try again later. If this error persists, please reach out to australia.citiservice@citi.com
      tags:
      - Mandates
    get:
      summary: Retrieve Mandate Response From Citi System
      description: A Mandate inquiry is used to check the details/status of the mandates.
      operationId: inquiryMandate
      parameters:
      - name: country
        in: query
        required: true
        description: Country
        schema:
          type: string
          pattern: ^[A-Z]{2,2}$
          description: Country Is mandatory
      - name: mandate_request_identification
        in: query
        required: false
        description: mandate_request_identification
        schema:
          type: string
          minLength: 1
          maxLength: 35
          description: mandate_request_identification is used to retrieve the status of a mandate.<br>Populate value from unique value generated by Citi Connect.
      - name: mandate_identification
        in: query
        required: false
        description: mandate_identification
        schema:
          type: string
          minLength: 1
          maxLength: 35
          description: mandate_identification is used to retrieve the status of a mandate.
      callbacks:
        asynchronous-mandateStatusInquiry-push-notification:
          $ref: '#/components/callbacks/MandateStatusInquiryPushNotification'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InquiryMandateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: VC00001
                  issue: Invalid value provided for property country
                  action: Please provide valid value for property country
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00007
                  issue: Authorization failed
                  action: Please try again with valid credentials.
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00001
                  issue: Method not supported
                  action: Please use valid HTTP verb.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00004
                  issue: Unable to serve your request at this moment
                  action: Please try again later. If this error persists, please reach out to australia.citiservice@citi.com
      tags:
      - Mandates
  /v1/mandates/status:
    patch:
      summary: Change the Status of a Mandate
      description: This endpoint allows you to change the status of a mandate. A status change should always be performed as a unilateral operation. The status change can only be performed when the mandate is currently active or suspended. Releasing a suspended mandate can only be performed by the party that suspended the mandate.
      operationId: updateMandateStatus
      parameters:
      - name: client_id
        in: query
        description: Unique reference which was shared during CitiConnect API Onboarding (`client_id` which used during OAuth token generation).
        required: true
        schema:
          type: string
          example: 4683fd9f-03fe-4268-b5da-93bf8203fd91
      - name: mandate_identification
        in: query
        description: Specify unique identification, as assigned by the clearing scheme, to identify the mandate.
        required: true
        schema:
          type: string
          example: CRED14243536457658
      requestBody:
        description: Update mandate client details required.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMandateDetails'
      callbacks:
        asynchronous-mandatestatuschange-push-notification:
          $ref: '#/components/callbacks/UpdateStatusPushNotification'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MandateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: VC00001
                  issue: Invalid value provided for property mandateDetails.paymentExecutionNotBeforeTime
                  action: Please provide valid value for property mandateDetails.paymentExecutionNotBeforeTime
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00007
                  issue: Authorization failed
                  action: Please try again with valid credentials.
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00001
                  issue: Method not supported
                  action: Please use valid Http Verb.
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00002
                  issue: Media type not supported
                  action: Resend the request with content-type as application/JSON in header
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00004
                  issue: Unable to serve your request at this moment
                  action: Please try again later. If this error persists, please reach out to australia.citiservice@citi.com
      tags:
      - Mandates
  /v1/mandates/amend:
    patch:
      summary: Amend Specific Information In An Existing Mandate
      description: 'This endpoint allows to perform amend an existing mandate by Initiator.


        Mandates amended by initiator can be unilateral or bilateral. When applied unilaterally, then the amendment will be done immediately. When applied bilaterally, the amendment will remain pending until it is completed or declined by the counter party, or until it is recalled by the proposing party, or until it expires.'
      operationId: amendmandate
      parameters:
      - name: client_id
        in: query
        description: Unique reference which was shared during CitiConnect API Onboarding (client_id which used during OAuth token generation)
        required: true
        schema:
          type: string
          example: 4683fd9f-03fe-4268-b5da-93bf8203fd91
      - name: mandate_identification
        in: query
        description: Specify Unique identification, as assigned by the clearing scheme, to identify the mandate.
        required: true
        schema:
          type: string
          example: CRED9945461615156344324324354
      requestBody:
        description: Update Mandate client status details required
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmendMandateDetails'
      callbacks:
        asynchronous-mandateamendment-push-notification:
          $ref: '#/components/callbacks/AmendmentPushNotification'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MandateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: VC00001
                  issue: Invalid value provided for property mandateDetails.paymentExecutionNotBeforeTime
                  action: Please provide valid value for property mandateDetails.paymentExecutionNotBeforeTime
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00007
                  issue: Authorization failed
                  action: Please try again with valid credentials.
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00001
                  issue: Method not supported
                  action: Please use valid Http Verb.
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00002
                  issue: Media type not supported
                  action: Resend the request with content-type as application/JSON in header
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00004
                  issue: Unable to serve your request at this moment
                  action: Please try again later. If this error persists, please reach out to australia.citiservice@citi.com
      tags:
      - Mandates
  /v1/mandates/recall:
    patch:
      summary: Recall Existing Mandate by Initiator
      description: This endpoint allows the client to request the recall of an existing mandate. Initiator client can recall the mandate if the mandate creation or mandate amendment is not approved or declined by the payer customer within the given stipulated time. Client can define business expiry time up to 5 calender days and after which initiator client can recall the mandate, if the payer customer did not approve or decline.
      operationId: recallMandate
      parameters:
      - name: client_id
        in: query
        description: Unique reference which was shared during CitiConnect API onboarding (client_id which used during OAuth token generation).
        required: true
        schema:
          type: string
          example: 4683fd9f-03fe-4268-b5da-93bf8203fd91
      - name: mandate_identification
        in: query
        description: Specify unique identification, as assigned by the clearing scheme, to identify the mandate.
        required: true
        schema:
          type: string
          example: CRED9945461615156344324324354
      requestBody:
        description: Recall
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecallMandate'
      callbacks:
        asynchronous-mandaterecall-push-notification:
          $ref: '#/components/callbacks/MandateRecallPushNotification'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MandateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: VC00001
                  issue: Invalid value provided for property mandateDetails.paymentExecutionNotBeforeTime
                  action: Please provide valid value for property mandateDetails.paymentExecutionNotBeforeTime
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00007
                  issue: Authorization failed
                  action: Please try again with valid credentials.
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00001
                  issue: Method not supported
                  action: Please use a valid HTTP verb.
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00002
                  issue: Media type not supported
                  action: Resend the request with content-type as application/JSON in the header.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                ref_id: ec689822-9864-4c4d-9d68-222467627902
                error_details:
                - code: CC00004
                  issue: Unable to serve your request at this moment
                  action: Please try again later. If this error persists, please reach out to australia.citiservice@citi.com
      tags:
      - Mandates
components:
  schemas:
    MandateClientDetails:
      title: MandateClientDetails
      type: object
      required:
      - mandate_details
      properties:
        mandate_details:
          $ref: '#/components/schemas/MandateDetails'
        initiating_party:
          $ref: '#/components/schemas/InitiatingParty'
        debtor:
          $ref: '#/components/schemas/Debtor'
        creditor:
          $ref: '#/components/schemas/Creditor'
        ultimate:
          $ref: '#/components/schemas/Ultimate'
    AmendDetails:
      title: AmendDetails
      type: object
      required:
      - amend_reason
      properties:
        amend_reason:
          title: amend_reason
          type: string
          enum:
          - MD16
          - MD17
          - MD18
          - MS02
          - MS03
          - NARR
          description: Specification of amendment reason <br> MD16-Requested By Customer <br> MD17-Requested By Initiating Party<br> MD18-Requested By Initiating Party And Customer<br>MS02-Not Specified Reason Customer<br>MS03-Not Specified Reason Agent Generated <br> MSUC-Mandate suspended after 7 consecutive unsuccessful collections <br> NARR- Reason is provided as narrative information
        amend_additional_information:
          title: amend_additional_information
          type: string
          description: Specification of amendment additional information
          example: Requested by Customer
    StatusRequest:
      title: StatusRequest
      type: object
      required:
      - change
      properties:
        change:
          title: change
          type: string
          enum:
          - CANC
          - SUSP
          - RELS
          description: Specify the status request type <br> - CANC = Cancelled (Cancel a mandate) <br> - SUSP = Suspended (Suspend an active mandate) <br> - RELS = Release (Release a suspended mandate)
          example: CANC
    AmendmentCreditor:
      title: AmendmentCreditor
      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. For Australia, this parameter is allowed to amend unilaterally.
          example: Samiel
        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.
          example: OlympusA
        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.
          example: Rodas enclave
        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.
          example: Ireland
        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.
          example: IR
        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.
          example: '12345'
        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.
          example: Dublin
        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.
          example: +989-4198941
        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.
          example: +989-4198941
        email:
          title: email
          type: string
          format: email
          description: Specify the Address for electronic mail (e-mail). This parameter is not applicable to Australia.
          example: abc@gmail.com
        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 either `ORG` or `PVT`. For Australia, this parameter is allowed to amend unilaterally.
          example: ORG
        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. For Australia, this parameter is allowed to amend unilaterally.
          example: BANK
        other_identification:
          title: other_identification
          type: string
          minLength: 1
          maxLength: 35
          description: Specify the value of an organization/private identification. For Australia this parameter is allowed to amend unilaterally.
          example: JUNO1552212
        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.'
          example: '1234567891'
        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). For Australia this parameter is not allowed to amend.
          example: CITI4564464
        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. For Australia this parameter is not allowed to amend.
          example: Bank Branch Code
        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.
          example: scheme identification
        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. For Australia, this parameter is allowed to amend unilaterally.
          example: account
        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). For Australia this parameter is allowed to amend unilaterally.
          example: BBAN
        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. For Australia, this parameter is allowed to amend unilaterally.
          example: '9190000001253'
        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 the 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. For Australia, this parameter is allowed to amend unilaterally.
          example: TELE
    MandateResponse:
      title: MandateResponse
      type: object
      description: MandateResponse
      required:
      - mandate_request_identification
      - status
      properties:
        mandate_acceptance:
          title: mandate_response_mandate_acceptance
          type: object
          properties:
            mandate_request_identification:
              title: mandate_request_identification
              type: string
              description: Specify Unique identification, as assigned by the clearing scheme, to identify the mandate.
              minLength: 1
              maxLength: 35
            status:
              title: status
              type: string
              description: Specifies the status of the mandate registration requested.<br>PDNG=Pending<br>RJCT= Rejected<br>CRTD = Created<br>ACTV = Active<br>SUSD = Suspended<br>CNCD = Cancelled
              enum:
              - PDNG
              - RJCT
              - CRTD
              - ACTV
              - SUSD
              - CNCD
    UpdateMandateDetails:
      title: UpdateMandateDetails
      type: object
      required:
      - status_request
      - request_reason
      - mandate_status_update
      properties:
        status_request:
          $ref: '#/components/schemas/StatusRequest'
        request_reason:
          $ref: '#/components/schemas/RequestReason'
        mandate_status_update:
          $ref: '#/components/schemas/MandateStatusUpdate'
    MandateStatusUpdate:
      title: MandateStatusUpdate
      type: object
      required:
      - country
      properties:
        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
          example: AU
    RequestReason:
      title: RequestReason
      type: object
      required:
      - code
      properties:
        code:
          title: code
          type: string
          enum:
          - MD16
          - MD17
          - MD18
          - MD19
          - MD20
          - MD21
          - MD22
          - MS02
          - MS03
          - NARR
        

# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-mandates-api-openapi.yml