Revoke a manual handoff

Revokes an active manual handoff and invalidates grants.

Revocation closes the handoff and revokes active interactive grants. If payer submit may have happened, Collate must reconcile before projecting payer truth.

Returns

Returns handoff closure state.

Authentication

AuthorizationBearer

API key passed as Authorization: Bearer <API_KEY>.

Path parameters

authorization_idstringRequired

Authorization ID returned by POST /v1/prior-authorizations.

handoff_idstringRequired

Manual handoff ID returned by POST /manual-handoffs.

Request

This endpoint expects an object.

reasonstringRequired

notesstring or nullOptional

Response

Successful Response

manualHandoffIdstring

stateenum

Allowed values:

authorizationobject

resultenum or null

reconciliationobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error

$	curl -X POST https://api.sandbox.trycollate.ai/v1/prior-authorizations/authorization_id/manual-handoffs/handoff_id/revoke \
>	-H "If-Match: If-Match" \
>	-H "Authorization: Bearer <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"reason": "string"
>	}'

1	{
2	"manualHandoffId": "string",
3	"state": "offered",
4	"authorization": {
5	"id": "string",
6	"version": 1,
7	"status": "requires_action"
8	},
9	"result": "completed_reported",
10	"reconciliation": {
11	"id": "string",
12	"state": "pending"
13	}
14	}

Returns

Authentication

Path parameters

Headers

Request

Response

Errors

Authentication

Path parameters

Headers

Request

Response

Errors