SIsilverflow
File Subscriptions

Create File Subscription

Creates a new subscription based on the provided list of supported file types along with the distributionKey.

Note: Distributions configured for email deliveries are not supported.

Requires the fileSubscription:Create permission.

post/fileSubscription

Request

Request body

acquirerReferencesstring[] required

Network-specific references for file routing. The type of reference required depends on the card network:

Card NetworkRequired ValueBIN Object Field
American ExpressSubmitter IDacquirerIdCode
VisaAcquirer BINacquirerBin
MastercardAcquirer BINacquirerBin
DiscoverAcquirer BINacquirerBin

These references are used to match incoming card network files to subscriptions.

distributionKeystring required

Key of the distribution where files will be sent.

fileTypesstring[] required

List of card network file types to subscribe to. Each file type represents a specific format of raw data files from different card networks.

publicKeystring required

ASCII-armored PGP public key for file encryption. Supported algorithms: RSA (2048+ bits), Ed25519, ECDSA.

Example request

{
  "acquirerReferences": [
    "12345678"
  ],
  "distributionKey": "dst-abc123",
  "fileTypes": [
    "visa_undif"
  ],
  "publicKey": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmDMEaXoDqhYJKwYBBAHaRw8BAQdAAXC6iV1W+X99JGIDOnI5hMgw1VDzenarIZEG\nQYXyGnK0IlRlc3QgQ3VydmUyNTUxOSA8dGVzdEBleGFtcGxlLmNvbT6IkwQTFgoA\nOxYhBGZ+HE/2DHpE2YOgUMVV8LqjGPxvBQJpegOqAhsBBQsJCAcCAiICBhUKCQgL\nAgQWAgMBAh4HAheAAAoJEMVV8LqjGPxvWboBAO9BvHEW3HXyXInh5uMV+s94Y0+r\nvmnqUAvTbX5+DcK+AP9FnJLEhdNILIlxhAZTWEVOtR1dZ8CSVTj0XBrRpc2dArg4\nBGl6A6sSCisGAQQBl1UBBQEBB0BXhFyhSYpKx9OtXWSXOpZcoKMTFrKaiWJZqoly\n2GkHagMBCAeIeAQYFgoAIBYhBGZ+HE/2DHpE2YOgUMVV8LqjGPxvBQJpegOrAhsM\nAAoJEMVV8LqjGPxvzFUA+wZlIck8LzliQRE9TFiyuAFYepNuwy1NiJj8f77tWdPu\nAP9HhrHZHvcUgppsLpDOsFDQwUe4zJsB+PoNQ60W55zxCA==\n=Qe/m\n-----END PGP PUBLIC KEY BLOCK-----"
}

Response

The created file subscription

subscriptionKeystring required

The key of a subscription.

agentKeystring required

The key of an agent.

acquirerReferencesstring[] required

Network-specific references for file routing. The type of reference required depends on the card network:

Card NetworkRequired ValueBIN Object Field
American ExpressSubmitter IDacquirerIdCode
VisaAcquirer BINacquirerBin
MastercardAcquirer BINacquirerBin
DiscoverAcquirer BINacquirerBin

These references are used to match incoming card network files to subscriptions.

distributionKeystring required

Key of the distribution where files will be sent.

fileTypesstring[] required

List of card network file types to subscribe to. Each file type represents a specific format of raw data files from different card networks.

Changes

No recorded changes to this operation across all 1 revision of this API.