Rapyd.Services.Issuing (rapyd v1.0.0)

Copy Markdown View Source

Rapyd Issuing — issue and manage physical and virtual payment cards.

Covers: Issued Cards, Card Details (PAN/CVV), Card Status, Card Transactions, Remote Authorizations, CNLS Queries, Digital Wallet Tokens, and Hosted Activation Pages.

Summary

Functions

Submit a Card Network Lookup Service (CNLS) query.

Create a hosted card activation page.

Deactivate a digital wallet card token.

Retrieve a card.

Retrieve the PAN and CVV for a card (PCI scope).

Check digital wallet provisioning eligibility.

Get card status history.

Retrieve a digital wallet card token.

Retrieve a single card transaction.

Get results of a previous CNLS query by reference ID.

Retrieve a hosted activation page by token.

Retrieve a remote authorization by ID.

Issue a new card.

List digital wallet card tokens.

List pending remote authorizations.

Personalize an issued card (emboss name, delivery details).

Provision a card to Apple Pay.

Provision a card to Google Pay.

Respond to a remote authorization request.

Set the PIN for an issued card.

Simulate a card block event (sandbox only).

Simulate a card authorization (sandbox only).

Simulate a non-EEA card authorization (sandbox only).

Simulate a card clearing/settlement (sandbox only).

Simulate a non-EEA card clearing (sandbox only).

Update a card (metadata, limits).

Update a card's status (activate, block, unblock, lost, stolen).

Update the status of a digital wallet card token.

Functions

activate_card(client, card_id)

@spec activate_card(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Activate a card.

block_card(client, card_id)

@spec block_card(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Block a card.

cnls_query(client, params)

@spec cnls_query(Rapyd.Client.t(), map()) :: {:ok, map()} | {:error, Rapyd.Error.t()}

Submit a Card Network Lookup Service (CNLS) query.

create_hosted_activation_page(client, params)

@spec create_hosted_activation_page(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Create a hosted card activation page.

deactivate_card_token(client, card_id, token_id)

@spec deactivate_card_token(Rapyd.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Deactivate a digital wallet card token.

get_card(client, card_id)

@spec get_card(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a card.

get_card_details(client, card_id)

@spec get_card_details(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve the PAN and CVV for a card (PCI scope).

get_card_eligibility(client, card_id)

@spec get_card_eligibility(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Check digital wallet provisioning eligibility.

get_card_status_history(client, card_id)

@spec get_card_status_history(Rapyd.Client.t(), String.t()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

Get card status history.

get_card_token(client, card_id, token_id)

@spec get_card_token(Rapyd.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a digital wallet card token.

get_card_transaction(client, card_id, txn_id)

@spec get_card_transaction(Rapyd.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a single card transaction.

get_cnls_query_results(client, reference_id)

@spec get_cnls_query_results(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Get results of a previous CNLS query by reference ID.

get_hosted_activation_page(client, token)

@spec get_hosted_activation_page(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a hosted activation page by token.

get_remote_authorization(client, auth_id)

@spec get_remote_authorization(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a remote authorization by ID.

issue_card(client, params)

@spec issue_card(Rapyd.Client.t(), map()) :: {:ok, map()} | {:error, Rapyd.Error.t()}

Issue a new card.

list_card_tokens(client, card_id, filters \\ %{})

@spec list_card_tokens(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

List digital wallet card tokens.

list_card_transactions(client, card_id, filters \\ %{})

@spec list_card_transactions(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

List transactions on a card.

list_cards(client, filters \\ %{})

@spec list_cards(Rapyd.Client.t(), map()) :: {:ok, list()} | {:error, Rapyd.Error.t()}

List issued cards.

list_remote_authorizations(client, filters \\ %{})

@spec list_remote_authorizations(Rapyd.Client.t(), map()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

List pending remote authorizations.

personalize_card(client, params)

@spec personalize_card(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Personalize an issued card (emboss name, delivery details).

provision_apple_pay(client, card_id, params)

@spec provision_apple_pay(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Provision a card to Apple Pay.

provision_google_pay(client, card_id, params)

@spec provision_google_pay(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Provision a card to Google Pay.

respond_to_remote_authorization(client, auth_id, params)

@spec respond_to_remote_authorization(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Respond to a remote authorization request.

set_pin(client, params)

@spec set_pin(Rapyd.Client.t(), map()) :: {:ok, map()} | {:error, Rapyd.Error.t()}

Set the PIN for an issued card.

simulate_block_card(client, card_id)

@spec simulate_block_card(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Simulate a card block event (sandbox only).

simulate_card_auth(client, params)

@spec simulate_card_auth(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Simulate a card authorization (sandbox only).

simulate_card_auth_non_eea(client, params)

@spec simulate_card_auth_non_eea(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Simulate a non-EEA card authorization (sandbox only).

simulate_card_clearing(client, params)

@spec simulate_card_clearing(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Simulate a card clearing/settlement (sandbox only).

simulate_card_clearing_non_eea(client, params)

@spec simulate_card_clearing_non_eea(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Simulate a non-EEA card clearing (sandbox only).

unblock_card(client, card_id)

@spec unblock_card(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Unblock a card.

update_card(client, card_id, params)

@spec update_card(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Update a card (metadata, limits).

update_card_status(client, params)

@spec update_card_status(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Update a card's status (activate, block, unblock, lost, stolen).

update_card_token_status(client, card_id, token_id, params)

@spec update_card_token_status(Rapyd.Client.t(), String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Update the status of a digital wallet card token.