Jump to Content
Mambu Payments (formerly Numeral)
GuidesAPI referenceRelease notes
Mambu Payments (formerly Numeral)
API reference
GuidesAPI referenceRelease 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
    • SEPA reason codes
    • Bacs reason codes
    • FPS reason codes
    • Purpose codes
  • Pagination
  • Metadata

Events and webhooks

  • Events
  • Webhooks
  • Webhooks security

Payments

  • Payment orders
    • Payment order object
    • Payment order lifecycle
    • Create payment orderpost
    • Approve payment orderpost
    • Cancel payment orderpost
    • Retry payment orderpost
    • Update payment orderpost
    • Update payment order validationpost
    • List payment ordersget
    • Retrieve payment orderget
  • Incoming payments
    • Incoming payment object
    • Incoming payment lifecycle
    • Confirm incoming paymentpost
    • Reject incoming paymentpost
    • Update incoming payment validationpost
    • Update incoming paymentpost
    • List incoming paymentsget
    • Retrieve incoming paymentget
    • Track incoming paymentpost
  • Returns
    • Return object
    • Return lifecycle
    • Create returnpost
    • Update returnpost
    • Approve returnpost
    • Cancel returnpost
    • List returnsget
    • Retrieve returnget
    • Update return validationpost

Investigations

  • Return requests
    • Return request object
    • Return request lifecycle
    • Create return requestpost
    • Accept return requestpost
    • Deny return requestpost
    • List return requestsget
    • Retrieve return requestget
  • Claims
    • Claim object
    • Claim lifecycle
    • Create claimpost
    • List claimsget
    • Retrieve claimget
    • Accept claimpost
    • Reject claimpost
  • Inquiries
    • Inquiry object
    • Inquiry lifecycle
    • Deny inquirypost
    • Create inquirypost
    • List inquiriesget
    • Retrieve inquiryget

Accounts

  • Connected accounts
    • Connected account object
    • List connected accountsget
    • Retrieve connected accountget
  • Transactions
    • Transaction object
    • Transaction lifecycle
    • Update transactionpost
    • List transactionsget
    • Retrieve transactionget
  • Balances
    • Balance object
    • Balance lifecycle
    • List balancesget
    • Retrieve balanceget

Counterparties

  • Account holders
    • Account holder object
    • Account holder lifecycle
    • Create account holderpost
    • Update account holderpost
    • Disable account holderpost
    • List account holdersget
    • Retrieve account holderget
  • External accounts
    • External account object
    • External account lifecycle
    • Create external accountpost
    • Approve external accountpost
    • Deny external accountpost
    • Disable external accountpost
    • Verify external accountpost
    • Update external accountpost
    • List external accountsget
    • Retrieve external accountget
  • Internal accounts
    • Internal account object
    • Internal account lifecycle
    • Create internal accountpost
    • Block internal accountpost
    • Unblock internal accountpost
    • Update an internal accountpost
    • Disable internal accountpost
    • List internal accountsget
    • Retrieve internal accountget
  • Direct debit mandates
    • Direct debit mandate object
    • Direct debit mandate lifecycle
    • Create direct debit mandatepost
    • Update direct debit mandatepost
    • Disable direct debit mandatepost
    • Block direct debit mandatepost
    • Authorize direct debit mandatepost
    • List direct debit mandatesget
    • Retrieve direct debit mandateget

Reconciliations

  • Expected payments
    • Expected payment object
    • Expected payment lifecycle
    • Create expected paymentpost
    • Cancel expected paymentpost
    • Update expected paymentpost
    • List expected paymentsget
    • Retrieve expected paymentget
  • Payment captures
    • Payment capture object
    • Payment capture lifecycle
    • Create payment capturepost
    • Cancel payment capturepost
    • Update payment capturepost
    • List payment capturesget
    • Retrieve payment captureget
  • Reconciliations
    • Reconciliation object
    • Reconciliation lifecycle
    • Create reconciliationpost
    • Cancel reconciliationpost
    • Update reconciliationpost
    • List reconciliationsget
    • Retrieve reconciliationget

Files

  • Files
    • File object
    • File lifecycle
    • Approve filepost
    • Cancel filepost
    • List filesget
    • Retrieve fileget
    • Download fileget

Events

  • Events
    • Event object
    • Event lifecycle
    • Retry failed eventspost
    • Resend eventpost
    • List eventsget
    • Retrieve eventget

Verification of Payee

  • Payee verification requests
    • Payee verification request object
    • Payee verification request lifecycle
    • Payee verification request bulk action lifecycle
    • Send verification payee requestpost
    • Simulate incoming payee verification requestpost
    • List payee verification requestsget
    • Retrieve payee verification requestget
    • Create bulk action for payee verification requestspost
    • Retrieve bulk actionget
    • Retrieve bulk action itemsget
  • Verification scheme participants
    • Get supported identification types for a payee accountget
    • Retrieve verification scheme participantget

Tools

  • Audit trails
    • Audit trail object
    • List audit trailsget
    • Retrieve audit trailget
  • Process payments
    • Process paymentspost
  • Bulk actions
    • Bulk action object
    • Bulk action lifecycle
    • Create bulk actionpost
    • List bulk actionsget
    • Retrieve bulk actionget
    • Retrieve bulk action related itemsget
  • Message forward
    • Forward messagepost
  • Custom fields
    • Custom field object
    • Create custom fieldpost
    • Update custom fieldpost
    • List custom fieldsget
    • Retrieve custom fieldget
  • Payment retry rules
    • Payment retry rule object
    • List payment retry rulesget
    • Retrieve payment retry ruleget
  • Bank code lookup
    • Bank code lookup overview
    • Bank code lookuppost
  • Simulator
    • Simulate message receivedpost
    • Update payment statuspost
    • Create balancepost
    • Create transactionpost
    • Create incoming paymentpost
  • Connectivity syncs
    • Connectivity sync object
    • Connectivity sync lifecycle
    • List connectivity syncsget
    • Retrieve connectivity syncget
  • Platform health check
    • Check platform healthget

Developers

  • API keys
    • API key object
    • List API keysget
    • Retrieve API keyget

Additional resources

  • Account details
  • Address
  • Organization identification
  • Private identification
  • External account verification
  1. API basics
  2. Reason and purpose codes

Purpose codes

Learn more about purpose codes supported in the Mambu Payments API