Compliance requests Operations
Retrieve an existing compliance request by payment ID.
The compliance request's payment ID.
curl 'https://{prefix}.api.sandbox.checkout.com/compliance-requests/{payment_id}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"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"
}Submit a response to a compliance request.
The compliance request's payment ID.
The response details.
Represents the payload used to respond to a compliance request.
Groups the responded fields by party (sender/recipient).
Optional free-text comment provided with the response.
curl 'https://{prefix}.api.sandbox.checkout.com/compliance-requests/{payment_id}' \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"fields": {
"sender": [
{
"name": "date_of_birth",
"value": null,
"not_available": false
}
],
"recipient": [
{
"name": "date_of_birth",
"value": null,
"not_available": false
}
]
},
"comments": "Optional comment"
}'