Get The Status Of An eMandate | Citi Docs Demo

curl -G https://tts.apib2b.citi.com/citiconnect/prod/emandateservices/v2/emandatestatusinquiry \
     -H "Accept: Accept" \
     -H "Authorization: Bearer <token>" \
     -H "region: region" \
     -d mandateRefId=mandateRefId \
     -d schemeId=schemeId

{
  "mandate_acceptance": [
    {
      "accepted": "NO",
      "mandate_request_identification": "e27kpp59yb",
      "reasons": [
        {
          "code": "PDNG",
          "description": "READY_FOR_EXPORT"
        }
      ],
      "scheme_identification": "w24no84ybp",
      "mandate_identification": "test2402"
    }
  ],
  "mandate_full_details": {
    "mandate_details": {
      "mandate_request_identification": "string",
      "mandate_occurence": {
        "sequence_type": "RCUR",
        "frequency": "string"
      },
      "mandate_type": {
        "local_instrument": {},
        "service_level": {}
      },
      "tracking_indicator": false
    },
    "debtor": {
      "name": "Samiel",
      "account": {
        "currency_code": "string",
        "bic": "CITIGB2LXXX",
        "branch_country": "string",
        "identification": "00100560",
        "iban": "GB62CITI18500800100560"
      },
      "address": {
        "address_line_1": "OlympusA",
        "address_line_2": "Rodas enclave",
        "town_name": "Ireland",
        "postal_code": "12345",
        "country_code": "IE"
      },
      "contact": {
        "mobile_number": "9167632379",
        "email": "kalpita1.sawant@citi.com"
      }
    },
    "creditor": {
      "name": "string",
      "account": {
        "currency_code": "string",
        "bic": "CLRBGB21",
        "branch_country": "string",
        "iban": "GB42CLRB04041320000046"
      }
    },
    "scheme": {
      "identification": "string",
      "type": "string",
      "name": "string",
      "private_identification": "w24no84ybp"
    }
  }
}

The eMandate Status Inquiry API V2 allows you to access the status of your eMandate and generates eMandate details with the status of the transaction. After the initial eMandate initiation call, there is an ability to view transaction status at any later point using the eMandate Status Inquiry API V2. You generate these details by passing values for the following fields in your request: Mandate Req ID, Scheme ID. The request follows custom schema formatting, and the response follows JSON message format.

<font size=‘2’>Content-Type: Supports ‘application/json’.
Authorization: The OAuth Token prefixed with “Bearer“ and space in between.

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

mandateRefIdstringRequired

Unique identification assigned/generated by the initiating party or by Origix platform respectively to clearly identify the transaction. This Identification is passed on, unchanged, throughout the entire end-to-end chain.

schemeIdstringRequired

SchemeId assigned to each merchant during onboarding process.

mandateIdstringOptional

mandateId is to retreive the status of mandate.

payer_reference_numberstringOptional

Unique and unambiguous identification as assigned by the creditor to the referred document shared with the debtor for its own reference.
Specify the reference document for the mandate, to be referred by debtor..

max_transaction_amountdoubleOptional

Maximum amount that may be collected from the debtor’s account,per instruction.
Amount of the transaction. Determine how and when a currency fractional (decimals) should be indicated in each transaction.Maximum of 15 Digits (Including decimals).

currency_codestringOptional

Maximum amount that may be collected from the debtor’s account, per instruction.
Amount of the transaction. Determine how and when a currency fractional (decimals) should be indicated in each transaction. Maximum of 15 Digits (Including decimals).

Response

mandate_acceptancelist of objects

Indicates whether the mandate request was accepted or rejected or in-progress.
Accepted - ‘Yes’
In-Progress, Rejected - ‘No’
Possible DDI status for BACS -‘Active’, ‘Cancelled’, ‘Complete’, ‘Pending’, ‘Ready for Export’, ‘Exported’
Possible DDI status for SEPA -‘Active’, ‘Cancelled’, ‘Complete’, ‘Pending’
Possible Mandate status for HK - ‘Processed’, ‘CB-Rejected’, ‘Deleted’

mandate_full_detailsobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

405

Method Not Allowed Error

415

Unsupported Media Type Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response

Errors