Transfers

Attach the supporting document (invoice) for a payout

Attaches the commercial supporting document for a payout transfer: in practice the invoice the payment settles. The receiving institution validates the purpose code against this document, so a payout can be accepted and then sit unsettled while it is missing.

One document per transfer. Upload it before the payout is dispatched: the document is forwarded to the receiving institution only after the payment order exists, so this response does not say whether it has been forwarded.

The bytes travel inline as base64 in a single call, unlike customer documents, which use a two-call signed upload. A payout document is one small file per operation, and a single call makes the result indivisible, with no window where the document is registered and its bytes are absent.

post/transfers/{transfer_id}/documents

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

transfer_idstring required

The opaque transfer id (ozav_tr_...).

Request body

file_namestring required

Name shown to compliance reviewers.

content_type'application/pdf' required

PDF only. The receiving institution named PDF as the format for the invoice, and a file its compliance review cannot accept comes back as a request for information days later, by email. Refusing here is an immediate message to whoever still has the file in hand.

content_base64string required

The file, base64-encoded, without a data: prefix. Maximum 10 MB decoded. Content that does not decode, or decodes to zero bytes, is refused with 400 DOCUMENT_CONTENT_INVALID before anything is stored.

Example request

{
  "file_name": "invoice-2026-08.pdf",
  "content_base64": "JVBERi0xLjQKJeLjz9MK"
}

Response

Document stored and linked to the payout.

idstring uuid
object'payout_document'
transfer_idstring

The transfer this document supports (ozav_tr_...).

file_namestring
content_typestring
size_bytesinteger

Decoded size.

Changes

No recorded changes to this operation across all 1 revision of this API.