RArainforestpay
Devices

Present payin on a registered device

Present a payin for processing on a registered device using a payin configuration. The merchant status must be ACTIVE to process a payin.

📘 Note

A payment method created on a registered device may only be used for payins within the same merchant for which it was collected.

post/v1/device_registrations/{device_registration_id}/payin

Request

  • Base URL
    https://api.sandbox.rainforestpay.com
  • URL
    https://api.sandbox.rainforestpay.com/v1/device_registrations/{device_registration_id}/payin
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1payins/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1device_registrations~1{device_registration_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

OK

statusStatus (unresolved $ref)
dataData (unresolved $ref)
errorsErrors (unresolved $ref)

Changes

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