PureBasic / Razorpay APIs / Composite API - VPA
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "username")
CkHttp::setCkPassword(http, "password")
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "account_number": "account_number",
; "amount": 10000,
; "currency": "INR",
; "mode": "UPI",
; "purpose": "refund",
; "fund_account": {
; "account_type": "vpa",
; "vpa": {
; "address": "gauravkumar@exampleupi"
; },
; "contact": {
; "name": "Gaurav Kumar",
; "email": "gaurav.kumar@example.com",
; "contact": "9876543210",
; "type": "employee",
; "reference_id": "Acme Contact ID 12345",
; "notes": {
; "notes_key_1": "Tea, Earl Grey, Hot",
; "notes_key_2": "Tea, Earl Grey… decaf."
; }
; }
; },
; "queue_if_low_balance": true,
; "reference_id": "Acme Transaction ID 12345",
; "narration": "Acme Corp Fund Transfer",
; "notes": {
; "notes_key_1": "Beam me up Scotty",
; "notes_key_2": "Engage"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"account_number","account_number")
CkJsonObject::ckUpdateInt(json,"amount",10000)
CkJsonObject::ckUpdateString(json,"currency","INR")
CkJsonObject::ckUpdateString(json,"mode","UPI")
CkJsonObject::ckUpdateString(json,"purpose","refund")
CkJsonObject::ckUpdateString(json,"fund_account.account_type","vpa")
CkJsonObject::ckUpdateString(json,"fund_account.vpa.address","gauravkumar@exampleupi")
CkJsonObject::ckUpdateString(json,"fund_account.contact.name","Gaurav Kumar")
CkJsonObject::ckUpdateString(json,"fund_account.contact.email","gaurav.kumar@example.com")
CkJsonObject::ckUpdateString(json,"fund_account.contact.contact","9876543210")
CkJsonObject::ckUpdateString(json,"fund_account.contact.type","employee")
CkJsonObject::ckUpdateString(json,"fund_account.contact.reference_id","Acme Contact ID 12345")
CkJsonObject::ckUpdateString(json,"fund_account.contact.notes.notes_key_1","Tea, Earl Grey, Hot")
CkJsonObject::ckUpdateString(json,"fund_account.contact.notes.notes_key_2","Tea, Earl Grey… decaf.")
CkJsonObject::ckUpdateBool(json,"queue_if_low_balance",1)
CkJsonObject::ckUpdateString(json,"reference_id","Acme Transaction ID 12345")
CkJsonObject::ckUpdateString(json,"narration","Acme Corp Fund Transfer")
CkJsonObject::ckUpdateString(json,"notes.notes_key_1","Beam me up Scotty")
CkJsonObject::ckUpdateString(json,"notes.notes_key_2","Engage")
CkHttp::ckSetRequestHeader(http,"X-Payout-Idempotency","")
resp.i = CkHttp::ckPostJson3(http,"https://api.razorpay.com/v1/payouts","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-u 'username:password'
-H "X-Payout-Idempotency: "
-d '{
"account_number":"account_number",
"amount":10000,
"currency":"INR",
"mode":"UPI",
"purpose":"refund",
"fund_account":{
"account_type":"vpa",
"vpa":{
"address":"gauravkumar@exampleupi"
},
"contact":{
"name":"Gaurav Kumar",
"email":"gaurav.kumar@example.com",
"contact":"9876543210",
"type":"employee",
"reference_id":"Acme Contact ID 12345",
"notes":{
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
}
}
},
"queue_if_low_balance":true,
"reference_id":"Acme Transaction ID 12345",
"narration":"Acme Corp Fund Transfer",
"notes":{
"notes_key_1":"Beam me up Scotty",
"notes_key_2":"Engage"
}
}'
https://api.razorpay.com/v1/payouts
Postman Collection Item JSON
{
"name": "Composite API - VPA",
"request": {
"method": "POST",
"header": [
{
"key": "X-Payout-Idempotency",
"value": "",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"account_number\":\"account_number\",\n \"amount\":10000,\n \"currency\":\"INR\",\n \"mode\":\"UPI\",\n \"purpose\":\"refund\",\n \"fund_account\":{\n \"account_type\":\"vpa\",\n \"vpa\":{\n \"address\":\"gauravkumar@exampleupi\"\n },\n \"contact\":{\n \"name\":\"Gaurav Kumar\",\n \"email\":\"gaurav.kumar@example.com\",\n \"contact\":\"9876543210\",\n \"type\":\"employee\",\n \"reference_id\":\"Acme Contact ID 12345\",\n \"notes\":{\n \"notes_key_1\":\"Tea, Earl Grey, Hot\",\n \"notes_key_2\":\"Tea, Earl Grey… decaf.\"\n }\n }\n },\n \"queue_if_low_balance\":true,\n \"reference_id\":\"Acme Transaction ID 12345\",\n \"narration\":\"Acme Corp Fund Transfer\",\n \"notes\":{\n \"notes_key_1\":\"Beam me up Scotty\",\n \"notes_key_2\":\"Engage\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.razorpay.com/v1/payouts",
"protocol": "https",
"host": [
"api",
"razorpay",
"com"
],
"path": [
"v1",
"payouts"
]
},
"description": "Use this [API](https://razorpay.com/docs/api/razorpayx/composite-api/#vpa-upi-id) to create a payout using contact and VPA."
},
"response": [
]
}
