Table of contents
Documentation PG Collection (Scale UPI)

UPI Collect

Use this API to make a payment collection request to the payer's UPI App. The payer (VPA holder) will receive a notification on their UPI App for making payment.

Flow: Create a Collect request -> user will receive a notification -> user makes a payment -> you will receive a callback from Bulkpe about the collection status.

Set up Webhook (callback) from Bulkpe Dashboard -> Settings -> Developer Controls -> Webhook -> PG Collection. - learn more.

Request

API URL: https://api.bulkpe.in/client/createCollectionRequest

Method: POST

Auth: Please refer to the Authorization page.

Body

{ "reference_id": "Sathyatest000334222", "amount": 6, "device": "ANDROID", "upi": "sathyatest@ybl" }

Response

{ "status": true, "statusCode": 200, "data": { "partnerRef": "Sathyatest000334222", "referance": "BPCA001", "upi": "sathyatest@ybl", "status": "PENDING" }, "message": "Collect request sent to UPI App" }

Webhook response

You will receive a webhook response after the money collected successfully or failed due to various reason.

Set up Webhook (callback) from Bulkpe Dashboard -> Settings -> Developer Controls -> Webhook -> PG Collection. - learn more.

{ "status": true, "statusCode": 200, "data": { "transaction_id": "BPTR003350149", "reference_id": "Sathya-1725963921", "order_id": "BPCA0927983242", "account_number": "328478343453535", "ifsc": "HDFC0000005", "upi": "sathyatest@ybl", "amount": 1, "payment_mode": "UPI", "payment_remark": "", "statusDescription": "Collected Successfully", "status": "SUCCESS", "utr": "425415924630", "holderName": "Name of the Bank Account Holder Comes here", "type": "Credit", "charge": 0.02, "gst": 0, "createdAt": "2024-09-10T10:26:48.286Z", "updatedAt": "2024-09-10T10:26:48.321Z" }, "message": "", "event": "UPI_COLLECT" }
previous
Create Dynamic VPA
next
Refund UPI Transaction