Get customer's contracts by

Required Scopes(any of): CUSTOMER_CONTRACT_READ, CUSTOMER_READ

Returns customer's contracts by one of the given parameters

SecurityApiKeyAuth
Request
query Parameters
cardNumber
string

Card number to identify the customer

cardNumberFormat
string (CardNumberFormat)
Default: "DECIMAL"

Defines how card numbers are interpreted

Enum: "DECIMAL" "HEX_MSB" "HEX_LSB"
debtorId
string

Unique ID of the debtor

qrCodeUuid
string <uuid>
Deprecated

QR code UUID to identify the customer

barcode
string

Barcode to identify the customer

customerNumber
string

Customer number to identify the customer

status
string (ContractStatus)

The contracts desired or current status

Enum: Description
ACTIVE

Identifies active contracts

INACTIVE

Identifies inactive contracts

Example: status=ACTIVE
Responses
200

OK

400

Validation of the request failed.

401

Authentication failed. No api-key, wrong api-key or wrong header name.

403

Authorization failed. The caller has no privilege to the given resource.

404

Entity does not exists.

409

Conflict

429

Access denied - rate limit is exceeded.

500

Unexpected system error.

get/v1/customers/contracts/by
Request samples 
Response samples 
application/json
[
  • {
    }
]