For AI agents: visit https://docs.numeral.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Guides API reference Release notes

API reference

Guides API reference Release notes

Getting started

Introduction

API basics

Main API resources
API docs
Environments
API authentication
Sign API requests
API versioning
Status codes
Rate limiting
Idempotency
Payment types
Data types
- Standard data types
- Currency codes and decimals
Reason and purpose codes
Pagination
Metadata

Events and webhooks

Events
Webhooks
Webhooks security

Payments

Payment orders
Incoming payments
Returns

Investigations

Return requests
Claims
Inquiries

Accounts

Connected accounts
Balances
Transactions

Counterparties

Counterparties
Counterparty accounts
Virtual accounts
Account holders
External accounts
Internal accounts
Direct debit mandates

Reconciliations

Expected payments
Payment captures
Reconciliations

Files

Files

Events

Events

Verification of Payee

Payee verification requests
Verification scheme participants
- Get supported identification types for a payee accountget
- Retrieve verification scheme participantget

Mambu Lending integration

Credit arrangements
Loans

Developers

API keys

Tools

Platform health check
- Check platform healthget
Connectivity syncs
Audit trails
Process payments
- Process paymentspost
Bulk actions
Custom fields
Message forward
- Forward message (deprecated)post
- Forward messagepost
Payment retry rules
Bank code lookup
- Bank code lookup overview
- Bank code lookuppost
Simulator

Additional resources

Account details
Address
Organization identification
Private identification
External account verification
Payment references

Proxy Lookup

Proxy keys
Proxy lookups
DICT proxy claims
Proxy lookup simulator
- Trigger a proxy-lookup simulator eventpost

Counterparties

Virtual accounts

⚠️ Deprecated: This endpoint is deprecated and will be removed.

Updated 10 months ago

Retrieve counterparty account

Virtual account object

Did this page help you?

Updated 10 months ago

Retrieve counterparty account

Virtual account object

Did this page help you?