Attach proof of payment

Attach a proof of payment to a payment: a bank confirmation or EFT slip supporting an outcome recorded by hand with record a payment outcome.

Attaching a file changes nothing about the payment itself, and there is no status restriction: a proof can be attached before, after, or long after the outcome is recorded. Files accumulate rather than replace, so list them with list proofs of payment.

Recording payment outcomes is opt-in per organization: unless the manual_payment_outcome feature flag is enabled for your organization this endpoint returns 403.

Path Params
string
required

The unique identifier of the payment to attach the file to.

Body Params
string
required
length between 1 and 255

The file name to store the document under. Its extension must match the file's actual contents: remittance.pdf carrying PNG bytes is rejected.

string
required
length ≤ 10485760

The file's contents, base64-encoded. Capped at 10MB of encoded payload, because these routes sit behind the standard JSON body limit, not the larger one the dedicated attachment routes get.

string
enum
required

The document's MIME type, which must match the file's actual contents and the extension on file_name.

Allowed:
Responses

400

Validation error. Examples: file_type is not one of the three accepted types, the file's contents do not match the declared type, or file_name's extension does not match its contents.

403

Recording a payment outcome is not enabled for the organization, or the caller is missing the payments:external:update permission.

404

No such payment.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json