Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NALA Payment Account API

The Payment Account API from NALA — 1 operation(s) for payment account.

NALA Payment Account API is one of 5 APIs that NALA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 1 path, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 1.

Requests are made against a single base URL, https://rest.sandbox.rafiki-api.com/v1.

2 operations 1 paths 18 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1
Base URL
https://rest.prod.rafiki-api.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

NALA Payment Account API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Account 2
GET
/payment-accounts
List
2 params → 200422500
POST
/payment-accounts
Get or create
body → 200201422500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are openapi.PaymentAccountGetOrCreateResponse (7 properties), openapi.PaymentAccountGetOrCreateRequest (5 properties), openapi.ResponseBodyValidationFailed (3 properties), openapi.ResponseBodySuccessCollection (2 properties). Each schema is shown below with its type and property counts.

_payment_accounts_post_200_response
openapi_PaymentAccountListResponseMeta_paging
object
2 properties
openapi.PaymentAccountListResponseMeta
object
1 property
openapi_PaymentAccountGetOrCreateResponse_mobile_money
object
2 properties
openapi_PaymentAccountListResponseMeta_paging_cursors
object
1 property
_payment_accounts_get_200_response
openapi_PaymentAccountGetOrCreateResponse_holder
object
2 properties
openapi_PaymentAccountGetOrCreateResponse_bank_account
object
2 properties
openapi.ResponseBodyValidationFailed
object
3 properties
openapi.PaymentAccountGetOrCreateRequest
object
5 properties
openapi.ResponseBodyInternalServerError
object
2 properties
openapi_PaymentAccountGetOrCreateRequest_holder
object
required The individual (or business) in whose name the bank account is registered
2 properties
openapi_PaymentAccountGetOrCreateRequest_bank_account
object
2 properties
openapi.PaymentAccountGetOrCreateResponse
object
7 properties
openapi.ResponseBodySuccessCollection
object
2 properties
openapi_ResponseBodyValidationFailed_errors
object
1 property
openapi_PaymentAccountGetOrCreateRequest_mobile_money
object
2 properties
openapi.ResponseBodySuccessNoMeta
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nala-payment-account-api-openapi.yml Raw ↑

Other APIs NALA publishes across the network.

NALA Bank API
NALA Lookup API
NALA Payout API
NALA Wallet API