Skip to main content

Consent Success

The URL that will be used by Open Gateway (OG) upon successful consent flow. This URL will have the following query parameters

  • state - the contents of the state value passed during the prime call
  • agreementId - the agreementId of the agreement that this callback relates to. Will match the response from the corresponding prime call.

Software products can use these query params to co-relate the callback with the original prime request.

Sample URL​

See https://guides.biza.io/og/developer-resources/open-gateway-api#tag/CDR:-Actions/operation/primeCDRSharingV1

https://<prime.redirectUri>?state=test-state&agreementId=c0969358-a7c3-472c-a29a-f80abbdb6179