PayFac Reporting Document Upload Documentation

Authentication

To access the payfac reporting API you must have an API key. Keys are the same as are used by the reporting API. They are not tied to the IP address.

Keys are included as a url parameter for any POST calls. Example: https://reporting.vantagepay.io/api/...?key=xxxx-xxxx-xxxx-xxxx-xxxx

Transactions

ALL calls to the document upload are POST calls. Below is a breakdown of the URL and KEY parameter 

          https://reporting.vantagepay.io/documentupload?key=xxx
          \___________________________________________/  \_____/ 
                          |                                 | 
                   API's Base URL                           | 
                                                          Api Key

DocumentUpload (POST) for Chargebacks and Retrievals https://reporting.vantagepay.io/documentupload?key=[Api Key]

Response Class (Status 200)
OK

                    

                    
                    
                    

                    Header
                    Value
                    

                    

                    Content-Type
                    application/json
                            

                        

Example POST Message Body


{
DocumentType needs to be set to chargeback
    "DocumentType":"ChargeBack",
This is the Propay Merchant Account Number
    "MerchantID":"3000000",
Either TransactionID or TransactionInfoID is required and verified against the merchant number
    "TransactionID": "1000",
or
    "TransactionInfoID":"300000000",
Optional Reason and Notes are to allow information about the files to be passed to Vantage.
    "Reason":"Service was provided",
    "Notes":"Attaching signed acceptance documents...",

    At least one attachment is required.  Supports JPG, JPEG, PDF, TIF, TIFF.  The DOC, DOCX, PNG file formats will no longer be supported by Propay after May 1, 2024.
    Up to 5 MB attachment as accepted

    "Attachments":[
    {
    "FileType":"JPG",
    "FileContents": (Base64 encoded contents)
    },
    {
    "FileType":"PNG",
    "FileContents": (Base64 encoded contents)
    }
    ]

DocumentUpload (POST) for Applications https://reporting.vantagepay.io/documentupload?key=[Api Key]

Response Class (Status 200)
OK

                    

                    
                    
                    

                    Header
                    Value
                    

                    

                    Content-Type
                    application/json
                    

                        

Example POST Message Body

{
Document Type needs to be set to Application
    "DocumentType":"Application",
This is the AccountID returned by the Boarding API
    "AccountID":"10",
Optional Notes are to allow information about the files to be passed to Vantage.
    "Notes":"Attaching requested bank documents...",

    At least one attachment is required.  Supports JPG, PDF, DOC, DOCX, TIF, TIFF, PNG
    Up to 5 MB attachment as accepted
    
    "Attachments":[
    {
    "FileType":"JPG",
    "Description":"Voided Check",
    "FileContents": (Base64 encoded contents)
    },
    {
    "FileType":"PNG",
    "Description":"Letter from Bank",
    "FileContents": (Base64 encoded contents)
    }
    ]