SettlementParticipant

Stay organized with collections Save and categorize content based on your preferences.

Contains all information about a participant in a payment settlement (either the payer or the payee).

JSON representation
{
  "participant": {
    object (Participant)
  },
  "account": {
    object (AccountReference)
  },
  "merchantInfo": {
    object (MerchantInfo)
  }
}
Fields
participant

object (Participant)

The participant information.

account

object (AccountReference)

Unique identification of an account according to India's UPI standards.

merchantInfo

object (MerchantInfo)

Information about a merchant who is a participant in the payment. This field will be specified only if the participant is a merchant.

MerchantInfo

Information about a merchant entity participating in a payment settlement.

JSON representation
{
  "id": string,
  "name": {
    object (MerchantName)
  },
  "additionalInfo": {
    object (MerchantAdditionalInfo)
  }
}
Fields
id

string

A unique identifier for the merchant.

name

object (MerchantName)

The name of the merchant who is a party in the payment. Includes multiple possible names for the merchant.

additionalInfo

object (MerchantAdditionalInfo)

India specific merchant additional information.

MerchantName

The name of a merchant who is a party in a payment settlement. Includes multiple possible names for the merchant.

JSON representation
{
  "brand": string,
  "legal": string,
  "franchise": string
}
Fields
brand

string

The name the merchant is commonly known as.

legal

string

The merchant's Legal Name.

franchise

string

The franchise name under which the merchant operates.

MerchantAdditionalInfo

Additional merchant information specific to India's UPI requirements.

JSON representation
{
  "categoryCode": string,
  "storeId": string,
  "terminalId": string,
  "type": enum (Type),
  "genre": enum (Genre),
  "onboardingType": enum (OnboardingType),
  "ownershipType": enum (OwnershipType),
  "additionalInfo": [
    {
      object (AdditionalInfo)
    }
  ]
}
Fields
categoryCode

string

Merchant Category code as specified by UPI (A four-digit number listed in ISO 18245 for retail financial services).

storeId

string

A unique identifier for the merchant store where the payment occurs.

terminalId

string

A unique identifier for the POS terminal in the store where the payment occurs.

type

enum (Type)

Indicates the type of merchant.

genre

enum (Genre)

Indicates the genre of the merchant.

onboardingType

enum (OnboardingType)

Indicates by whom the merchant has been onboarded.

ownershipType

enum (OwnershipType)

Indicates the type of ownership for the merchant.

additionalInfo[]

object (AdditionalInfo)

Additional information about the merchant.

Type

Indicates whether it is a small or large merchant.

Enums
TYPE_UNSPECIFIED Unspecified merchant type.
SMALL Small merchant.
LARGE Large merchant.

Genre

Indicates whether it is an online or offline merchant.

Enums
GENRE_UNSPECIFIED Unspecified merchant genre.
ONLINE Online merchant.
OFFLINE Offline merchant

OnboardingType

Indicates whether the merchant has been onboarded by a bank or an aggregator.

Enums
ONBOARDING_TYPE_UNSPECIFIED Unspecified merchant onboarding type.
BANK Onboarded by bank.
AGGREGATOR Onboarded by aggreagator.

OwnershipType

Indicates the type of ownership for the merchant.

Enums
OWNERSHIP_TYPE_UNSPECIFIED Unspecified merchant ownership type.
PROPRIETARY Properiety ownership.
PARTNERSHIP Partnership ownership.
PUBLIC Public ownership.
PRIVATE Private ownership.
OTHERS Other ownership model.