Skip to content
SDKs

Go SDK

Install and configure the Go SDK client, and make your first authenticated call.

Installation

Install the SDK with your package manager, then read the API key from the environment rather than hard-coding it.

1npm install @paycux/node

Beta Versions

Beta Versions is handled by Go SDK rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Paycux Go Library

Official SDKs are published for Node.js, Python, Ruby, Go, PHP, Java and .NET. They share the same method names, so a snippet translates between languages with little more than syntax changes.

Each SDK reads PAYCUX_API_KEY from the environment by default and retries idempotent requests on transport errors.

Usage

Usage is handled by Go SDK rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Services

Services is handled by Go SDK rather than by your application code. Paycux exposes it through the same API surface as the rest of the platform, so the client you already configured needs no additional setup.

Configuration lives in the dashboard and is versioned per environment. Change it in staging, confirm the behaviour, then apply the same change to production.

Error Handling

If something does not work, check these first — they cover the large majority of failed setups:

  • The values were pasted into the wrong environment. Staging and production hold separate configuration.
  • A trailing slash or stray whitespace in the ACS URL or redirect URI. Both are matched exactly.
  • The connection is saved but not activated. An inactive connection returns connection_inactive.
  • Attribute names differ from what the mapping expects, so the user is created without an email address.

Every failed authentication is recorded with a reason on the connection's page in the dashboard. Start there before reading application logs.

Pagination

List endpoints return up to one hundred records per call and are ordered newest first. Pass limit, and use after with the last record's ID to walk forward through the collection.

1import Paycux from '@paycux/node';
2
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4
5const result = await paycux.organizations.list({ limit: 100 });
6console.log(result);

Webhook Verification

Webhooks deliver each event to your endpoint over HTTPS with a signature header. Verify the signature before you trust the body, and respond with a 2xx status within thirty seconds.

Delivery is at-least-once, so make your handler idempotent — key it on the event ID and ignore an ID you have already processed. Failed deliveries retry with exponential backoff for twenty-four hours.