Introduction

Downloading a file (e.g. mandate PDF) generated by PAYONE platform.

Integration

POST Request - getfile
Account Parameters
request
required
Fixed Value: getfile
mid
required
your merchant ID, 5-digit numeric
portalId
required
your Portal ID, 7-digit numeric
key
required
your key value, alpha-numeric
common Parameters
file_format
required
Permitted Value PDF

Binary date of the PDF document
file_type
required
Permitted Value SEPA_MANDATE

PDF Mandate file 
file_reference
required
Format AN..35

Mandate identification
Response Parameters
ResponseType
HttpResponse
ResponseSize
Size of the response
HttpStatusCode
Format LIST
200 ok
3xx Redirect to content

Response Parameter (Error)
errorcode
Format NUMERIC(1..6)

In case of error the PAYONE Platform returns an error code for your internal usage.
errormessage
Format CHAR(1..1024)

In case of error the PAYONE Platform returns an error message for your internal usage.
customermessage
Format CHAR(1..1024)

The customermessage is returned to your system in order to be displayed to the customer.

(Language selection is based on the end customer's language, parameter "language")

 
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
            
encoding=UTF-8
file_format=PDF
file_reference=PO-21201401
file_type=SEPA_MANDATE
key=97ac20723479111f623d21a42bf4e9a1
mid=49692
mode=live
portalid=2036257
request=getfile
RESPONSE
                        
ResponseType=HttpResponse
ResponseSize=5341
HttpStatusCode=200