Jump to Content

Guides API reference Release notes

Log in Contact us

API reference

Log in Contact us

Guides API reference Release notes

All

Pages

Start typing to search…

Numeral API

Getting started
Environments
API authentication
Sign API requests
Webhooks
Verify webhooks
Rate limiting
Idempotency
Status codes
API versioning
Data types
- Standard data types
- Currency codes and decimals
Pagination
Metadata
Reason and purpose codes

Payments

Payment orders
Incoming payments
Returns

Investigations

Return requests
Claims
Inquiries

Accounts

Connected accounts
Transactions
Balances

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

Tools

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

Additional resources

Account details
Address
Organization identifications
Private identification
External account verification

Developers

API Keys
- List API keysget
- Retrieve API keyget

Retrieve API key

get https://sandbox.numeral.io/v1/api_keys/{id}

Retrieve the details of a specific API key.

Language

Credentials

Header

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