Additional underwriting data

Additional underwriting data passed to Rainforest when creating a merchant

A new field additional_underwriting_data object will be added to the create merchant endpoint for the platform to send merchant specific information to Rainforest when initiating the merchant onboarding process.

This field will not be returned in the Rainforest API on merchant or merchant application endpoints.

FieldTypeDescription
merchant.start_dateString, in the format of YYYY-MM-DDThe merchant start date on the platform.
historic_payment_volume.last_30_daysInteger, $ amount in centsThe total payment volume processed in the last 30 days (1 month).
historic_payment_volume.last_180_daysInteger, $ amount in centsThe total payment volume processed in the last 180 days (6 months).
historic_payment_volume.currency_codeString, enum of USDThree-letter ISO currency code, in uppercase. Currently, only USD is supported.
subscription.amountInteger, $ amount in centsThe merchant's subscription cost to the platform, dependent on the frequency.
subscription.currency_codeString, enum of USDThree-letter ISO currency code, in uppercase. Currently, only USD is supported.
subscription.frequencyString, enum list of ONE_TIME, WEEKLY, MONTHLY, ANNUALLY, OTHERThe frequency the merchant's subscription amount is paid to the platform.

Example Payload

{
  // ...
  "additional_underwriting_data": {
    "merchant": {
      "start_date": "2023-12-01",
    },
    "historic_payment_volume": {
      "last_30_days": 100000, // $1,000.00
      "last_180_days": 600000, // $6,000.00
      "currency_code": "USD"
    },
    "subscription": {
      "amount": 10000, // $100.00
      "currency_code": "USD",
      "frequency": "MONTHLY"
    }
  }
}