Inquire for the latest status of a transaction using UETR and Message Id. | Citi Docs Demo

curl -G https://b2b.api.icg.citi.com/citiconnect/prod/paymentservices/v1/payments/uetr/messages/0c4fb98bd77a446896bb0c88b3b8f75a \
     -H "Authorization: Bearer <token>" \
     -d client_id=6d3cf821-db6d-496d-bec0-064a362e9c31

{
  "message_id": "bea176bf1d5d48cc88fb1d0e06af90g5",
  "creation_date_time": "2023-01-10T07:45:10.489Z",
  "message_type": "RFR",
  "original_payment": {
    "message_id": "M2017111202120020101BTRF00000000011",
    "creation_date_time": "2023-01-01T17:06:49.712Z",
    "instruction_id": "2017111202120020101BSTRF00000000011",
    "end_to_end_id": "I364836174511668",
    "transaction_id": "20230411021000089T1BXPAY09462848400",
    "uetr": "bea176bf-1d5d-48cc-88fb-1d0e06af43e7",
    "clearing_reference": "7634an78543",
    "instructed_amount": 144.56,
    "instructed_currency": "USD",
    "value_date": "2023-01-01",
    "message_name_identification": "123456BKLO",
    "debtor": {
      "bank_id": "021000089",
      "name": "John M",
      "street_name": "1515 3rd Street",
      "building_number": "A1234",
      "postal_code": "94158",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "org_id": "12333333",
      "birth_date": "1950-09-26",
      "birth_city": "San Francisco",
      "birth_country": "US"
    },
    "creditor": {
      "bank_id": "000000010",
      "name": "BeakalWoldemariam",
      "street_name": "5th Street",
      "building_number": "123444",
      "postal_code": "22079",
      "city": "Lorton",
      "state": "CA",
      "country": "US",
      "org_id": "6563",
      "birth_date": "1967-11-27",
      "birth_city": "San Francisco",
      "birth_country": "US"
    }
  },
  "message": {
    "case_id": "M20230411021000089T1BXPY09462848401",
    "country": "US",
    "reasons": {
      "code": "AC03",
      "description": "InvalidCreditorAccountNumber"
    },
    "requestor_bank_id": "0027849",
    "requestor_name": "Khalq",
    "status": {
      "code": "RCVD",
      "date_time": "2023-01-10T08:59:10.489Z",
      "description": "Received"
    }
  }
}

Returns the status of a non-payment message initiated through the messages/POST endpoint. See Express Instant Payments Error Codes for a complete list of messages and their explanations.

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.

Path parameters

uetrstringRequiredformat: "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"

Unique end-to-end transaction reference

message_idstringRequired<=35 characters

Unique message id

Query parameters

client_idstringRequired

Your unique identification, same as the identification you use for OAuth token generation, Citi shared with you during your CitiConnect API onboarding

Response headers

request_idstringOptional

Citi's unique identification for your request

Response

message_idstringRead-only<=35 characters

Message Identification

creation_date_timedatetimeRead-only

UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ)

Date time when a message was created

message_typeenum

Message Type as provided by the customer

RFR - Request for Refund (camt.056)
RRFR - Response to Request for Refund(camt.029)
PCR - Payment Confirmation Request
RPCR - Response to Payment Confirmation Request
RFP - Request for Payment (pain.013)
RRFP - Response to Request for Payment (pain.014)
RFICS - Request for Information Compliance
RRFICS - Response to Request for Information Compliance

original_paymentobjectOptionalRead-only

messageobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error