Object

Shown below is a sample bharat_connect.payment object for Register Business.


{
    "id":"bcpa_k3pbaBewh1CmzTPTOToHywYey",
    "object":"bharat_connect.payment",
    "type":"OUTGOING",
    "invoice": {
        "id": "bcinv_k3pbaALyh1CmzTPTOToHywYey",
        "status":"PAYMENT INITIATED"
    },
    "netPaidAmount": 4,
    "netAdjustmentAmount": 0,
    "totalAmount": 4,
    "paid_mode": "",
    "initiated_at":"",
     "response":{
	    "status":"SUCCESS",
	    "message":""
    },
    "metadata":""
}


The table below lists the various parameters in the bharat_connect.payment object.

ParametersTypeDescription
idstringUnique identifier for the payment. Example: bcpa_k3pbaBewh1CmzTPTOToHywYey
objectstringType of the object. Example: bharat_connect.payment
typestringType of payment. Example: OUTGOING
invoiceobjectDetails of the associated invoice.
netPaidAmountintegerNet amount paid. Example: 4
netAdjustmentAmountintegerNet adjustment amount. Example: 0
totalAmountintegerTotal amount. Example: 4
paid_modestringMode of payment (e.g., card, netbanking, etc.). Example: "" for empty or unknown mode
initiated_atstringTimestamp when payment was initiated. Example: "" for empty or unknown timestamp
responseobjectResponse details for the payment.
metadatastringAdditional metadata about the payment. Example: "" for empty metadata

Child Object Invoice

The table below lists the various parameters in the invoice object which is part of the bharat_connect.payment object.

ParametersTypeDescription
idstringUnique identifier for the invoice. Example: bcinv_k3pbaALyh1CmzTPTOToHywYey
statusstringCurrent status of the invoice. Example: PAYMENT INITIATED

Child Object Response

The table below lists the various parameters in the Response object which is part of the bharat_connect.payment object.

ParametersTypeDescription
statusstringResponse status of the payment. Example: SUCCESS
messagestringAdditional response message. Example: "" for empty message