Customer

Get Customer Fields

This API retrieves the mandatory fields required to create a transacting customer for your organisation. Once all required fields are provided, the customer is moved to the UNDER_REVIEW state and, upon approval, can be used to create Customer Wallets or Virtual Accounts and to send or receive funds.

TYPE is mandatory and must be specified as part of the query parameter. Supported values are: [company, individual]

Note: Customers can now be created in a PENDING_INFO state by providing a minimal set of fields. This is intended for non-transactional use-cases such as Accounts Receivable (AR). Customers created with this minimal set of fields cannot create customer wallets or VAs nor can the funds be received or sent corresponding to them.

Minimal fields required to create a customer in PENDING_INFO state by TYPE [individual, company]: <br/> Individual: first_name, last_name <br/> Company: name

get/customer/fields

Request

  • Base URL
    https://api.finmo.net/v1
  • Auth
    HTTP basic

Query parameters

type'individual' | 'company' required
Example:company

Type of customer - individual or company

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Example response

{
  "data": {
    "type": "object"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.