Invalidate contract information for an entity

Invalidate contract information for an entity.

  • Method: POST

  • RPC service: contract_routing.ContractScoreCalculator/InvalidateContract

Request example (cURL)

curl --request POST \
  --url https://api.example.com/contract_routing.ContractScoreCalculator/InvalidateContract \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-profile-id: <x-profile-id>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "id": "merchant1"
}
'

Response example (200)

{
  "status": "CONTRACT_INVALIDATION_SUCCEEDED"
}

Headers

  • x-tenant-id (string) — required

  • x-profile-id (string) — required

  • x-api-key (string) — required

Body

Content-Type: application/json

  • id (string) — required Entity identifier to invalidate Example: "merchant1"

Response

200 — application/json Contract invalidation succeeded

Response fields:

  • status (string, enum) — required Status of the invalidation operation. Available options:

    • CONTRACT_INVALIDATION_SUCCEEDED

    • CONTRACT_INVALIDATION_FAILED


Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/intelligent-router-api-reference/contract-routing/invalidate-contract-information-for-an-entity.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/intelligent-router-api-reference/contract-routing/invalidate-contract-information-for-an-entity

Related:

  • Update contract information for an entity: https://api-reference.hyperswitch.io/intelligent-router-api-reference/contract-routing/update-contract-information-for-an-entity

  • Create a routing Rule: https://api-reference.hyperswitch.io/intelligent-router-api-reference/static-routing/create-a-routing-rule