payrix-api-sdk
v1.0.0
Published
SDKs for Payrix API
Readme
Getting Started with Payrix
Install the Package
Run the following command from your project directory to install the package from npm:
npm install [email protected]For additional package details, see the Npm page for the [email protected] npm.
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| environment | Environment | The API environment. Default: Environment.Sandbox |
| timeout | number | Timeout for API calls.Default: 0 |
| httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. |
| unstableHttpClientOptions | any | Unstable configurable http client options. |
| apiKeyCredentials | ApiKeyCredentials | The credential object for apiKey |
| sessionKeyCredentials | SessionKeyCredentials | The credential object for sessionKey |
| txnSessionKeyCredentials | TxnSessionKeyCredentials | The credential object for txnSessionKey |
| usernameCredentials | UsernameCredentials | The credential object for username |
| passwordCredentials | PasswordCredentials | The credential object for password |
The API client can be initialized as follows:
import { Client, Environment } from 'payrix-api-sdk';
const client = new Client({
apiKeyCredentials: {
'APIKEY': 'APIKEY'
},
sessionKeyCredentials: {
'SESSIONKEY': 'SESSIONKEY'
},
txnSessionKeyCredentials: {
'TXNSESSIONKEY': 'TXNSESSIONKEY'
},
usernameCredentials: {
'USERNAME': 'USERNAME'
},
passwordCredentials: {
'PASSWORD': 'PASSWORD'
},
timeout: 0,
environment: Environment.Sandbox,
});Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description | | --- | --- | | sandbox | Default | | canada sandbox | - |
Authorization
This API uses the following authentication schemes.
apiKey (Custom Header Signature)sessionKey (Custom Header Signature)txnSessionKey (Custom Header Signature)username (Custom Header Signature)password (Custom Header Signature)
List of APIs
- API Keys
- Apple Domains
- Apple Domains Mass Enablement
- Accounts Verifications
- Aggregation Result Groups
- Aggregation Results
- Alert Actions
- Alert Triggers
- Authentication Tokens
- Batches Settlements
- Billing Modifiers
- Billing Events
- Change Requests
- Chargeback Documents
- Chargeback Message Results
- Chargeback Messages
- Chargeback Statuses
- Confirmation Codes
- Decision Actions
- Decision Rules
- Disbursement Entries
- Disbursement Reference
- Disbursement Results
- Embedded Finance
- Entity Debts
- Entity Reserves
- Entity Returns
- Entity Terms
- Entry Origin
- Fee Modifiers
- Fee Rules
- Fraud Sight Enablements
- Host Themes
- Fund Origins
- IP Address Lists
- Invoice Items
- Invoice Parameters
- Invoice Line Items
- Invoice Results
- Logins Helpers
- Merchant Results
- Merchant Platform Statuses
- Message Threads
- Note Documents
- Orgs VAS Efe Products
- Orgs VAS Omni Tokens
- Orgs VAS Revenue Boosts
- Orgs VAS Safer Payments
- Orgs VA Stax Form Enablements
- Org Entities
- Org Flow Actions
- Org Flows
- Org Flow Rules
- Payment Update Groups
- Payment Updates
- Payout Flows
- Pending Entry
- Profit Share Results
- Profit Share Rules
- Profit Shares
- Reserve Entry
- Revenue Boosts
- Rev Share Schedules
- Rev Share Statements
- Safer Payments
- Statement Entry
- Subscription Tokens
- Tax Form Requests
- Team Logins
- Terminal Transaction Reference
- Terminal Transactions Datas
- Terminal Transactions
- Terminal Transaction Results
- Terminal Transactions Metadatas
- Token Results
- Transaction Datas
- Transaction Metadatas
- Transaction Holds
- Transaction Items
- Transactions Results
- Fee Refunds
- Transactions Txns
- Tax Form Enablements
- Txn Sessions
- VAS Efe Offers
- VAS Efe Offer Updates
- Orgs VA Sfraud Sight Enablements
- Fraud Sight Results
- Accounts
- Adjustments
- Aggregations
- Alerts
- Assessments
- Billing
- Bins
- Chargebacks
- Contacts
- Credentials
- Customers
- Decisions
- Disbursements
- Divisions
- Entities
- Entity Refs
- Entity Data
- Entities Custom Fields
- Entries
- Fees
- Funds
- Invoices
- Logins
- Mappings
- Members
- Merchants
- Messages
- Notes
- Omni Tokens
- Orgs
- Payouts
- Plans
- Reserves
- Secrets
- Sessions
- Statements
- Subscriptions
- Teams
- Terminals
- Tokens
- Vendors
