{"openapi":"3.1.0","info":{"title":"BigStar Notification API","version":"1.0"},"servers":[{"url":"https://api-mint.paramountcommerce.com/oebigstarnoti"}],"security":[{"bearerAuth":[]}],"paths":{"/report/v4/report":{"post":{"summary":"Reporting","description":"The Reporting API supports two types of report: transaction reports and return reports.","operationId":"reporting","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string","description":"The relevant error code, if applicable.","example":"V026"},"errorMessage":{"type":"string","description":"The error message associated with the error code.","example":"Report query type not specified."}}}}}},"500":{"description":"Internal system error"}},"deprecated":false}},"/report/v4/transaction-status":{"post":{"summary":"Get transaction status","description":"Get transaction status endpoint.","operationId":"transactionStatus","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionStatusRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionStatusResponse"}}}},"400":{"description":"Invalid request"},"401":{"description":"Not authorized"},"500":{"description":"Internal system error"}}}},"/service/servlet/ConfirmTrans":{"post":{"summary":"Verifying notifications","description":"Merchant confirm notification","operationId":"confirmTransaction","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmTransactionRequest"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmTransactionResponse"}}}}}}}},"webhooks":{"sendTransactionNotification":{"post":{"summary":"Transaction notifications","description":"After Instant Bank Transfer processes a transaction request, it sends a notification to the merchant's transaction notification URL.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionNotification"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}},"sendReturnNotification":{"post":{"summary":"Return notifications","description":"A return notification notifies the merchant that a settled payment transaction has been returned by the consumer’s bank.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnNotification"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TransactionStatusRequest":{"type":"object","required":["transactionId"],"properties":{"transactionId":{"type":"string","description":"The Paramount-assigned unique product transaction ID.","example":"20210512184646190729000000"}}},"TransactionStatusResponse":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"},"transaction":{"$ref":"#/components/schemas/StatusTransaction"},"account":{"$ref":"#/components/schemas/StatusAccount"}}},"StatusTransaction":{"type":"object","properties":{"transactionType":{"type":"string","description":"DEBIT is a consumer payin. CREDIT is a payout from merchant to consumer. Allowed values: DEBIT | CREDIT","enum":["DEBIT","CREDIT"]},"transactionFee":{"type":"integer","description":"The transaction fee amount payable by the merchant, if applicable.","example":100},"transactionStatus":{"type":"string","description":"A FAILED status typically indicates an error related to transaction processing, such as a validation or internal error. A REJECTED status typically indicates that a service, such as risk management, stopped the request from proceeding. Allowed values: SUCCESS | REJECTED | FAILED","enum":["SUCCESS","REJECTED","FAILED"]},"currencyCode":{"type":"string","description":"The 3-letter currency code (ISO 4217).","example":"CAD"},"transactionId":{"type":"string","description":"The Paramount-assigned unique product transaction ID.","example":"20210512184646190729000000"},"paymentMethod":{"type":"string","description":"The payment processing method. Allowed value: EFT"},"errorCode":{"type":"string","description":"The relevant error code, if applicable.","example":"99"},"returnCode":{"type":"string","description":"The applicable EFT return code. This is included only if the transactionStatus is RETURNED or RETURNED_WITH_REPRESENTMENT."},"nextActionDate":{"type":"string","description":"The representment date. This is included only if the transactionStatus is RETURNED or RETURNED_WITH_REPRESENTMENT.(ISO 8601) yyyy-MM-dd","example":"2022-10-1"}}},"StatusAccount":{"type":"object","properties":{"accountMask":{"type":"string","description":"The masked account number that will be displayed by the merchant to the consumer in subsequent transactions. This is in the format ****1234.","minLength":8,"maxLength":8},"bankName":{"type":"string","description":"The name of the consumer’s bank."},"obvToken":{"type":"string","description":"A token that uniquely identifies the consumer’s bank account in the Instant Bank Transfer system."},"accountType":{"type":"string","description":"The consumer’s bank account type, either personal checking (PC) or personal savings (PS)"}}},"ReportRequest":{"type":"object","required":["productList","report"],"properties":{"productList":{"type":"string","description":"The product type. Allowed value: IBT","example":"IBT"},"report":{"$ref":"#/components/schemas/ReportInfo"},"merchant":{"$ref":"#/components/schemas/ReportMerchant"},"transaction":{"$ref":"#/components/schemas/ReportTransaction"}}},"ReportInfo":{"type":"object","required":["startDateTime","endDateTime","outputType"],"properties":{"queryType":{"type":"string","enum":["TRANSACTION","RETURN"],"description":"The type of report to generate.  Allowed values: TRANSACTION, RETURN","example":"TRANSACTION"},"startDateTime":{"type":"string","description":"he report start date and time (UTC). Format: 2020-02-21T00:00:00.000Z (ISO 8601)","format":"date","example":"2020-02-21T00:00:00.000Z"},"endDateTime":{"type":"string","description":"The report end date and time (UTC). Format: 2020-02-21T00:00:00.000Z (ISO 8601)","format":"date","example":"2020-03-21T23:59:59.000Z"},"outputType":{"type":"string","description":"The report output format: JSON or CSV. Allowed values: JSON, CSV","enum":["JSON","CSV"],"example":"JSON"},"outputZipFile":{"type":"boolean","description":"True or false. If true, the JSON or CSV data is provided in a compressed ZIP file.  Allowed values: TRUE, FALSE","example":false}}},"ReportMerchant":{"type":"object","properties":{"merchantList":{"type":"array","description":"A list of merchant IDs.","items":{"type":"string"},"example":["Test_Q_A","AutoMerV"]},"merchantConsumerId":{"type":"string","description":"The merchant-assigned unique Consumer ID.","minLength":3,"maxLength":64,"example":"user123"},"merchantTransactionList":{"type":"array","description":"A list of transaction IDs.","items":{"type":"string"}}}},"ReportTransaction":{"type":"object","properties":{"transactionType":{"type":"string","description":"The transaction type.  Allowed values: DEBIT, CREDIT, VERIFY","enum":["DEBIT","CREDIT","VERIFY"],"example":"DEBIT"},"transactionStatus":{"type":"string","description":"The transaction status. PENDING indicates that the transaction notification is not in its final status. SUCCESSFUL indicates that the transaction is completed and has been submitted for processing. REJECTED indicates that the transaction could not be completed.  Allowed values: PENDING, SUCCESSFUL, REJECTED","example":"SUCCESSFUL"},"transactionId":{"type":"string","description":"The Paramount-assigned unique transaction ID."},"productUserId":{"type":"string","description":"The product consumer ID, if applicable."},"currencyCode":{"type":"string","description":"The 3-letter currency code (ISO 4217).","example":"CAD"},"deviceType":{"type":"string","description":"The type of device used by the consumer when the transaction was initiated.  Allowed values: DESKTOP, MOBILE, TABLET, UNKNOWN","enum":["DESKTOP","MOBILE","TABLET","UNKNOWN"]}}},"ReportResponse":{"type":"object","properties":{"product":{"type":"string","example":"IBT"},"merchantId":{"type":"string","description":"The Paramount-assigned unique merchant ID.","example":"ABC12345"},"merchantUserId":{"type":"string","description":"The Merchant-assigned unique consumer ID.","example":"Suneesh132"},"merchantTransactionId":{"type":"string","description":"The merchant-assigned transaction ID.","example":"1623075288364"},"transactionId":{"type":"string","description":"The Paramount-assigned unique product transaction ID.","example":"20210512184646190729000000"},"transactionNotifyStatus":{"type":"string","description":"The notification status of the transaction. C is completed, S is sent, I is not sent.","example":"C"},"transactionRegion":{"type":"string","description":"The consumer's 2-letter province or other applicable geographic region. (ISO 3166-2:CA)","example":"ON"},"transactionAmount":{"type":"integer","description":"The transaction amount, expressed in cents.","example":241},"currencyCode":{"type":"string","description":"The 3-letter currency code (ISO 4217).","example":"CAD"},"countryCode":{"type":"string","description":"The 2-letter country code (ISO 3166-1 Alpha 2 Code).","example":"CA"},"transactionType":{"type":"string","description":"DEBIT is a consumer payin. CREDIT is a payout from merchant to consumer.","example":"DEBIT"},"transactionStatus":{"type":"string","description":"The transaction status. Allowed values: SUCCESSFUL, PENDING, REJECTED","example":"SUCCESSFUL"},"transactionFee":{"type":"integer","description":"The transaction fee amount, expressed in cents, payable by the merchant, if applicable.","example":300},"transactionDateTime":{"type":"string","description":"The date and time the transaction was received by Instant Bank Transfer (ISO 8601).","example":"2021-06-07T14:15:06.401093Z"},"externalReference":{"type":"string","description":"External reference number.","example":"AH75WMHO3UQ1UNF"},"errorCode":{"type":"string","description":"The relevant error code, if applicable.","example":null},"errorMessage":{"type":"string","description":"The error message associated with the error code.","example":null},"transactionPaymentMethod":{"type":"string","description":"The payment processing method.","example":"EFT"}}},"ConfirmTransactionResponse":{"type":"object","properties":{"verification_code":{"type":"string","example":0}}},"ConfirmTransactionRequest":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"},"additionalData":{"$ref":"#/components/schemas/AdditionalData"},"transaction":{"$ref":"#/components/schemas/ConfirmTransaction"},"accountInfo":{"$ref":"#/components/schemas/AccountInfo"}}},"ConfirmTransaction":{"type":"object","properties":{"transactionType":{"type":"string","description":"DEBIT is a consumer payin. CREDIT is a payout from merchant to consumer. Allowed values: DEBIT | CREDIT","enum":["DEBIT","CREDIT"]},"transactionFee":{"type":"integer","description":"The transaction fee amount payable by the merchant, if applicable.","example":100},"transactionStatus":{"type":"string","description":"A FAILED status typically indicates an error related to transaction processing, such as a validation or internal error. A REJECTED status typically indicates that a service, such as risk management, stopped the request from proceeding. Allowed values: SUCCESS | REJECTED | FAILED","enum":["SUCCESS","REJECTED","FAILED"]},"dataPassThrough":{"type":"string","description":"A pass-through field that can be used as an extra parameter to identify the transaction or consumer.","minLength":0,"maxLength":128,"example":"sub-"},"transactionAmount":{"type":"integer","description":"The transaction amount. Transactions less than the minimum or greater than the maximum are rejected.","minimum":100,"maximum":100000000,"example":2000},"errorCode":{"type":"string","description":"The relevant error code, if applicable.","example":"99"},"currencyCode":{"type":"string","description":"The 3-letter currency code (ISO 4217).","example":"CAD"},"transactionId":{"type":"string","description":"The Paramount-assigned unique product transaction ID.","example":"20210512184646190729000000"},"returnCode":{"type":"string","description":"Return code"},"nextActionDate":{"type":"string","description":"Next action date"}}},"AdditionalData":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"TransactionNotification":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"},"accountInfo":{"$ref":"#/components/schemas/AccountInfo"},"transaction":{"$ref":"#/components/schemas/Transaction"}}},"ReturnNotification":{"type":"object","properties":{"merchant":{"$ref":"#/components/schemas/Merchant"},"transaction":{"$ref":"#/components/schemas/Transaction"}}},"Merchant":{"type":"object","properties":{"merchantId":{"type":"string","description":"The Paramount-assigned unique merchant ID.","minLength":1,"maxLength":16,"example":"ABC12345"},"merchantSubId":{"type":"integer","description":"The merchant account sub ID assigned by Paramount.","minimum":0,"maximum":1000000,"example":24},"merchantTransactionId":{"type":"string","description":"The merchant-assigned unique transaction ID.","minLength":1,"maxLength":30,"example":"A1B2C320190123"},"merchantUserId":{"type":"string","description":"The merchant-assigned unique consumer ID. This must be unique per consumer.","minLength":3,"maxLength":64,"example":"user123"}}},"AccountInfo":{"type":"object","properties":{"accountToken":{"type":"string","description":"A token that uniquely identifies the consumer’s bank account in the Instant Bank Transfer system."},"accountLabel":{"type":"string","description":"The masked account number that will be displayed by the merchant to the consumer in subsequent transactions. This is in the format ****1234.","minLength":8,"maxLength":8},"accountType":{"type":"string","description":"The consumer’s bank account type, either personal checking (PC) or personal savings (PS)"},"fiName":{"type":"string","description":"The name of the consumer’s bank."}}},"Transaction":{"type":"object","properties":{"transactionType":{"type":"string","description":"DEBIT is a consumer payin. CREDIT is a payout from merchant to consumer. Allowed values: DEBIT | CREDIT","enum":["DEBIT","CREDIT"]},"transactionFee":{"type":"integer","description":"The transaction fee amount payable by the merchant, if applicable.","example":100},"transactionStatus":{"type":"string","description":"A FAILED status typically indicates an error related to transaction processing, such as a validation or internal error. A REJECTED status typically indicates that a service, such as risk management, stopped the request from proceeding. Allowed values: SUCCESS | REJECTED | FAILED","enum":["SUCCESS","REJECTED","FAILED"]},"dataPassThrough":{"type":"string","description":"A pass-through field that can be used as an extra parameter to identify the transaction or consumer.","minLength":0,"maxLength":128,"example":"sub-"},"transactionAmount":{"type":"integer","description":"The transaction amount. Transactions less than the minimum or greater than the maximum are rejected.","minimum":100,"maximum":100000000,"example":2000},"errorCode":{"type":"string","description":"The relevant error code, if applicable.","example":"99"},"currencyCode":{"type":"string","description":"The 3-letter currency code (ISO 4217).","example":"CAD"},"transactionId":{"type":"string","description":"The Paramount-assigned unique product transaction ID.","example":"20210512184646190729000000"}}}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":true,"samples-enabled":true}}