RArainforestpay
Devices

Create device registration

Create a device registration for payment processing on a specific merchant. When a device is registered, the device receives a new device_registration_id for payment processing. The merchant status must be ACTIVE to register a device.

post/v1/device_registrations

Request

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

Parameters

#/paths/~1v1~1payins/get/parameters/0 (unresolved $ref)

Request body

merchant_idstring required

The unique merchant identifier.

Prefix is "mid" in production and "sbx_mid" in sandbox.

registration_codestring required

The code that appears on an internet-connected device when it is not yet registered or has been deregistered.

On sandbox, a virtual device can be registered to test the device integration without a physical device. Use the registration code VIRTUAL_DEVICE to register a virtual device to any sandbox merchant account.

device_namestring required

The name that will appear on the device screen when internet-connected.

Example request

{
  "merchant_id": "mid_2DrDFJPutxE5AIbJSopAnqniEbr"
}

Response

OK

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

Changes

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