Privacy.com API
This library provides you with all you need to make proper calls to the Privacy.com API from a node environment. It is written in TypeScript and only has a dependency on Axios, so its usage is simple and straightforward.
Installation
using npm:
npm i --save privacy.com
or, using yarn:
yarn add privacy.com
Usage
With typescript:
;// Importing the request's Params type can help you with intellisense, but is optional;// If you want your caught errors to be typed, import AxiosError; ; ; // Using async/awaittry catch e // Using then/catchprivacyApi .createCardparams .then .catch;
With JavaScript:
; const privacyApi = "API_KEY" true /* sandbox (default) */; const params = type: "UNLOCKED" memo: "friendly identifier" spend_limit: 1000 spend_limit_duration: "MONTHLY"; // Using async/awaittry const createCardResponse = await privacyApi; console; catch e const code = eresponsestatus; const message = eresponsedata; console; // Using then/catchprivacyApi ;
Endpoints
All of the API endpoints from the Privacy.com API are supported.
createCard(params: CreateCardParams)
: Create a new card for the privacy accountaddBank(params: AddBankParams)
: Adds a bank account as a funding source using routing and account numberslistCards(params?: ListCardsParams)
: List cards associated with the privacy accountlistFundingAccounts(params?: ListFundingAccountsParams)
: List all the funding accounts associated with the privacy accountlistTransactions(params?: ListTransactionsParams)
: List transactions associated with the privacy account or a specific cardhostedCardUi(params: HostedCardUiParams)
: Get iframe data to display card detailsupdateCard(params: UpdateCardParams)
: Update a card by its token for the privacy accountsimulateAuthorization(params: SimulateAuthorizationParams)
: Simulates an authorization request from the payment network as if it came from a merchant acquirersimulateVoid(params: SimulateVoidParams)
: Voids an existing, uncleared (aka pending) authorizationsimulateClearing(params: SimulateClearingParams)
: Clears an existing authorization. After this event, the transaction is no longer pendingsimulateReturn(params: SimulateReturnParams)
: Returns (aka refunds) an amount back to a card. Returns are cleared immediately and do not spend time in a "pending" state