API Reference

Create payin

post
https://api.sandbox.rainforestpay.com/v1/payins

Create and process a payin with sensitive PCI data using a payin configuration. The merchant status must be ACTIVE to create a payin.

This endpoint requires Rainforest approval. Platforms that meet all requirements and are approved by Rainforest can send the full card and bank account numbers to Rainforest via a server-to-serve direct API integration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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.

string
enum
required

The type of payment method.

Allowed:
card
object

Card payment method. Required for method_type CARD.

ach
object

ACH payment method details. Required for method_type ACH.

billing_contact
object

Billing contact details. The following billing contact fields are required for payment processing depending on the payment method type:

  • Card: postal_code
  • ACH: name

The billing contact fields can also be passed in the payin config.

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

Updated 8 months ago

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 8 months ago