Skip to main content

Transaction Providers Service

Query available transaction providers with the SDK.

Methods​

getMany()​

List all available transaction providers.

const providers = await sdk.transactionProviders.getMany({
  take: 10,
  skip: 0,
});

console.log('Providers:', providers.items);
console.log('Total:', providers.totalCount);

getOne()​

Get a specific transaction provider by ID.

const provider = await sdk.transactionProviders.getOne({
  id: 'provider-id',
});

Examples​

List Available Providers​

const providers = await sdk.transactionProviders.getMany({});

providers.items.forEach(provider => {
  console.log(`Provider: ${provider.name} (${provider.code})`);
  console.log(`Status: ${provider.status}`);
});

Get Provider Details​

// Get provider details before creating a transaction
const provider = await sdk.transactionProviders.getOne({
  id: 'provider-id',
});

if (provider.status === 'ACTIVE') {
  // Use this provider for transactions
  const session = await sdk.transactions.clientSessions.payments.start({
    transactionProvider: provider.code,
    // ... other configuration
  });
}

Filter Providers by Status​

// Get all providers and filter active ones
const allProviders = await sdk.transactionProviders.getMany({});
const activeProviders = allProviders.items.filter(
  p => p.status === 'ACTIVE'
);

See API Reference for more information about transaction providers.