Variable Recurring Payments

Open banking mandate authorisation callback

Exchanges the authorisation code and id_token returned by the ASPSP redirect for a mandate authorisation outcome.

post/open-banking/mandates/{mandate_id}/auth/callback

Request

Base URL
https://test-api.acquired.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/acquired/apis/acquired-api/docs/open-banking/mandates/:mandate_id/auth/callback/post.ts
A function with typed inputs. Its response is checked against the schema.

mandate_idstring required

The unique ID assigned to the open banking mandate.

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Midstring uuid

Unique ID assigned by Acquired.com connecting to a specific acquiring bank.

codestring required

Authorisation code returned by the ASPSP.

id_tokenstring required

ID token returned by the ASPSP redirect.

webhook_urlstring uri

Optional webhook URL to receive mandate status updates.

{
  "code": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "webhook_url": "https://webhook.example.com/ob/mandate-status"
}

object required

Empty object returned on success.

{}