Utility Bill Approval API

PUT

/api/v0/utilityPayment/status

This API to used to confirm the fund debit from wallet. This API to be used when user want to manual approve bills for payment. If configuration enabled for debit funds on bill creation, this API is not required.

Request

Body Params application/json

utilityPaymentIds

array[string]

required

List of bills to approve for debit funds

>= 1 items<= 1000 items

approvalStatus

enum<string>

optional

Fix value: CHECKER_APPROVED

Allowed value:

CHECKER_APPROVED

remarks

string

optional

Optional remarks

Match pattern:

^[A-Za-z0-9 ,@#$%^&*+:;?!()\-_"'`]{1,255}$

Example

{
    "utilityPaymentIds": [
        "string"
    ],
    "approvalStatus": "CHECKER_APPROVED",
    "remarks": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://test.your-api-server.com/api/v0/utilityPayment/status' \
--header 'Content-Type: application/json' \
--data-raw '{
    "utilityPaymentIds": [
        "string"
    ],
    "approvalStatus": "CHECKER_APPROVED",
    "remarks": "string"
}'

Responses

🟢200Success

application/json

Body

response_code

integer

required

response_message

string

required

payload

null

optional

Example

{
    "response_code": 0,
    "response_message": "Success",
    "payload": null
}

Bill Payment

Get Utility Bill Status