Jump to Content

Guides API reference Release notes

API reference

Guides API reference Release notes

All

Pages

Start typing to search…

Getting started

Introduction

API basics

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

Events and webhooks

Events
Webhooks
Verify events

Payments

Payment orders
Incoming payments
Returns

Investigations

Return requests
Claims
Inquiries

Accounts

Connected accounts
Transactions
Balances

Counterparties

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

Tools

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

Developers

API keys

Additional resources

Account details
Address
Organization identification
Private identification
External account verification

Accounts
Balances

Retrieve balance

get

https://sandbox.numeral.io/v1/balances/{id}

Retrieve a balance

Language

Credentials

Header

Click Try It! to start a request and see the response here!