POST
/
subscriptions
/
pay
/
documents
/
{payment_id}
curl --request POST \
  --url https://sandbox.cashfree.com/pg/subscriptions/pay/documents/{payment_id} \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --form action=UPLOAD \
  --form 'file=@'\''/Users/john/Downloads/pan.jpeg'\''' \
  --form payment_id=payment-1234
{
  "payment_id": "payment-1234",
  "authorization_status": "INITIALIZED",
  "action": "SUBMIT_DOCUMENT",
  "payment_message": "file uploaded successfully."
}

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app id in the merchant dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret in the merchant dashboard.

Headers

​
x-api-version
string
default:2025-01-01
required

API version to be used. Format is in YYYY-MM-DD.

​
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

​
x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Path Parameters

​
payment_id
string
required

Provide the PaymentId using which the payment was created.

Body

multipart/form-data
Request Body to upload Physical Nach Image.
​
file
file
required

Select the .jpg file that should be uploaded or provide the path of that file. You cannot upload a file that is more than 1MB in size.

​
payment_id
string
required

Authorization Payment Id for physical nach authorization

​
action
string
required

Action to be performed on the file. Can be SUBMIT_DOCUMENT

Response

200
application/json
Upload Pnach Image 200 response.

Response of pnach image upload API.

​
payment_id
string

The payment_id against which the pnach image is uploaded.

​
authorization_status
string

Authorization status of the subscription.

​
action
string

Action performed on the file.

​
payment_message
string

Message of the API.

Was this page helpful?