Skip to main content

Motor Payment URL API

Payment URL API will enable the consumers to intiate payment against the insurance policy application, and will response back with Payment Url to make payment.

Request Body required

1SB Payment URL request

    distributor object

    Distributor and channel details for identifying the selling partner and journey context.

    distributorID string

    Unique distributor/partner identifier.

    channelType string

    Sales channel classification (e.g., B2C, B2B).

    agentID string

    Agent/advisor identifier mapped to the distributor.

    salesChannel string

    Sales channel name or sub-channel (if applicable).

    varFields object[]

    Additional distributor-level attributes (if any) passed as key-value pairs.

  • Array [
  • fieldName string

    Name/key of the additional attribute.

    fieldValue string

    Value of the additional attribute.

  • ]
  • productGroupId string

    Product group identifier for the line of business.

    insuranceCompanyCode string

    Insurer/manufacturer code for which the payment is being initiated.

    applicationNo string

    Application/proposal number reference used for insurer/payment tracking.

    productCode string

    Product code identifying the insurer’s motor product variant/plan configuration.

    policyNo string

    Policy/proposal number reference (may be same as application number depending on insurer flow).

    quoteId string

    Quote identifier generated for the motor quote against which payment is being made.

    redirectUrl string

    URL to which the customer should be redirected after payment initiation/completion.

    UITrackingRefNo string

    UI tracking reference number generated by 1SB for tracking the payment journey on UI.

    additionalSetup object

    Technical and contextual metadata used for payment processing and tracking.

    currency string

    Currency in which payment is to be made.

    userCountry string

    Customer’s country (if captured).

    userRegion string

    Customer’s region/state (if captured).

    userLanguage string

    Customer’s preferred language (if captured).

    userIP string

    Customer’s IP address (if captured).

    userAgent string

    Customer’s browser/device user-agent string (if captured).

    userGeoLocation object

    Customer’s geo-location details (if captured).

    latitude string

    Latitude coordinate of the customer location (if available).

    longitude string

    Longitude coordinate of the customer location (if available).

    memberDetails object

    Customer/member details required by insurer/payment system for generating payment link.

    firstName string

    Customer first name.

    lastName string

    Customer last name.

    mobileNumber string

    Customer mobile number.

    email string

    Customer email address.

    varFields object[]

    Additional member/customer attributes passed as key-value pairs.

  • Array [
  • fieldName string

    Name/key of the additional member attribute.

    fieldValue string

    Value of the additional member attribute.

  • ]
  • paymentDetails object

    Payment configuration and payer details used to initiate the transaction.

    premiumPaymentFrequency string

    Premium payment frequency/mode used for payment (e.g., S for Single/Annual).

    amountToBePaid string

    Total amount payable for the transaction.

    method string

    Payment method (if selected/known). Blank if not selected at request time.

    bankAccount object

    Bank account details used when payment method requires bank details (if applicable).

    name string

    Account holder name (if applicable).

    accountNumber string

    Bank account number (if applicable).

    ifsc string

    IFSC code of the bank branch (if applicable).

    accountType string

    Type of bank account (if applicable).

    varFields object[]

    Additional payment-related attributes passed as key-value pairs.

  • Array [
  • fieldName string

    Name/key of the additional payment attribute.

    fieldValue string

    Value of the additional payment attribute.

  • ]
Responses

Successful Response


Schema
    reqId string required

    Unique request identifier generated for the payment transaction.

    errors object[] required

    List of errors returned during the request execution. Empty array indicates success.

  • Array [
  • code string
    message string
  • ]
  • data object[] required

    Payment response details.

  • Array [
  • applicationNo string required

    Application number generated for the proposal.

    UITrackingRefNo string required

    UI tracking reference number.

    policyNo string required

    Policy or proposal number.

    quoteId string required

    Quote identifier.

    redirectUrl string required

    Redirect URL for payment flow.

    referenceId string required

    Reference ID used for payment tracking.

    paymentDetails object required
    paymentUrl string required

    Payment gateway URL generated for completing the transaction.

    varFields object[] required

    Additional payment-related parameters.

  • Array [
  • fieldName string
    fieldValue string
  • ]
  • varFields object[] required

    Additional response-level parameters.

  • Array [
  • fieldName string
    fieldValue string
  • ]
  • ]
Loading...