AZA Finance Recipients API
The Recipients API from AZA Finance — 3 operation(s) for recipients.
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.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
3 paths
56 schemas
1 DELETE2 GET1 PATCH
Metadata
The identity and technical contract details declared by the specification.
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 fieldsAuthorizationSecret— Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fieldsAuthorizationNonce— Please see the [Authentication guide](https://docs.transferzero.com/docs/authentication) on how to use these fieldsAuthorizationSignature— 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
DELETE
/recipients/{Recipient ID}
Cancelling a recipient
PATCH
/recipients/{Recipient ID}
Updating a recipient
GET
/recipients/{Recipient ID}/proof_of_payments
Returns list of proof of payments
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.
PayoutMethodDetailsMADCash
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+212537718685" Mandatory; E.164 international format "senderidentitycardtype" = "O"…
12 properties
5 required
PayoutMethodDetailsXAFBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "CM2110033052090901100045910", IBAN format "bankaccount": "09011000459", "bankname": "Unite…
10 properties
3 required
PayoutMethodDetailsGBPBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "GB45LOYD60161331926819", // Required if no bankaccount and sortcode "bankaccount": "123456…
9 properties
2 required
PayoutMethodDetailsCADBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankaccount": "123456789", "bankcode": "003", "branchcode": "12345" } See [CAD Bank](https://docs.…
6 properties
5 required
PayoutMethodDetailsBRLBank
object
PIX Payment: JSON "details": { "firstname": "First", "lastname": "Last", "city": "Brasilia", "postalcode": "70070", "phonenumber": "+552112345678", // E.164 in…
14 properties
6 required
RecipientStateReasonDetails
PayoutMethodDetailsNGNBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankcode": "058", "bankaccount": "123456789", "bankaccounttype": "10", 10 for saving, 20 for curre…
7 properties
4 required
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…
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…
RecipientResponse
object
1 property
PayoutMethodDetailsBWPBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankname": "Banc ABC", "bankaccount": "12345678912345678", "branchcode": "550067", } See [BWP Bank…
6 properties
5 required
PayoutMethodDetailsBalance
object
JSON "details": { "reference": "Reference" // optional }
1 property
PayoutMethodDetailsBTC
object
JSON "details": { "firstname": "First", "lastname": "Last", "name": "Full Name" "address": "n4VQ5YdHf7hLQ2gWQYYrcxoE5B7nWuDFNF" }
5 properties
4 required
ProofOfPayment
object
4 properties
PayoutMethodDetailsKESMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "street": "1 Linford Street", "city": "Nairobi", "phonenumber": "+254123456789", // E.164 internati…
12 properties
8 required
PayoutMethodDetailsGNFMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+224444044436", // E.164 international format "mobileprovider": "mtn" }
5 properties
4 required
FieldDescription
object
2 properties
PayoutMethodDetailsEGPBank
object
JSON "details": { "firstname": "First", "middlename": "Middle", "lastname": "Last", "street": "1 Main Street", "phonenumber": "+201023456789", "bankaccount": "…
9 properties
6 required
FieldSelectValidation
object
2 properties
PayoutMethodDetailsUGXBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "street": "1, Old Taxi Park", "city": "Kampala", "postalcode": "10102", "identitycardid": "30819001…
10 properties
9 required
PayoutMethod
object
This describes the specific details on how the payment has to be routed to the recipient.
6 properties
PaginationMeta
object
1 property
RecipientListResponse
object
2 properties
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…
Recipient
object
The recipient describes the amount, the currency and the destination where the money should be sent.
25 properties
3 required
PayoutMethodDetailsZMWBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankaccount": "1234567890", "branchcode": "ZM210003", } See [ZMW Bank](https://docs.transferzero.c…
5 properties
4 required
StateReasonDetails
object
4 properties
PayoutMethodDetails
PayoutMethodBankAccountTypeEnum
string
The type of the bank account: - 10: Savings account - 20: Current account - 30: Payment account - 40: Salary account
PayoutMethodDetailsGHSMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+233302123456", // E.164 international format "mobileprovider": "vodafone", "transf…
5 properties
3 required
Pagination
object
5 properties
RecipientRequest
object
1 property
PayoutMethodDetailsZARBank
object
JSON "details": { "firstname": "First", // Mandatory for personal payouts; "lastname": "Last", // Mandatory for personal payouts; "name" "First Ltd", // Mandat…
20 properties
4 required
PayoutMethodDetailsUSDCash
object
JSON "details": { "firstname": "Jane", "lastname": "Doe", "phonenumber": "+2341234567", // E.164 international format "country": "NG" } See [USD Cash](https://…
5 properties
4 required
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…
PayoutMethodDetailsNZDBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankaccount": "1212341234567123", "bankname": "ASB Bank" } See [NZD Bank](https://docs.transferzer…
5 properties
4 required
PayoutMethodDetailsXAFMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+237674044436", // E.164 international format "mobileprovider": "orange", "country"…
6 properties
4 required
PayoutMethodGenderEnum
string
The gender of the sender: - M: Male - F: Female
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
PayoutMethodDetailsIBAN
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "DE89370400440532013000", "bic": "DEUTDEBBXXX", // Optional "bankname": "Deutsche Bank", //…
7 properties
3 required
PayoutMethodCashProviderEnum
string
The cash provider for the pickup: For XOF valid options are: - wizall: Wizall
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…
ProofOfPaymentListResponse
object
1 property
PayoutMethodNatureOfBusinessEnum
string
Nature of business options (used only with a Business sender) Available values: - personal: Personal - agricultureandhunting: Agriculture and Hunting - forestr…
PayoutMethodDetailsKESBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "street": "Main Street", "city": "Nairobi", "bankcode": "68", "bankaccount": "12345678", "transferr…
11 properties
8 required
PayoutMethodDetailsEGPCash
object
JSON "details": { "firstname": "First", "middlename": "Middle", "lastname": "Last", "phonenumber": "+201023456789", "street": "1 Main Street", "transferreason"…
8 properties
6 required
PayoutMethodDetailsXOFCash
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+221774044436", // E.164 international format "cashprovider": "wizall" // Mandatory…
6 properties
4 required
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
PayoutMethodDetailsUSDBank
object
Nigeria: JSON "details": { "firstname": "Jane", "lastname": "Doe", "phonenumber": "+2341234567", // E.164 international format "bankcode": "057", "bankaccount"…
15 properties
3 required
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…
PayoutMethodTransferReasonEnum
string
Reason of transfer Available values: - personalaccount: Sending money into my own account - donationsandgifts: Donations and gifts - thirdpartypersonaccount: S…
FieldValidation
object
3 properties
PayoutMethodDetailsGHSBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankcode": "030100", "bankaccount": "123456789", "transferreason": "thirdpartypersonaccount" } The…
6 properties
4 required
PayoutMethodDetailsXOFMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+221708766123", // E.164 international format "mobileprovider": "orange", // "orang…
7 properties
4 required
PayoutMethodDetailsXOFBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "BJ0610100100144390000769", BBAN format "bankname": "Bank Of Africa Bénin", "bankcountry":…
8 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AZA Finance 12
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
#Recipients