Get a compliance request
Retrieve an existing compliance request by payment ID.
SecurityOAuth2: OAuth or API Key: ApiSecretKey
Responses
200
Compliance request retrieved successfully.
400
Compliance request could not be retrieved. See the response body for more information.
401
Unauthorized request
403
Forbidden
404
Compliance request not found
get/compliance-requests/{payment_id}
Request samples
- curl
- Java
- C#
- Python
Response samples
- 200
application/json
{- "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"
}Respond to a compliance request
Submit a response to a compliance request.
SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
Request Body schema: application/json
The response details.
Responses
202
Response to compliance request accepted
400
Response to compliance request could not be submitted. See the response body for more information.
401
Unauthorized request
403
Forbidden
404
Compliance request not found
409
The compliance request has already been responded to.
post/compliance-requests/{payment_id}
Request samples
- Payload
- curl
- Java
- C#
- Python
application/json
{- "fields": {
- "sender": [
- {
- "name": "date_of_birth",
- "value": null,
- "not_available": false
}
], - "recipient": [
- {
- "name": "date_of_birth",
- "value": null,
- "not_available": false
}
]
}, - "comments": "Optional comment"
}