CyberSource Purchase And Refund Details API
API for Purchase and Refund Details
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cybersource-purchase-and-refund-details-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.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 Purchase And Refund Details API
servers:
- url: https://apitest.cybersource.com/
tags:
- name: Purchase And Refund Details
description: API for Purchase and Refund Details
paths:
/reporting/v3/purchase-refund-details:
get:
tags:
- Purchase And Refund Details
summary: Get Purchase and Refund Details
description: 'Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.
'
operationId: getPurchaseAndRefundDetails
x-devcenter-metaData:
categoryTag: Reporting
enableDownload: true
x-custom-headers:
accept:
- text/csv
- application/xml
- application/hal+json
x-queryParameterDefaults:
organizationId: testrest
startTime: '2020-01-01T12:00:00Z'
endTime: '2020-01-30T12:00:00Z'
groupName: groupName
paymentSubtype: VI
viewBy: requestDate
offset: '20'
limit: '2000'
parameters:
- name: startTime
in: query
description: "Valid report Start Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n"
required: true
schema:
type: string
format: date-time
- name: endTime
in: query
description: "Valid report End Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n"
required: true
schema:
type: string
format: date-time
- name: organizationId
in: query
description: Valid Organization Id
required: false
schema:
type: string
maxLength: 32
minLength: 1
pattern: '[a-zA-Z0-9-_]+'
- name: paymentSubtype
in: query
description: "Payment Subtypes.\n - **ALL**: All Payment Subtypes\n - **VI** : Visa\n - **MC** : Master Card\n - **AX** : American Express\n - **DI** : Discover\n - **DP** : Pinless Debit\n"
required: false
schema:
type: string
default: ALL
- name: viewBy
in: query
description: "View results by Request Date or Submission Date.\n - **requestDate** : Request Date\n - **submissionDate**: Submission Date\n"
required: false
schema:
type: string
default: requestDate
- name: groupName
in: query
description: Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
required: false
schema:
type: string
- name: offset
in: query
description: Offset of the Purchase and Refund Results.
required: false
schema:
type: integer
format: int32
- name: limit
in: query
description: Results count per page. Range(1-2000)
required: false
schema:
type: integer
format: int32
default: 2000
maximum: 2000
minimum: 1
responses:
'200':
description: Ok
content:
application/hal+json:
schema:
title: reportingV3PurchaseRefundDetailsGet200Response
type: object
properties:
offset:
type: integer
limit:
type: integer
pageResults:
type: integer
requestDetails:
type: array
description: List of Request Info values
items:
type: object
properties:
requestId:
type: string
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
cybersourceMerchantId:
type: string
example: Cybersource Merchant Id
description: Cybersource Merchant Id
processorMerchantId:
type: string
example: Processor Merchant Id
description: Cybersource Processor Merchant Id
groupName:
type: string
example: '996411990498708810001'
description: Group Name
transactionReferenceNumber:
type: string
example: RZ3J9WCS9J33
description: Transaction Reference Number
merchantReferenceNumber:
type: string
example: '47882339'
description: Merchant Reference Number
description: Request Info Section
settlements:
type: array
description: List of Settlement Info values
items:
type: object
properties:
requestId:
type: string
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
transactionType:
type: string
example: Purchases
description: Transaction Type
submissionTime:
type: string
example: '2017-10-01T10:10:10+05:00'
description: Submission Date
format: date-time
amount:
type: string
example: '23.00'
description: Amount
currencyCode:
type: string
example: USD
description: Valid ISO 4217 ALPHA-3 currency code
paymentMethod:
type: string
example: VISA
description: payment method
walletType:
type: string
example: V.me
description: Solution Type (Wallet)
paymentType:
type: string
example: credit card
description: Payment Type
accountSuffix:
type: string
example: '0004'
description: Account Suffix
cybersourceBatchTime:
type: string
example: '2017-10-01T10:10:10+05:00'
description: Cybersource Batch Time
format: date-time
cybersourceBatchId:
type: string
example: '123123123123123'
description: Cybersource Batch Id
cardType:
type: string
example: 'null'
description: Card Type
debitNetwork:
type: string
example: ''
description: Debit Network
authorizations:
type: array
description: List of Authorization Info values
items:
type: object
properties:
requestId:
type: string
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
transactionReferenceNumber:
type: string
example: RZ3J9WCS9J27
description: Authorization Transaction Reference Number
time:
type: string
example: '2017-10-01T10:10:10+05:00'
description: Authorization Date
format: date-time
authorizationRequestId:
type: string
example: '12345678901234567890123459'
description: Authorization Request Id
amount:
type: string
example: '2.50'
description: Authorization Amount
currencyCode:
type: string
example: USD
description: Valid ISO 4217 ALPHA-3 currency code
code:
type: string
example: '160780'
description: Authorization Code
rcode:
type: string
example: '1'
description: Authorization RCode
description: Authorization Info Values
feeAndFundingDetails:
type: array
description: List of Fee Funding Info values
items:
type: object
properties:
requestId:
type: string
maxLength: 26
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
interchangePerItemFee:
type: string
example: '2.7'
description: interchange Per Item Fee
interchangeDescription:
type: string
example: Visa International Assessments (Enhanced)
description: interchange Description
interchangePercentage:
type: string
example: '0.25'
description: interchange Percentage
interchangePercentageAmount:
type: string
example: '-3.7500'
description: interchange Percentage Amount
discountPercentage:
type: string
example: '2.39'
description: Discount Percentage
discountAmount:
type: string
example: '0.429'
description: Discount Amount
discountPerItemFee:
type: string
example: '0.002'
description: Discount Per Item Fee
totalFee:
type: string
example: '0.429'
description: Total Fee
feeCurrency:
type: string
example: '1'
description: Fee Currency
duesAssessments:
type: string
example: '0'
description: Dues Assessments
fundingAmount:
type: string
example: '2.50'
description: Funding Amount
fundingCurrency:
type: string
example: USD
description: Funding Currency (ISO 4217)
description: Fee Funding Section
others:
type: array
description: List of Other Info values
items:
type: object
properties:
requestId:
type: string
maxLength: 26
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
merchantData1:
type: string
example: Merchant Defined Data
description: Merchant Defined Data
merchantData2:
type: string
example: Merchant Defined Data
description: Merchant Defined Data
merchantData3:
type: string
example: Merchant Defined Data
description: Merchant Defined Data
merchantData4:
type: string
example: Merchant Defined Data
description: Merchant Defined Data
firstName:
type: string
example: First Name
description: First Name
lastName:
type: string
example: Last Name
description: Last Name
description: Other Merchant Details Values.
settlementStatuses:
type: array
description: List of Settlement Status Info values
items:
type: object
properties:
requestId:
type: string
maxLength: 26
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
status:
type: string
example: Settlement Status
description: Settlement Status
settlementTime:
type: string
example: '2017-10-01T10:10:10+05:00'
format: date-time
description: Settlement Date
reasonCode:
example: reasonCode
type: string
description: ReasonCode
errorText:
example: errorText
type: string
description: errorText
description: Settlement Status Section Values.
description: PurchaseAndRefundDetails
application/xml:
schema:
title: reportingV3PurchaseRefundDetailsGet200Response
type: object
properties:
offset:
type: integer
limit:
type: integer
pageResults:
type: integer
requestDetails:
type: array
description: List of Request Info values
items:
type: object
properties:
requestId:
type: string
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
cybersourceMerchantId:
type: string
example: Cybersource Merchant Id
description: Cybersource Merchant Id
processorMerchantId:
type: string
example: Processor Merchant Id
description: Cybersource Processor Merchant Id
groupName:
type: string
example: '996411990498708810001'
description: Group Name
transactionReferenceNumber:
type: string
example: RZ3J9WCS9J33
description: Transaction Reference Number
merchantReferenceNumber:
type: string
example: '47882339'
description: Merchant Reference Number
description: Request Info Section
settlements:
type: array
description: List of Settlement Info values
items:
type: object
properties:
requestId:
type: string
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
transactionType:
type: string
example: Purchases
description: Transaction Type
submissionTime:
type: string
example: '2017-10-01T10:10:10+05:00'
description: Submission Date
format: date-time
amount:
type: string
example: '23.00'
description: Amount
currencyCode:
type: string
example: USD
description: Valid ISO 4217 ALPHA-3 currency code
paymentMethod:
type: string
example: VISA
description: payment method
walletType:
type: string
example: V.me
description: Solution Type (Wallet)
paymentType:
type: string
example: credit card
description: Payment Type
accountSuffix:
type: string
example: '0004'
description: Account Suffix
cybersourceBatchTime:
type: string
example: '2017-10-01T10:10:10+05:00'
description: Cybersource Batch Time
format: date-time
cybersourceBatchId:
type: string
example: '123123123123123'
description: Cybersource Batch Id
cardType:
type: string
example: 'null'
description: Card Type
debitNetwork:
type: string
example: ''
description: Debit Network
authorizations:
type: array
description: List of Authorization Info values
items:
type: object
properties:
requestId:
type: string
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
transactionReferenceNumber:
type: string
example: RZ3J9WCS9J27
description: Authorization Transaction Reference Number
time:
type: string
example: '2017-10-01T10:10:10+05:00'
description: Authorization Date
format: date-time
authorizationRequestId:
type: string
example: '12345678901234567890123459'
description: Authorization Request Id
amount:
type: string
example: '2.50'
description: Authorization Amount
currencyCode:
type: string
example: USD
description: Valid ISO 4217 ALPHA-3 currency code
code:
type: string
example: '160780'
description: Authorization Code
rcode:
type: string
example: '1'
description: Authorization RCode
description: Authorization Info Values
feeAndFundingDetails:
type: array
description: List of Fee Funding Info values
items:
type: object
properties:
requestId:
type: string
maxLength: 26
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
interchangePerItemFee:
type: string
example: '2.7'
description: interchange Per Item Fee
interchangeDescription:
type: string
example: Visa International Assessments (Enhanced)
description: interchange Description
interchangePercentage:
type: string
example: '0.25'
description: interchange Percentage
interchangePercentageAmount:
type: string
example: '-3.7500'
description: interchange Percentage Amount
discountPercentage:
type: string
example: '2.39'
description: Discount Percentage
discountAmount:
type: string
example: '0.429'
description: Discount Amount
discountPerItemFee:
type: string
example: '0.002'
description: Discount Per Item Fee
totalFee:
type: string
example: '0.429'
description: Total Fee
feeCurrency:
type: string
example: '1'
description: Fee Currency
duesAssessments:
type: string
example: '0'
description: Dues Assessments
fundingAmount:
type: string
example: '2.50'
description: Funding Amount
fundingCurrency:
type: string
example: USD
description: Funding Currency (ISO 4217)
description: Fee Funding Section
others:
type: array
description: List of Other Info values
items:
type: object
properties:
requestId:
type: string
maxLength: 26
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
merchantData1:
type: string
example: Merchant Defined Data
description: Merchant Defined Data
merchantData2:
type: string
example: Merchant Defined Data
description: Merchant Defined Data
merchantData3:
type: string
example: Merchant Defined Data
description: Merchant Defined Data
merchantData4:
type: string
example: Merchant Defined Data
description: Merchant Defined Data
firstName:
type: string
example: First Name
description: First Name
lastName:
type: string
example: Last Name
description: Last Name
description: Other Merchant Details Values.
settlementStatuses:
type: array
description: List of Settlement Status Info values
items:
type: object
properties:
requestId:
type: string
maxLength: 26
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
status:
type: string
example: Settlement Status
description: Settlement Status
settlementTime:
type: string
example: '2017-10-01T10:10:10+05:00'
format: date-time
description: Settlement Date
reasonCode:
example: reasonCode
type: string
description: ReasonCode
errorText:
example: errorText
type: string
description: errorText
description: Settlement Status Section Values.
description: PurchaseAndRefundDetails
text/csv:
schema:
title: reportingV3PurchaseRefundDetailsGet200Response
type: object
properties:
offset:
type: integer
limit:
type: integer
pageResults:
type: integer
requestDetails:
type: array
description: List of Request Info values
items:
type: object
properties:
requestId:
type: string
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
cybersourceMerchantId:
type: string
example: Cybersource Merchant Id
description: Cybersource Merchant Id
processorMerchantId:
type: string
example: Processor Merchant Id
description: Cybersource Processor Merchant Id
groupName:
type: string
example: '996411990498708810001'
description: Group Name
transactionReferenceNumber:
type: string
example: RZ3J9WCS9J33
description: Transaction Reference Number
merchantReferenceNumber:
type: string
example: '47882339'
description: Merchant Reference Number
description: Request Info Section
settlements:
type: array
description: List of Settlement Info values
items:
type: object
properties:
requestId:
type: string
example: '12345678901234567890123456'
description: An unique identification number assigned by CyberSource to identify the submitted request.
transactionType:
type: string
example: Purchases
description: Transaction Type
submissionTime:
type: string
example: '2017-10-01T10:10:10+05:00'
description: Submission Date
format: date-time
amount:
type: string
example: '23.00'
description: Amount
currencyCode:
type: string
example: USD
description: Valid ISO 4217 ALPHA-3 currency code
paymentMethod:
type: string
example: VISA
description: payment method
walletType:
type: string
example: V.me
description: Solution Type (Wallet)
paymentType:
type: string
example: credit card
description: Payment Type
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cybersource/refs/heads/main/openapi/cybersource-purchase-and-refund-details-api-openapi.yml