CyberSource SecureFileShare API
The SecureFileShare API from CyberSource — 2 operation(s) for securefileshare.
OpenAPI Specification
swagger: '2.0'
info:
description: All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
version: 0.0.1
title: CyberSource Merged Spec bankAccountValidation SecureFileShare API
host: apitest.cybersource.com
basePath: /
schemes:
- https
consumes:
- application/json;charset=utf-8
produces:
- application/hal+json;charset=utf-8
tags:
- name: SecureFileShare
paths:
/sfs/v1/file-details:
get:
tags:
- SecureFileShare
summary: Get List of Files
description: Get list of files and it's information of them available inside the report directory
operationId: getFileDetail
x-devcenter-metaData:
categoryTag: Secure_File_Share
developerGuides: https://developer.cybersource.com/api/developer-guides/dita-secure-file-share-api-102718/secure_file_share_api_intro.html
x-queryParameterDefaults:
organizationId: testrest
startDate: '2020-10-20'
endDate: '2030-01-01'
name: ''
produces:
- application/hal+json
consumes:
- '*/*;charset=utf-8'
parameters:
- name: startDate
in: query
description: "Valid start date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)\n\n **Example date format:**\n - yyyy-MM-dd\n"
required: true
type: string
format: date
- name: endDate
in: query
description: "Valid end date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)\n\n **Example date format:**\n - yyyy-MM-dd\n"
required: true
type: string
format: date
- name: organizationId
in: query
description: Valid Cybersource Organization Id
pattern: '[a-zA-Z0-9-_]+'
required: false
type: string
minLength: 1
maxLength: 32
- name: name
in: query
description: '**Tailored to searches for specific files with in given Date range**
example : MyTransactionDetailreport.xml
'
pattern: '[a-zA-Z0-9-_\.]+'
required: false
type: string
responses:
'200':
description: Ok
schema:
title: V1FileDetailsGet200Response
type: object
properties:
fileDetails:
type: array
items:
type: object
properties:
fileId:
type: string
description: Unique identifier of a file
example: AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B
name:
type: string
description: Name of the file
example: MyTransactionDetailreport.xml
createdTime:
type: string
format: date-time
description: Date and time for the file in PST
example: '2017-10-01T00:00:00+05:00'
lastModifiedTime:
type: string
format: date-time
description: Date and time for the file in PST
example: '2017-10-01T00:00:00+05:00'
date:
type: string
format: date
description: Date and time for the file in PST
example: '2017-10-05'
mimeType:
type: string
description: '''File extension''
Valid values:
- ''application/xml''
- ''text/csv''
- ''application/pdf''
- ''application/octet-stream''
'
example: application/xml
size:
type: number
description: Size of the file in bytes
example: 2245397
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
example: /sfs/v1/file-details?startDate=2018-01-01&endDate=2018-01-02
method:
type: string
example: GET
files:
type: array
items:
type: object
properties:
fileId:
type: string
description: Unique identifier for each file
example: AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B
href:
type: string
example: /sfs/v1/files/AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B
method:
type: string
example: GET
'400':
description: Invalid request
schema:
title: V1FilesGet400Response
type: object
required:
- code
- message
properties:
code:
type: string
description: Error code
message:
type: string
description: Error message
localizationKey:
type: string
description: Localization Key Name
correlationId:
type: string
description: Correlation Id
detail:
type: string
description: Error Detail
fields:
type: array
description: Error fields List
items:
type: object
properties:
path:
type: string
description: Path of the failed property
message:
type: string
description: Error description about validation failed field
localizationKey:
type: string
description: Localized Key Name
description: Provide validation failed input field details
description: Error Bean
examples:
application/json:
code: VALIDATION_ERROR
correlationId: null
detail: null
fields:
- path: startTime
message: Start date should not precede 18 months from current time in GMT
localizationKey: null
localizationKey: cybsapi.validation.errors
message: Field validation errors
'401':
description: Ok
schema:
title: V1FileDetailsGet401Response
type: object
required:
- code
- message
properties:
code:
type: string
description: Error code
message:
type: string
description: Error message
localizationKey:
type: string
description: Localization Key Name
correlationId:
type: string
description: Correlation Id
detail:
type: string
description: Error Detail
fields:
type: array
description: Error fields List
items:
type: object
properties:
path:
type: string
description: Path of the failed property
message:
type: string
description: Error description about validation failed field
localizationKey:
type: string
description: Localized Key Name
description: Provide validation failed input field details
description: Error Bean
examples:
application/json:
code: VALIDATION_ERROR
correlationId: null
detail: null
fields:
- path: organizationId
message: Organization doesn't has access to File details
localizationKey: null
localizationKey: cybsapi.validation.errors
message: Field validation errors
'404':
description: Files Info not found
schema:
title: V1FileDetailsGet404Response
type: object
required:
- code
- message
properties:
code:
type: string
description: Error code
message:
type: string
description: Error message
localizationKey:
type: string
description: Localization Key Name
correlationId:
type: string
description: Correlation Id
detail:
type: string
description: Error Detail
fields:
type: array
description: Error fields List
items:
type: object
properties:
path:
type: string
description: Path of the failed property
message:
type: string
description: Error description about validation failed field
localizationKey:
type: string
description: Localized Key Name
description: Provide validation failed input field details
description: Error Bean
examples:
application/json:
code: RESOURCE_NOTFOUND
correlationId: null
detail: The requested resource is not found. Please try again later.
localizationKey: cybsapi.resource.notfound
message: Files Info not found for requested input values
'500':
description: Internal Server Error
schema:
title: V1FileDetailsGet500Response
type: object
required:
- code
- message
properties:
code:
type: string
description: Error code
message:
type: string
description: Error message
localizationKey:
type: string
description: Localization Key Name
correlationId:
type: string
description: Correlation Id
detail:
type: string
description: Error Detail
fields:
type: array
description: Error fields List
items:
type: object
properties:
path:
type: string
description: Path of the failed property
message:
type: string
description: Error description about validation failed field
localizationKey:
type: string
description: Localized Key Name
description: Provide validation failed input field details
description: Error Bean
examples:
application/json:
code: SERVER_ERROR
correlationId: null
detail: Internal Server Error. Please contact the customer support.
localizationKey: cybsapi.server.error
message: Error encountered while processing request
/sfs/v1/files/{fileId}:
get:
tags:
- SecureFileShare
summary: Download a File with File Identifier
description: Download a file for the given file identifier
operationId: getFile
x-streaming: true
x-devcenter-metaData:
categoryTag: Secure_File_Share
developerGuides: https://developer.cybersource.com/api/developer-guides/dita-secure-file-share-api-102718/secure_file_share_api_intro.html
enableDownload: true
x-custom-headers:
accept:
- text/csv
- application/xml
- application/pdf
x-queryParameterDefaults:
organizationId: testrest
x-depends:
example:
path: /sfs/v1/file-details
verb: get
exampleId: Get list of files
fieldMapping:
- sourceField: fileDetails[0].fileId
destinationField: fileId
fieldTypeInDestination: path
produces:
- application/xml
- text/csv
- application/pdf
consumes:
- '*/*;charset=utf-8'
parameters:
- name: fileId
in: path
description: Unique identifier for each file
required: true
type: string
- name: organizationId
in: query
description: Valid Cybersource Organization Id
pattern: '[a-zA-Z0-9-_]+'
required: false
type: string
minLength: 1
maxLength: 32
responses:
'200':
description: OK
'400':
description: Invalid Request
schema:
type: object
required:
- code
- message
properties:
code:
type: string
description: Error code
message:
type: string
description: Error message
localizationKey:
type: string
description: Localization Key Name
correlationId:
type: string
description: Correlation Id
detail:
type: string
description: Error Detail
fields:
type: array
description: Error fields List
items:
type: object
properties:
path:
type: string
description: Path of the failed property
message:
type: string
description: Error description about validation failed field
localizationKey:
type: string
description: Localized Key Name
description: Provide validation failed input field details
description: Error Bean
'404':
description: No Reports Found
x-devcenter-metaData:
categoryTagArray:
- name: Payments
description: For more information about Payments transactions, see the [Payments Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html).
- name: Transaction_Batches
description: For more information about Transaction Batches, see the [Transaction Batches Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-transaction-batch-api/txn_batch_api_intro.html).
- name: eCheck_AVS
description: For more information about eCheck Account Validation, see the [Account Validation Developer Guides Page](https://...).
- name: Token_Management
description: For more information about the Token Management Service (TMS) see the [Token Management Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/tms/developer/all/rest/tms/tms-overview.html)
- name: Flex_Microform
description: Microform Integration is a lightweight acceptance solution designed to safely and securely accept payment information within your web page. Microform is designed to a be embedded seamlessly within your existing webpage experience, blending in with your existing acceptance form. This solution allows for the replacement of sensitive payment date with a transient token (a short lived reference to the sensitive payment data). For more information about Flex Microform transactions, see the [Flex Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken.html). For examples on how to integrate Flex Microform within your webpage please see our [GitHub Flex Samples](https://github.com/CyberSource?q=flex&type=&language=)
- name: Flex_API
description: For more information about Flex API, please see [Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/digital-accept-flex/developer/all/rest/digital-accept-flex/da-flex-api-intro.html).
- name: Risk_Management
- name: Payouts
description: 'For more information about Payouts, see the [Payouts Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payouts/Introduction.html).
'
- name: Installments
description: For more information about Installment contact Cybersource Support. For Visa installments contact VISthroughCYBS@visa.com
- name: Recurring_Billing_Subscriptions
description: For more information about Recurring Billing, see the [Recurring Billing Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-developer/recur-bill-services-intro.html).
- name: BIN_Lookup
description: 'The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources.
This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses with a flexible choice of inputs such as primary account number (PAN), network token from major networks (such as Visa, American Express, Discover and regional networks) which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS).
Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant.
'
- name: Transaction_Details
description: For more information about Transaction Details, see the [Transaction Details Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn_details_api.html).
- name: Transaction_Search
description: For more information about Transaction Search, see the [Transaction Search Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn_search_api.html).
- name: Reporting
description: 'For more information about Reporting, see the [Reporting Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-reporting-rest-api-dev-guide-102718/reporting_api.html).
'
- name: Secure_File_Share
description: For more information about Secure File Share, see the [Secure File Share Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-secure-file-share-api-102718/secure_file_share_api_intro.html).
- name: Invoices
description: For more information about Invoicing, see the [Invoicing Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/invoicing/developer/all/rest/invoicing/Introduction.html).
- name: Pay_By_Link
description: For more information about PayByLink, see the [PBL Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/boarding/user/all/rest/boarding/templates-matrix-intro/templates-matrix-pay-by-link.html).
- name: User_Management
description: For more information about User Management, see the [User Managment Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-user-management-api-102718/user_management_api_intro.html).
- name: Value_Added_Service
- name: Fee Service
- name: Merchant_Boarding
description: For more information about Merchant Boarding, please see [Developer Guides Page](https://developer.cybersource.com/api/developer-guides/Merchant-Boarding-API_ditamap/Merchant-Boarding-API.html).
- name: Webhooks
description: For more information about Webhooks, please see [Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.html).
- name: Unified_Checkout
description: For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html).
- name: Unified_Checkoutv1
description: For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-about-guide.html).
- name: Account_Updater
description: For more information about Account Updater, see the [Account Updater Developer Guides Page:](https://developer.cybersource.com/library/documentation/dev_guides/Account_Updater_UG/html/index.html).
- name: Visa_Bank_Account_Validation
description: 'The Visa Bank Account Validation Service is a new standalone product designed to validate customer''s routing and bank account number combination for ACH transactions. Merchant''s can use this standalone product to validate their customer''s account prior to processing an ACH transaction against the customer''s account to comply with Nacha''s account validation mandate for Web-debit transactions.
'
- name: Currency Conversion
description: 'Empower global transactions with transparency and choice. Our Dynamic Currency Conversion API lets merchants offer customers the option to pay in their home currency at checkout, delivering real-time exchange rates and clear cost disclosure.
**Key Benefits:**
- **Enhanced Customer Experience:** Provide clarity and convenience for international shoppers.
- **Real-Time Rates:** Accurate currency conversion with all the data required for acquirers and their merchants to maintain compliance with card network rules.
- **Seamless Integration:** Flexible API endpoints for rate lookup, authorization, and capture.
- **Regulatory Compliance:** Provides the data required for acquirers and merchants to meet and maintain card scheme requirements for disclosure and consent.
Ideal for merchants and payment partners seeking to boost trust and conversion in cross-border commerce.
**Key Features:**
- **Rate Lookup:** Retrieves the most up-to-date exchange rate for eligible cards before authorization.
- **Currency Choice:** Enables the merchant to offer customers the option to select between the merchant''s local currency and their card''s billing currency.
- **Compliance:** Ensures merchants have the data required to adhere to card network regulations; exchange rates, markups, etc.
**Supported Scenarios:**
- Dynamic Currency Conversion when cardholder''s billing currency differs from merchant''s pricing currency.
- Merchant and acquirer must support the cardholder''s billing currency.
**Core API Endpoints:**
**Currency Conversion API**
Returns eligibility and exchange rate details, including:
- exchangeRate
- marginRate
- reconciliationId and Id (for subsequent payment requests)
**Payment Authorization with DCC***
POST /pts/v2/payments
Required fields include:
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.originalCurrency
- orderInformation.amountDetails.originalAmount
- orderInformation.amountDetails.exchangeRate
- currencyConversion.indicator (e.g., 1 = Converted, 2 = Nonconvertible, 3 = Declined)
**Capture with DCC***
POST /pts/v2/payments/{id}/captures
Maps from original authorization and includes original and converted amounts.
**Refund with DCC***
POST /pts/v2/captures/{id}/refunds
Maps from original authorization and includes original and converted amounts.
*Note: DCC is only supported on select processors. Contact your acquirer or account manager for more information.
**Compliance & Disclosure:**
Merchants must:
- Adhere to card network rules for Dynamic Currency Conversion (DCC) transactions.
- Display the converted amount, exchange rate, and markup percentage and other required disclosures.
- Obtain explicit cardholder consent before applying DCC.
- Work with your acquirer to obtain full set of compliance requirements.
For more information, see the [Currency Conversion Developer Guide](https://developer.cybersource.com/docs/cybs/en-us/currency-conversion/developer/all/rest/currency-conversion/cc-intro.html).
'
- name: Intelligent_Commerce_Connect
description: For more information about Intelligent Commerce Cross Network Service API, please see [Developer Guides](https://developer.cybersource.com/docs/cybs/en-us/intelligent-commerce/developer/all/rest/intelligent-commerce/intelligent-commerce-about-guide.html).