Upload an attachment
Stores a supporting document for the entity and returns an opaque id you can pass as attachmentId when creating a payment. Upload once, reference from as many payments as you need.
Send multipart/form-data with the document in a part named file. PDF, JPEG and PNG are accepted, up to 8 MB. The bytes are not readable back through this API — only the metadata below is returned.
The main reason to use this: some international destinations will not accept a payment without a supporting document, and POST /payments then fails with 400 ATTACHMENT_REQUIRED. See attachmentId on the payment request.
Authorizations
Headers
Entity the request operates on — an entity id (ent_<uuid>) or me (the partner's sole entity).
Body
The document: PDF, JPEG or PNG, up to 8 MB.
Response
Attachment stored.
A stored document. The bytes are write-only through this API; what comes back is the id to reference from a payment plus enough metadata to recognise which file it was.
Attachment id (att_). Pass as attachmentId on POST /payments.
"att_9f8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
The filename as uploaded.
"invoice-2043.pdf"
The document's media type.
application/pdf, image/jpeg, image/png Size of the uploaded document in bytes.
182734
When the document was stored.