Appearance

Server-side Install ​

While server-side integration is optional, you'll usually want to confirm payment on the server-side. The SDK is split into multiple packages, each of which can be installed separately. This allows you to install only the packages you need, and avoid installing unnecessary dependencies.

A typical server-side integration will look something like this:

mermaid
sequenceDiagram
  autonumber
  participant User
  participant Client

  User->>Client: Land on payment page
  Client->>Server: Send order information
  Server->>Code Sequencer: POST /v1/createIntent
  Code Sequencer->>Server: Return PaymentIntent status
  Server->>Client: Return PaymentIntent's client_secret
  Client->>Code Sequencer: Open message stream at rendezvous value
sequenceDiagram
  autonumber
  participant User
  participant Client

  User->>Client: Land on payment page
  Client->>Server: Send order information
  Server->>Code Sequencer: POST /v1/createIntent
  Code Sequencer->>Server: Return PaymentIntent status
  Server->>Client: Return PaymentIntent's client_secret
  Client->>Code Sequencer: Open message stream at rendezvous value

You can learn more about the payment flow here.

Installation ​

bash
npm install @code-wallet/client
npm install @code-wallet/client
bash
pip install code-wallet
pip install code-wallet
bash
composer require code-wallet/client
composer require code-wallet/client
bash
go get github.com/code-payments/code-sdk-go
go get github.com/code-payments/code-sdk-go

Quick Start ​

Once installed, you can import the SDK into your project.

js
import code from '@code-wallet/client';

const { intent } = await code.paymentIntents.create({
    // ...
});
import code from '@code-wallet/client';

const { intent } = await code.paymentIntents.create({
    // ...
});
python
from code_wallet.client.intents import payment_intents

payment_intents.create({
    #...
})
from code_wallet.client.intents import payment_intents

payment_intents.create({
    #...
})
php
use CodeWallet\Client\PaymentIntents;

$data = [
    'destination' => "E8otxw1CVX9bfyddKu3ZB3BVLa4VVF9J7CTPdnUwT9jR",
    'amount' => 0.05,
    'currency' => 'usd',
];

// Create a payment request intent
$response = PaymentIntents::create($data);

// After some time, you can verify the status of the intent
$status = PaymentIntents::getStatus($response['id']);
use CodeWallet\Client\PaymentIntents;

$data = [
    'destination' => "E8otxw1CVX9bfyddKu3ZB3BVLa4VVF9J7CTPdnUwT9jR",
    'amount' => 0.05,
    'currency' => 'usd',
];

// Create a payment request intent
$response = PaymentIntents::create($data);

// After some time, you can verify the status of the intent
$status = PaymentIntents::getStatus($response['id']);
go
// Setup the Code web client
client := codesdk.NewWebClient()

// Specify payment request details
intent, err := codesdk.NewPaymentRequestIntent(
  // Or the string "usd"
  codesdk.USD,
  // Minimum amount is $0.05 USD
  0.05,
  // Code Deposit Address or any Kin token account
  "E8otxw1CVX9bfyddKu3ZB3BVLa4VVF9J7CTPdnUwT9jR",
)
check(err)

// Create a payment request intent
_, err = client.CreatePaymentRequest(ctx, intent)
check(err)

// Check the intent status
_, err = client.GetIntentStatus(ctx, intent.GetIntentId())
check(err)
// Setup the Code web client
client := codesdk.NewWebClient()

// Specify payment request details
intent, err := codesdk.NewPaymentRequestIntent(
  // Or the string "usd"
  codesdk.USD,
  // Minimum amount is $0.05 USD
  0.05,
  // Code Deposit Address or any Kin token account
  "E8otxw1CVX9bfyddKu3ZB3BVLa4VVF9J7CTPdnUwT9jR",
)
check(err)

// Create a payment request intent
_, err = client.CreatePaymentRequest(ctx, intent)
check(err)

// Check the intent status
_, err = client.GetIntentStatus(ctx, intent.GetIntentId())
check(err)

See a minimal server example here.

Full Examples

If you prefer running full examples, we have a few available.

Checkout the full Node.js Examples, our Python Example, our PHP Example, or our Go Example.