API Reference
  1. Payouts
  2. Payout Receivers

Create payout receiver

post
https://api.sandbox.rainforestpay.com/v1/merchants//payout_receivers

Create a payout receiver for a merchant. Payout receivers can receive payouts from a merchant's available balance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique merchant identifier.

Prefix is "mid" in production and "sbx_mid" in sandbox.

Body Params

Request to create a payout receiver for a merchant. A MERCHANT-type payout receiver is the merchant itself and advances straight to ACTIVE.

string
enum
required

The type of payout receiver.

Allowed:
string
required

The payout receiver's display name.

string

The receiver's legal registered business name. Only applicable for type EXTERNAL_BUSINESS. For type MERCHANT, the legal name will be populated by the merchant's data.

string

The receiver's first name. Only applicable for type EXTERNAL_INDIVIDUAL. For type MERCHANT, the first name will be populated by the merchant's data if the merchant type is INDIVIDUAL.

string

The receiver's last name. Only applicable for EXTERNAL_INDIVIDUAL. For type MERCHANT, the last name will be populated by the merchant's data if the merchant type is INDIVIDUAL.

string
enum

The default category to set on a payout.

Allowed:
metadata
object

Valid JSON key-value object specified by the platform to store additional information on the receiver. Do not use the metadata field to store sensitive or confidential data.

Metadata must be less than 8 KB in size.

Headers
string
enum
Defaults to 2024-10-16
Allowed:
Responses

Updated about 16 hours ago

Did this page help you?
Language
Credentials
Bearer
APIKey
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 16 hours ago

Did this page help you?