Skip to main content
GET
/
v1
/
operations
/
{operationId}
/
documents
List operation documents
curl --request GET \
  --url https://sandbox.payfi.global/v1/operations/{operationId}/documents \
  --header 'X-PayFi-Api-Key: <api-key>' \
  --header 'X-PayFi-Nonce: <api-key>' \
  --header 'X-PayFi-Signature: <api-key>'
[
  {
    "documentId": "doc_example",
    "documentType": "invoice",
    "originalFileName": "invoice-123.pdf",
    "fileName": "invoice-123.pdf",
    "contentType": "application/pdf",
    "sizeBytes": 123456,
    "status": "PROCESSED",
    "rejectionReason": null,
    "createdAt": "2026-05-20T12:00:00.000Z",
    "updatedAt": "2026-05-20T12:05:00.000Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.payfi.global/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-PayFi-Api-Key
string
header
required
​
X-PayFi-Nonce
string
header
required
​
X-PayFi-Signature
string
header
required

Path Parameters

​
operationId
string
required

Operation ID.

Response

Operation documents.

​
documentId
string
Example:

"doc_example"

​
documentType
enum<string>
Available options:
invoice,
bill_of_lading,
packing_list,
di_duimp,
bank_details,
proforma,
service_contract,
insurance_policy
Example:

"invoice"

​
originalFileName
string
Example:

"invoice-123.pdf"

​
fileName
string
Example:

"invoice-123.pdf"

​
contentType
string
Example:

"application/pdf"

​
sizeBytes
number
Example:

123456

​
status
enum<string>
Available options:
REGISTERED,
UPLOAD_PENDING,
UPLOADED,
SCANNING,
CLEAN,
REJECTED,
PROCESSING,
PROCESSED,
PROCESSING_FAILED
Example:

"PROCESSED"

​
rejectionReason
string | null
Example:

null

​
createdAt
string
Example:

"2026-05-20T12:00:00.000Z"

​
updatedAt
string
Example:

"2026-05-20T12:05:00.000Z"