Skip to main content
POST
/
terminal
/
{cf_terminal_id}
/
docs
Upload Terminal Docs
curl --request POST \
  --url https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}/docs \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "doc_type": "PHOTOGRAPH",
  "doc_value": "john",
  "file": null
}
'
[
  {
    "cf_terminal_id": 1838,
    "doc_type": "PHOTOGRAPH",
    "doc_value": "docs/20260/1838/ymGCq-GIRphoto1",
    "status": "ACTIVE"
  }
]

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 key in the Merchant Dashboard.

Headers

​
x-api-version
string
default:2023-08-01
required

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

​
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<UUID>

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

​
cf_terminal_id
integer
required

Provide the Cashfree terminal ID for which the details have to be updated.

Body

application/json

Request Body to update terminal documents for SPOS.

Request body to upload terminal documents.

​
doc_type
string
required

Mention the document type you are uploading. Possible values - ADDRESSPROOF, PHOTOGRAPH.

​
doc_value
string
required

Enter the display name of the uploaded file.

​
file
string
required

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

Response

Upload Terminal Docs

​
cf_terminal_id
integer
​
doc_type
string
​
doc_value
string
​
status
string