Package com.adyen.service.balanceplatform

Class CardOrdersApi

  • public class CardOrdersApi
extends Service

    • Constructor Detail

      • CardOrdersApi

        public CardOrdersApi​(Client client)
        Card orders constructor in package.
        Parameters:
        client - Client (required)

      • CardOrdersApi

        public CardOrdersApi​(Client client,
                     String baseURL)
        Card orders constructor in package. Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
        Parameters:
        client - Client (required)
        baseURL - String (required)

    • Method Detail

      • listCardOrders

        public PaginatedGetCardOrderResponse listCardOrders​(String id,
                                                    String cardManufacturingProfileId,
                                                    String status,
                                                    String txVariantCode,
                                                    OffsetDateTime createdSince,
                                                    OffsetDateTime createdUntil,
                                                    OffsetDateTime lockedSince,
                                                    OffsetDateTime lockedUntil,
                                                    String serviceCenter,
                                                    Integer offset,
                                                    Integer limit,
                                                    RequestOptions requestOptions)
                                             throws ApiException,
                                                    IOException
        Get a list of card orders
        Parameters:
        id - String Query: The unique identifier of the card order. (optional)
        cardManufacturingProfileId - String Query: The unique identifier of the card manufacturer profile. (optional)
        status - String Query: The status of the card order. (optional)
        txVariantCode - String Query: The unique code of the card manufacturer profile. Possible values: **mcmaestro**, **mc**, **visa**, **mcdebit**. (optional)
        createdSince - OffsetDateTime Query: Only include card orders that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. (optional)
        createdUntil - OffsetDateTime Query: Only include card orders that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. (optional)
        lockedSince - OffsetDateTime Query: Only include card orders that have been locked on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. (optional)
        lockedUntil - OffsetDateTime Query: Only include card orders that have been locked on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**. (optional)
        serviceCenter - String Query: The service center at which the card is issued. The value is case-sensitive. (optional)
        offset - Integer Query: Specifies the position of an element in a list of card orders. The response includes a list of card orders that starts at the specified offset. **Default:** 0, which means that the response contains all the elements in the list of card orders. (optional)
        limit - Integer Query: The number of card orders returned per page. **Default:** 10. (optional)
        requestOptions - RequestOptions Object to store additional data such as idempotency-keys (optional)
        Returns:
        PaginatedGetCardOrderResponse
        Throws:
        ApiException - if fails to make API call
        IOException