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 Payout API

The Payout API from NALA — 2 operation(s) for payout.

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

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

This API exposes 3 operations across 2 paths, and defines 33 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.

3 operations 2 paths 33 schemas 2 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 Payout API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

Paths & Operations 3

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

Payout 3
GET
/payouts
List
4 params → 200422500
POST
/payouts
Create
1 param body → 202402409422500503
GET
/payouts/{id}
Get
1 param → 200404500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are openapi.PayoutGetResponse (11 properties), openapi.PayoutCreateResponse (10 properties), openapi.PayoutCreateRequest (8 properties), openapi_PayoutCreateRequest_sender_address (6 properties). Each schema is shown below with its type and property counts.

openapi_PayoutCreateRequest_amount
object
required The intended amount to send to either the paymentaccountid or paymentaccount
2 properties
openapi.ResponseBodyWalletInsufficientBalance
object
2 properties
openapi_PayoutListResponseMeta_paging_cursors
object
1 property
openapi_PayoutCreateRequest_sender_individual
object
2 properties
openapi.ResponseBodyIdempotencyConflict
object
2 properties
openapi_ResponseBodyValidationFailed_errors
object
1 property
openapi.ResponseBodySuccessCollection
object
2 properties
openapi_PayoutCreateResponse_sender_individual_identity_document
object
5 properties
_payouts_get_200_response
openapi.ResponseBodySuccessNoMeta
object
1 property
openapi_PayoutCreateResponse_state
object
2 properties
openapi_PayoutCreateResponse_amount
object
2 properties
openapi.PaymentAccountGetOrCreateRequest
object
5 properties
openapi.ResponseBodyValidationFailed
object
3 properties
_payouts_post_202_response
openapi_PayoutListResponseMeta_paging
object
2 properties
openapi_PaymentAccountGetOrCreateRequest_bank_account
object
2 properties
openapi_PayoutCreateResponse_sender_address
object
6 properties
openapi.ResponseBodyNotFound
object
2 properties
openapi.PayoutCreateRequest
object
8 properties
openapi_PaymentAccountGetOrCreateRequest_mobile_money
object
2 properties
openapi_PayoutCreateRequest_sender
object
An optional property for incorporating sender details. Please refer to the "💡 Compliance requirements" documentation above.
4 properties
openapi.PayoutGetResponse
object
11 properties
openapi_PayoutCreateRequest_sender_individual_identity_document
object
5 properties
openapi_PayoutCreateResponse_sender_individual
object
2 properties
openapi.ResponseBodyInternalServerError
object
2 properties
openapi.PayoutListResponseMeta
object
1 property
openapi.ResponseBodyPayoutPaymentAccountTemporarilyUnavailable
object
2 properties
openapi.PayoutCreateResponse
object
10 properties
openapi_PayoutCreateRequest_sender_address
object
6 properties
_payouts__id__get_200_response
openapi_PayoutCreateResponse_sender
object
4 properties
openapi_PaymentAccountGetOrCreateRequest_holder
object
required The individual (or business) in whose name the bank account is registered
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nala-payout-api-openapi.yml Raw ↑

Other APIs NALA publishes across the network.

NALA Bank API
NALA Lookup API
NALA Payment Account API
NALA Wallet API