Create Authorization Request

Use this API to create an authorisation request for a particular subscription. This API is applicable only if you have created a subscription via Create Seamless Subscription API. Use the response of the Create Seamless Subscription API to get the supported banks for E_MANDATE and supported UPI handles.

POST /api/v2/subscriptions/seamless/authorization

cURL

upiAuthorizationRequest

curl --request POST \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/seamless/authorization \
  --header 'Content-Type: application/json' \
  --data '
{
  "subReferenceId": 123456,
  "merchantTxnId": "merchant-txn-id-1",
  "authPaymentInfo": {
    "paymentType": "UPI",
    "vpa": "johndoe@upi",
    "authFlow": "UPI_COLLECT"
  }
}
'

200

defaultAuthorization

{
  "status": 200,
  "message": "Authorization Created",
  "data": {
    "subReferenceId": 123456,
    "authId": 23456789,
    "authStatus": "INITIALIZED",
    "merchantTxnId": "txn.id-1_2_3",
    "authPaymentData": {
      "paymentType": "UPI"
    }
  }
}

Headers

x-client-id · string

Example:

"{{X-Client-Id}}"

x-client-secret · string

Example:

"{{X-Client-Secret}}"

Body

application/json

subReferenceId · integer

Reference ID for the subscription.

Example:

123456

merchantTxnId · string

Unique transaction ID for the merchant.

Example:

"merchant-txn-id-1"

authPaymentInfo · object

Show child attributes

Response

200

application/json

Successful authorization request.