Libraries

Official libraries wrap the API for Node.js, Python, PHP, Go and Dart. They all do the same things: create and read payments, list the coins a customer can pay with, manage your webhook (IPN) URL, verify webhook notifications in one call, and call the public checkout API. Field names are the API's own, so everything in these docs applies. Each library has a full reference page.

The Python package is published as payitgo and imported as payitgo.

A WooCommerce shop needs no code: the WooCommerce plugin adds crypto to its checkout and marks orders paid by itself.

Use the libraries on your server: they need your secret key. The exceptions need no key, only the payment's checkout_token from your server: Dart's PayitgoCheckout, made for Flutter apps, and the React checkout widget, which shows the payment in a modal in a React app.

Creating a client

Every client takes your secret key and the same options. The key decides the mode: a test key works with test payments and the test webhook and its secret, a live key with live ones. Use the webhook secret of the same mode. A missing key is refused when the client is created, before any request. The key's text does not say its mode: ask payitgo with isLive() (the first call reads it, later ones use the answer).

Without a base URL option, the libraries use PAYITGO_BASE_URL (except Dart), then the gateway address they were released with.

Errors and retries

• The status is the API's HTTP status, or 0 when no answer came (a network error or a timeout). The message is the API's error message (Errors and limits).
• Retries. Network errors and timeouts, 429 and 5xx are retried up to twice (the retries option), after 0.5 s and then 1 s. Other statuses are never retried. Every call is safe to repeat: creating a payment again for the same order_id returns its open payment, choosing a coin that was already chosen answers 409, and setting or removing the webhook URL twice changes nothing.

Webhooks

Every library manages the webhook of the key's mode (get, set, remove, test) and verifies notifications in constant time: it checks the X-Webhook-Signature against the raw body, refuses a timestamp more than 5 minutes from your clock, and returns the parsed event (how it works).

Reference

The same calls in each language:

Method names follow each language: select_token and construct_event in Python; Get (not retrieve), SelectToken, Set, Remove, Test and ConstructEvent with a context.Context in Go. Dart also has checkout.watch, a stream of the payment's status changes that follows late payments (it polls every 5 seconds: the fallback for apps that cannot use the socket), checkout.simulate for a Flutter app's test payments (no key), and close() for the HTTP client it made.

A payment's own webhook URL

Pass webhook_url to send one payment's notifications somewhere else (why), or set the client's default webhook URL option to do it for every payment that client creates. A payment's own webhook_url wins over the client's default:

const payitgo = new Payitgo(process.env.PAYITGO_STORE_KEY, {
  webhookUrl: "https://eu.acme.example/payitgo/ipn",   // every payment of this client
  webhookSecret: process.env.PAYITGO_WEBHOOK_SECRET,   // the same secret signs them
});
await payitgo.payments.create({ order_id: "EU-77", amount_usd: 20, webhook_url: "https://eu.acme.example/orders/EU-77/ipn" }); // this one only

Flutter apps

Never ship a secret key in an app. The Dart library's PayitgoCheckout needs no key: your backend creates the payment and hands the app its checkout_token, and the app shows the payment, lets the customer choose the coin and follows its status (a full screen). Follow it with the socket (subscribe with the checkout token) for every change as it happens; checkout.watch polls every 5 seconds, for apps that cannot use socket.io:

final checkout = PayitgoCheckout(baseUrl: 'https://api.payitgo.co');
await for (final p in checkout.watch(checkoutToken)) {
  if (p.isConfirmed) showPaid();
}

By language

Node.js

Install · configuration · errors · payments · webhooks · types · your own payment page · test mode

Python

Install · configuration · errors · payments · webhooks · types · your own payment page · test mode

PHP

Install · configuration · errors · payments · webhooks · types · your own payment page · test mode

Go

Install · configuration · errors · payments · webhooks · types · your own payment page · test mode

Dart

Install · configuration · errors · payments · webhooks · types · your own payment page · Flutter · test mode