How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
AZA Finance

AZA Finance Recipients API

The Recipients API from AZA Finance — 3 operation(s) for recipients.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 4 operations across 3 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

4 operations 3 paths 56 schemas 1 DELETE2 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
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 Recipients 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 3 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Recipients 4
GET
/recipients
Getting a list of recipients with filtering
get-recipients 8 params → 200401500
DELETE
/recipients/{Recipient ID}
Cancelling a recipient
delete-recipient 1 param → 200401404422500
PATCH
/recipients/{Recipient ID}
Updating a recipient
patch-recipient 1 param body → 200401404422500
GET
/recipients/{Recipient ID}/proof_of_payments
Returns list of proof of payments
proof-of-payments 1 param → 200422

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are Recipient (25 properties), PayoutMethodDetailsZARBank (20 properties), PayoutMethodDetailsUSDBank (15 properties), PayoutMethodDetailsBRLBank (14 properties). Each schema is shown below with its type and property counts.

ProofOfPaymentListResponse
object
1 property
PayoutMethodDetailsBTC
object
JSON "details": { "firstname": "First", "lastname": "Last", "name": "Full Name" "address": "n4VQ5YdHf7hLQ2gWQYYrcxoE5B7nWuDFNF" }
5 properties 4 required
PayoutMethod
object
This describes the specific details on how the payment has to be routed to the recipient.
6 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…
Pagination
object
5 properties
RecipientStateReasonDetails
RecipientState
string
The state of the recipient. Can be one of the following: initial: We haven't initiated the payout yet, you can still cancel the transaction pending: Payout has…
PayoutMethodCashProviderEnum
string
The cash provider for the pickup: For XOF valid options are: - wizall: Wizall
FieldSelectValidation
object
2 properties
PayoutMethodDetailsIBAN
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "DE89370400440532013000", "bic": "DEUTDEBBXXX", // Optional "bankname": "Deutsche Bank", //…
7 properties 3 required
PayoutMethodDetailsXOFCash
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+221774044436", // E.164 international format "cashprovider": "wizall" // Mandatory…
6 properties 4 required
PayoutMethodNatureOfBusinessEnum
string
Nature of business options (used only with a Business sender) Available values: - personal: Personal - agricultureandhunting: Agriculture and Hunting - forestr…
PayoutMethodDetailsEGPCash
object
JSON "details": { "firstname": "First", "middlename": "Middle", "lastname": "Last", "phonenumber": "+201023456789", "street": "1 Main Street", "transferreason"…
8 properties 6 required
RecipientListResponse
object
2 properties
PayoutMethodDetailsNGNBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankcode": "058", "bankaccount": "123456789", "bankaccounttype": "10", 10 for saving, 20 for curre…
7 properties 4 required
PayoutMethodDetailsXAFBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "CM2110033052090901100045910", IBAN format "bankaccount": "09011000459", "bankname": "Unite…
10 properties 3 required
PayoutMethodDetailsXOFMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+221708766123", // E.164 international format "mobileprovider": "orange", // "orang…
7 properties 4 required
PayoutMethodDetailsMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+221708766123" // E.164 international format } Please note when sending XOF::Cash p…
5 properties 3 required
FieldDescription
object
2 properties
PayoutMethodDetailsXOFBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "BJ0610100100144390000769", BBAN format "bankname": "Bank Of Africa Bénin", "bankcountry":…
8 properties 3 required
ProofOfPayment
object
4 properties
PayoutMethodDetailsUSDCash
object
JSON "details": { "firstname": "Jane", "lastname": "Doe", "phonenumber": "+2341234567", // E.164 international format "country": "NG" } See [USD Cash](https://…
5 properties 4 required
PayoutMethodDetailsKESMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "street": "1 Linford Street", "city": "Nairobi", "phonenumber": "+254123456789", // E.164 internati…
12 properties 8 required
PayoutMethodDetailsZARBank
object
JSON "details": { "firstname": "First", // Mandatory for personal payouts; "lastname": "Last", // Mandatory for personal payouts; "name" "First Ltd", // Mandat…
20 properties 4 required
PayoutMethodDetailsBalance
object
JSON "details": { "reference": "Reference" // optional }
1 property
PayoutMethodDetailsGHSMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+233302123456", // E.164 international format "mobileprovider": "vodafone", "transf…
5 properties 3 required
PayoutMethodDetailsGHSBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankcode": "030100", "bankaccount": "123456789", "transferreason": "thirdpartypersonaccount" } The…
6 properties 4 required
PayoutMethodDetails
RecipientRequest
object
1 property
PayoutMethodDetailsUGXBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "street": "1, Old Taxi Park", "city": "Kampala", "postalcode": "10102", "identitycardid": "30819001…
10 properties 9 required
StateReasonDetails
object
4 properties
PayoutMethodIdentityCardTypeEnum
string
The type of the identity card used by the sender or recipient: - PP: Passport - ID: National Identity Card - O: Other type of identity card - DL: Driving Licen…
ValidationErrorDescription
object
The description of the error
1 property
PayoutMethodTransferReasonEnum
string
Reason of transfer Available values: - personalaccount: Sending money into my own account - donationsandgifts: Donations and gifts - thirdpartypersonaccount: S…
PayoutMethodDetailsCADBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankaccount": "123456789", "bankcode": "003", "branchcode": "12345" } See [CAD Bank](https://docs.…
6 properties 5 required
PayoutMethodGenderEnum
string
The gender of the sender: - M: Male - F: Female
PayoutMethodLegalEntityTypeEnum
string
The entity type of the recipient. For ZAR personal payouts valid options are: - person: Person For ZAR business payouts valid options are: - soleproprietorship…
PayoutMethodDetailsXAFMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+237674044436", // E.164 international format "mobileprovider": "orange", "country"…
6 properties 4 required
PayoutMethodBankAccountTypeEnum
string
The type of the bank account: - 10: Savings account - 20: Current account - 30: Payment account - 40: Salary account
PayoutMethodPixKeyTypeEnum
string
The type of pix key used by the recipient - cpf: Natural person register number - cnpj: Company registration number - phone: Phone number - email: Email addres…
PayoutMethodDetailsGBPBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "GB45LOYD60161331926819", // Required if no bankaccount and sortcode "bankaccount": "123456…
9 properties 2 required
PayoutMethodDetailsNZDBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankaccount": "1212341234567123", "bankname": "ASB Bank" } See [NZD Bank](https://docs.transferzer…
5 properties 4 required
PayoutMethodDetailsKESBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "street": "Main Street", "city": "Nairobi", "bankcode": "68", "bankaccount": "12345678", "transferr…
11 properties 8 required
FieldValidation
object
3 properties
PayoutMethodDetailsZMWBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankaccount": "1234567890", "branchcode": "ZM210003", } See [ZMW Bank](https://docs.transferzero.c…
5 properties 4 required
RecipientResponse
object
1 property
PayoutMethodDetailsGNFMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+224444044436", // E.164 international format "mobileprovider": "mtn" }
5 properties 4 required
PayoutMethodDetailsBRLBank
object
PIX Payment: JSON "details": { "firstname": "First", "lastname": "Last", "city": "Brasilia", "postalcode": "70070", "phonenumber": "+552112345678", // E.164 in…
14 properties 6 required
PaginationMeta
object
1 property
PayoutMethodDetailsUSDBank
object
Nigeria: JSON "details": { "firstname": "Jane", "lastname": "Doe", "phonenumber": "+2341234567", // E.164 international format "bankcode": "057", "bankaccount"…
15 properties 3 required
PayoutMethodDetailsBWPBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankname": "Banc ABC", "bankaccount": "12345678912345678", "branchcode": "550067", } See [BWP Bank…
6 properties 5 required
TransactionState
string
The state of the transaction, which can be one of the following: initial: Transaction is created, but not yet ready to receive payments (waiting for Sender to…
PayoutMethodDetailsMADCash
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+212537718685" Mandatory; E.164 international format "senderidentitycardtype" = "O"…
12 properties 5 required
Recipient
object
The recipient describes the amount, the currency and the destination where the money should be sent.
25 properties 3 required
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…
PayoutMethodDetailsEGPBank
object
JSON "details": { "firstname": "First", "middlename": "Middle", "lastname": "Last", "street": "1 Main Street", "phonenumber": "+201023456789", "bankaccount": "…
9 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aza-finance-recipients-api-openapi.yml Raw ↑

Other APIs AZA Finance publishes across the network.

AZA Finance Account Debits API
AE Profile APIs.io
AZA Finance Account Validation API
AE Profile APIs.io
AZA Finance Accounts API
AE Profile APIs.io
AZA Finance API Logs API
AE Profile APIs.io
AZA Finance Currency Info API
AE Profile APIs.io
AZA Finance dlocal balance API
AE Profile APIs.io
AZA Finance Documents API
AE Profile APIs.io
AZA Finance Logs API
AE Profile APIs.io
AZA Finance Mandates API
AE Profile APIs.io
AZA Finance Payin Methods API
AE Profile APIs.io
AZA Finance Payment Methods API
AE Profile APIs.io
AZA Finance Payout Methods API
AE Profile APIs.io
#Recipients
← Back to A APIs
API Details
ID
aza-finance:aza-finance-recipients-api
Base URL
https://api.transferzero.com/v1
Docs
https://docs.transferzero.com/
Provider
AZA Finance
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=aza-finance-recipients-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/aza-finance-recipients-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of AZA Finance Recipients API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.