5.1. Add Document

Introduction

Add Document allow to send request with document to attach it to the specific transaction. It is possible to attach any additional document to the existing transaction in the Payment Gateway. The attached document can be later downloaded from order details screen. This page describes how to attach the document to transaction by API.

Add Document Flow

skinparam roundcorner 20
skinparam sequenceArrowThickness 1
skinparam maxmessagesize 1200
skinparam sequenceParticipant underline
participant "Connecting Party" as A
participant Payneteasy as B
autonumber
hnote over A,B : Relevant Payment Flow

A -> A: Collect Documents
activate A
A -> B: Request to attach documents by Order ID
deactivate A
activate B
B -> B: Request confirmed
B -> B: Attach Document to transaction
activate A
B -> A: Document has been attached
deactivate B
deactivate A

(2) Each transaction in the System has assigned Order ID. Connecting Party makes upload document request to attach it to the specified transaction by Order ID, using /api/v2/documents/add-document.