Skip to content
/Credit Notes

Request a credit note document upload

Request

Creates a pending credit note document and returns a presigned upload request. Upload the document with every returned upload_headers entry, including Content-Type (the requested filetype), then use document_id as merchant_credit_note_document_id when creating the credit note after validation succeeds.

Security
bearerAuth or basicAuth
Bodyapplication/jsonrequired

Document metadata used to request a credit note attachment upload.

filenamestringrequired

Original filename. The extension must match filetype.

Example:"credit-note.pdf"
filetypestringrequired

MIME type of the credit note document.

Enum:"application/pdf""image/png""image/jpeg""image/jpg"
Example:"application/pdf"
curl -i -X POST \
  https://docs.resolvepay.com/_mock/merchant-api/openapi/credit-notes/documents \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filename": "credit-note.pdf",
    "filetype": "application/pdf"
  }'

Responses

Pending credit note document upload request.

Bodyapplication/json
idstringrequired
document_idstringrequired

Use as merchant_credit_note_document_id after validation succeeds.

urlstring, (uri)required
upload_urlstring, (uri)required
upload_expires_atstring, (date-time)required
object_keystringrequired
transfer_methodstringrequired
Value:"presigned_upload"
upload_headersobjectrequired
validation_profilestringrequired
Value:"merchant_credit_note_document_default"
Response
{
  "id": "string",
  "document_id": "string",
  "url": "http://example.com",
  "upload_url": "http://example.com",
  "upload_expires_at": "2019-08-24T14:15:22Z",
  "object_key": "string",
  "transfer_method": "presigned_upload",
  "upload_headers": {
    "property1": "string",
    "property2": "string"
  },
  "validation_profile": "merchant_credit_note_document_default"
}