Understanding payins

❗️
API version 2023-01-01 deprecating
This version will be deprecated on May 1, 2025. If your platform is on this version, you should upgrade to at least 2023-12-01 to simplify authorization and access new features.

Payin

A payin is a type of payment and is the movement of funds from a User to a Merchant.

A payin is identified by the payin_id in the Rainforest ecosystem. The prefix for a payin_id is pyi_ on production and sbx_pyi on sandbox.

Status

The payin status is the descriptor of the current status in the life cycle of the payin.

Status	Description
`CREATED`	Payin was created and waiting approval. This is an interim state.
`PRESENTING`	Payin has been presented on a terminal device and waiting for the user to process the payin on the device. This is an interim state.
`PROCESSING`	Payin was approved and is currently processing. This is an interim state.
`SUCCEEDED`	Payin has completed processing and the funds are available for deposit.
`FAILED`	Payin unsuccessfully attempted to process.
`CANCELED`	Payin processing was canceled and no funds will be moved.
`IN_REVIEW`	Payin has been flagged for risk review.

Payment methods

Payins can process via ACH bank transfers and all major card types, including Visa, Mastercard, Discover, and American Express. Cards can be accepted from any international location. ACH bank transfers must be from US bank accounts.

A payment method is identified by the payment_method_id in the Rainforest ecosystem. The prefix for a payment_method_id is mtd_ on production and sbx_mtd_ on sandbox.

Status

The payment method status is the descriptor of the current status in the life cycle of the payment method.

Status	Description
`CREATED`	Payment method was created and waiting to be saved. This is an interim state.
`PRESENTING`	Payment method has been presented on a terminal device and waiting for the user to save the payment method using the device. This is an interim state.
`ACTIVE`	Payment method is saved and ready for use.
`FAILED`	Payment method unsuccessfully attempted to be saved.
`CANCELED`	Payment method was canceled during the attempt to save it on a device.