iris.merchants
Module iris.merchants
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_iris.merchants_1.1.0.png)
ballerinax/iris.merchants Ballerina library
Overview
This is a generated connector for IRIS Merchants API v1.6.4 OpenAPI specification.
Populate your data warehouse programmatically through this Merchants API and interact with your merchant services portfolio.
Data points include merchant demographics, deposits, transactions, retrievals, chargebacks, and statements across supported processors.
Each merchant account is accessible by users through a set of permissions controlled on the User Class level.
Segment your portfolio of merchants by filters such as processor, data source, and processing status.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a IRIS CRM account
- Obtain tokens by following this guide
Quickstart
To use the IRIS Merchants connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/iris.merchants
module into the Ballerina project.
import ballerinax/iris.merchants;
Step 2: Create a new connector instance
Create a merchants:ApiKeysConfig
with the API key obtained, and initialize the connector with it.
merchants:ApiKeysConfig config = { xApiKey: "<API_KEY>" } merchants:Client baseClient = check new Client(config);
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example on how to get a list of merchants using the connector.
Get a list of merchants
public function main() returns error? { merchants:InlineResponse200 response = check baseClient->getMerchants(); log:printInfo(response.toString()); }
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
iris.merchants: Client![](/images/permalink.svg)
This is a generated connector for IRIS Merchants API v1.6.4 OpenAPI specification.
Populate your data warehouse programmatically through this Merchants API and interact with your merchant services portfolio.
Data points include merchant demographics, deposits, transactions, retrievals, chargebacks, and statements across supported processors.
Each merchant account is accessible by users through a set of permissions controlled on the User Class level.
Segment your portfolio of merchants by filters such as processor, data source, and processing status.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a IRIS account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, string serviceUrl, ClientConfiguration clientConfig)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
getMerchants![](/images/permalink.svg)
function getMerchants(int? page, int? perPage, string? sortBy, string sortDir, string? 'group, string? processor, string? datasource, string? mid, string? name, string? vim, string? active, string? status, string? dateFilter, string? startDate, string? endDate) returns InlineResponse200|error
Get a list of merchants
Parameters
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
- sortBy string? (default ()) - Sorting of merchants by the field value
- sortDir string (default "asc") - Direction of sorting
- 'group string? (default ()) - Filter merchants by a group name
- processor string? (default ()) - Filter merchants by a processor name
- datasource string? (default ()) - Filter merchants by a data source name
- mid string? (default ()) - Filter merchants by a partial merchant number
- name string? (default ()) - Filter merchants by a partial merchant name
- vim string? (default ()) - Filter merchants by a merchant vim field
- active string? (default ()) - Filter merchants by a merchant active field
- status string? (default ()) - Filter merchants by a merchant status field
- dateFilter string? (default ()) - Filter merchants by a merchant specific date field
- startDate string? (default ()) - Start date for date_filter filter in format ISO 8601 for created and modified properties (Please note that
+
sign should be encoded to%2B
), for others properties you should use simple date format (Y-m-d).
- endDate string? (default ()) - End date for date_filter filter in format ISO 8601 for created and modified properties (Please note that
+
sign should be encoded to%2B
), for others properties you should use simple date format (Y-m-d)
Return Type
- InlineResponse200|error - A JSON array of merchants
getMerchantInformation![](/images/permalink.svg)
function getMerchantInformation(int merchantNumber) returns InlineResponse2001|error
Get detailed merchant information
Parameters
- merchantNumber int - Merchant number
Return Type
- InlineResponse2001|error - Detailed merchant account information
updateMerchantInformation![](/images/permalink.svg)
function updateMerchantInformation(int merchantNumber, MerchantsMerchantnumberBody payload) returns InlineResponse2002|error
Update an existing merchant
Parameters
- merchantNumber int - Merchant number
- payload MerchantsMerchantnumberBody - Merchant changes (send only fields you want to change)
Return Type
- InlineResponse2002|error - Merchant has been updated successfully
getDepositRecords![](/images/permalink.svg)
function getDepositRecords(int merchantNumber, int year, int month, int day, string? endDate) returns InlineResponse2003|error
Get a list of deposits records and totals
Parameters
- merchantNumber int - Merchant number
- year int - Start deposits year
- month int - Start deposits month
- day int - Start deposits day.
- endDate string? (default ()) - Filter deposits by a date in format Y-m-d. Should be no more than 90 days from the start date.
Return Type
- InlineResponse2003|error - A list of deposits
getBatches![](/images/permalink.svg)
function getBatches(int merchantNumber, int? page, int? perPage, string? startDate, string? endDate) returns InlineResponse2004|error
Get a list of batches and transactions
Parameters
- merchantNumber int - Merchant number
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
- startDate string? (default ()) - Filter batches by a date (Y-m-d)
- endDate string? (default ()) - Filter batches by a date (Y-m-d)
Return Type
- InlineResponse2004|error - A list of batches and transactions
getChargebacks![](/images/permalink.svg)
function getChargebacks(int merchantNumber, int? page, int? perPage, string? startDate, string? endDate) returns InlineResponse2005|error
Get a list of chargeback cases
Parameters
- merchantNumber int - Merchant number
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
- startDate string? (default ()) - Filter batches by a date (Y-m-d)
- endDate string? (default ()) - Filter batches by a date (Y-m-d)
Return Type
- InlineResponse2005|error - A list of chargeback cases
getChargebackCaseInformation![](/images/permalink.svg)
function getChargebackCaseInformation(int merchantNumber, string caseNumber) returns ChargebackReplyResponse|error
Get detailed chargeback case information
Return Type
- ChargebackReplyResponse|error - Chargeback detail information
getRetrievalCases![](/images/permalink.svg)
function getRetrievalCases(int merchantNumber, int? page, int? perPage, string? startDate, string? endDate) returns InlineResponse2007|error
Get a list of retrieval cases
Parameters
- merchantNumber int - Merchant number
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
- startDate string? (default ()) - Filter batches by a date (Y-m-d)
- endDate string? (default ()) - Filter batches by a date (Y-m-d)
Return Type
- InlineResponse2007|error - A list of retrieval cases
getDetailedRetrievalCaseInformation![](/images/permalink.svg)
function getDetailedRetrievalCaseInformation(int merchantNumber, string caseNumber) returns RetrievalsReplyResponse|error
Get detailed retrieval case information
Return Type
- RetrievalsReplyResponse|error - A list of retrieval cases
getStatements![](/images/permalink.svg)
function getStatements(int merchantNumber, int? page, int? perPage) returns InlineResponse2008|error
Get a list of statements
Parameters
- merchantNumber int - Merchant number
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse2008|error - A list of statements
downloadStatement![](/images/permalink.svg)
Download a statement
uploadAttachment![](/images/permalink.svg)
function uploadAttachment(string filename) returns InlineResponse2009|error
Upload an attachment to a chargeback or retrieval dispute case
Parameters
- filename string - File name for validation
Return Type
- InlineResponse2009|error - Document
downloadChargebackCaseFiles![](/images/permalink.svg)
function downloadChargebackCaseFiles(int merchantNumber, int caseNumber, int fileId) returns DisputeFile[]|error
Download chargeback case files
Parameters
- merchantNumber int - Merchant number
- caseNumber int - Chargeback case number
- fileId int - File Id (leave empty to get all case files)
Return Type
- DisputeFile[]|error - Files
Records![](/images/permalink.svg)
iris.merchants: AdjustmentsInner![](/images/permalink.svg)
Fields
- date string? - Adjustment date
- 'type string? - Adjustment type
- amount string? - Adjustment amount
iris.merchants: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Represents API Key
X-API-KEY
iris.merchants: BriefMerchantInfo![](/images/permalink.svg)
Fields
- mid string? - Merchant number
- name string? - Merchant name
- opened string? - Merchant open date
- closed string? - Merchant closed date
- created string? - Merchant created date
- modified string? - Merchant modified date
- first_batch string? - Merchant first batch date
- last_batch string? - Merchant last batch date
- 'group string? - Group name
- processor string? - Processor name
- datasource string? - Data source name
- sic_code string? - SIC Code
- vim string? - Is VIM?
- deactivated string? - Merchant deactivation date
- status string? - Merchant status
- active string? - Merchant active flag
iris.merchants: Chargeback![](/images/permalink.svg)
Fields
- id int? - Chargeback internal ID
- merchant_id string? - Merchant ID
- dba string? - Merchant DBA
- case_number string? - Case number
- chargeback_date string? - Chargeback date
- transaction_date string? - Transaction date
- respond_due string? - Respond due date
- amount string? - Amount
- original_amount string? - Original amount of transaction
- currency string? - Transaction currency
- reason string? - Chargeback reason
- reason_code string? - Chargeback reason code
- card_number string? - Cardholder number
- reply_form string? - Reply form type. Affects reply options.
- cycle_indicator string? - Chargeback cycle indicator
- transaction_id string? - Transaction ID
- reference_number string? - Transaction ID
- case_status string? - Case status
- case_status_description string? - Status description
- mcc string? - MCC code
- dispute_jurisdiction string? - Dispute jurisdiction
- card_product_type string? - Card product
- process_date string? - Process date
- transaction_method string? - Transaction method
- invoice_number string? - Invoice number
- microfilm_number string? - Microfilm number
- airline_ticket_number string? - Airline ticket number
- order_number string? - Order number
- tracking_number string? - Tracking number
- last_status_date string? - Date of the last status update
- updated_at string? - Date of the most recent update
- case_action string? - Case action
- action string? - Can the case be viewed of replied
- foreign_amount string? - Foreign amount of transaction
- transaction_locator string? - Transaction locator
- authorization_code string? - Authorization code
- 'type string? - Chargeback type
iris.merchants: ChargebackReplyResponse![](/images/permalink.svg)
Fields
- chargeback ChargebackreplyresponseChargeback? -
- items ChargebackreplyresponseItems? -
- Fields Included from *DisputeDetailsResponse
- transactions DisputedetailsresponseTransactions[]|()
- auth_records DisputedetailsresponseTransactions[]|()
- notes DisputedetailsresponseNotes[]|()
- messages DisputedetailsresponseMessages[]|()
- directories DisputedetailsresponseDirectories[]|()
- anydata...
iris.merchants: ChargebackreplyresponseChargeback![](/images/permalink.svg)
Fields
- id string? -
- merchant_id string? -
- dba string? -
- cycle_indicator string? -
- date string? -
- transaction_date string? -
- amount string? -
- reason_code string? -
- reason string? -
- card_number string? -
- case_number string? -
- case_action string? -
- action string? -
- reply_form string? -
- case_status string? -
- case_status_description string? -
- last_status_date string? -
- respond_due string? -
- original_amount string? -
- updated_at string? -
- mcc string? -
- dispute_jurisdiction string? -
- card_product_type string? -
- process_date string? -
- transaction_method string? -
- invoice_number string? -
- microfilm_number string? -
- airline_ticket_number string? -
- order_number string? -
- tracking_number string? -
iris.merchants: ChargebackreplyresponseItems![](/images/permalink.svg)
Fields
- reason string? -
- message_from_bank string? -
- merchant_due_date string? -
- financial_disposition_date string? -
- 'type string? -
iris.merchants: DepositsInner![](/images/permalink.svg)
Fields
- date string? - Deposit date
- amount string? - Deposit amount
- transactions int? - Transactions count
- batch string? - Deposit batch number
iris.merchants: DisputeDetailsResponse![](/images/permalink.svg)
Fields
- transactions DisputedetailsresponseTransactions[]? -
- auth_records DisputedetailsresponseTransactions[]? -
- notes DisputedetailsresponseNotes[]? -
- messages DisputedetailsresponseMessages[]? -
- directories DisputedetailsresponseDirectories[]? -
iris.merchants: DisputedetailsresponseDirectories![](/images/permalink.svg)
Fields
- time string? -
- title string? -
- files DisputedetailsresponseFiles[]? -
iris.merchants: DisputedetailsresponseFields![](/images/permalink.svg)
Fields
- 'key string? -
- value string? -
iris.merchants: DisputedetailsresponseFiles![](/images/permalink.svg)
Fields
- time string? -
- title string? -
- url string? - site url
- api_url string? - api url
iris.merchants: DisputedetailsresponseMessages![](/images/permalink.svg)
Fields
- message string? -
- description string? -
- added_at string? -
- viewed_on string? -
iris.merchants: DisputedetailsresponseNotes![](/images/permalink.svg)
Fields
- message string? -
- added_at string? -
iris.merchants: DisputedetailsresponseTransactions![](/images/permalink.svg)
Fields
- reference string? -
- fields DisputedetailsresponseFields[]? -
iris.merchants: DisputeFile![](/images/permalink.svg)
Fields
- name string? - File name
- directory string? - Folder name
- content string? - base64 encoded content
iris.merchants: InlineResponse200![](/images/permalink.svg)
Fields
- data record { leads int[]? }[]? -
- links Links? -
- meta Meta? -
iris.merchants: InlineResponse2001![](/images/permalink.svg)
Fields
- general BriefMerchantInfo? -
- account_information string[]? -
- leads int[]? - A list of linked lead Id's. First from this list is always used as a primary lead.
iris.merchants: InlineResponse2002![](/images/permalink.svg)
Fields
- message string? -
iris.merchants: InlineResponse2003![](/images/permalink.svg)
Fields
- deposits Deposits? -
- adjustments Adjustments? -
- totals InlineResponse2003Totals? -
iris.merchants: InlineResponse2003Totals![](/images/permalink.svg)
Fields
- total_paid_by_us string? -
- monthly_total string? -
- adjustments InlineResponse2003TotalsAdjustments[]? -
- deposits InlineResponse2003TotalsDeposits[]? -
- per_card_type InlineResponse2003TotalsPerCardType[]? -
- transactions_count int? -
iris.merchants: InlineResponse2003TotalsAdjustments![](/images/permalink.svg)
Fields
- 'type string? -
- amount string? -
iris.merchants: InlineResponse2003TotalsDeposits![](/images/permalink.svg)
Fields
- date string? -
- amount string? -
iris.merchants: InlineResponse2003TotalsPerCardType![](/images/permalink.svg)
Fields
- 'type string? -
- amount string? -
- count int? -
iris.merchants: InlineResponse2004![](/images/permalink.svg)
Fields
- data MonetaryBatch[]? -
- links Links? -
- meta Meta? -
- adjustments Adjustments? -
iris.merchants: InlineResponse2005![](/images/permalink.svg)
Fields
- data Chargeback[]? -
- links Links? -
- meta Meta? -
iris.merchants: InlineResponse2007![](/images/permalink.svg)
Fields
- data Retrieval[]? -
- links Links? -
- meta Meta? -
iris.merchants: InlineResponse2008![](/images/permalink.svg)
Fields
- data InlineResponse2008Data[]? -
iris.merchants: InlineResponse2008Data![](/images/permalink.svg)
Fields
- id int? - Statement Id
- date string? - Statement date
iris.merchants: InlineResponse2009![](/images/permalink.svg)
Fields
- status string? -
- file_id string? -
iris.merchants: Links![](/images/permalink.svg)
Fields
- first string? - An URL to the first page of the data set
- last string? - An URL to the last page of the data set
- prev string? - An URL to the previous page of the data set
- next string? - An URL to the next page of the data set
iris.merchants: MerchantsMerchantnumberBody![](/images/permalink.svg)
Fields
- name string? - Merchant name
- opened string? - Merchant open date (YYYY-MM-DD)
- closed string? - Merchant closed date (YYYY-MM-DD)
- processor string? - Processor name
- datasource string? - Data source name
- 'group string? - Group name
- vim string? - Is VIM?
- status string? - Merchant status
- active string? - Merchant active flag
iris.merchants: Meta![](/images/permalink.svg)
Fields
- current_page int? - The current page number of a data set
- 'from int? - The current position of a data set
- last_page string? - The last page of a data set
- path string? - API path
- per_page int? - A number of records per page
- to int? - The last position in a data set
- total int? - Total number of records in a data set
iris.merchants: MonetaryBatch![](/images/permalink.svg)
Fields
- date string? - Batch date
- reference_number string? - Batch description
- amount string? - Batch amount
- count string? - A number of transactions
- terminal_number string? - Batch terminal number
- transactions MonetarybatchTransactions[]? -
iris.merchants: MonetarybatchTransactions![](/images/permalink.svg)
Fields
- id int? - Transaction ID
- date string? - Transaction date
- 'type string? - Transaction type
- amount string? - Transaction amount
- cardholder string? - Cardholder number
- auth_code string? - Transaction auth code
- pos_entry_mode string? - POS entry mode
- invoice_number string? - Invoice number
- void_reject_chargeback boolean? - Is a transaction rejected?
iris.merchants: Retrieval![](/images/permalink.svg)
Fields
- id int? - Chargeback internal ID
- merchant_id string? - Merchant ID
- dba string? - Merchant DBA
- case_number string? - Case number
- retrieval_date string? - Request date
- transaction_date string? - Transaction date
- amount string? - Amount
- respond_due string? - Respond due date
- original_amount string? - Original amount of transaction
- currency string? - Transaction currency
- reason string? - Retrieval case reason
- reason_code string? - Retrieval case reason code
- card_number string? - Cardholder number
- transaction_id string? - Transaction ID
- reference_number string? - Transaction ID
- case_status string? - Case status
- case_status_description string? - Status description
- mcc string? - MCC code
- dispute_jurisdiction string? - Dispute jurisdiction
- card_product_type string? - Card product
- transaction_method string? - Transaction method
- invoice_number string? - Invoice number
- microfilm_number string? - Microfilm number
- airline_ticket_number string? - Airline ticket number
- order_number string? - Order number
- tracking_number string? - Tracking number
- last_status_date string? - Date of the last status update
- updated_at string? - Date of the most recent update
- case_action string? - Case action
- action string? - Can the case be viewed of replied
- foreign_amount string? - Foreign amount of transaction
- transaction_locator string? - Transaction locator
iris.merchants: RetrievalsReplyResponse![](/images/permalink.svg)
Fields
- retrieval RetrievalsreplyresponseRetrieval? -
- Fields Included from *DisputeDetailsResponse
- transactions DisputedetailsresponseTransactions[]|()
- auth_records DisputedetailsresponseTransactions[]|()
- notes DisputedetailsresponseNotes[]|()
- messages DisputedetailsresponseMessages[]|()
- directories DisputedetailsresponseDirectories[]|()
- anydata...
iris.merchants: RetrievalsreplyresponseRetrieval![](/images/permalink.svg)
Fields
- id string? -
- merchant_id string? -
- dba string? -
- date string? -
- transaction_date string? -
- amount string? -
- reason_code string? -
- reason string? -
- card_number string? -
- case_number string? -
- case_action string? -
- action string? -
- case_status string? -
- case_status_description string? -
- last_status_date string? -
- respond_due string? -
- original_amount string? -
- updated_at string? -
- mcc string? -
- dispute_jurisdiction string? -
- card_product_type string? -
- foreign_amount string? -
- transaction_method string? -
- transaction_locator string? -
- invoice_number string? -
- microfilm_number string? -
- airline_ticket_number string? -
- order_number string? -
- tracking_number string? -
Import
import ballerinax/iris.merchants;
Metadata
Released date: over 2 years ago
Version: 1.1.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta6
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Paid
Contributors
Dependencies