The identity and technical contract details declared by the specification.
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…
PayinMethod
object
This describes the specific details on how the funds should be collected from the sender.
9 properties
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…
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:…
ValidationErrorDescription
object
The description of the error
1 property
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
FieldDescription
object
2 properties
WebhookDefinition
object
Object that holds where to send webhooks, and what events should it be triggered with
5 properties
2 required
PayoutMethodDetailsUGXBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "street": "1, Old Taxi Park", "city": "Kampala", "postalcode": "10102", "identitycardid": "30819001…
10 properties
9 required
PayinMethodDetailsNGNBank
object
JSON "details": { "phonenumber": "+2348187221236", "accountname": "Test Merchant", "accountnumber": "1234567890" }
3 properties
PayoutMethodDetailsGHSBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankcode": "030100", "bankaccount": "123456789", "transferreason": "thirdpartypersonaccount" } The…
6 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
PayoutMethodDetailsUSDBank
object
Nigeria: JSON "details": { "firstname": "Jane", "lastname": "Doe", "phonenumber": "+2341234567", // E.164 international format "bankcode": "057", "bankaccount"…
15 properties
3 required
PayoutMethodDetailsNZDBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankaccount": "1212341234567123", "bankname": "ASB Bank" } See [NZD Bank](https://docs.transferzer…
5 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
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…
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
PaginationMeta
object
1 property
PayoutMethodDetailsXOFMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+221708766123", // E.164 international format "mobileprovider": "orange", // "orang…
7 properties
4 required
PayoutMethodCashProviderEnum
string
The cash provider for the pickup: For XOF valid options are: - wizall: Wizall
PayoutMethodDetailsNGNBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankcode": "058", "bankaccount": "123456789", "bankaccounttype": "10", 10 for saving, 20 for curre…
7 properties
4 required
WebhookDefinitionListResponse
object
2 properties
PayoutMethodDetailsEGPCash
object
JSON "details": { "firstname": "First", "middlename": "Middle", "lastname": "Last", "phonenumber": "+201023456789", "street": "1 Main Street", "transferreason"…
8 properties
6 required
PayoutMethodTransferReasonEnum
string
Reason of transfer Available values: - personalaccount: Sending money into my own account - donationsandgifts: Donations and gifts - thirdpartypersonaccount: S…
Recipient
object
The recipient describes the amount, the currency and the destination where the money should be sent.
25 properties
3 required
PayoutMethodDetailsIBAN
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "DE89370400440532013000", "bic": "DEUTDEBBXXX", // Optional "bankname": "Deutsche Bank", //…
7 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
WebhookDefinitionResponse
object
1 property
StateReasonDetails
object
4 properties
FieldSelectValidation
object
2 properties
PayoutMethod
object
This describes the specific details on how the payment has to be routed to the recipient.
6 properties
PayoutMethodDetailsBWPBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankname": "Banc ABC", "bankaccount": "12345678912345678", "branchcode": "550067", } See [BWP Bank…
6 properties
5 required
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…
PayoutMethodDetailsCADBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "bankaccount": "123456789", "bankcode": "003", "branchcode": "12345" } See [CAD Bank](https://docs.…
6 properties
5 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…
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…
PayoutMethodDetailsEGPBank
object
JSON "details": { "firstname": "First", "middlename": "Middle", "lastname": "Last", "street": "1 Main Street", "phonenumber": "+201023456789", "bankaccount": "…
9 properties
6 required
WebhookDefinitionRequest
object
1 property
TransactionTraits
object
Additional features that are enabled on the transaction. For more details please see [Additional features](https://docs.transferzero.com/docs/additional-featur…
2 properties
PayoutMethodBankAccountTypeEnum
string
The type of the bank account: - 10: Savings account - 20: Current account - 30: Payment account - 40: Salary account
Document
object
15 properties
2 required
PayoutMethodDetailsGNFMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+224444044436", // E.164 international format "mobileprovider": "mtn" }
5 properties
4 required
WebhookDefinitionEventListResponse
object
1 property
Pagination
object
5 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…
PayoutMethodDetailsZARBank
object
JSON "details": { "firstname": "First", // Mandatory for personal payouts; "lastname": "Last", // Mandatory for personal payouts; "name" "First Ltd", // Mandat…
20 properties
4 required
PoliticallyExposedPerson
object
8 properties
Transaction
object
The template of transactions are the following: JSON { "inputcurrency": // currency to pay in, "sender":{ // details of the sender }, "recipients":[ { "request…
16 properties
3 required
PayoutMethodDetailsBalance
object
JSON "details": { "reference": "Reference" // optional }
1 property
PayoutMethodDetailsXAFBank
object
JSON "details": { "firstname": "First", "lastname": "Last", "iban": "CM2110033052090901100045910", IBAN format "bankaccount": "09011000459", "bankname": "Unite…
10 properties
3 required
PayoutMethodDetailsBTC
object
JSON "details": { "firstname": "First", "lastname": "Last", "name": "Full Name" "address": "n4VQ5YdHf7hLQ2gWQYYrcxoE5B7nWuDFNF" }
5 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
PayoutMethodDetailsMADCash
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+212537718685" Mandatory; E.164 international format "senderidentitycardtype" = "O"…
12 properties
5 required
PayoutMethodDetailsXOFCash
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+221774044436", // E.164 international format "cashprovider": "wizall" // Mandatory…
6 properties
4 required
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…
Webhook
object
Whenever objects in the TransferZero API change state, we can optionally send the changed details to a pre-registered webhook address. Webhooks can be created…
3 properties
3 required
PayoutMethodDetailsGHSMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "phonenumber": "+233302123456", // E.164 international format "mobileprovider": "vodafone", "transf…
5 properties
3 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…
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
PayinMethodDetailsMobile
object
JSON "details": { "phonenumber": "+256129999999", }
4 properties
PayoutMethodDetailsBRLBank
object
PIX Payment: JSON "details": { "firstname": "First", "lastname": "Last", "city": "Brasilia", "postalcode": "70070", "phonenumber": "+552112345678", // E.164 in…
14 properties
6 required
PayoutMethodDetailsKESMobile
object
JSON "details": { "firstname": "First", "lastname": "Last", "street": "1 Linford Street", "city": "Nairobi", "phonenumber": "+254123456789", // E.164 internati…
12 properties
8 required
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…
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AZA Finance publishes across the network.
