Inquire for the latest status of a transaction using UETR.

GET

/paymentservices/v1/payments/:uetr

GET

/citiconnect/prod/paymentservices/v1/payments/:uetr

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

{
  "debtor": {
    "account": "897654321"
  },
  "creditor": {
    "account": "44227754321"
  },
  "method": {
    "country": "TH",
    "instructed_currency": "THB",
    "method": "IP",
    "type": "CT"
  },
  "transaction": {
    "end_to_end_id": "r/434SKtUcdGQ",
    "uetr": "4f09214d-296c-494b-8e9c-810bf1d9fc93",
    "creation_date_time": "2022-09-13T08:23:49.112Z",
    "status": {
      "date_time": "2022-09-13T08:23:56.223Z",
      "code": "ACCC",
      "description": "Completed"
    },
    "network_id": "209323283934",
    "local_reference": "7634an78543",
    "bill_id_1": "77889900",
    "type": "credit",
    "purpose": "CASH",
    "value_date": "2022-09-13",
    "instructed_amount": 29876.98,
    "settlement_currency": "THB",
    "settlement_amount": 29876.98,
    "reasons": [
      {
        "description": "Citi validated and commercially completed the transaction. Account posting may be pending."
      }
    ]
  }
}

Get the latest status of a payment transaction using unique end-to-end transaction reference (UETR). Currently, you can get the latest transaction status up to 90 days from the payment initiation date. If the latest transaction status date is 90+ days old, the endpoint responds with HTTP status 404 (not found).

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

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

debtorobject

Debtor information

creditorobject

Object representing the receiver of a transaction.

methodobject

transactionobject

message_idstringOptional<=35 characters

Message Identification

If transaction.status.code = ACCC/PDNG/RJCT/ACWP then this field may be present

ultimate_debtorobjectOptional

ultimate_creditorobjectOptional

intermediarylist of objectsOptional

Intermediary agent information status

instructed_agentobjectOptional

instructing_agentobjectOptional

account_validationobjectOptional

initiating_partyobjectOptional

original_paymentobjectOptional

Either populate uetr OR (end_to_end_id AND value_date) for the refund to be processed

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error