Get card order items

get/cardorders/{id}/items

API Version

Returns the item list of a specific card order.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v2/cardorders/{id}/items

Query Parameters

Required

Optional

The number of card order items returned per page. Default: 10.

Specifies the position of an element in a list of card orders. The response includes a list of card order items that starts at the specified offset.

Default: 0, which means that the response contains all the elements in the list of card order items.

Path Parameters

Required

Optional

The unique identifier of the card order.

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.
dataarray[object]
List of card order items in the card order batch.
balancePlatformstring
The unique identifier of the balance platform.
cardobject
The status of the card delivery.

Possible values: created, rejected, processing, produced, shipped, delivered, notApplicable, unknown.
errorMessagestring
An error message.
statusstring
The status of the PIN delivery.
trackingNumberstring
The tracking number of the PIN delivery.
cardOrderItemIdstring
The unique identifier of the card order item.
creationDatestring
The date and time when the event was triggered, in ISO 8601 extended format. For example, 2020-12-18T10:15:30+01:00.
idstring
The ID of the resource.
paymentInstrumentIdstring
The unique identifier of the payment instrument related to the card order item.
pinobject
Contains information about the status of the PIN delivery.
errorMessagestring
An error message.
statusstring
The status of the PIN delivery.
trackingNumberstring
The tracking number of the PIN delivery.
shippingMethodstring
The shipping method used to deliver the card or the PIN.
hasNextboolean
Indicates whether there are more items on the next page.
hasPreviousboolean
Indicates whether there are more items on the previous page.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this 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
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Get card order items

HTTP Responses

200 - OK

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error