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

The Senders API from AZA Finance — 2 operation(s) for senders.

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

This API exposes 5 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.

5 operations 2 paths 12 schemas 1 DELETE2 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 Senders 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 5

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

Senders 5
GET
/senders
Listing senders
get-senders 5 params → 200401500
POST
/senders
Creating a sender
post-senders body → 201401422500
GET
/senders/{Sender ID}
Fetching a sender
get-sender 1 param → 200401404500
DELETE
/senders/{Sender ID}
Deleting a sender
delete-sender 1 param → 200401404422500
PATCH
/senders/{Sender ID}
Updating a sender
patch-sender 1 param body → 200401404422500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Sender (62 properties), Document (15 properties), PoliticallyExposedPerson (8 properties), Pagination (5 properties). Each schema is shown below with its type and property counts.

SenderResponseMeta
object
1 property
SenderRequest
object
1 property
PaginationMeta
object
1 property
ValidationErrorDescription
object
The description of the error
1 property
SenderResponse
object
2 properties
SenderState
string
The state of the sender. Can be one of the following: - incomplete: When a sender has not submitted required details or documents (cannot transact) - initial:…
Pagination
object
5 properties
Document
object
15 properties 2 required
SenderResponseExisting
object
1 property
PoliticallyExposedPerson
object
8 properties
Sender
object
This contains the details of the sender. The first time a specific sender is used the full details should be provided. Once a sender is created and is used, th…
62 properties 7 required
SenderListResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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