Create a Counterparty with an External Account

Counterparties must be created prior to initiating any Credit Transfers or Direct Debits. You can do this either in the dashboard or via our /payments/v2/counterparties API endpoint.

curl 'https://api.atlar.com/payments/v2/counterparties' \
  -u 'ACCESS_KEY:SECRET' \
  -H 'Content-Type: application/json' \
  -d '{
    "legalName": "Max Müller",
    "alias": "Customer #123",
    "partyType": "INDIVIDUAL",
    "accounts": [{
      "market": "DE",
      "identifiers": [{
        "market": "DE",
        "type": "IBAN",
        "number": "DE75512108001245126199"
      }]
    }]
  }'

Save the ID of the created external_account ($.accounts.[0].id) since this will be used when making your first payment. The ID can also be found by navigating into the counterparty details in the dashboard.

Retrieve the ID of the initiating, source, Account

In order to make a Credit Transfer or collect a Direct Debit via our API on one of your configured bank accounts, we need to retrieve the ID of the account. To do that, you can either navigate into the account details in the dashboard or query the API endpoint /financial-data/v2/accounts.

curl 'https://api.atlar.com/financial-data/v2/accounts' \
  -u 'ACCESS_KEY:SECRET'

Creating the Credit Transfer

After you’ve configured the Roles & Users, set up Counterparties and retrieved the IDs, you’re ready to create your first Credit Transfer. To create a credit transfer, you’ll need to specify the $.source.id, identifying one of your bank accounts, and the $.destination.id, identifying the account of the counterparty you’re making the payment to.

To make a SEPA Credit Transfer:

curl 'https://api.atlar.com/payments/v2/credit-transfers' \
  -u 'ACCESS_KEY:SECRET' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": {
        "currency": "EUR",
        "value": 2500
    },
    "date": "yyyy-mm-dd",
    "scheme": "SCT",
    "source": {
      "type": "ACCOUNT",
      "id": "<source account id>"
    },
    "destination": {
      "type": "EXTERNAL_ACCOUNT",
      "id": "<external account id>"
    },
    "reference": "payout-12345"
  }'

Approving the Payment

If a payment is created and no Approval Chains are configured, or if a payment is created but if falls outside of the conditions that are configured by existing Approval Chains, the Owner of the organization must approve the payments. It is possible to configure approval chains to not require any approvals (ie. auto-approvals or straight-through processing), but Atlar has chosen a security-first approach where this is an opt-in feature.

Most easily, one approves payments through the Atlar Dashboard, but it is possible to do so over API as well: Approve credit transfer.

Staying up to date with a payment

You can stay up to date with the payment by receiving webhooks. You can set up webhooks via our /v1/webhooks endpoint.

What’s next?

Create additional roles and invite your colleagues to the platform. To further configure your account, you can create approval chains to suit your payment needs in Settings. For example, you can specify a threshold below which credit transfers and direct debits are automatically approved or require the approval of a certain user.