Upload new document

Upload new document

POST https://<payengine-host>/merchant/:merchantId/file-upload

Path Parameters

Name	Type	Description
merchantId*	string	Merchant ID

Headers

Name	Type	Description
Content-Type*		multipart/form-data
Authorization*	String	Basic <your-private-key>

Request Body

Name	Type	Description
file*	file	Only JPG, TIFF, PDF, DOC, DOCX, XLS, XLSX, TXT are allowed
type*	string	Document type - Please see the description below for allowed types
description	string	Description

200: OK File uploaded successfully

{
    "message": "succeeded",
    "data": {
        "id": "23f0405c-b610-4dee-85b3-27b6b16e72e2",
        "merchant_id": "455d22ed-7dbb-4e3b-b791-ef3a6379eae0",
        "account_id": "a4c83161-e2c9-4aa4-83d8-922cdd593035",
        "attachment_type": "OTH",
        "attachment_description": "Bank statement",
        "attachment_format": "pdf",
        "attachment_size": 65970,
        "created_at": "2022-03-10T18:01:30.920Z",
        "updated_at": "2022-03-10T18:01:30.920Z",
        "attachment_name": "fields.pdf"
    }
}

Response Field Definition

Field Name	Type	Description
id	string	Unique attachment ID
merchant_id	string	Merchant ID
account_id	string	Account ID
attachment_type	string	Type of document
attachment_description	string	Description
attachment_format	string	Attachment format (PDF, PNG etc)
attachment_size	real	Attachment size
attachment_name	string	File name
created_at	string	Timestamp file was uploaded
updated_at	string	Timestamp file was updated

Attachment Types

Code	Description
SMA	Signed Merchant Agreement"
FS	Financial Statements
SS	Site Survey
BL	Bank Letter
PB	Proof of Business
BR	Bank Rating Form
PS	Processing Statements
MM	Marketing Materials
FD	FDG Leasing Addendum
TAX	IRS W9
PA	Petro Addendum
NP	Proof of Nonprofit Status
CH	Proof of 501(c)(3) Status
VSD	Visual Support Document
PST	Past Credit Card Processing Statements
VCA	Voided Check from your intended operating bank account for ACH transactions
OTH	Other document