Skip to main content

Validate transaction data

POST 
/v2/config/digital-wallet/openid/sdjwt/transaction-data

Validates the transaction data that a holder approved during an OID4VCI credential issuance.

The server reads the key binding JWT of paymentWalletAttestation, calculates the hash of the transaction data, and compares it with the hashes in the key binding JWT. It then stores the result. Read transactionDataVerified of the answer to see the result.

Rules that the server applies:

  • Send the payload in transactionData or in transactionDataBase64, but not in both.
  • transactionDataHashesAlg must hold exactly one value, and that value must be sha-256.
  • The organisation must have a key.

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

Body

required

Transaction data and the Payment Authenticator presentation that proves the holder agreed to the transaction.

    paymentWalletAttestation stringrequired

    Payment Authenticator Verifiable Presentation token that the holder sent. The token must hold a key binding JWT with the transaction data hashes.

    transactionDataHashesAlg string[]required

    Possible values: [sha-256], >= 1, <= 1

    Hash algorithm that the key binding JWT uses for the transaction data hashes. Give exactly one value, and the only supported value is sha-256.

    transactionData object

    Transaction data payload in plain JSON. Send this property or transactionDataBase64, but not both.

    property name* any

    Transaction data payload in plain JSON. Send this property or transactionDataBase64, but not both.

    transactionDataBase64 string

    Transaction data payload as a base64url encoded string, in the form that the OpenID4VP Authorization Request carries. Send this property or transactionData, but not both.

Responses​

The issuer validated the transaction data and stored the result.

Response Headers
    Schema
      transactionDataHistory objectrequired

      The stored transaction data record. Read transactionDataVerified to see the validation result.

      id stringrequired

      Internal record identifier of the transaction data record. It is not the same value as transactionDataId. Always use transactionDataId to address the record.

      transactionDataId stringrequired

      Unique identifier that the server gives to the transaction data record. Use this identifier in the path of the read endpoint.

      credentialExchangeId stringrequired

      Identifier of the credential issuance history record that this transaction data belongs to. The value is an empty string when the record belongs to no credential issuance.

      openIdOrganisationId stringrequired

      Identifier of the OpenID4VC deployment that validated the transaction data.

      transactionDataBase64s string[]

      Base64url encoded transaction data strings that the issuer verified against the key binding JWT. The value is null when the issuer verified no string.

      paymentWalletAttestation stringrequired

      Payment Authenticator Verifiable Presentation token that the holder sent.

      transactionData object

      Transaction data payload in plain JSON, for example the payee and the amount of a payment. The value is null when the request gave the payload as transactionDataBase64.

      property name* any

      Transaction data payload in plain JSON, for example the payee and the amount of a payment. The value is null when the request gave the payload as transactionDataBase64.

      transactionDataVerified booleanrequired

      true when the issuer verified the transaction data hashes against the key binding JWT.

      vpTokenDecoded object

      Decoded payload of the Verifiable Presentation token that the holder sent. The value is null when the issuer could not decode the token.

      property name* any

      Decoded payload of the Verifiable Presentation token that the holder sent. The value is null when the issuer could not decode the token.

      createdAt numberrequired

      Unix timestamp, in seconds, of the moment that the server created this record.

      updatedAt numberrequired

      Unix timestamp, in seconds, of the moment that the server last changed this record.

    Loading...
    Last updated on