--- swagger: '2.0' info: version: v1 title: PivotalPayments.App.Pivotal360.Web description: A REST API that provides access to transaction processing data in Pivotal Reporting host: pivotalpayments-dev.apigee.net schemes: - https paths: "/reporting/api/Batches/List": get: tags: - Batches summary: Get a list of batches for a set of MIDs operationId: Batches_List consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: mids in: query description: Comma separated list of mids required: true type: string - name: startDate in: query description: start date required: true type: string format: date-time - name: endDate in: query description: end data required: true type: string format: date-time responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/Batch" deprecated: false "/reporting/api/Batches/Totals": get: tags: - Batches summary: Gets the totals for a batch list query. operationId: Batches_Totals consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: mids in: query description: Comma separated list of mids required: true type: string - name: startDate in: query description: start date required: true type: string format: date-time - name: endDate in: query description: end data required: true type: string format: date-time responses: '200': description: OK schema: "$ref": "#/definitions/BatchTotal" deprecated: false "/reporting/api/Batches/Details": get: tags: - Batches summary: Gets the details for a specific batch. operationId: Batches_Details consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: merchantPK in: query description: Found from the batch list record. required: true type: integer format: int64 - name: merchantTIDPK in: query description: Found from the batch list record. required: true type: integer format: int64 - name: batchID in: query description: Found from the batch list record. required: true type: integer format: int32 - name: batchCloseDatePK in: query description: Found from the batch list record. required: true type: integer format: int32 responses: '200': description: OK schema: "$ref": "#/definitions/BatchDetail" deprecated: false "/reporting/api/Batches/Transactions": get: tags: - Batches summary: Gets the transactions for a specific batch. operationId: Batches_Transactions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: merchantPK in: query description: Found from the batch list record. required: true type: integer format: int64 - name: merchantTIDPK in: query description: Found from the batch list record. required: true type: integer format: int64 - name: batchID in: query description: Found from the batch list record. required: true type: integer format: int32 - name: batchCloseDatePK in: query description: Found from the batch list record. required: true type: integer format: int32 responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/BatchDetailTransaction" deprecated: false "/reporting/api/Batches/Last5": get: tags: - Batches summary: Gets the last 5 batches for a group of mids. operationId: Batches_Last5 consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: mids in: query description: Comma separated list of mids required: true type: string responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/Last5Batch" deprecated: false "/reporting/api/Funding/Last5": get: tags: - Funding summary: Gets the last 5 funding for a group of mids. operationId: Funding_Last5 consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: mids in: query description: Comma separated list of mids required: true type: string responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/Last5Funding" deprecated: false "/reporting/api/Transactions/GetACHTransactions": get: tags: - Transactions summary: Gets a list of ACH Transactions operationId: Transactions_GetACHTransactions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: startDate in: query description: The date to filter begin required: true type: string format: date-time - name: endDate in: query description: The date to filter end required: true type: string format: date-time - name: dateType in: query description: Type of date to filter by. 0 = TransactionDateTime, 1 = EffectiveDate, 2 = DateCode required: false type: integer format: int32 enum: - 0 - 1 - 2 responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/ACHTransaction" deprecated: false "/reporting/api/Transactions/GetCreditTransactions": get: tags: - Transactions summary: Gets a list of Credit Transactions operationId: Transactions_GetCreditTransactions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: startDate in: query description: The date to filter begin required: true type: string format: date-time - name: endDate in: query description: The date to filter end required: true type: string format: date-time responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/CreditTransaction" deprecated: false "/reporting/api/Transactions/GetDisputeTransactions": get: tags: - Transactions summary: Gets a list of Dispute Transactions operationId: Transactions_GetDisputeTransactions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: startDate in: query description: The date to filter begin required: true type: string format: date-time - name: endDate in: query description: The date to filter end required: true type: string format: date-time responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/DisputeTransaction" deprecated: false "/reporting/api/Transactions/GetFundingTransactions": get: tags: - Transactions summary: Gets a list of Funding Transactions operationId: Transactions_GetFundingTransactions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: startDate in: query description: The date to filter begin required: true type: string format: date-time - name: endDate in: query description: The date to filter end required: true type: string format: date-time responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/FundingTransaction" deprecated: false "/reporting/api/Transactions/GetAuthorizationTransactions": get: tags: - Transactions summary: Gets a list of Authorization Transactions operationId: Transactions_GetAuthorizationTransactions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: startDate in: query description: The date to filter begin required: true type: string format: date-time - name: endDate in: query description: The date to filter end required: true type: string format: date-time responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/AuthorizationTransaction" deprecated: false "/reporting/api/Transactions/GetBatchTransactions": get: tags: - Transactions summary: Gets a list of Batch Transactions operationId: Transactions_GetBatchTransactions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: startDate in: query description: The date to filter begin required: true type: string format: date-time - name: endDate in: query description: The date to filter end required: true type: string format: date-time responses: '200': description: OK schema: type: array items: "$ref": "#/definitions/BatchTransaction" deprecated: false definitions: Batch: type: object properties: BatchID: format: int32 type: integer TID: type: string BatchCloseDate: format: date-time type: string SaleCnt: format: int32 type: integer ReturnCnt: format: int32 type: integer SaleAmt: format: double type: number ReturnAmt: format: double type: number BatchNet: format: double type: number BankCardCnt: format: int32 type: integer BankCardAmt: format: double type: number DebitCnt: format: int32 type: integer DebitAmt: format: double type: number AmexCnt: format: int32 type: integer AmexAmt: format: double type: number OtherCnt: format: int32 type: integer OtherAmt: format: double type: number MID: type: string Merchant_FK: format: int64 type: integer BatchCloseDate_DateCode_FK: format: int32 type: integer MerchantTID_FK: format: int64 type: integer FundingAmount: format: double type: number FundingDate: format: date-time type: string BatchTotal: type: object properties: Count: format: int32 type: integer Net: format: double type: number SalesCount: format: int32 type: integer SalesAmount: format: double type: number ReturnsCount: format: int32 type: integer ReturnsAmount: format: double type: number BankCardCount: format: int32 type: integer BankCardAmount: format: double type: number AmexCount: format: int32 type: integer AmexAmount: format: double type: number DebitCount: format: int32 type: integer DebitAmount: format: double type: number OtherCount: format: int32 type: integer OtherAmount: format: double type: number BatchDetail: type: object properties: MID: type: string TerminalID: type: string BatchID: format: int64 type: integer BatchDate: format: date-time type: string Count: format: int32 type: integer Net: format: double type: number SalesCount: format: int32 type: integer SalesAmount: format: double type: number ReturnsCount: format: int32 type: integer ReturnsAmount: format: double type: number BankCardCount: format: int32 type: integer BankCardAmount: format: double type: number AmexCount: format: int32 type: integer AmexAmount: format: double type: number DebitCount: format: int32 type: integer DebitAmount: format: double type: number OtherCount: format: int32 type: integer OtherAmount: format: double type: number BatchDetailTransaction: type: object properties: MID: type: string MaskedPAN: type: string TransactionNumber: format: int64 type: integer ARN: type: string TransactionDate: format: date-time type: string EntryMode: type: string TransactionType: type: string CardType: type: string AuthCode: type: string Amount: format: double type: number TID: type: string BatchCloseDate: format: date-time type: string BatchID: format: int64 type: integer CVVResponse: format: int32 type: integer AuthResponseCode: format: int32 type: integer AVSResponseCode: format: int32 type: integer TransactionCurrencyCode: type: string CurrencyCode: type: string ConversionRate: format: double type: number CardholderAmount: format: double type: number CardCategory: type: string CardCategory2: type: string Merchant_PK: format: int64 type: integer MerchantTerminal_PK: format: int64 type: integer BatchCloseDate_DateCode_FK: format: int32 type: integer Last5Batch: type: object properties: BatchID: format: int64 type: integer TID: type: string BatchCloseDate: type: string SaleCnt: format: int32 type: integer ReturnCnt: format: int32 type: integer SaleAmt: format: double type: number ReturnAmt: format: double type: number BatchNet: format: double type: number MID: type: string Merchant_FK: format: int64 type: integer BatchCloseDate_DateCode_FK: format: int32 type: integer MerchantTID_FK: format: int64 type: integer Last5Funding: type: object properties: MID: type: string FundingDate: format: date-time type: string LinkCount: format: int32 type: integer CreditAmount: format: double type: number DebitAmount: format: double type: number NetAmount: format: double type: number ACHTransaction: description: ACH Transaction type: object properties: EntityID: description: Entity Identifier type: string TransactionDateTime: description: Transaction date and time on the ACH Provider type: string BatchNumber: description: Batch number - assigned by the ACH Provider type: string OriginatedAs: description: Transaction originated as - 'ACH' is the default value - assigned by the ACH Provider type: string IsDuplicate: description: Duplicate flag used by the ACH Provider type: string EffectiveDate: description: Transaction date and time transaction was sent on the ACH Provider type: string FaceFeeType: description: It designates the type of fee being charged. Default is null - assigned by the ACH Provider type: string TransactionStatus: description: Transaction has been declined/processed - assigned by the ACH Provider type: string PaymentType: description: The type of payment being requested – checking (default), money order, Master Card - assigned by the ACH Provider type: string NameOnAccount: description: Cardholder Name type: string TransactionNumber: description: Unique Transaction number type: string ReferenceNumber: description: Unique Transaction number - assigned by the ACH Provider type: string CustomerNumber: description: Unique identifier for each customer - assigned by the ACH Provider type: string OperationType: description: Operation type; sale, auth, capture - assigned by the ACH Provider type: string LocationName: description: Merchant name type: string TotalAmount: description: Total transaction amount type: string AuthResponse: description: It designates the response code of a transaction - assigned by the ACH Provider type: string PaymentOrigin: description: Origin of the payment ( Internet, Telephone, Signature_original) - assigned by the ACH Provider type: string SettlementStatus: description: Transaction status is settled - assigned by the ACH Provider type: string AccountNumber: description: Account number - assigned by the ACH Provider type: string CheckNumber: description: Cheque number of the transaction - assigned by the ACH Provider type: string CustField1: description: Custom field - assigned by the ACH Provider type: string CustField2: description: Custom field - assigned by the ACH Provider type: string CustField3: description: Custom field - assigned by the ACH Provider type: string Field1: description: Custom field - assigned by the ACH Provider type: string Field2: description: Custom field - assigned by the ACH Provider type: string Field3: description: Custom field - assigned by the ACH Provider type: string ThirdPartyReferenceNumber: description: Third party number - assigned by the ACH Provider type: string AuditUserName: description: User name - assigned by the ACH Provider type: string EventDateTime: description: Historical time events of a transaction - assigned by the ACH Provider type: string EventType: description: Event status type from ACH provider- Settled, declined, approved, originated type: string EventDataString: description: Event description of a transaction - Success, velocity exceeded type: string OwnerApplication: description: Application owner - e.g. - Web service - assigned by the ACH Provider type: string ReceivingApplication: description: Source of the application - e.g. - Web service - assigned by the ACH Provider type: string OwnerAppReferenceId: description: Owner application referece ID - assigned by the ACH Provider type: string ReturnCode: description: Return Entry Codes - assigned by the ACH Provider type: string Notice_Of_Change: description: NOC code + '-' + description - assigned by the ACH Provider type: string MainAgent: description: Main agent identifier type: string Mid: description: Merchant identifier type: string AchMid: format: int32 description: Ach merchant identifier type: integer AchLid: format: int32 description: '' type: integer CreditTransaction: description: Credit card transaction type: object properties: MID: description: Merchant Identifier type: string MaskedPAN: description: Masked Credit card number type: string TransactionNumber: format: int32 description: Unique Transaction Number type: integer ARN: description: Acquirer Reference Number type: string TransactionDate: format: date-time description: Date of the transaction type: string EntryMode: description: 'Way card processed: card present, card not present, swipes, chip' type: string TransactionType: description: Type for Credit Card used for Transaction type: string CardType: description: Tyoe for Credit Card used for Transaction type: string AuthCode: description: Authorization Code type: string Amount: format: double description: The amount of the transaction type: number TID: description: Terminal ID type: string BatchCloseDate: format: date-time description: The date the batch was closed type: string BatchID: format: int32 description: The identifier of the batch type: integer CVVResponse: description: CVV validation response type: string AuthResponseCode: description: The authorization response code type: string AVSResponseCode: description: Address verification response type: string TransactionCurrencyCode: description: The currency code of the transaction type: string CardholderCurrencyCode: description: The currency code of the card holder type: string CardholderConversionRate: format: double description: Conversion rate of the transaction if applicable type: number CardholderAmount: format: double description: The amount of the transaction in native currency type: number CardCategory: type: string CardCategory2: type: string OrderID: description: The order identifier supplied by merchant type: string UniqueRef: description: The unique transaction identifier type: string DisputeTransaction: description: Disute transaction type: object properties: DisputeDate: format: date-time description: The date of the dispute type: string DisputeType: description: The type of dispute submitted type: string DisputeAmount: format: double description: The amount of the dispute type: number CardType: description: Card type of the dispute type: string CaseNumber: description: The case number of the dispute type: string ARN: description: Acquirer Reference Number type: string OriginalTransactionDate: format: date-time description: The date of the disputed transaction type: string ReasonDescKey: description: The dispute reason key type: string ReasonDesc: description: A description of the dispute type: string ResolutionDate: format: date-time description: The date the dispute was resolved type: string BatchID: format: int32 description: The associated batch. type: integer MerchantTID_FK: format: int64 type: integer MID: description: Merchant identifier type: string PAN: description: Masked card number type: string FundingTransaction: description: Funding transaction type: object properties: MID: description: Merchant identifier type: string BatchDesc: description: The batch description type: string CodeDescription: type: string FundingDate: format: date-time description: The date of funding type: string Amount: format: double description: The amount that was funded type: number RecordCount: format: int32 description: Number of transactions in the funding type: integer RefNumber: description: Funding reference number type: string Batch: description: Associated batch for the funding if applicable type: string AuthorizationTransaction: description: Authorization transactions type: object properties: MID: description: Merchant Identifier type: string MaskedPAN: description: Masked Credit card number type: string TransactionNumber: format: int32 description: Unique Transaction Number type: integer RetrievalReferenceNumber: description: Links incremental/estimated sales to original authorization request type: string TransactionDate: format: date-time description: Date of the transaction type: string EntryMode: description: 'Way card processed: card present, card not present, swipes, chip' type: string TransactionType: description: Type of transaction (Sale, refund, etc) type: string CardType: description: Type for Credit Card used for Transaction type: string AuthCode: description: Authorization Code type: string Amount: format: double description: The amount of the transaction type: number TID: description: Terminal ID type: string TransactionCurrencyCode: description: The currency code of the transaction type: string CardCategory: type: string CardCategory2: type: string MTI: description: Message Type Indicator (numeric code identifying transaction type) type: string ResponseCode: description: Auth Response Code (approved, declined, NSF, etc.) type: string BatchTransaction: description: Batch Transaction type: object properties: BatchID: format: int32 description: Batch Identifier type: integer TID: description: Terminal Identifier type: string BatchCloseDate: format: date-time description: The close date of the batch type: string SaleCnt: format: int32 description: The number of sales in the batch type: integer ReturnCnt: format: int32 description: The number of returns in the batch type: integer SaleAmt: format: double description: The total amount of all sales type: number ReturnAmt: format: double description: The total amount of all returns type: number BatchNet: format: double description: The total net amount of the batch type: number BankCardCnt: format: int32 description: The number of bank card transactions in the batch type: integer BankCardAmt: format: double description: The total amount of bank card transactions type: number DebitCnt: format: int32 description: The number of debit transactions type: integer DebitAmt: format: double description: The total amount of debit transactions type: number AmexCnt: format: int32 description: The number of American Express transactions type: integer AmexAmt: format: double description: The total amount of American Express transactions type: number OtherCnt: format: int32 description: The number of other transactions type: integer OtherAmt: format: double description: The total amount of other transactions type: number MID: description: Merchant Identifier type: string