Get specific sandbox agreement

GET 
/v1/sandbox/agreements/:mockAgreementId

Only for managing sandbox data, not part of the production API. Get single agreement created using POST /v1/sandbox/agreements. Both private and corporate agreements can be retrieved.

Request

Path Parameters

mockAgreementId stringrequired

Header Parameters

Accept string
Advertises which content types, expressed as MIME types, the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the Content-Type response header.
Example: application/json
Accept-Charset string
Advertises which character set the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice within the Content-Type response header.
Example: utf-8
Accept-Encoding string
Advertises which content encoding, usually a compression algorithm, the client is able to understand. Using content negotiation, the server selects one of the proposals, uses it and informs the client of its choice with the Content-Encoding response header.
Example: deflate, gzip;q=1.0, *;q=0.5
Accept-Language string
Advertises which natural languages the client is able to understand, and which locale variant is preferred. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the Content-Language response header.
Example: en-US,en;q=0.7,nb;q=0.3
Host string
The domain name of the server (for virtual hosting), and (optionally) the TCP port number on which the server is listening.
Example: openbanking.sgsparebank.no
X-Request-ID stringrequired
Request identifier, unique to the call, as determined by the TPP.
Example: 4eba4445-1a4b-47b8-bdd5-4e56ef026b19
TPP-Signature-Certificate stringrequired
The certificate used for signing the request in base64 encoding.
Example: MIFFTzCCAzegAkIBAgMJANnQVDLqktJUMA0GCS....8WLZOX3YxNoH4k==
Signature stringrequired
HTTP Message Signature as specified by https://tools.ietf.org/html/draft-cavage-http-signatures-10 with requirements imposed by Berlin Group's NextGenPSD2 Framework.
• keyId must be formatted as keyId="SN=XXX,CA=YYY" where XXX is the serial number of the signing certificate in hexadecimal encoding and YYY is the full Distinguished Name of the Certificate Authority having certificate
• algorithm must identify the same algorithm for the signature as presented in the signing certificate and should be rsa-sha256
• headers must contain date, digest, x-request-id, psu-id, psu-corporate-id, and tpp-redirect-uri when available
• signature must be computed as Base64(RSA-SHA256(signingString))
If any values in the Signature header is ISO-8859-1 or UTF-8 encoded you need to URL encode the Signature header according to RFC 2047 which means MIME encoding the signature.
Also the signature must be wrapped using this format: =?charset?encoding?encoded signature?=
Example of this encoding: =?utf-8?B?a2V5QTQsQ0E9Mi41LjQuOTc9IzB........jMTM1MDUzNDQ0ZTRmMmQ0NjUz?=
Java example of how to implement encoding:
if (charset.equals(StandardCharsets.UTF_8)) {
  Signature = String.format("=?utf-8?B?%s?=", Base64.getEncoder().encodeToString(signature.getBytes(StandardCharsets.UTF_8)));
}
Example: keyId="SN=6AEB4444FBAAD267,CA=O=PSDNO-FSA-ABCA,L=Trondheim,C=NO", algorithm="rsa-sha256", headers="date x-request-id tpp-redirect-uri psu-id", signature="***************"

Responses

201

application/json

Schema

Schema

id stringrequired
name stringrequired
owner string

engagements

object[]

required

Array [

id stringrequired

customer stringrequired

name string

account

object

required

bban stringrequired

iban stringrequired

roles string[]required

Possible values: [OWNER, DISPOSAL, VIEW, REGISTER, APPROVE, INTERNAL_TRANSFER, SALARY]

accessRights booleanrequired

paymentRights booleanrequired

transferRights booleanrequired

registerLimit int32required

approvalLimit int32required

]

_links objectrequired

Example (from schema)

{
  "id": "enc!!oHc4g0K00_s2115LNqycmoQWN8tluC1Apmivegog7Ix3EpASoZ-Doe3mR7tuLEyvRbS7CdzKM1FnHYKx4KTKyA==",
  "name": "Testavtale",
  "owner": "999999991",
  "engagements": [
    {
      "id": "enc!!s5D4NqQEMBHkWZB-bKMJPBtBfr5D6qhsKNsOQ1um5jHiJdEThVowZHquX20B7jNGop831hQj_9sXLqAVwls9OA==",
      "customer": "01085800481",
      "name": "ABC",
      "account": {
        "bban": "90412263056",
        "iban": "NO2390412263056"
      },
      "roles": [
        "VIEW",
        "REGISTER"
      ],
      "accessRights": false,
      "paymentRights": false,
      "transferRights": false,
      "registerLimit": 0,
      "approvalLimit": 0
    }
  ],
  "_links": {}
}

application/json;charset=utf-8

{
  "id": "enc!!oHc4g0K00_s2115LNqycmoQWN8tluC1Apmivegog7Ix3EpASoZ-Doe3mR7tuLEyvRbS7CdzKM1FnHYKx4KTKyA==",
  "name": "Testavtale",
  "owner": "999999991",
  "engagements": [
    {
      "id": "enc!!s5D4NqQEMBHkWZB-bKMJPBtBfr5D6qhsKNsOQ1um5jHiJdEThVowZHquX20B7jNGop831hQj_9sXLqAVwls9OA==",
      "customer": "01085800481",
      "account": {
        "bban": "90412263056",
        "iban": "NO2390412263056"
      },
      "roles": [
        "VIEW",
        "REGISTER"
      ],
      "accessRights": false,
      "paymentRights": false,
      "transferRights": false,
      "registerLimit": 0,
      "approvalLimit": 0
    }
  ],
  "_links": {}
}

Loading...