CyberSource SearchTransactions API
The SearchTransactions API from CyberSource — 2 operation(s) for searchtransactions.
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 SearchTransactions API
host: apitest.cybersource.com
basePath: /
schemes:
- https
consumes:
- application/json;charset=utf-8
produces:
- application/hal+json;charset=utf-8
tags:
- name: SearchTransactions
paths:
/tss/v2/searches:
post:
summary: Create a Search Request
description: 'Create a search request.
'
tags:
- SearchTransactions
produces:
- application/json;charset=utf-8
operationId: createSearch
x-devcenter-metaData:
categoryTag: Transaction_Search
developerGuides: https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn_search_api.html
parameters:
- name: createSearchRequest
in: body
required: true
schema:
type: object
properties:
save:
type: boolean
description: 'Indicates whether or not you want to save this search request for future use. The options are:
* `true`
* `false` (default value)
If set to `true`, this field returns
`searchID` in the response. You can use this value to retrieve the details of the saved search.
'
name:
type: string
description: 'Name of this search. When `save` is set to `true`, this search is saved with this name.
'
timezone:
type: string
description: 'Merchant''s time zone in ISO standard, using the TZ database format. For example: `America/Chicago`
'
query:
type: string
description: 'String that contains the filters and variables for which you want to search. For information about supported field-filters and operators, see the [Query Filters]( https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn-search-intro/txn-filtering.html) section of the Transaction Search Developer Guide.
'
offset:
type: integer
description: 'Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset.
For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this:
`offset=0`
`offset=5`
`offset=10`
**Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned.
'
limit:
type: integer
description: 'Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500.
'
sort:
type: string
description: 'A comma separated list of the following form:
`submitTimeUtc:desc`
'
example:
save: 'false'
name: Search By Code
timezone: America/Chicago
query: clientReferenceInformation.code:123456 AND submitTimeUtc:[NOW/DAY-7DAYS TO NOW/DAY+1DAY}
offset: 0
limit: 100
sort: id:asc, submitTimeUtc:asc
responses:
'201':
description: Successful response.
schema:
type: object
title: tssV2TransactionsPost201Response
properties:
searchId:
type: string
maxLength: 60
description: An unique identification number assigned by CyberSource to identify each Search request.
save:
type: boolean
description: 'Indicates whether or not you want to save this search request for future use. The options are:
* `true`
* `false` (default value)
If set to `true`, this field returns
`searchID` in the response. You can use this value to retrieve the details of the saved search.
'
name:
type: string
description: 'Name of this search. When `save` is set to `true`, this search is saved with this name.
'
timezone:
type: string
description: 'Merchant''s time zone in ISO standard, using the TZ database format. For example: `America/Chicago`
'
query:
type: string
description: 'String that contains the filters and variables for which you want to search. For information about supported field-filters and operators, see the [Query Filters]( https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn-search-intro/txn-filtering.html) section of the Transaction Search Developer Guide.
'
offset:
type: integer
description: 'Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset.
For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this:
`offset=0`
`offset=5`
`offset=10`
**Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned.
'
limit:
type: integer
description: 'Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2500.
'
sort:
type: string
description: 'A comma separated list of the following form:
`submitTimeUtc:desc`
'
count:
type: integer
description: Results for this page, this could be below the limit.
totalCount:
type: integer
description: Total number of results.
submitTimeUtc:
type: string
description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`
**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).
The `T` separates the date and the time. The `Z` indicates UTC.
Returned by Cybersource for all services.
'
_embedded:
type: object
properties:
transactionSummaries:
type: array
description: transaction search summary
items:
type: object
properties:
id:
type: string
maxLength: 26
description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services.
It is also appended to the endpoint of the resource.
On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.
'
submitTimeUtc:
type: string
description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`
**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).
The `T` separates the date and the time. The `Z` indicates UTC.
Returned by Cybersource for all services.
'
merchantId:
type: string
description: Your CyberSource merchant ID.
status:
type: string
description: 'The status of the submitted transaction.
Note: This field may not be returned for all transactions.
'
applicationInformation:
type: object
properties:
reasonCode:
type: string
description: 'Indicates the reason why a request succeeded or failed and possible action to take if a request fails.
For details, see the appendix of reason codes in the documentation for the relevant payment method.
'
rCode:
type: string
description: 'Indicates whether the service request was successful.
Possible values:
- `-1`: An error occurred.
- `0`: The request was declined.
- `1`: The request was successful.
'
rFlag:
type: string
description: 'One-word description of the result of the application.
'
applications:
type: array
items:
type: object
properties:
name:
type: string
description: 'The name of the CyberSource transaction type (such as CC settlement or CC authorization) that the merchant wants to process in a transaction request. More than one transaction type can included in a transaction request. Each transaction type separately returns their own status, reasonCode, rCode, and rFlag messages.
'
reasonCode:
type: string
description: 3-digit reason code that indicates why the customer profile payment succeeded or failed.
status:
type: string
description: 'The status of the submitted transaction.
Note: This field may not be returned for all transactions.
'
reason:
type: string
description: 'Description of why a request failed.
Note: This field may not be returned for all transactions.
'
rCode:
type: string
description: 'Indicates whether the service request was successful.
Possible values:
- `-1`: An error occurred.
- `0`: The request was declined.
- `1`: The request was successful.
'
rFlag:
type: string
description: 'One-word description of the result of the application.
'
reconciliationId:
type: string
description: 'Reference number that you use to reconcile your CyberSource reports with your processor reports.
'
rMessage:
type: string
description: 'Message that explains the reply flag for the application.
'
returnCode:
type: integer
description: The description for this field is not available.
returnCode:
type: integer
description: The description for this field is not available.
buyerInformation:
type: object
properties:
merchantCustomerId:
type: string
maxLength: 100
description: 'Your identifier for the customer.
When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.
#### Comercio Latino
For recurring payments in Mexico, the value is the customer''s contract number.
Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.
#### Worldpay VAP
For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order
given, for a customer account ID value and uses the first value it finds:
1. `customer_account_id` value in the follow-on credit request
2. Customer account ID value that was used for the capture that is being credited
3. Customer account ID value that was used for the original authorization
If a customer account ID value cannot be found in any of these locations, then no value is used.
'
clientReferenceInformation:
type: object
properties:
code:
type: string
maxLength: 59
description: 'Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each
transaction so that you can perform meaningful searches for the transaction.
#### Used by
**Authorization**
Required field.
#### PIN Debit
Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being
reversed.
Required field for all PIN Debit requests (purchase, credit, and reversal).
#### FDC Nashville Global
Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
'
applicationName:
type: string
description: 'The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.
'
applicationUser:
type: string
description: 'The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.
'
partner:
type: object
properties:
solutionId:
type: string
maxLength: 8
description: 'Identifier for the partner that is integrated to CyberSource.
Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.
**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.
'
consumerAuthenticationInformation:
type: object
properties:
xid:
type: string
maxLength: 40
description: 'Transaction identifier.
'
transactionId:
type: string
description: Payer auth Transaction identifier.
eciRaw:
type: string
maxLength: 2
description: 'Raw electronic commerce indicator (ECI).
'
deviceInformation:
type: object
properties:
ipAddress:
type: string
maxLength: 45
description: 'IP address of the customer.
#### Used by
**Authorization, Capture, and Credit**
Optional field.
'
errorInformation:
type: object
properties:
reason:
type: string
description: 'Description of why a request failed.
Note: This field may not be returned for all transactions.
'
fraudMarkingInformation:
type: object
properties:
reason:
type: string
description: 'Reason for adding the transaction to the negative list. This field can contain one of the following values:
- fraud_chargeback: You have received a fraudrelated chargeback for the transaction.
- non_fraud_chargeback: You have received a non-fraudulent chargeback for the transaction.
- suspected: You believe that you will probably receive a chargeback for the transaction.
- creditback: You issued a refund to the customer to avoid a chargeback for the transaction.
'
merchantDefinedInformation:
type: array
description: 'The object containing the custom data that the merchant defines.
'
items:
type: object
properties:
key:
type: string
maxLength: 50
description: 'The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.
For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.
#### CyberSource through VisaNet
For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and
`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the
transaction.
'
value:
type: string
maxLength: 800
description: "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
merchantInformation:
type: object
properties:
resellerId:
type: string
maxLength: 26
description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services.
It is also appended to the endpoint of the resource.
On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.
'
orderInformation:
type: object
properties:
billTo:
type: object
properties:
firstName:
type: string
maxLength: 60
description: 'Customer''s first name. This name must be the same as the name on the card.
**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
#### SEPA
Required for Create Mandate and Import Mandate
#### BACS
Required for Import Mandate
#### CyberSource Latin American Processing
**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\
**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports.
#### CyberSource through VisaNet
Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.
#### For Payouts:
This field may be sent only for FDC Compass.
#### Chase Paymentech Solutions
Optional field.
#### Credit Mutuel-CIC
Optional field.
#### OmniPay Direct
Optional field.
#### SIX
Optional field.
#### TSYS Acquiring Solutions
Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.
#### Worldpay VAP
Optional field.
#### All other processors
Not used.
'
lastName:
type: string
maxLength: 60
description: 'Customer''s last name. This name must be the same as the name on the card.
**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
#### SEPA
Required for Create Mandate and Import Mandate
#### BACS
Required for Import Mandate
#### Chase Paymentech Solutions
Optional field.
#### Credit Mutuel-CIC
Optional field.
#### CyberSource Latin American Processing
**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\
**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.
#### CyberSource through VisaNet
Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.
#### For Payouts:
This field may be sent only for FDC Compass.
#### OmniPay Direct
Optional field.
#### RBS WorldPay Atlanta
Optional field.
#### SIX
Optional field.
#### TSYS Acquiring Solutions
Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.
#### Worldpay VAP
Optional field.
#### All other processors
Not used.
'
address1:
type: string
maxLength: 60
description: 'Payment card billing street address as it appears on the credit card issuer''s records.
#### SEPA
Required for Create Mandate and Import Mandate
#### Atos
This field must not contain colons (:).
#### CyberSource through VisaNet
**Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2,
CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters,
CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank.
Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.
Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet
accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations
of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the
credit card networks. Therefore, CyberSource t
# --- truncated at 32 KB (176 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cybersource/refs/heads/main/openapi/cybersource-searchtransactions-api-openapi.yml