Tokenize from sFTP

get

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

This method will retrieve a file from the sFTP server provided, process it to extract the card details listed and tokenize them

Once the response from the third party is received in PCI Booking. the card details will be extracted from the message body and tokenized, the card details in the message will be masked and the token URI will be added to the response header (the header field will be X-pciBooking-cardUri).

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 downloaded from. This can either an individual folder or a whole path.

fileName

string

required

The file name that should be downloaded. 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 downloaded 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.

Headers

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