Deposit Documents
Attach an invoice or other supporting document to a payment route deposit
X-Api-Key<token>API key in format: sti_env_prefix_secret
transactionId*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidRequest schema for attaching a document to a transaction
application/json- body
Request schema for attaching a document to a transaction
file_name*stringOriginal file name, preserved for the download
1 <= length <= 255base64_url*stringThe file as a base64 data URL, e.g. data:application/pdf;base64,JVBERi0…. Accepts application/pdf, image/jpeg and image/png; the declared media type must match the file's actual contents, which are checked server-side. Maximum 10MB decoded.
1 <= lengthtype?DocumentTypeWhat the attached file is. Defaults to invoice.
"invoice""invoice""contract""other"Default Response
application/json- response
A single transfer document
document*A file attached to a transaction
curl -X POST 'https://api.sandbox.stables.money/api/v1/deposits/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents' \ -H 'Content-Type: application/json' \ -d '{ "file_name": "string", "base64_url": "string"}'{ "document": { "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6", "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482", "transaction_type": "transfer", "type": "invoice", "file_name": "string", "content_type": "string", "size_bytes": -9007199254740991, "created_at": "string" }}List the documents attached to a payment route deposit, newest first
X-Api-Key<token>API key in format: sti_env_prefix_secret
transactionId*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidDefault Response
application/json- response
Documents attached to a transaction, newest first
documents*array<>curl -X GET 'https://api.sandbox.stables.money/api/v1/deposits/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents'{ "documents": [ { "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6", "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482", "transaction_type": "transfer", "type": "invoice", "file_name": "string", "content_type": "string", "size_bytes": -9007199254740991, "created_at": "string" } ]}Get a short-lived presigned URL for downloading a payment route deposit document
X-Api-Key<token>API key in format: sti_env_prefix_secret
transactionId*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuiddocumentId*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidDefault Response
application/json- response
A short-lived link for downloading a transaction document
url*stringShort-lived presigned download URL (expires in 5 minutes)
file_name*stringcontent_type*stringexpires_in*integerURL lifetime in seconds
-9007199254740991 <= value <= 9007199254740991curl -X GET 'https://api.sandbox.stables.money/api/v1/deposits/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/download-url'{ "url": "string", "file_name": "string", "content_type": "string", "expires_in": -9007199254740991}Remove a document from a payment route deposit
X-Api-Key<token>API key in format: sti_env_prefix_secret
transactionId*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuiddocumentId*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidDefault Response
application/json- response
Confirmation the document was removed
deleted*booleancurl -X DELETE 'https://api.sandbox.stables.money/api/v1/deposits/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "deleted": true}Attach an invoice or other supporting document to a payment route deposit, for example when Stables compliance asks for one.