Sign in

v1

latestOpenAPI 3.0.12026-07-24256962.9 KB
Documents

Upload a document

post/documents

Headers

Trace-Idstring

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agentstring

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ipstring

The IP address of the end user. Recommended for compliance.

End-User-OSstring

The Operating System of the end user. Recommended for compliance.

End-User-Device-Idstring

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturerstring

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Modelstring

The device model used by the end user. Recommended for compliance.

Request body

OR
OR

Example request

{
  "paymentIntent": {
    "id": "c46abad9-16a1-47da-8e48-3eafc24aad54"
  },
  "payer": {
    "id": "8f51c396-6e29-49a6-ba5a-1a31d5420158"
  },
  "filename": "invoice_123.pdf"
}

Response

Document upload URL generated successfully

uploadURLstring url

Example response

{
  "metadata": {
    "success_action_status": "201"
  }
}