Payment Interface

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

Payment Order Creation

post

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

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Body

application/jsontext/jsonapplication/*+json

Set Debit Transaction Request Class

amountnumber · doubleRequired

Payment Amount

sourceNostring · min: 1Required

Merchant Order Serial Number

callbackUrlstring | nullOptional

Callback Address

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Debit/Set

HTTPcURLJavaScriptPython

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

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

application/jsontext/jsonapplication/*+json

200

OK

{
  "code": 0,
  "errorDesc": null,
  "result": {
    "channelDebitOrderSimpleInfo": {
      "id": 1,
      "merchantId": null,
      "merchantSourceNo": null,
      "fiatAmount": null,
      "tokenAmount": null,
      "processCode": 0,
      "createdTime": 1,
      "updatedTime": 1,
      "payerAccountDetail": {
        "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
      },
      "callbackCode": 0,
      "closedTime": null,
      "feeFiatAmount": null,
      "settlementFiatAmount": null,
      "flag": 1
    }
  }
}

Payment 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

Set Debit Transaction Request Class

datastring · min: 1Required

Encrypted Data

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Debit/Place

HTTPcURLJavaScriptPython

POST /api/channel/Debit/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": {
    "channelDebitOrderSimpleInfo": {
      "id": 1,
      "merchantId": null,
      "merchantSourceNo": null,
      "fiatAmount": null,
      "tokenAmount": null,
      "processCode": 0,
      "createdTime": 1,
      "updatedTime": 1,
      "payerAccountDetail": {
        "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
      },
      "callbackCode": 0,
      "closedTime": null,
      "feeFiatAmount": null,
      "settlementFiatAmount": null,
      "flag": 1
    }
  }
}

Payment Order Query

post

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

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Body

application/jsontext/jsonapplication/*+json

Get Debit Transaction Request Class

channelDebitOrderIdinteger | nullOptional

Transaction ID

sourceNostring | nullOptional

Client Source Number

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Debit/Get

HTTPcURLJavaScriptPython

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

{
  "channelDebitOrderId": null,
  "sourceNo": null
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "code": 0,
  "errorDesc": null,
  "result": {
    "channelDebitOrderSimpleInfo": {
      "id": 1,
      "merchantId": null,
      "merchantSourceNo": null,
      "fiatAmount": null,
      "tokenAmount": null,
      "processCode": 0,
      "createdTime": 1,
      "updatedTime": 1,
      "payerAccountDetail": {
        "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
      },
      "callbackCode": 0,
      "closedTime": null,
      "feeFiatAmount": null,
      "settlementFiatAmount": null,
      "flag": 1
    },
    "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
    }
  }
}

Payment 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, failed when ProcessCode==40, please refer to documentation for other statuses. The Data in callback contains encrypted channelDebitOrderSimpleInfo object

Authorizations

Bearer

AuthorizationstringRequired

Authorization Code

Body

application/jsontext/jsonapplication/*+json

Set Debit Transaction Request Class

datastring · min: 1Required

Encrypted Data

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/channel/Debit/GetV2

HTTPcURLJavaScriptPython

POST /api/channel/Debit/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": {
    "channelDebitOrderSimpleInfo": {
      "id": 1,
      "merchantId": null,
      "merchantSourceNo": null,
      "fiatAmount": null,
      "tokenAmount": null,
      "processCode": 0,
      "createdTime": 1,
      "updatedTime": 1,
      "payerAccountDetail": {
        "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
      },
      "callbackCode": 0,
      "closedTime": null,
      "feeFiatAmount": null,
      "settlementFiatAmount": null,
      "flag": 1
    },
    "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
    }
  }
}