Numeral

---

SUMMARY

• Configuration
• Requests
  • Balances
  • Connected Accounts
  • Counterparties
  • Counterparty Accounts
  • Direct Debit Mandates
  • Files
  • IncomingPayments
  • Inquiries
  • Payment Orders
  • Returns
  • ReturnRequests
  • Transactions
  • Virtual Accounts

---

Configuration

require "numeral"

Numeral.configuration do |conf|
  conf.url_api = "url_api"
  conf.api_key = "api_key"
end

Requests

AccountHolder

An account holder is an individual or organization you send payments to or receive payments from.

Numeral::V1::AccountHolders.get_list(options)
Numeral::V1::AccountHolders.create(body: body)
Numeral::V1::AccountHolders::AccountHolderId.get(account_holder_id)
Numeral::V1::AccountHolders::AccountHolderId.update(account_holder_id, body: body)
Numeral::V1::AccountHolders::AccountHolderId.disable(account_holder_id)

Balances

A balance is the balance of a connected account on a given date and time. Numeral connects to your bank to retrieve account statements and extract account balances.

Numeral::V1::Balances.get_list(options)
Numeral::V1::Balances::AccountId.get(account_id)

ConnectedAccounts

A connected account is a bank account managed through Numeral.

Numeral::V1::ConnectedAccounts.get_list(options)
Numeral::V1::ConnectedAccounts::AccountId.get(account_id)

Direct debit mandates

A direct debit mandate authorises a creditor (a company, public administration, or association) to collect payments from a debtor's bank account (a company, public administration, association, or individual).

Numeral::V1::DirectDebitMandates.get_list(options)
Numeral::V1::DirectDebitMandates.create(body: body)
Numeral::V1::DirectDebitMandates::DirectDebitMandateId.get(direct_debit_mandate_id)
Numeral::V1::DirectDebitMandates::DirectDebitMandateId.update(direct_debit_mandate_id, body: body)
Numeral::V1::DirectDebitMandates::DirectDebitMandateId.disable(direct_debit_mandate_id)
Numeral::V1::DirectDebitMandates::DirectDebitMandateId.block(direct_debit_mandate_id)
Numeral::V1::DirectDebitMandates::DirectDebitMandateId.authorize(direct_debit_mandate_id)

ExternalAccount

An external account represents the bank account details required to send payments to or collect payments from an external account holder.

Numeral::V1::ExternalAccounts.get_list(options)
Numeral::V1::ExternalAccounts.create(body: body)
Numeral::V1::ExternalAccounts::ExternalAccounttId.get(external_account_id)
Numeral::V1::ExternalAccounts::ExternalAccounttId.update(external_account_id, body: body)
Numeral::V1::ExternalAccounts::ExternalAccounttId.approve(external_account_id)
Numeral::V1::ExternalAccounts::ExternalAccounttId.deny(external_account_id)
Numeral::V1::ExternalAccounts::ExternalAccounttId.verify(external_account_id)
Numeral::V1::ExternalAccounts::ExternalAccounttId.disable(external_account_id)

Files

A file is received from or sent to a bank. A file can be a payment file, a payment status report, an account statement, etc. The Numeral API allows you to list, approve, and download files. ⚠️ TEST not complete for approve and cancel. Automatically approved by Numeral

Numeral::V1::Files.get_list(options)
Numeral::V1::Files::FileId.get(file_id)
Numeral::V1::Files::FileId.approve(file_id)
Numeral::V1::Files::FileId.cancel(file_id)

IncomingPayments

An incoming payment is a payment received included in an incoming payment file, such as a pacs.008 file for incoming SEPA credit transfers (SCTs) or pacs.003 file for incoming SEPA direct debits (SDD). Numeral receives incoming payment files from your bank and breaks them down into individual incoming payments. This feature is only available to financial institution customers. ⚠️ TEST failing. Can't update a incoming payments because only with status pending_confirmation can be confirmed

Numeral::V1::IncomingPayments.get_list(options)
Numeral::V1::IncomingPayments::IncomingPaymentId.get(incoming_payment_id)
Numeral::V1::IncomingPayments::IncomingPaymentId.update(incoming_payment_id, body: body)
Numeral::V1::IncomingPayments::IncomingPaymentId.reject(incoming_payment_id, body: body)
Numeral::V1::IncomingPayments::IncomingPaymentId.accept(incoming_payment_id)

Inquiries

An inquiry is a request for status update on a previous message. Only inquiries that relate to return requests are processed. ⚠️ TEST failing. Can't create inquiry

Numeral::V1::Inquiries.get_list(options)
Numeral::V1::Inquiries.create(body: body)
Numeral::V1::Inquiries::InquiryId.deny(inquiry_id, body: body)
Numeral::V1::Inquiries::InquiryId.get(inquiry_id)

InternalAccount

Payment Service Providers (PSPs) are expected to manage customers’ accounts from which payment should be sent to and to which they can be received. Such accounts are identified in Numeral as Internal accounts. They will be typed "own", or "virtual" to encompass both own interbank accounts used by regulated financial institutions, as well as regular virtual accounts (also referred to as "virtual IBANs" or "VIBANs").

Numeral::V1::InternalAccounts.get_list(options)
Numeral::V1::InternalAccounts.create(body: body)
Numeral::V1::InternalAccounts::InternalAccounttId.get(internal_account_id)
Numeral::V1::InternalAccounts::InternalAccounttId.update(internal_account_id, body: body)
Numeral::V1::InternalAccounts::InternalAccounttId.disable(internal_account_id)

PaymentOrders

A payment order is an order to create a payment to or out of one of your connected accounts. Numeral connects to your bank to process this payment and sends status updates through webhooks.

Numeral::V1::PaymentOrders.get_list(options)
Numeral::V1::PaymentOrders.create(body: body)
Numeral::V1::PaymentOrders::PaymentOrderId.get(payment_order_id)
Numeral::V1::PaymentOrders::PaymentOrderId.update(payment_order_id, body: body)
Numeral::V1::PaymentOrders::PaymentOrderId.approve(payment_order_id)
Numeral::V1::PaymentOrders::PaymentOrderId.cancel(payment_order_id)
Numeral::V1::PaymentOrders::PaymentOrderId.retry(payment_order_id, body: body)

Returns

A return is the return of an incoming payment or payment order.

Numeral::V1::Returns.get_list(options)
Numeral::V1::Returns.create(body: body)
Numeral::V1::Returns::ReturnId.get(return_id)

ReturnRequests

Also sometimes called a recall, a return request is the request to return an incoming payment or payment order. This feature is only available to financial institution customers.

Numeral::V1::ReturnRequests.get_list(options)
Numeral::V1::ReturnRequests.create(body: body)
Numeral::V1::ReturnRequests::ReturnRequestId.get(return_request_id)
Numeral::V1::ReturnRequests::ReturnRequestId.deny(return_request_id)
Numeral::V1::ReturnRequests::ReturnRequestId.accept(return_request_id)

Transactions

A transaction is a debit or credit transaction on a connected account. Numeral connects to your bank to retrieve account statements and extract transactions.

Numeral::V1::Transactions.get_list(options)
Numeral::V1::Transactions::TransactionId.get(transaction_id)

Development

To run all tests : bundle exec rake test