Consent status

GET

/api/v2/consents

Code sample: Shell / cURL

curl --request GET \
  --url https://api.ztlpay.io/api/v2/consents \
  --header 'Authorization: Bearer <token>' \
  --header 'PSU-IP-Address: 192.158.1.38' \
  --header 'PSU-User-Agent: Mozilla/5.0 (Windows NT 10.0; …) Gecko/20100101 Firefox/63.0' \
  --header 'consent-id: 3a797348-ef0c-4f52-b821-fdfcdb98c4d9'

• Production environment
• Sandbox environment for testing

Authorizations

• OAuth2Sandbox
  api://ac0d1aea-5e3a-463f-9dd1-194898ee5820/.default
• OAuth2Production
  api://1f115cad-5576-4db9-a7f9-8921c47a86e4/.default

Parameters

Header Parameters

consent-id

required

string format: uuid

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

A valid consentId

PSU-IP-Address

string

Example

192.158.1.38

AAA IP Address of the end-user initiating the payment. DO NOT use any other IP address than what you can collect from the current user session that uses your system (don’t use something stored in your DB). This information is used by the banks to manage traffic and handle security.

PSU-User-Agent

string

The forwarded Agent header field of the HTTP request between PSU and TPP.

Example

Mozilla/5.0 (Windows NT 10.0; …) Gecko/20100101 Firefox/63.0

Responses

200

Consent status

Media typeapplication/json

object

id

required

An ID that will be used to identify the consent. Used in all AIS and PIS calls.

string format: uuid

status

required

• AWAITING_AUTHORIZATION Requires user approval
• VALID Valid consent, can be used for AIS and PIS.
• REJECTED Consent creation or authentication failed.
• EXPIRED Consent has expired, a new consent must be created to replace the expired consent.
• REVOKED Consent was revoked either by user or bank. A new consent must be created to replace the revoked consent.

string

Allowed values: AWAITING_AUTHORIZATION VALID REJECTED EXPIRED REVOKED

sca

One of:

redirect

redirect

object

type

required

Redirect link to redirect authorization flow. After the redirect, the url will contain the query parameter status, with the possible values [success, rejected, cancelled]

string

Allowed values: redirect

url

required

Url to start authorization redirect flow

string

qr

qr

object

type

required

Qr image, used with bank app to scan image for authentication

string

Allowed values: qr

qrCode

Qr code which can be used to generate Qr image. Can be used to customize image. Might not be available for all banks.

string

qrImage

required

Qr code as image, base64 encoded

string

qrType

required

• Dynamic Dynamic image, valid for 1 sec. Must be refreshed by fetching updated approval status.
• Static Static image, valid for a longer period dependent on bank. Usually 30 seconds.

string

Allowed values: Dynamic Static

validUntil

string format: date

Example

{
  "id": "B44E9297-934D-4975-8951-7843B16DF63F",
  "status": "AWAITING_AUTHORIZATION",
  "sca": {
    "type": "redirect",
    "url": "https://api.ztlpay.io/api/v2/consents/sca/redirect/start/6212d401-1785-4739-8843-55fe4eb9dad4"
  },
  "validUntil": "2022-01-01"
}

400

Bad Request

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

403

Forbidden

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

404

Not found

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

409

Conflict

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

500

Internal server error

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

503

Service unavailable

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9