The Rapyd Client Portal Developer Hub

Welcome to the Rapyd Client Portal developer hub. You'll find comprehensive guides and documentation to help you start working with Rapyd Client Portal as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Listing Payouts

You can view a list of all payout transactions.

How to View All Payouts

  1. Sign in as described in Accessing the Client Portal and navigate to Disburse > Payouts.
    The Payouts page appears.
  1. Modify the display by doing the following:
  • To add or remove columns, click the Choose Columns icon at the top right. The icon has three vertical bars. On the Choose Columns panel, select the columns you want to appear on screen.
  • To change the column order, tap on a column header and drag it to a new place.
  1. Other things you can do:
  • To view additional columns, hover over the table and move the horizontal scroll bar at the bottom of the page.
  • To scroll through the pages of the table, move the vertical scroll bar at the right side of the page.
  • To filter the list, type a value in the Search field.
  • To sort the list, tap the column heading.

Description of Fields

The following tables describe the fields in the Payouts page.

Payout Details

Field

Description

Amount

The amount of the payout, in units defined by Currency.

Created at

Date and time that the payout was created.

Completed at

The date that the payout was completed.

Currency

Three-letter ISO 4217 code for the currency used in the Amount field.

Merchant Reference ID

ID defined by the merchant. Rapyd does not validate this value to enforce uniqueness.

Payout ID

ID of the payout object. String starting with payout_.

Payout Method Type

The payout method type, for example us_mastercard_card.

Payout Type

The type of the payout. One of the following:

  • bank - Bank transfer.
  • card - Payout to a card.
  • cash - Payout in cash at a point of sale.
  • ewallet - An eWallet managed by a third-party company.

Status

Indicates the status of the payout. One of the following:

  • Canceled - The payout was canceled.
  • Completed - The beneficiary received the payout funds.
  • Confirmation - The payout is waiting for a confirmation of the FX rate.
  • Created - The payout was created successfully.
  • Error - The payout was not created.
  • Updated - The payout was updated.

Sender Fields

Field

Description

Sender Entity Type

Type of entity of the sender.
One of the following:

  • Individual
  • Company

Sender Full Name

The sender's full name.

Sender ID

The ID of the sender.

Sender Country

The country of the sender.

Sender Currency

The currency used by the sender.

Beneficiary Details

Field

Description

Beneficiary ID

The ID of the beneficiary.

Beneficiary Country

Country of the beneficiary.

Beneficiary Entity Type

The entity type of the beneficiary.

Beneficiary Full Name

The beneficiary's full name.

Updated 21 days ago


Listing Payouts


You can view a list of all payout transactions.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.