CHcheckout
Compliance requests

Get a compliance request

Retrieve an existing <a href="https://www.checkout.com/docs/business-operations/respond-to-compliance-requests">compliance request</a> by payment ID.

get/compliance-requests/{payment_id}

Request

Path parameters

payment_idstring required

The compliance request's payment ID.

Response

Compliance request retrieved successfully.

payment_idstring nullable

The compliance request's payment ID.

client_idstring nullable

The compliance request's client ID.

entity_idstring nullable

The compliance request's entity ID.

segment_idstring nullable

The compliance request's segment ID.

amountstring nullable

The payment's transaction amount.

currencystring nullable

The payment's transaction currency, as a three-letter <a href="https://www.checkout.com/docs/developer-resources/codes/currency-codes">ISO currency code</a>.

recipient_namestring nullable

The payment's recipient's name.

requested_onstring nullable

The date and time when the compliance request was initiated.

statusstring nullable

The compliance request's status.

transaction_referencestring nullable

The payment's transaction reference.

sender_referencestring nullable

The payment sender's reference.

last_updatedstring nullable

The date and time when the compliance request was last updated.

sender_namestring nullable

The payment sender's name.

payment_typestring nullable

The payment type.

Example response

{
  "payment_id": "pay_fun26akvvjjerahhctaq2uzhu4",
  "client_id": "cli_vkuhvk4vjn2edkps7dfsq6emqm",
  "entity_id": "ent_azsiyswl7bwe2ynjzujy7lcjca",
  "segment_id": "seg_siopnqocrc4ehgyer4tpepq5pp",
  "amount": "38.23",
  "currency": "HKD",
  "recipient_name": "Jia Tsang",
  "requested_on": "2026-02-04T15:46:44.9663151Z",
  "status": "responded",
  "fields": {
    "sender": [
      {
        "name": "date_of_birth",
        "type": "date",
        "value": "2000-01-01"
      }
    ],
    "recipient": [
      {
        "name": "date_of_birth",
        "type": "date",
        "value": "2000-01-01"
      }
    ]
  },
  "transaction_reference": "ref-abc",
  "sender_reference": "ref-def",
  "last_updated": "2026-02-04T15:47:18.6326970Z",
  "sender_name": "Ali Farid",
  "payment_type": "PayToCard"
}

Changes

No recorded changes to this operation across all 1 revision of this API.