Chilkat Online Tools

PureBasic / Razorpay APIs / Create Payout Link (using customer details)

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",
    ;   "contact": {
    ;     "name": "Gaurav Kumar",
    ;     "type": "customer",
    ;     "contact": "912345678",
    ;     "email": "gaurav.kumar@example.com"
    ;   },
    ;   "amount": 1000,
    ;   "currency": "INR",
    ;   "purpose": "refund",
    ;   "description": "Payout link for Gaurav Kumar",
    ;   "receipt": "Receipt No. 1",
    ;   "notes": {
    ;     "random_key_1": "Make it so.",
    ;     "random_key_2": "Tea. Earl Grey. Hot."
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"account_number","account_number")
    CkJsonObject::ckUpdateString(json,"contact.name","Gaurav Kumar")
    CkJsonObject::ckUpdateString(json,"contact.type","customer")
    CkJsonObject::ckUpdateString(json,"contact.contact","912345678")
    CkJsonObject::ckUpdateString(json,"contact.email","gaurav.kumar@example.com")
    CkJsonObject::ckUpdateInt(json,"amount",1000)
    CkJsonObject::ckUpdateString(json,"currency","INR")
    CkJsonObject::ckUpdateString(json,"purpose","refund")
    CkJsonObject::ckUpdateString(json,"description","Payout link for Gaurav Kumar")
    CkJsonObject::ckUpdateString(json,"receipt","Receipt No. 1")
    CkJsonObject::ckUpdateString(json,"notes.random_key_1","Make it so.")
    CkJsonObject::ckUpdateString(json,"notes.random_key_2","Tea. Earl Grey. Hot.")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.razorpay.com/v1/payout-links","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 "Content-Type: application/json"
	-d '{
  "account_number": "account_number",
  "contact": {
    "name": "Gaurav Kumar",
    "type": "customer",
    "contact": "912345678",
    "email": "gaurav.kumar@example.com"
  },
  "amount": 1000,
  "currency": "INR",
  "purpose": "refund",
  "description": "Payout link for Gaurav Kumar",
  "receipt": "Receipt No. 1",
  "notes": {
    "random_key_1": "Make it so.",
    "random_key_2": "Tea. Earl Grey. Hot."
  }
}'
https://api.razorpay.com/v1/payout-links

Postman Collection Item JSON

{
  "name": "Create Payout Link (using customer details)",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"account_number\": \"account_number\",\n  \"contact\": {\n    \"name\": \"Gaurav Kumar\",\n    \"type\": \"customer\",\n    \"contact\": \"912345678\",\n    \"email\": \"gaurav.kumar@example.com\"\n  },\n  \"amount\": 1000,\n  \"currency\": \"INR\",\n  \"purpose\": \"refund\",\n  \"description\": \"Payout link for Gaurav Kumar\",\n  \"receipt\": \"Receipt No. 1\",\n  \"notes\": {\n    \"random_key_1\": \"Make it so.\",\n    \"random_key_2\": \"Tea. Earl Grey. Hot.\"\n  }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.razorpay.com/v1/payout-links",
      "protocol": "https",
      "host": [
        "api",
        "razorpay",
        "com"
      ],
      "path": [
        "v1",
        "payout-links"
      ]
    },
    "description": "Use this [API](https://razorpay.com/docs/api/razorpayx/payout-links/#create-a-payout-link) to create a Payout Link."
  },
  "response": [
  ]
}