Deposit Methods

Create payin from deposit method

Create and process a payin using a payin configuration and a deposit method. The merchant status must be ACTIVE to create a payin.

The deposit method details (i.e bank account number and billing contact) will be duplicated to a payment method and a payin will process against the newly created payment method. Metadata, method metadata, and new billing contact details can be defined on the Payin Config.

This endpoint requires Rainforest approval.

post/v1/deposit_methods/{deposit_method_id}/payin

Request

Base URL
https://api.sandbox.rainforestpay.com
URL
https://api.sandbox.rainforestpay.com/v1/deposit_methods/{deposit_method_id}/payin
Auth
HTTP bearer

Headers

Rainforest-Api-Version'2024-10-16'

Parameters

#/paths/~1v1~1deposit_methods~1{deposit_method_id}/get/parameters/1 (unresolved $ref)

Request body

payin_config_idstring required

The unique payin config identifier. A payin must be configured prior to this request. See "Create a Payin Config" if a payin configuration has not been created yet.

Prefix is "cfg" in production and "sbx_cfg" in sandbox.

Example request

{
  "payin_config_id": "cfg_2A4d6U0tMyovzTbVT1ktmRzdRaD"
}

Response

statusStatus (unresolved $ref)

errorsErrors (unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.