@spec activate_card(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Activate a card — Activate a card

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec activate_card!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like activate_card/2 but returns the value directly and raises on error.

@spec create_card_image(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Create Card Image — Create a card image entity. Note that this does not include the image data itself. You can upload the image data via a subsequent uploadCardImageData request using the ID created here.

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec create_card_image!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like create_card_image/2 but returns the value directly and raises on error.

@spec create_gateway(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Create Gateway — Create a new Authorization Gateway Configuration

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec create_gateway!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like create_gateway/2 but returns the value directly and raises on error.

@spec get_card(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get Card — Get the details about a card that has been issued

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_card!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()

Like get_card/3 but returns the value directly and raises on error.

@spec get_card_barcode(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get Card Barcode — This endpoint is for testing environment only to provide access to barcode of a test card

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_card_barcode!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_card_barcode/3 but returns the value directly and raises on error.

@spec get_card_image_data(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get Card Image Data — Get card image data

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_card_image_data!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_card_image_data/3 but returns the value directly and raises on error.

@spec get_card_image_details(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get Card Image Details — Get card image details

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_card_image_details!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_card_image_details/3 but returns the value directly and raises on error.

@spec get_card_widget_url(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get card widget URL — This endpoint returns a URL address of the specified widget for a given card

Options

Query options: :widget_type, :customer_id, :account_id, :card_id

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_card_widget_url!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like get_card_widget_url/2 but returns the value directly and raises on error.

@spec get_client_access_token(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get a client token — Create a client access token for interacting with a card. This token will be used on the client to identify the card for flows like viewing Full PAN or setting the PIN in a PCI compliant manner.

Options

• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_client_access_token!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_client_access_token/3 but returns the value directly and raises on error.

@spec get_client_single_use_token(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get single-use token — This endpoint returns a single-use access token. This type of token authorizes a single request to access API endpoints and data associated with a particular user

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_client_single_use_token!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like get_client_single_use_token/2 but returns the value directly and raises on error.

@spec get_gateway(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get Gateway — Get the details of an Authorization Gateway that has been configured

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec get_gateway!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()

Like get_gateway/3 but returns the value directly and raises on error.

@spec issue_card(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Issue a Card — Issue or reissue a new card for a customer

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec issue_card!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like issue_card/2 but returns the value directly and raises on error.

@spec list_card_image_details(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List Card Image Details — List all card image details

Options

Query options: :customer_id

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec list_card_image_details!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_card_image_details/2 but returns the value directly and raises on error.

@spec list_card_products(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List Card Products

Options

Query options: :limit, :page_token

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec list_card_products!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_card_products/2 but returns the value directly and raises on error.

@spec list_cards(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List Cards — List of cards matching query parameters

Options

Query options: :customer_id, :account_id, :emboss_name, :last_four, :expiration_date, :card_type, :card_brand, :form, :card_product_id, :card_status, :postal_code, :limit, :page_token, :sort_by

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec list_cards!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_cards/2 but returns the value directly and raises on error.

@spec list_changes(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List Card Changes — List card change history

Options

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec list_changes!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like list_changes/3 but returns the value directly and raises on error.

@spec list_gateways(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List Gateways — List of gateways matching query parameters

Options

Query options: :limit, :page_token

• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec list_gateways!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_gateways/2 but returns the value directly and raises on error.

@spec update_card(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Update Card — Integrators can update the card resource to change status, update shipping (if the card hasn't been shipped) or edit metadata.

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec update_card!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()

Like update_card/3 but returns the value directly and raises on error.

@spec update_card_image_details(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Update Card Image Details — Update card image details. The only detail that can be updated is the card status as APPROVED or REJECTED.

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec update_card_image_details!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like update_card_image_details/3 but returns the value directly and raises on error.

@spec update_gateway(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Update Gateway — Update Authorization Gateway configuration

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec update_gateway!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like update_gateway/3 but returns the value directly and raises on error.

@spec upload_card_image_data(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Upload Card Image — Upload card image data

Options

• :body — request body (map), required.
• :idempotency_key — see Synctera.Idempotency.
• :device_info — a %Synctera.DeviceInfo{} overriding the client default.

@spec upload_card_image_data!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like upload_card_image_data/3 but returns the value directly and raises on error.