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

AZA Finance Payin Methods API

The Payin Methods API from AZA Finance — 2 operation(s) for payin methods.

AZA Finance Payin Methods API is one of 16 APIs that AZA Finance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payin Methods. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 4 operations across 2 paths, and defines 12 schemas. It is described by OpenAPI 3.0.2, at version 1.0.

Requests are made against 2 base URLs: https://api-sandbox.transferzero.com/v1, https://api.transferzero.com/v1.

4 operations 2 paths 12 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0
Base URL
https://api.transferzero.com/v1
Authentication
API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

AZA Finance Payin Methods API declares 4 security schemes for authenticating requests. An API key is passed in the header as Authorization-Key (AuthorizationKey). An API key is passed in the header as Authorization-Secret (AuthorizationSecret). An API key is passed in the header as Authorization-Nonce (AuthorizationNonce). An API key is passed in the header as Authorization-Signature (AuthorizationSignature). By default, every request must be authenticated.

  • AuthorizationKey — Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fields
  • AuthorizationSecret — Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fields
  • AuthorizationNonce — Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fields
  • AuthorizationSignature — Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fields

Paths & Operations 4

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

Payin Methods 4
GET
/payin_methods/{PayinMethod ID}
Fetching a payin method
get-payin-method 1 param → 200401404500
DELETE
/payin_methods/{PayinMethod ID}
Deleting a payin method
delete-payin-method 1 param → 200401404422500
PATCH
/payin_methods/{PayinMethod ID}
Updating a payin method
patch-payin-method 1 param body → 200401404422500
POST
/payin_methods/{PayinMethod ID}/retry
Retries PayinMethod
retry-payin-method 1 param → 200401404422500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are PayinMethod (9 properties), PayinMethodDetailsMobile (4 properties), StateReasonDetails (4 properties), PayinMethodDetailsNGNBank (3 properties). Each schema is shown below with its type and property counts.

PayinMethod
object
This describes the specific details on how the funds should be collected from the sender.
9 properties
PayinMethodDetailsBTC
object
JSON "details": { "refundaddress": "n4VQ5YdHf7hLQ2gWQYYrcxoE5B7nWuDFNF" }
1 property
PayinMethodUxFlow
string
Describes the collection experience that will be presented to the sender. Can be one of the following: ussdpopup: Payment prompt is pushed to the sender's phon…
ValidationErrorDescription
object
The description of the error
1 property
PayoutMethodCountryEnum
string
The country for the pickup or mobile payout. For USD cash pickup in Nigeria, valid options are: - NG: Nigeria For XOF cash pickup, valid options are: - CI: Ivo…
PayinMethodState
string
The state of the payin method, which can be one of the following: incomplete: Some fields need to be filled in indetails before we can initiate the collection…
PayinMethodDetailsNGNBank
object
JSON "details": { "phonenumber": "+2348187221236", "accountname": "Test Merchant", "accountnumber": "1234567890" }
3 properties
PayinMethodDetails
Fields needed by the payment processor. Depends on the chose payin type. See the appropriate model details for more info: - NGN::Bank: see [PayinMethodDetailsN…
PayinMethodResponse
object
1 property
StateReasonDetails
object
4 properties
PayinMethodDetailsMobile
object
JSON "details": { "phonenumber": "+256129999999", }
4 properties
PayoutMethodMobileProviderEnum
string
The Mobile Wallet provider of the recipient: For XOF (Senegal) valid options are: - orange: Orange - tigo: Tigo - emoney: Emoney - free: Free - expresso : Expr…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aza-finance-payin-methods-api-openapi.yml Raw ↑

Other APIs AZA Finance publishes across the network.

AZA Finance Account Debits API
AZA Finance Account Validation API
AZA Finance Accounts API
AZA Finance API Logs API
AZA Finance Currency Info API
AZA Finance dlocal balance API
AZA Finance Documents API
AZA Finance Logs API
AZA Finance Mandates API
AZA Finance Payment Methods API
AZA Finance Payout Methods API
AZA Finance Recipients API