api
Cancel Copay Request
Cancel an existing Copay Request if the status is 'Pending' or 'Triage'.
post/api/v1/copay_request/cancel
Request
- Base URLhttps://api.truepill.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"copay_request_token": "4526d90a",
"request_id": "bf11da52584eb54188bf8ebed33ef15f"
}Response
Accepted
Example response
{
"request_id": "40277544de5c6ba685dc4161e189d3e2",
"status": "success",
"details": {
"code": "CUSTOMER_CANCELLATION_REQUEST",
"description": "Copay Request Cancelled by Customer Request",
"message": "Accepted: Copay Request 34f68f71f980f78bb0bc has been cancelled."
}
}Changes
No recorded changes to this operation across all 2 revisions of this API.