Skip to main content

Payment Intimation​

Payment Intimation API is used to submit insurance proposal payment details and mandate information after a successful customer payment, and to confirm proposal tracking details with the insurer.For enum values, please refer to the Master Lookup API available in the Building Block.

Request Body required

1SB Payment Intimation request

    Distributor object

    Return a JSON object with latitude and longitude properties to point to location of user.

    distributorID string

    Possible values: <= 20 characters

    Distributor ID assigned to each consumer by 1SB.

    agentID string

    Possible values: <= 20 characters

    PoSP code or SP code or Brokder Qualified Person.

    salesChannel string

    Possible values: <= 20 characters, [B2B, B2C]

    This is used by insurance companies to identify sales channel.

    varFields object[]

    varField array hold any additional data related to Distributor

  • Array [
    • fieldName string

    Possible values: <= 20 characters

    Name of additional fields

    fieldValue string

    Possible values: <= 20 characters

    Value of additional fields

  • ]
    • trackInfo object required

    Tracking information for proposal and policy

    manuApplicationNo string required

    Possible values: <= 100 characters

    Manufacturer application number

    manufacturerQuoteID string required

    Possible values: <= 100 characters

    Quote ID generated by manufacturer

    proposalNo string

    Possible values: <= 100 characters

    Proposal number

    policyNumber string

    Possible values: <= 100 characters

    Policy number

    merchantName string

    Possible values: <= 50 characters, [BCIBL, GFPL]

    Insurance company merchant name

    merchantId string

    Possible values: <= 50 characters

    Merchant ID provided by insurer

    insuranceCompanyCode string required

    Possible values: <= 15 characters, [NBHI, TAGIC, BAGIC, HDFCERGO]

    Insurance company identifier

    productCode string required

    Possible values: <= 20 characters, [Reassure, MEDICARE]

    Product code

    personalInformation object required

    Proposer and insured personal details

    individualDetails object[] required
  • Array [
    • memberType string required

    Possible values: [LIFE ASSURED, PROPOSER]

    Role of member

    memberSequenceNumber integer required

    Sequence number of member

    title string

    Possible values: <= 10 characters, [MR, MRS, MS]

    Title of member

    firstName string required

    Possible values: <= 50 characters

    First name

    lastName string required

    Possible values: <= 50 characters

    Last name

    gender string required

    Possible values: <= 10 characters, [MALE, FEMALE, OTHER, TRANSGENDER, OTHERS]

    Gender of Member

    dateOfBirth date required

    Date of Birth of Member. Date is formatted string as per ISO 8601 standard.Format - YYYY-MM-DD

    maritalStatus string

    Possible values: <= 20 characters, [DIVORCEE, MARRIED, SINGLE, WIDOW, WIDOWER]

    Marital status

    email string

    Possible values: <= 100 characters

    Email address

    mobileNumber integer required

    Possible values: <= 10 characters

    Mobile number

    zipCode string

    Possible values: <= 10 characters

    Pin / Zip code

    quoteAmount number

    Quoted premium amount

    premiumPaymentFrequency string

    Possible values: [HY, M, Q, S, Y]

    Premium payment frequency

  • ]
    • paymentDetails object required

    Payment transaction details

    paymentOrderID string required

    Possible values: <= 100 characters

    Payment order ID

    currencyName string

    Possible values: <= 5 characters, [INR]

    By default should be INR

    consumerReferenceNo string

    Consumer reference number

    status string required

    Possible values: [Success]

    Payment status

    paymentTransactionId string

    Payment gateway transaction ID

    paymentMode string required

    Possible values: [Internet Banking, UPI, Credit Card]

    Mode of payment

    txnAmount string required

    Transaction amount

    txnDate string required

    Date is formatted string as per ISO 8601 standard.Format - YYYY-MM-DD

    gatewayResponse string

    Raw response received from PG.

    type string

    Payment type

    autoDebitDate string

    Auto debit start date. Date is formatted string as per ISO 8601 standard.Format - YYYY-MM-DD

    autoDebitMode string

    Auto debit mode

    eMandateDetails object

    eMandate / subscription details

    premiumPaymentFrequency string

    Frequency of mandate

    amountToBePaid string

    Mandate debit amount

    method string

    Mandate method

    startDate string

    Mandate start date.Date is formatted string as per ISO 8601 standard.Format - YYYY-MM-DD

    endDate string

    Mandate end date. Date is formatted string as per ISO 8601 standard.Format - YYYY-MM-DD

    subscriptionId string

    Subscription Id provided by gateway

    subscriptionDesc string

    Subscription description

    status string

    Mandate status

Responses

Successful Response

Schema
    reqId string

    Request ID

    errors object[]

    Error list

    data object
    data object
    status string

    Response status code

    message string

    Response message

    trackInfo object
    manuApplicationNo string

    Manufacturer application number

    manufacturerQuoteID string

    Manufacturer quote ID

    proposalNo string

    Proposal number

    policyNumber string

    Policy number

    receiptNumber string

    Receipt number

Loading...