Collection Interface

The encrypted content of callback data is the channelCreditOrderSimpleInfo object from the query response

Collection Order Creation

post

V1 version, this interface will be deprecated in the future. Order is successful when ProcessCode==30, please refer to documentation for other statuses

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Body

application/jsontext/jsonapplication/*+json

Set Credit Transaction Request Class

amountnumber · doubleRequired

Credit Amount

sourceNostring · min: 1Required

Merchant Order Serial Number

callbackUrlstring | nullOptional

Callback Address

payerAccountDetailListarray | nullOptional

Payer account information, as shown below:

[
   {
     "accountName": "Account real name",
     "bankNo": "Indian bank IFSC code",
     "bankName": "Bank name",
     "bankAccount": "Account/Card number/VPA",
     "accountType": "1" for IFSC, "2" for UPI,
     "mobile": "Account owner mobile number",
   }
]

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Credit/Set

HTTPcURLJavaScriptPython

POST /api/channel/Credit/Set HTTP/1.1
Host: api-beta.bharatpay.cc
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "amount": 1,
  "sourceNo": "text",
  "callbackUrl": null,
  "payerAccountDetailList": [
    {
      "accountName": null,
      "bankNo": null,
      "bankAccount": null,
      "bankName": null,
      "accountType": null,
      "mobile": null
    }
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "code": 0,
  "errorDesc": null,
  "result": {
    "channelCreditOrderSimpleInfo": {
      "id": 1,
      "merchantId": null,
      "merchantSourceNo": null,
      "fiatAmount": null,
      "tokenAmount": null,
      "processCode": 0,
      "createdTime": 1,
      "updatedTime": 1,
      "cashierLink": null,
      "payerAccountDetailList": [
        {
          "accountName": null,
          "bankNo": null,
          "bankAccount": null,
          "bankName": null,
          "accountType": null,
          "mobile": null
        }
      ],
      "payeeAccountDetail": {
        "accountName": null,
        "bankNo": null,
        "bankAccount": null,
        "bankName": null,
        "accountType": null,
        "mobile": null
      },
      "paid": null,
      "callbackCode": 0,
      "closedTime": null,
      "feeFiatAmount": null,
      "settlementFiatAmount": null
    },
    "channelPaymentRecordSimpleInfo": {
      "id": 1,
      "status": 0,
      "amount": null,
      "upiUrl": null,
      "processCode": 0,
      "generated": true,
      "expiredTime": 1,
      "upi": null,
      "upiName": null,
      "upiHandle": null,
      "utr": null,
      "errorMessage": null
    },
    "deeplink": null
  }
}

Collection Order Creation V2

post

V2 encapsulates the original V1 request parameters into AES encrypted string, transmitted through Data field. Order is successful when ProcessCode==30, please refer to documentation for other statuses

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Body

application/jsontext/jsonapplication/*+json

Get Credit Transaction Request Class

datastring · min: 1Required

Encrypted Data

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Credit/Place

HTTPcURLJavaScriptPython

POST /api/channel/Credit/Place HTTP/1.1
Host: api-beta.bharatpay.cc
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "data": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "code": 0,
  "errorDesc": null,
  "result": {
    "channelCreditOrderSimpleInfo": {
      "id": 1,
      "merchantId": null,
      "merchantSourceNo": null,
      "fiatAmount": null,
      "tokenAmount": null,
      "processCode": 0,
      "createdTime": 1,
      "updatedTime": 1,
      "cashierLink": null,
      "payerAccountDetailList": [
        {
          "accountName": null,
          "bankNo": null,
          "bankAccount": null,
          "bankName": null,
          "accountType": null,
          "mobile": null
        }
      ],
      "payeeAccountDetail": {
        "accountName": null,
        "bankNo": null,
        "bankAccount": null,
        "bankName": null,
        "accountType": null,
        "mobile": null
      },
      "paid": null,
      "callbackCode": 0,
      "closedTime": null,
      "feeFiatAmount": null,
      "settlementFiatAmount": null
    },
    "channelPaymentRecordSimpleInfo": {
      "id": 1,
      "status": 0,
      "amount": null,
      "upiUrl": null,
      "processCode": 0,
      "generated": true,
      "expiredTime": 1,
      "upi": null,
      "upiName": null,
      "upiHandle": null,
      "utr": null,
      "errorMessage": null
    },
    "deeplink": null
  }
}

Collection Order Query

post

V1 version, this interface will be deprecated in the future. Order is successful when ProcessCode==30, please refer to documentation for other statuses. The Data in callback contains encrypted channelCreditOrderSimpleInfo object

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Body

application/jsontext/jsonapplication/*+json

Get Credit Transaction Request Class

channelCreditOrderIdinteger | nullOptional

Transaction ID

sourceNostring | nullOptional

Client Source Number

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Credit/Get

HTTPcURLJavaScriptPython

POST /api/channel/Credit/Get HTTP/1.1
Host: api-beta.bharatpay.cc
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "channelCreditOrderId": null,
  "sourceNo": null
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "code": 0,
  "errorDesc": null,
  "result": {
    "channelCreditOrderSimpleInfo": {
      "id": 1,
      "merchantId": null,
      "merchantSourceNo": null,
      "fiatAmount": null,
      "tokenAmount": null,
      "processCode": 0,
      "createdTime": 1,
      "updatedTime": 1,
      "cashierLink": null,
      "payerAccountDetailList": [
        {
          "accountName": null,
          "bankNo": null,
          "bankAccount": null,
          "bankName": null,
          "accountType": null,
          "mobile": null
        }
      ],
      "payeeAccountDetail": {
        "accountName": null,
        "bankNo": null,
        "bankAccount": null,
        "bankName": null,
        "accountType": null,
        "mobile": null
      },
      "paid": null,
      "callbackCode": 0,
      "closedTime": null,
      "feeFiatAmount": null,
      "settlementFiatAmount": null
    },
    "channelPaymentRecordSimpleInfo": {
      "id": 1,
      "status": 0,
      "amount": null,
      "upiUrl": null,
      "processCode": 0,
      "generated": true,
      "expiredTime": 1,
      "upi": null,
      "upiName": null,
      "upiHandle": null,
      "utr": null,
      "errorMessage": null
    }
  }
}

Collection Order Query V2

post

V2 encapsulates the original V1 request parameters into AES encrypted string, transmitted through Data field. Order is successful when ProcessCode==30, please refer to documentation for other statuses. The Data in callback contains encrypted channelCreditOrderSimpleInfo object

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Body

application/jsontext/jsonapplication/*+json

Get Credit Transaction Request Class

datastring · min: 1Required

Encrypted Data

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Credit/GetV2

HTTPcURLJavaScriptPython

POST /api/channel/Credit/GetV2 HTTP/1.1
Host: api-beta.bharatpay.cc
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "data": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "code": 0,
  "errorDesc": null,
  "result": {
    "channelCreditOrderSimpleInfo": {
      "id": 1,
      "merchantId": null,
      "merchantSourceNo": null,
      "fiatAmount": null,
      "tokenAmount": null,
      "processCode": 0,
      "createdTime": 1,
      "updatedTime": 1,
      "cashierLink": null,
      "payerAccountDetailList": [
        {
          "accountName": null,
          "bankNo": null,
          "bankAccount": null,
          "bankName": null,
          "accountType": null,
          "mobile": null
        }
      ],
      "payeeAccountDetail": {
        "accountName": null,
        "bankNo": null,
        "bankAccount": null,
        "bankName": null,
        "accountType": null,
        "mobile": null
      },
      "paid": null,
      "callbackCode": 0,
      "closedTime": null,
      "feeFiatAmount": null,
      "settlementFiatAmount": null
    },
    "channelPaymentRecordSimpleInfo": {
      "id": 1,
      "status": 0,
      "amount": null,
      "upiUrl": null,
      "processCode": 0,
      "generated": true,
      "expiredTime": 1,
      "upi": null,
      "upiName": null,
      "upiHandle": null,
      "utr": null,
      "errorMessage": null
    }
  }
}

Get Recommended Amount

get

To avoid risks, please obtain recommended amounts before creating orders and guide users to select from returned recommended amounts

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Query parameters

Amountnumber · doubleRequired

Amount

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/channel/Credit/AdvisedAmount

HTTPcURLJavaScriptPython

GET /api/channel/Credit/AdvisedAmount?Amount=1 HTTP/1.1
Host: api-beta.bharatpay.cc
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "code": 0,
  "errorDesc": null,
  "result": {
    "amountList": [
      1
    ]
  }
}

Collection Supplement Order

post

V1 version, this interface will be deprecated in the future. If an order remains unpaid for a long time, you can call the supplement order interface. Order is successful when ProcessCode==30, please refer to documentation for other statuses

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Body

application/jsontext/jsonapplication/*+json

Process Credit Transaction Request Class

channelCreditOrderIdinteger · int64Required

Transaction ID

utrstring | nullOptional

UTR Certificate

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Credit/Process

HTTPcURLJavaScriptPython

POST /api/channel/Credit/Process HTTP/1.1
Host: api-beta.bharatpay.cc
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "channelCreditOrderId": 1,
  "payerVoucherDetail": {
    "voucherLink": null
  },
  "utr": null
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "code": 0,
  "errorDesc": null,
  "result": true
}

Collection Supplement Order V2

post

V2 encapsulates the original V1 request parameters into AES encrypted string, transmitted through Data field. If an order remains unpaid for a long time, you can call the supplement order interface. Order is successful when ProcessCode==30, please refer to documentation for other statuses

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Body

application/jsontext/jsonapplication/*+json

Process Credit Transaction Request Class

datastring · min: 1Required

Encrypted Data

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Credit/ProcessV2

HTTPcURLJavaScriptPython

POST /api/channel/Credit/ProcessV2 HTTP/1.1
Host: api-beta.bharatpay.cc
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "data": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "code": 0,
  "errorDesc": null,
  "result": true
}