Articles in this section

Available Altar APIs

Tanisha Ray
Updated

When you configure an export, import, or other type of flow step using the prebuilt Altar connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Altar API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Accounts

Get account

X

List accounts

X

List balances

X

Update account

X

Counterparties

List counterparties

X

Get counterparty

X

List counterparty events

X

Create counterparty

X

Update counterparty

X

Delete counterparty

X

Credit transfers

List credit transfers

X

Get credit transfer

X

List credit transfer events

X

List credit transfer batches

X

Get credit transfer batch

X

List credit transfer batch results

X

Create credit transfer

X

Update credit transfer

X

Approve credit transfer

X

Reject credit transfer

X

Create credit transfer batch

X

Approve credit transfer batch

X

Reject credit transfer batch

X

Direct debits

List direct debits

X

Retrieve direct debit

X

List direct debit events

X

Create direct debit payment

X

Approve direct debit

X

Reject direct debit

X

Entities

List entities

X

Get entity

X

Create entity

X

Delete entity

X

Update entity

X

Events (webhooks)

Resource event webhook

X

External accounts

Get external account

X

List external accounts

X

Update external account

X

Delete external account

X

Create external account

X

Mandates

List mandates

X

Get mandate

X

List mandate events

X

Create mandate

X

Cancel mandate

X

Pending transactions

List pending transactions

X

Get transaction

X

List pending transaction events

X

Transactions

List transactions

X

Get transaction

X

Update transaction

X