API Reference

Create payin from deposit method

post
https://api.sandbox.rainforestpay.com/v1/deposit_methods//payin

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.

Path Params
string
required

The unique deposit method identifier.

Prefix is "dmt" in production and "sbx_dmt" in sandbox.

Body Params
string
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.

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

Updated 7 months ago

Language
Credentials
Bearer
APIKey
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago