OPopen-finance

Get mandate by resource ID

Returns the content of a mandate object

get/v2/mandates/{resourceId}

Request

  • Base URL
    https://api.open-finance.ai/v2
  • URL
    https://api.open-finance.ai/v2/v2/mandates/{resourceId}
  • 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

mandateResourceIdstring uuid

Technical resource identification

mandateIdstring

Unique identification, as assigned by the creditor, to unambiguously identify the mandate

reasonCodestring
reasonProprietarystring
mandateReferencestring
mandateStatus'received' | 'valid' | 'partiallyAuthorised' | 'rejected' | 'revokedByPSU' | 'expired' | 'terminatedByTPP' | 'suspended'
lastActionDatestring date

Date of the last action on the mandate object

Changes

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