@payconductor/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @payconductor/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost:5173/api/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CardTokenizationApi | cardTokenize | POST /card-tokenization/ | Tokenize Card CustomerApi | customerCreate | POST /customers/ | Create New Customer CustomerApi | customerListCustom | GET /customers/ | Get All Customers CustomerApi | customerRead | GET /customers/{id} | Get Customer By ID CustomerApi | customerUpdate | PATCH /customers/{id} | Update Customer Data MerchantApi | getMerchants | GET /merchants/ | List Merchants MerchantApi | getMerchantsById | GET /merchants/{id} | Get Merchant By ID MerchantApi | postMerchants | POST /merchants/ | Create Merchant MerchantApi | postMerchantsByIdFlows | POST /merchants/{id}/flows | Configure Merchant Flows MerchantApi | postMerchantsByIdSubaccounts | POST /merchants/{id}/subaccounts | Update Merchant Subaccounts OrderApi | orderConfirm | POST /orders/{id}/confirm | Confirm Order OrderApi | orderCreate | POST /orders/ | Create Order OrderApi | orderList | GET /orders/ | List Orders OrderApi | orderRead | GET /orders/{id} | Get Order By ID OrderApi | orderRefund | POST /orders/{id}/refund | Refund Order WithdrawApi | withdrawCreate | POST /withdraws/ | Create Withdrawal WithdrawApi | withdrawList | GET /withdraws/ | List Withdrawals WithdrawApi | withdrawRead | GET /withdraws/{id} | Get Withdrawal By ID

Documentation For Models

• Acquirer
• AddressCreateRequest
• AddressCreateRequest1
• ApplePay
• ApplePayApplePay
• ApplePayApplePayHeader
• BrowserInformation
• CardCreateRequest
• CardTokenizationCreateRequest
• CardTokenizationCreateRequestCustomer
• CardTokenizationCreateResponse
• CardTokenizationCustomerByIdData
• CustomerAddressResponse
• CustomerCreateRequest
• CustomerListPagination
• CustomerListResponse
• CustomerReadResponse
• CustomerUpdateRequest
• DocumentType
• Event
• Expiration
• External3DSAuthentication
• Internal3DSAuthentication
• Merchant
• MerchantBusiness
• MerchantData
• MerchantFinancialRules
• MerchantFinancialRulesFeesInner
• MerchantFinancialRulesFeesInnerItemsInner
• MerchantFlow
• MerchantOwner
• MerchantPayoutAccount
• MerchantPayoutAccountChecking
• MerchantPayoutAccountPix
• MerchantResponse
• MerchantResponseBussiness
• MerchantResponseFinancialRules
• MerchantResponseOwner
• MerchantResponsePayoutAccounts
• MerchantResponsePayoutAccountsChecking
• MerchantResponsePayoutAccountsPix
• MerchantResponseSubaccountsInner
• OrderBankSlipInfo
• OrderBankSlipPaymentRequest
• OrderConfirmResponse
• OrderCreateRequest
• OrderCreateRequestSession
• OrderCreateResponse
• OrderCreateResponseSession
• OrderCreateResponseThreeDSecure
• OrderCreditCardInfo
• OrderCreditCardPaymentRequest
• OrderCreditCardPaymentRequestCard
• OrderCreditCardPaymentRequestThreeDSecure
• OrderDraftPaymentRequest
• OrderFraudFingerprints
• OrderGooglePayPaymentRequest
• OrderGooglePayPaymentRequestGooglePay
• OrderGooglePayPaymentRequestGooglePayIntermediateSigningKey
• OrderItemData
• OrderItemsInner
• OrderNuPayInfo
• OrderNuPayPaymentRequest
• OrderNuPayPaymentRequestNuPay
• OrderPIXInfo
• OrderPIXPaymentRequest
• OrderPaymentRequest
• OrderPicPayInfo
• OrderPicPayPaymentRequest
• OrderRoutingData
• OrderSplitDataInner
• OrderTokenizedCardData
• PaymentMethod
• PersonType
• PixType
• PostMerchantsByIdSubaccounts200Response
• ReceiverType
• Status
• Type
• WithdrawCreateRequest
• WithdrawCreateResponse
• WithdrawCreateResponsePayedAt
• WithdrawCreateResponsePayoutAccount
• WithdrawPayoutAccountData

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication