Checkout

1. Create Session.

First you need to create a session from your backend using the API key generated through the dashboard, a session must have one of two types, add_card or payment.

Add Card

Add Card

the add_card session is used to store a customer card, a unique customerId is required for add_card session type, while creating a new session, using this Id, you can get the corresponding customer cards when calling the getSession() method in the SDK

Request

curl --location --request POST 'https://sandbox.nearpay.io/checkout/sessions' \
--header 'Authorization: RoD43N1tjJs221nM37LR72Kf7IHG3uDYJAF4pu2HlrBkj9oxGdiUBO1sBGYN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "add_card",
    "customer": {
        "id": "${UUID}",
        "name": "", // optional
        "email": "", // optional
        "mobile": "+966XXXXXXXXX" // optional
    }
}'

Response

{
    "type": "payment",
    "status": "ready",
    "amount": 15000,
    "currency": "SAR",
    "callback_url": "https://google.com.sa",
    "extrernal_customer": {
        "id": "cc0a7499-0a7f-4616-b5ef-585dfb7e6978"
    },
    "customer": {
        "id": "dab4d476-6061-42e1-b0ce-d8a6e65b0e25",
        "name": null,
        "email": null,
        "mobile": null,
        "customer_id": "${UUID}",
        "created_at": "2022-05-30T11:39:11.734Z",
        "updated_at": "2022-05-30T11:39:11.734Z",
        "cards": [
            {
                "id": "${UUID}",
                "type": "card",
                "number": "4242",
                "year": "32",
                "month": "02",
                "name": "ABDULELAH OMER",
                "brand": "visa",
                "external_customer_id": "${UUID}",
                "card_hash": "8942bb738d827fc64466b2e02f900adec7c90e74b2a522bc35da313729eca665",
                "created_at": "2022-05-30T11:46:52.752Z",
                "updated_at": "2022-05-30T11:46:52.752Z"
            }
        ]
    },
    "client": {
        "id": "${UUID}"
    },
    "reference_id": null,
    "id": "${UUID}",
    "created_at": "2022-05-30T11:48:23.482Z",
    "updated_at": "2022-05-30T11:48:23.482Z"
}

Payment

2. Install SDK.

Install the payment SDK using either npm or yarn

JavaScript ( Web )

# npm
npm install @nearvault/payment-sdk
# or yarn
yarn add @nearvault/payment-sdk

3. PaymentSDK.

Using the SDK, you can use a previously created session to add cards, create payments and fetch previous payments as well.

List Cards

List Cards

You can list the cards associated with the customer_id, you can get details about your current session and the cards associated to the customer that owns the session by calling the getSession() method, this method will return a list of saved customer cards along with the session details

Request:

import PaymentSDK from '@nearvault/payment-sdk';

let sessionId = "${sessionId}";

const nearVault = new PaymentSDK(sessionId);
let session = await nearVault.getSession();

Session Object:

{
    "session": {
        "amount": 131,
        "currency": "SAR"
    },
    "cards": [
        {
            "id": "ec4a6b40-f5f5-48d7-a667-41efa053b719",
            "number": "4242",
            "year": "24",
            "month": "02",
            "name": "Hamzah AL Frahan",
            "brand": "visa"
        }
    ]
}

Add Card

Create Payment

Pay With Saved Card