Rapyd.Services.Disburse (rapyd v1.0.0)

Rapyd Disburse — send payouts to beneficiaries worldwide.

Covers: Payouts, Beneficiaries, Senders, Payout Method Types, and hosted Beneficiary Tokenization Pages.

Summary

Functions

cancel_payout(client, payout_id)

Cancel a payout.

complete_payout(client, payout_id)

Simulate payout completion (sandbox only).

confirm_payout(client, payout_id)

Confirm a payout (moves it from ACT to processing).

create_beneficiary(client, params)

Create a beneficiary.

create_beneficiary_tokenization_page(client, params)

Create a hosted beneficiary tokenization page.

create_extended_beneficiary(client, params)

Create an extended beneficiary (full identity fields required).

create_payout(client, params)

Create a payout.

create_sender(client, params)

Create a sender.

delete_beneficiary(client, beneficiary_id)

Delete a beneficiary.

delete_sender(client, sender_id)

Delete a sender.

get_beneficiary(client, beneficiary_id)

Retrieve a beneficiary.

get_beneficiary_tokenization_page(client, token)

Retrieve a beneficiary tokenization page.

get_payout(client, payout_id)

Retrieve a payout.

get_payout_method_type_fields(client, payout_method_type)

Get required fields for a payout method type.

get_payout_required_fields(client, payout_method_type, sender_entity_type, beneficiary_entity_type, sender_country, sender_currency)

Get required fields for a payout method type with entity-type scoping.

get_sender(client, sender_id)

Retrieve a sender.

list_payout_method_types(client, params \\ %{})

List available payout method types for a sender/beneficiary combination.

list_payouts(client, filters \\ %{})

List payouts.

set_payout_response(client, params)

Set the merchant response to an inbound payout request.

update_beneficiary(client, beneficiary_id, params)

Update a beneficiary.

update_payout(client, payout_id, params)

Update a payout.

update_sender(client, sender_id, params)

Update a sender.

upload_payout_document(client, payout_id, params)

Upload a supporting document to a payout record.

validate_beneficiary(client, params)

Validate a beneficiary's account details.

Functions

cancel_payout(client, payout_id)

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

Cancel a payout.

complete_payout(client, payout_id)

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

Simulate payout completion (sandbox only).

confirm_payout(client, payout_id)

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

Confirm a payout (moves it from ACT to processing).

create_beneficiary(client, params)

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

Create a beneficiary.

create_beneficiary_tokenization_page(client, params)

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

Create a hosted beneficiary tokenization page.

create_extended_beneficiary(client, params)

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

Create an extended beneficiary (full identity fields required).

create_payout(client, params)

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

Create a payout.

create_sender(client, params)

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

Create a sender.

delete_beneficiary(client, beneficiary_id)

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

Delete a beneficiary.

delete_sender(client, sender_id)

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

Delete a sender.

get_beneficiary(client, beneficiary_id)

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

Retrieve a beneficiary.

get_beneficiary_tokenization_page(client, token)

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

Retrieve a beneficiary tokenization page.

get_payout(client, payout_id)

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

Retrieve a payout.

get_payout_method_type_fields(client, payout_method_type)

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

Get required fields for a payout method type.

get_payout_required_fields(client, payout_method_type, sender_entity_type, beneficiary_entity_type, sender_country, sender_currency)

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

Get required fields for a payout method type with entity-type scoping.

get_sender(client, sender_id)

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

Retrieve a sender.

list_payout_method_types(client, params \\ %{})

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

List available payout method types for a sender/beneficiary combination.

list_payouts(client, filters \\ %{})

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

List payouts.

set_payout_response(client, params)

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

Set the merchant response to an inbound payout request.

update_beneficiary(client, beneficiary_id, params)

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

Update a beneficiary.

update_payout(client, payout_id, params)

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

Update a payout.

update_sender(client, sender_id, params)

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

Update a sender.

upload_payout_document(client, payout_id, params)

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

Upload a supporting document to a payout record.

validate_beneficiary(client, params)

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

Validate a beneficiary's account details.