Get started with the Ledger API

The Ledger API lets you create customers and accounts, link cards, move money in and out, and read balances and transactions. This page walks through a first integration end to end.

Before you begin

During onboarding, Paymentology sets up your ledger and a parent account for your accounts, and provides your API credentials. Follow Connecting to Lume to get an access token.

1. Create a customer

Call Create customer with the customer's name and mobile number. Keep the returned customer_id.

2. Open an account

Create an account under your parent account and link it to the customer. Use the returned account ID in every later call.

If the account needs one, generate a virtual IBAN.

3. Add a card

Create a card on the account, or link an existing card to it.

4. Fund the account

Call Create a deposit with the account ID as destination_account_id.

5. Move money

• Create a transfer between two accounts, in the same currency or across currencies at a rate you supply.
• Create a withdrawal to pay funds out of an account.

6. Check balances and history

• Retrieve account balances for an account.
• Search transactions for an account or a card, and filter by reference, amount or date. Page through results with cursor.

Rules to know

Before you go live, read the Ledger API overview for authentication, amounts, checking results, transaction status and idempotency.

Next steps

• Browse each operation's request and response in the Ledger API reference.