Token Replacement to FTPS

put

https://service.pcibooking.net/api/ftps/{serverAddress}/{folderPath}/{fileName}

This method will retrieve the Paycard(s) that you list from our secure vault, perform a replacement of the card details into the document and upload the file to the specified FTPS server.

We recommend that you first review the guide for this method.

Path Params

serverAddress

string

required

The sFTP server address. This could be the IP address or domain name of the server. If required, you can add the port number with a colon.
For example:
fsgatewaytest.aexp.com:22
10.200.1.10

folderPath

string

required

The folder path where the file should be uploaded to. This can either an individual folder or a whole path.

fileName

string

required

The file name that should be set for the content being uploaded. The file name should include both name and extension as required. For example: PCIBTST.xml

Query Params

sessionToken

string

required

Optional authentication method. Please use either the Session Token or the Access Token. The session token is the value returned by the call to the "Start a Temporary Session" method.

accessToken

string

Optional authentication method. Please use either the Session Token or the Access Token. The Access Token is generated as a result of running the "Generate Access Token" code sample.

filter

string

required

An indicator to PCI Booking which format of file is being sent in this request.
Read more on our Supported Formats.

timeout

string

The timeout, in seconds, of how long PCI Booking should wait for the sFTP server to respond.

Body Params

file

file to be uploaded

Headers

X-PciBooking-carduri

string

required

Comma-separated values of the tokens to insert into the file. The tokens should be listed in the order of their appearance in the file. Each token which should be listed multiple times in the file must include the number of occurrences between square brackets.

Authorization

string

required

The authorization parameter that should be used in order to authenticate to the sFTP server.

Content-Encoding

string

PCI Booking supports request compression in the formats of gzip and deflate. When sending a request that should be compressed with one of these formats, please add the Content-Encoding header with the value of gzip or deflate. If no compression is necessary, please omit this header from your request.

Responses

204204

400400