Skip to main content
POST
payments.evidence-file.upload

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
fileId
string
required

Id of an uploaded file holding dispute or arbitration evidence, at most 4 MB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
filename
string
required

Safe file name ending in pdf, jpg, jpeg or png.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,99}\.(pdf|jpg|jpeg|png)$
purpose
enum<string>
required

Why this evidence is being uploaded.

Available options:
dispute_evidence,
arbitration_evidence

Response

The result

evidenceFileId
string
required

Uploaded evidence file in your connected account.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$