Get sandbox customer
GET/v1/sandbox/customers
Only for managing sandbox data, not part of the production API. Get list of all customers created using POST /v1/sandbox/customers. customerNumber should be used as identifier when performing SCA in test.
Request
Query Parameters
set to true if you need the request to include mock accounts owned by this customer. Set to false if you do not need it and you want a faster response.
set to true if you need the request to include all agreements related to this customer. Set to false if you do not need it and you want a faster response.
Header Parameters
- keyId must be formatted as
keyId="SN=XXX,CA=YYY"
whereXXX
is the serial number of the signing certificate in hexadecimal encoding andYYY
is the ful 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
, andtpp-redirect-uri
when available - signature must be computed as
Base64(RSA-SHA256(signingString))
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.
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.
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.
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.
The domain name of the server (for virtual hosting), and (optionally) the TCP port number on which the server is listening.
Request identifier, unique to the call, as determined by the TPP.
The certificate used for signing the request in base64 encoding.
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.
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)));
}
Responses
- 200
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
Array [
]
]
Possible values: [PRIVATE
, CORPORATE
]
agreements
object[]
required
_links
object
required
self
object
required
engagements
object
required
_links
object
required
self
object
required
[
{
"customerId": "enc!!IZ5FQKfTP6SdoIoD_nyvKlJt1cHv_JOIku7xUgmyui1a18SoQ0YA4nfH7c28PLxf",
"customerNumber": "01085800481",
"customerType": "PRIVATE",
"customerName": "Testodius Test2",
"agreements": [
{
"id": "enc!!9LnOfAAQ-HgKXsU61DSZc0b1M9k-2FkJ4Hunsoe4mfTD3AOU_Evq91NkmNgd1lK9RRT6jE7MV7aAPxm7gMrQLg==",
"name": "Testodius Test2",
"engagements": [],
"_links": {
"self": {
"href": "/v1/sandbox/agreements/enc!!9LnOfAAQ-HgKXsU61DSZc0b1M9k-2FkJ4Hunsoe4mfTD3AOU_Evq91NkmNgd1lK9RRT6jE7MV7aAPxm7gMrQLg==",
"verbs": [
"GET",
"DELETE"
]
},
"engagements": {
"href": "/v1/sandbox/agreements/enc!!9LnOfAAQ-HgKXsU61DSZc0b1M9k-2FkJ4Hunsoe4mfTD3AOU_Evq91NkmNgd1lK9RRT6jE7MV7aAPxm7gMrQLg==/engagements",
"verbs": [
"POST",
"DELETE"
]
}
}
}
],
"accounts": [],
"cardAccounts": [],
"_links": {
"self": {
"href": "/v1/sandbox/customers/enc!!IZ5FQKfTP6SdoIoD_nyvKlJt1cHv_JOIku7xUgmyui1a18SoQ0YA4nfH7c28PLxf",
"verbs": [
"GET",
"DELETE"
]
}
}
}
]
[
{
"customerId": "enc!!IZ5FQKfTP6SdoIoD_nyvKlJt1cHv_JOIku7xUgmyui1a18SoQ0YA4nfH7c28PLxf",
"customerNumber": "01085800481",
"customerType": "PRIVATE",
"customerName": "Testodius Test2",
"agreements": [
{
"id": "enc!!9LnOfAAQ-HgKXsU61DSZc0b1M9k-2FkJ4Hunsoe4mfTD3AOU_Evq91NkmNgd1lK9RRT6jE7MV7aAPxm7gMrQLg==",
"name": "Testodius Test2",
"engagements": [],
"_links": {
"self": {
"href": "/v1/sandbox/agreements/enc!!9LnOfAAQ-HgKXsU61DSZc0b1M9k-2FkJ4Hunsoe4mfTD3AOU_Evq91NkmNgd1lK9RRT6jE7MV7aAPxm7gMrQLg==",
"verbs": [
"GET",
"DELETE"
]
},
"engagements": {
"href": "/v1/sandbox/agreements/enc!!9LnOfAAQ-HgKXsU61DSZc0b1M9k-2FkJ4Hunsoe4mfTD3AOU_Evq91NkmNgd1lK9RRT6jE7MV7aAPxm7gMrQLg==/engagements",
"verbs": [
"POST",
"DELETE"
]
}
}
}
],
"accounts": [],
"cardAccounts": [],
"_links": {
"self": {
"href": "/v1/sandbox/customers/enc!!IZ5FQKfTP6SdoIoD_nyvKlJt1cHv_JOIku7xUgmyui1a18SoQ0YA4nfH7c28PLxf",
"verbs": [
"GET",
"DELETE"
]
}
}
}
]