Skip to main content
PATCH
Upload Merchant Invoice

Overview

Attaches an invoice to a sub-merchant you have onboarded. The request is multipart/form-data, not JSON. Uploading again replaces the stored invoice. The upload is accepted in any status. The invoice is not returned by Get Merchant or List Merchants.

Path Parameters

Request Parameters

Response

Errors

Errors use the standard envelope. For a 400, details lists every problem, each field mapped to a list of messages; otherwise it is an empty object. See Create Merchant.

Authorizations

X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Path Parameters

merchant_id
string
required

The sub-merchant's ID.

Body

multipart/form-data

multipart/form-data with the document type and the file.

file
file
required

The invoice file: pdf, jpg, jpeg, png, csv, xlsx or docx, up to 10 MB, with a file name of up to 100 characters. The content must match the extension. A PDF must not be password-protected and must pass EximPe's security check.

document_type
enum<string>
required

Always INVOICE. No other document type is accepted.

Available options:
INVOICE

Response

Invoice uploaded.

success
boolean
message
string
data
object