Skip to main content
POST
/
file
Upload a file
curl --request POST \
  --url https://rest.staging.nickel.com/file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form type=ACH_DEBIT_AUTHORIZATION_PDF \
  --form 'data=<string>'
{
  "id": "<string>",
  "key": "<string>",
  "type": "ACH_DEBIT_AUTHORIZATION_PDF",
  "createdAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://dev.nickel.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

File Upload

​
file
file
required

The file to upload

​
type
enum<string>

The file type. Optional — if omitted, the type can be inferred from the data field.

Available options:
ACH_DEBIT_AUTHORIZATION_PDF,
CREDIT_CARD_AUTHORIZATION_PDF,
INVOICE_PDF
​
data
string

Alternative way to specify the file type using query-string format, e.g. "type=ACH_DEBIT_AUTHORIZATION_PDF". Either type or data must be provided.

Response

Successful operation

​
id
string
required
​
key
string
required
​
type
enum<string>
required
Available options:
ACH_DEBIT_AUTHORIZATION_PDF,
CREDIT_CARD_AUTHORIZATION_PDF,
INVOICE_PDF
​
createdAt
string<date-time>
required