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

The Mandates API from AZA Finance — 1 operation(s) for mandates.

AZA Finance Mandates 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 Mandates. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 1 operation across 1 path, and defines 3 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.

1 operations 1 paths 3 schemas 1 GET

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 Mandates 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 1

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

Mandates 1
GET
/mandates/{Mandate ID}
Fetch a single mandate
get-mandate 1 param → 200401404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Mandate (7 properties), MandateResponse (1 property). Each schema is shown below with its type and property counts.

Mandate
object
A Mandate authorises payouts to a Recipient. Mandates are issued per calendar year and must be in a signed (or bypassed) state before the linked Recipient can…
7 properties
MandateResponse
object
1 property
MandateStatus
string
Current state of the mandate. pending — created, awaiting signing flow notified — recipient has been notified to sign signed — recipient signed; mandate is act…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aza-finance-mandates-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 Payin Methods API
AZA Finance Payment Methods API
AZA Finance Payout Methods API
AZA Finance Recipients API