List transaction data templates

GET 
/v2/config/digital-wallet/openid/sdjwt/transaction-data-definitions

Lists the transaction data templates that the digital wallet supports.

Each template gives a type and the JSON Schema for that type. Set the type as the transactionDataDefinitionType of a presentation definition. The transactionData that you then send with a verification request must follow the JSON Schema of that type.

The list is fixed and is the same for every organisation. The response has no pagination.

The server keeps the answer in a cache, so a change in the digital wallet is not visible until the cache entry expires.

Request

Header Parameters

X-SandboxOrgId stringrequired
Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.
The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.
X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.
The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.
Example: 6889e1a4c5b2f30001a3d710

Responses

200

The server listed the transaction data templates.

Response Headers

application/json

Schema

Schema

transactionDataDefinitions object[]required
Transaction data templates that the digital wallet supports.
Array [
label stringrequired
Human-readable name of the transaction data template.
type stringrequired
Possible values: [payment_data, data_agreement_record, data_disclosure_agreement_record, qes_data, payment, login_risk_transaction, account_access, emandate, login_risk_transaction_non_ts12]
Type identifier of the transaction data template. Use this value as the transactionDataDefinitionType of a presentation definition.
schema objectrequired
JSON Schema that gives the structure and the validation rules of the transaction data of this type.
property name* any
JSON Schema that gives the structure and the validation rules of the transaction data of this type.
]

Example (from schema)

{
  "transactionDataDefinitions": [
    {
      "label": "Payment Data",
      "type": "payment_data",
      "schema": {}
    }
  ]
}

400

The organisation is unknown, the digital wallet deployment is not resolved, or the digital wallet did not answer.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...