POST /v1/obie/payment_order_consents

Overview

This endpoint creates a payments order consents resource for a set of scopes so that the authorization process can be initiated.

https://sandbox.konsentus.com/v1/obie/payment_order_consents

Request Properties

Headers

Authorization REQUIRED
string
Basic Auth Header
fi_reference_id REQUIRED
string
A string representing the FI authenticating with the system
version REQUIRED
string
A string representing version of the API you are using
ccg_token REQUIRED
string
Client credentials grant token
Content-Type REQUIRED
string
Must be set to: application/json

Further information is available on Authentication Headers, Client Credentials Grant Tokens and Version Header.

Response Properties

data object
response data
consent_id string
Unique identification as assigned to identify the payment order consent resource.
status string
Specifies the status of consent resource in code form.
status_update_date_time string (ISODateTime)
Date and time at which the resource was created.
creation_date_time string (ISODateTime)
Date and time at which the resource was created.
errors array<object>

        See error documentation for fields and descriptions

Responses

201

Request received, payment order consents resource returned.

{
  "data": {
    "consent_id": string,
    "status": string,
    "status_update_date_time": string
    "creation_date_time": string,
  }
}

400

Request received missing parameters or malformed.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

401

Unable to authorize.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

403

Forbidden.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

Response Example

201 CREATED

Success:

{
  "data": {
    "consent_id": "urn-examplebank-intent-12345",
    "status": "AwaitingAuthorisation",
    "status_update_date_time": "2018-07-03T09:37:52.179Z",
    "creation_date_time": "2018-07-03T09:37:52.179Z"
  }
}
Last Updated: 8/9/2019, 3:47:34 PM