Getting Started
Quick Start

7min
Get started with Pay3 Javascript SDK with a few lines of code. Pay3 SDK is designed to work in any javascript-based client-side application and work with most of the popular frontend frameworks like React. Pay3 also provides SDKs for React Native, Flutter and Unity. 
Install
The Pay3 JS SDK is available at the public npm registry @pay3/sdk . You can install and add to your App using the following command.
Shell
npm install @pay3/sdk --save
npm install @pay3/sdk --save
﻿
Initialization
Import the package installed in the previous step using import directive. Create a instance of Pay3 by passing the parameters you received during onboarding. Reference﻿﻿
index.js
// Import Pay3 package
import { initPay3 } from '@pay3/sdk';

// New Instance
const pay3 = initPay3({ 
                hostname: "https://pay3-hostname-shared-by-pay3", 
                clientId: "client-uuid-shared-by-pay3",
                isPaymentMode: true 
         });
// Import Pay3 package
import { initPay3 } from '@pay3/sdk';

// New Instance
const pay3 = initPay3({ 
                hostname: "https://pay3-hostname-shared-by-pay3", 
                clientId: "client-uuid-shared-by-pay3",
                isPaymentMode: true 
         });
﻿
Fiat Payin
Pay3 Web Modal provides a comprehensive digital asset purchase buy flow. User is able to choose a payment method and buy the digital asset using currencies across the globe. 
The request object requires a string requestId . This will be passed back along with the event emitted on completion of the buy flow.  Detailed documentation of openCheckout is present at Transactions﻿﻿
index.js
pay3.openCheckout({
  requestId: "dapp-can-pass-unique-id"
  "user": {
    "email": "user-email@address"
  },
  "payment": [
    {
      "amount": "2.00",
      "name": "brl_bz",
    },
    {
      "amount": "4.05",
      "name": "usd_usa",
    }
  ],
  "userMessage": "Checkout Sample"
});
pay3.openCheckout({
  requestId: "dapp-can-pass-unique-id"
  "user": {
    "email": "user-email@address"
  },
  "payment": [
    {
      "amount": "2.00",
      "name": "brl_bz",
    },
    {
      "amount": "4.05",
      "name": "usd_usa",
    }
  ],
  "userMessage": "Checkout Sample"
});
﻿
Fiat Payout
Pay3 Web Modal provides a withdraw functionality to users where they can receive funds in their local currency. User will be able to provide either bank details or local e-wallets to receive the funds. Detailed documentation of openPayout is present at Transactions﻿

The request object requires a string requestId and the token which is a unique id generated by Pay3 backend on calling create payout order﻿. 
index.js
 // Opens Pay3 Payout modal
 pay3Pay.openPayout( {
  "requestId": requestId,
  "token": pay3CreatedTokenId
});
 // Opens Pay3 Payout modal
 pay3Pay.openPayout( {
  "requestId": requestId,
  "token": pay3CreatedTokenId
});
﻿
Crypto Payin
This function opens Pay3 buy crypto modal. The Buy modal will guide the user through the digital asset purchase flow using user's own digital assets like Coins and ERC20 tokens. Detailed documentation of openCryptoCheckout is present at Transactions﻿﻿
The request object requires a string requestId and the token which is a unique id generated by Pay3 backend on calling create create crypto checkout order﻿.
index.js
// Opens Pay3 Crypto Checkout Modal
pay3.openCryptoCheckout({
  "requestId": requestId,
  "token": pay3CreatedTokenId
});
// Opens Pay3 Crypto Checkout Modal
pay3.openCryptoCheckout({
  "requestId": requestId,
  "token": pay3CreatedTokenId
});
﻿
Listen to transaction status events
On completion of the transaction flow an event is emitted with type pay3-sdk-transaction-status. The event data consists of fields status which is set to 'SUCCESS' when transaction  is completed successfully. The orderId is Pay3's transaction ID and requestId is the unique string passed by the application in openCheckout call.  
Reference﻿ 
index.js
pay3.on('pay3-sdk-transaction-status', (event) => {
  console.log("[dApp] received transaction status", event.data);
  const {status, orderId, requestId, message} = event.data;
});
pay3.on('pay3-sdk-transaction-status', (event) => {
  console.log("[dApp] received transaction status", event.data);
  const {status, orderId, requestId, message} = event.data;
});
﻿
﻿
﻿
Updated 10 May 2024
Did this page help you?
Getting Started
Pay3 Javascript SDK
Quick Start

Install

Initialization

Fiat Payin

Fiat Payout

Crypto Payin

Listen to transaction status events

﻿
