Understanding payins

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.

StatusDescription
CREATEDPayin was created and waiting approval. This is an interim state.
PRESENTINGPayin has been presented on a terminal device and waiting for the user to process the payin on the device. This is an interim state.
PROCESSINGPayin was approved and is currently processing. This is an interim state.
SUCCEEDEDPayin has completed processing and the funds are available for deposit.
FAILEDPayin unsuccessfully attempted to process.
CANCELEDPayin processing was canceled and no funds will be moved.
IN_REVIEWPayin 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.

StatusDescription
CREATEDPayment method was created and waiting to be saved. This is an interim state.
PRESENTINGPayment 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.
ACTIVEPayment method is saved and ready for use.
FAILEDPayment method unsuccessfully attempted to be saved.
CANCELEDPayment method was canceled during the attempt to save it on a device.