Token Replacement to sFTP

const response = await fetch(
  'https://service.pcibooking.net/api/sftp/sftp.gateway.com:22/uploads/batch/PCIBTST.xml?filter=GBT',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Basic dXNlcm5hbWU6cGFzc3dvcmQ=',
      'X-PciBooking-carduri': '555fd7b49f134b42a5dbe4d576b2e527,1d12f1d2b51f489f811d4f4176fde5f2[2]',
      'Content-Type': 'text/plain'
    },
    body: fileContent // the file to upload, in the format named by the filter parameter
  }
);

console.log(response.status);

import requests

response = requests.put(
    'https://service.pcibooking.net/api/sftp/sftp.gateway.com:22/uploads/batch/PCIBTST.xml',
    params={'filter': 'GBT'},
    headers={
        'Authorization': 'Basic dXNlcm5hbWU6cGFzc3dvcmQ=',
        'X-PciBooking-carduri': '555fd7b49f134b42a5dbe4d576b2e527,1d12f1d2b51f489f811d4f4176fde5f2[2]',
        'Content-Type': 'text/plain'
    },
    data=file_content  # the file to upload, in the format named by the filter parameter
)

print(response.status_code)

File uploaded successfully. No content returned.

{
    "code": -125,
    "message": "Bad input data",
    "moreInfo": "...",
    "errorList": null
}

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected Temp Session or One-Time Access Token",
    "errorList": null
}

PUT

api

sftp

{serverAddress}

{folderPath}

{fileName}

const response = await fetch(
  'https://service.pcibooking.net/api/sftp/sftp.gateway.com:22/uploads/batch/PCIBTST.xml?filter=GBT',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Basic dXNlcm5hbWU6cGFzc3dvcmQ=',
      'X-PciBooking-carduri': '555fd7b49f134b42a5dbe4d576b2e527,1d12f1d2b51f489f811d4f4176fde5f2[2]',
      'Content-Type': 'text/plain'
    },
    body: fileContent // the file to upload, in the format named by the filter parameter
  }
);

console.log(response.status);

import requests

response = requests.put(
    'https://service.pcibooking.net/api/sftp/sftp.gateway.com:22/uploads/batch/PCIBTST.xml',
    params={'filter': 'GBT'},
    headers={
        'Authorization': 'Basic dXNlcm5hbWU6cGFzc3dvcmQ=',
        'X-PciBooking-carduri': '555fd7b49f134b42a5dbe4d576b2e527,1d12f1d2b51f489f811d4f4176fde5f2[2]',
        'Content-Type': 'text/plain'
    },
    data=file_content  # the file to upload, in the format named by the filter parameter
)

print(response.status_code)

File uploaded successfully. No content returned.

{
    "code": -125,
    "message": "Bad input data",
    "moreInfo": "...",
    "errorList": null
}

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected Temp Session or One-Time Access Token",
    "errorList": null
}

File Transfer Token Replacement Guide

Replace tokens with card data in SFTP file transfers

Performs token replacement on a file and uploads the result directly to an SFTP server. Use this when you need to send batch files containing card data to a payment processor or partner that accepts SFTP delivery. PCI Booking replaces all card tokens in the file body with the real card data before uploading.

Error Responses

Code	HTTP Status	Condition
`-1003`	`401`	Authorization token is missing or invalid.
`-125`	`400`	Invalid host format (e.g. multiple colons in the server address).
`-125`	`400`	Invalid or missing Basic Auth credentials in the Authorization header.
`-125`	`400`	The requested filter name is not recognized.
`-125`	`400`	Token replacement could not be applied to the file content.
`-1003`	`401`	SFTP login failed (invalid server credentials).
`-160`	`404`	File upload failed on the remote server.

Parameter Constraints

serverAddress: Format is hostname or hostname:port. Only one colon is allowed. Default port is 22.
filter: Must be one of: GBT, SIMPLECSV, SIMPLEJSON, AIR, IUR, TADC, CSV. Case-insensitive.
Authorization header: Must contain valid Basic Auth credentials (username:password) for the SFTP server.

Parameters

Authentication

This is a browser-facing endpoint. Use one of the authentication methods below instead of the API key shown above.

string

Recommended. A long-lived token for browser-side calls. How to generate.

string

Alternative. Valid for 5 minutes. How to generate.

If both are provided, the session token takes precedence.

Path Parameters

string

required

The sFTP server address. This can be an IP address or domain name. Add the port number with a colon if required. For example: fsgatewaytest.aexp.com:22 or 10.200.1.10.

string

required

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

string

required

The file name for the content being uploaded, including extension. For example: PCIBTST.xml.

Query String

string

required

Indicates the format of the file being sent. Read more on Supported Formats.

string

The timeout, in seconds, for the sFTP server to respond.

Headers

string

required

Comma-separated token values to insert into the file. Tokens should be listed in the order of their appearance. For tokens appearing multiple times, include the number of occurrences in square brackets. Full token URIs or bare 32-character token IDs are both accepted. If fewer tokens are listed than there are card locations in the file, the last token is repeated for all remaining locations.

string

required

The authorization parameter used to authenticate to the sFTP server.

string

Supported compression formats: gzip and deflate. Omit this header if no compression is needed.

Request Body

The request body contains the raw file content as text, in the format named by the filter parameter. The preset filter determines where card data belongs in that format; PCI Booking inserts the card details of the tokens listed in X-PciBooking-carduri, in order, then uploads the result to the sFTP server.

const response = await fetch(
  'https://service.pcibooking.net/api/sftp/sftp.gateway.com:22/uploads/batch/PCIBTST.xml?filter=GBT',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Basic dXNlcm5hbWU6cGFzc3dvcmQ=',
      'X-PciBooking-carduri': '555fd7b49f134b42a5dbe4d576b2e527,1d12f1d2b51f489f811d4f4176fde5f2[2]',
      'Content-Type': 'text/plain'
    },
    body: fileContent // the file to upload, in the format named by the filter parameter
  }
);

console.log(response.status);

import requests

response = requests.put(
    'https://service.pcibooking.net/api/sftp/sftp.gateway.com:22/uploads/batch/PCIBTST.xml',
    params={'filter': 'GBT'},
    headers={
        'Authorization': 'Basic dXNlcm5hbWU6cGFzc3dvcmQ=',
        'X-PciBooking-carduri': '555fd7b49f134b42a5dbe4d576b2e527,1d12f1d2b51f489f811d4f4176fde5f2[2]',
        'Content-Type': 'text/plain'
    },
    data=file_content  # the file to upload, in the format named by the filter parameter
)

print(response.status_code)

Response

File uploaded successfully. No content returned.

{
    "code": -125,
    "message": "Bad input data",
    "moreInfo": "...",
    "errorList": null
}

{
    "code": -1003,
    "message": "Not authorized to access this resource",
    "moreInfo": "Bad or missing authorization data, expected Temp Session or One-Time Access Token",
    "errorList": null
}

Start Here

Authentication & General

Capture Cards

Manage Tokens

Use Tokens

Additional Functions

Payments Library

Token Replacement to sFTP

File Transfer Token Replacement Guide

Error Responses

Parameter Constraints

Parameters

Authentication

Path Parameters

Query String

Headers

Request Body

Response

File Transfer Token Replacement Guide

​Error Responses

​Parameter Constraints

​Parameters

​Authentication

​Path Parameters

​Query String

​Headers

​Request Body

​Response

Error Responses

Parameter Constraints

Parameters

Authentication

Path Parameters

Query String

Headers

Request Body

Response