OPopen-finance

Get mandate status

Can check the status of a mandate resource

get/v2/mandates/{resourceId}/status

Request

  • Base URL
    https://api.open-finance.ai/v2
  • URL
    https://api.open-finance.ai/v2/v2/mandates/{resourceId}/status
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.open-finance.ai/oauth/token scopes: read:mandates

Path parameters

resourceIdstring uuid required

Technical resource identification of the mandate

Response

Response

mandateStatus'received' | 'valid' | 'partiallyAuthorised' | 'rejected' | 'revokedByPSU' | 'expired' | 'terminatedByTPP' | 'suspended'

The overall lifecycle status of the mandate

mandateReasonCodestring

Mandate reason code

mandateReasonProprietarystring

Proprietary mandate reason code

Changes

No recorded changes to this operation across all 1 revision of this API.