Get a list of devices associated with an entity

get/scaAssociations

API Version

Returns a paginated list of the SCA devices associated with a specific entity.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/scaAssociations

Query Parameters

Required

Optional

The index of the page to retrieve. The index of the first page is 0 (zero).

Default: 0.

Minimum: 1Maximum: 10

The number of items to have on a page.

Default: 5.

Min length: 1Max length: 100

The unique identifier of the entity.

The type of entity you want to retrieve a list of associations for.

Possible values: accountHolder or paymentInstrument.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
_linksobject
A list of hyperlinks to resources related to this response.
firstobject
The link to the first page of the list.
hrefstring
lastobject
The link to the last page of the list.
hrefstring
nextobject
The link to the next page of the list.
hrefstring
previousobject
The link to the previous page of the list.
hrefstring
selfobject
The link to the list page you are currently viewing.
hrefstring
dataarray[object]
Contains a list of associations and their corresponding details.
createdAtstring
The date and time when the association was created.
entityIdstring
Min length: 1Max length: 100
The unique identifier of the entity.
entityTypestring
The type of the entity.

Possible values: accountHolder or paymentInstrument.
scaDeviceIdstring
Min length: 30Max length: 30
The unique identifier of the SCA device.
scaDeviceNamestring
Max length: 64
The human-readable name for the SCA device that was registered.
scaDeviceTypestring
The type of the device.
statusstring
The status of the association.

Possible values: active or pendingApproval.
itemsTotalinteger
The total number of items available.
pagesTotalinteger
The total number of pages available.
400 - Bad request
The request contains invalid input and fails validation.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Get a list of devices associated with an entity

HTTP Responses

200 - OK

400 - Bad request

401 - Unauthorized

403 - Forbidden

500 - Internal Server Error