syntax = "proto3";

package devvit.dev_portal.payments;

option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/devportal/payments";

// Get verification status.
message GetPaymentsVerificationStatusRequest {}

// Return verification response.
message GetPaymentsVerificationStatusResponse {
  PaymentsVerificationStatus status = 1;
}

// The verification status of a devvit developer. This shows whether or not a user can receive payments
// and their state in the verification flow. See design doc here:
// https://docs.google.com/document/d/1HuAfNB_26jnNu7gGDHk-vafzgpnoNaFqHoumE2C40cA/edit?tab=t.0#bookmark=id.hm6xb18pqjvh
enum PaymentsVerificationStatus {
  UNKNOWN = 0;
  // User has not begun the verification process and is permitted to.
  VERIFICATION_NOT_STARTED = 1;
  // User has begun the verification process.
  VERIFICATION_PENDING = 2;
  // User is not eligible to receive payments. This may be because they're ineligible to apply for payments
  // or because they applied and were rejected.
  VERIFICATION_CAN_NOT_START = 3;
  // Verification has been completed and the user is able to receive payments.
  VERIFICATION_SUCCESS = 4;
}