Synctera.ExternalCardsAlpha (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'External Cards (alpha)' endpoints.

Code generated by scripts/generate.py from the Synctera OpenAPI spec. Do not edit by hand — re-run mix generate (or python3 scripts/generate.py) to regenerate.

Summary

Functions

Create external card from token — Create an external card from token - You must first tokenize the external card using the external card iframe. You will receive a token for the external card upon successful completion. This endpoint will persist the external card and associate it to a customer. The customer's name and address should match that of the external card as entered in the iframe. <br>NB: Tokens should be associated right away. Tokens not associated within 30 mins of creation will be invalidated.</br> NB: If a valid business_id is provided, the address verification for the external card will be done against the address of the business. Otherwise, the address of the customer will be used. In either case, the name of the customer will be used to match the name of the cardholder.

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

Create external card transfer — Create a external card transfer

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

Get a external card — Get an external card

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

Get an external card transfer — Get an external transfer

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

List external transfers — List external card transfer

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

List external cards — List external cards

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

Functions

create_external_card_from_token(client, opts \\ [])

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

Create external card from token — Create an external card from token - You must first tokenize the external card using the external card iframe. You will receive a token for the external card upon successful completion. This endpoint will persist the external card and associate it to a customer. The customer's name and address should match that of the external card as entered in the iframe. <br>NB: Tokens should be associated right away. Tokens not associated within 30 mins of creation will be invalidated.</br> NB: If a valid business_id is provided, the address verification for the external card will be done against the address of the business. Otherwise, the address of the customer will be used. In either case, the name of the customer will be used to match the name of the cardholder.

Options

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

create_external_card_from_token!(client, opts)

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

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

create_external_card_transfer(client, opts \\ [])

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

Create external card transfer — Create a external card transfer

Options

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

create_external_card_transfer!(client, opts)

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

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

get_external_card(client, external_card_id, opts \\ [])

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

Get a external card — Get an external card

Options

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

get_external_card!(client, external_card_id, opts)

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

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

get_external_card_transfer(client, transfer_id, opts \\ [])

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

Get an external card transfer — Get an external transfer

Options

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

get_external_card_transfer!(client, transfer_id, opts)

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

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

list_external_card_transfers(client, opts \\ [])

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

List external transfers — List external card transfer

Options

Query options: :limit, :page_token, :customer_id, :external_card_id, :originating_account_id, :type

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

list_external_card_transfers!(client, opts)

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

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

list_external_cards(client, opts \\ [])

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

List external cards — List external cards

Options

Query options: :limit, :page_token, :customer_id, :business_id

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

list_external_cards!(client, opts)

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

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