Payout Transaction Object
Details on transaction object for payout transactions
Field | Required | Type | Description |
id | No | UUID | ID of the transaction created. |
user_id | Yes | UUID | Client ID for the transaction. |
from.first_name | Yes | String | First name or entity name of the sender |
from.middle_name | No | String | Middle name of the sender |
from.last_name | Yes, if individual | String | Last name of the sender |
from.country | Yes | String | 2-letter ISO code of the sender country |
from.zipcode | No | String | Zip code of user |
from.gender | No | String | Male, Female, Other |
from.date_of_birth | Yes | String | Birth date of individual or Day of formation for business in yyyy-MM-dd format. |
from.address_line1 | Yes | String | Street address of the sender |
from.city | Yes | String | City of the sender |
from.mobile_phone | Yes | Numeric | 10 digits mobile number of the individual or 10-15 digits phone number of the business. |
from.email | Yes | String | Email address of the sender |
from.state | Yes | String | 2-letter ISO code of the sender’s state |
from.mailingaddress.zipcode | Yes, if business | String | Zip code of the business |
from.mailingaddress.country | Yes, if business | String | 2-letter ISO code of the mailing country |
from.mailingaddress.address_line1 | Yes, if business | String | Address line 1 of the sender's mailing address |
from.mailingaddress.city | Yes, if business | String | City of sender's mailing address |
from.mailingaddress.state | No | String | State of sender's mailing address |
from.physical_documents | Yes, if business | Object | Copy of a sender's document. This may be required for individuals as well based on your spec sheet. |
from.physical_documents.document_type | Yes, if business | Category | Enumerated value: CERTIFICATE_OF_INCORPORATION,EIN, PASSPORT, DRIVING_LICENCE, STATE_ID |
from.physical_documents.document_value | Yes, if business | String | Copy of document. Documents must be encoded Base64 before being uploaded to our system. |
from.virtual_documents | Yes, if business | Object | Information of sender's document. This may be required for individuals as well based on your spec sheet. |
from.virtual_documents.document_type | Yes, if business | Category | Enumerated value: EIN_NUMBER, PASSPORT, DRIVING_LICENCE, STATE_ID |
from.virtual_documents.document_value | Yes, if business | String | Value of the document. |
to.payout_method | Yes | String | Payout method for transaction amount delivery. Enumerated Value: BANK_DEPOSIT (Default), CASH_PICKUP, WALLET |
to.first_name | Yes | String | First name or entity name of receiver |
to.last_name | Yes, if individual | String | Last name of receiver |
to.mobile_number | Yes | Number | 10 digits mobile number of the individual or 10-15 digits phone number of the business. |
to.destination_country | Yes | String | 2-letter ISO code of receiver's country. |
to.email | No | String | Email address of the receiver. This field may be required based on your spec sheet. |
to.address_line1 | Yes | String | Street address of the receiver's residence if individual and registered address if business |
to.address_line2 | No | String | Street address of the receiver's residence if individual and registered address if business |
to.city | No | String | Receiver's city of residence if individual and city of registration if business. |
to.state | No | String | Receiver's state |
to.zipcode | No | String | Receiver's zipcode |
to.bank_id | Yes, if bank_deposit | Number | Receiver's bank ID |
to.branch_id | Yes, if bank_deposit | Number | Receiver's branch ID |
to.bank_name | Yes, if bank_deposit | String | Receiver's bank name |
to.account_number | Yes, if bank_deposit | String | Receiver's bank account number |
to.rtn_number | No | String | Receiver's routing number |
to.payer_id | Yes, if cash_pickup and wallet | Number | ID of payer associated with the wallet or cash pickup |
to.pickup_location_id | No | Number | Location of the cash pickup agent |
to.msisdn | No | String | Receive user's wallet account number. (Default value if not provided for wallet payout method will be receiver's to.mobile_number) |
to.wallet_type | No | Category | Type of receive user wallet. Enumerated value: TEL (Default value if not provided for wallet payout method will be TEL) |
to.branch_location | No | String | Receiver bank branch location |
to.virtual_document | Yes, if business | Object | Information of a receiver's identificiation document. Details will be outlined in your spec sheet. |
to.virtual_document.document_type | Yes, if business | Category | Enumerated Value: EIN_NUMBER PASSPORT, DRIVING_LICENCE, STATE_ID |
to.virtual_document.document_value | Yes, if business | String | Value of the receiver's document. Documents must be encoded Base64 before being uploaded to our system. |
from_amount | Yes | Numeric | The amount entered by the user to be debited from the user’s account. We accept maximum two decimal places. |
physical_documents | No | Object | Copy of a document. This may be required for certain countries and will be outlined in your spec sheet. |
physical_documents.document_type | No | Category | Enumerated value: INVOICE |
physical_documents.document_value | No | String | Value of the document. Documents must be encoded Base64 before being uploaded to our system. |
to_amount | No | numeric | The amount to be received by the receiving user. We accept maximum two decimal places. |
from_currency | Yes | String | User’s currency |
to_currency | Yes | String | Receive user’s currency |
note | No | String | Note for transaction |
exchange_rate | Yes | numeric | Exchange rate used in transaction. We accept maximum four decimal places. |
fee_amount | Yes | numeric | Additional fee. |
purpose | Yes | Category | The purpose of sending money. Details below. |
custom_purpose | Yes, if purpose is OTHER | String | Additional details when purpose is OTHER |
calculation_mode | No | String | Enumerated value : SENDER_AMOUNT, RECEIVER_AMOUNT. |
ip_address | No | String | IP of the user |
txn_type | No | String | Enumerated value: PAYOUT |
transaction_status | No | String | Enumerated value : INITIATED, PENDING, PROCESSING, PROCESSED, CANCELED, FAILED, HOLD, REFUNDED, RETURNED Note: Transaction hold reasons are listed below. |
delivery_status | No | String | Enumerated Value : NONE, HOLD, PENDING, DELIVERY_REQUESTED, DELIVERED, DELIVERY_FAILED, DELIVERY_AUTHORIZED, DELIVERY_PAYOUT_READY |
risk_score | No | numeric | A Risk Score indicates the high or low risk of a transaction created by users. The lower the score, the less likely the event is high risk. |
reference_number | No | String | A unique identification number of a transaction. This number is generated once the transaction is in PENDING status. |
payout_reference_number | No | String | Reference number provided by the payout partner. |
Purpose
Purpose | Description |
COMPUTER_SERVICES | Computer service |
FAMILY_SUPPORT | Family support |
EDUCATION | Education |
GIFT_AND_DONATION | Gift and other donations |
MEDICAL_TREATMENT | Medical treatment |
MAINTENANCE_EXPENSES | Maintenance or other expenses |
TRAVEL | Travel |
SMALL_VALUE_REMITTANCE | Small value remittance |
LIBERALIZED_REMITTANCE | Liberalized remittance |
CONSTRUCTION_EXPENSES | Construction expenses |
HOTEL_ACCOMMODATION | Hotel accommodation |
ADVERTISING_EXPENSES | Advertising and/or public relations related expenses |
ADVISORY_FEES | Fees for advisory or consulting service |
BUSINESS_INSURANCE | Business related insurance payment |
INSURANCE_CLAIMS | Insurance claims payment |
DELIVERY_FEES | Delivery fees |
EXPORTED_GOODS | Payments for exported goods |
SERVICE_CHARGES | Payment for services |
LOAN_PAYMENT | Payment of loans |
OFFICE_EXPENSES | Office expenses |
PROPERTY_PURCHASE | Residential property purchase |
PROPERTY_RENTAL | Property rental payment |
ROYALTY_FEES | Royalty, trademark, patent and copyright fees |
SHARES_INVESTMENT | Investment in shares |
FUND_INVESTMENT | Fund investment |
TAX_PAYMENT | Tax payment |
TRANSPORTATION_FEES | Transportation fees |
UTILITY_BILLS | Utility bills |
PERSONAL_TRANSFER | Personal transfer |
SALARY_PAYMENT | Payment of salary |
REWARD_PAYMENT | Payment of rewards |
INFLUENCER_PAYMENT | Payment of Influencer |
OTHER_FEES | Broker, commitment, guarantee and other fees |
OTHER | Other purposes |
Transaction Hold Reasons
Transactions may be placed on hold for specific reasons. Regardless of the reason, transactions on hold for more than 7 days are automatically cancelled.
Code | Reason |
T001 | Transaction is under review by compliance. Machnet will provide further information once available. |
T002 | Issue processing transaction. Please contact Machnet customer support. |
T003 | Unable to check balance of the funding account. Please contact Machnet customer support. |
T004 | Transaction limit based on the current tier of the user has been exceeded. If the user is eligible to increase their limits, requested information must be submitted and verified for the transaction to be processed. Check requested information using this API. |
T005 | User is not verified. All basic information must be submitted and verified for the transaction to be processed. Check KYC status using this API. |
T006 | Issue processing transaction. Please contact Machnet customer support. |
Transaction Cancellation Reason
Code | Reason |
C001 | Transaction risk is high. |
C002 | Platform limit exceeded. |
C003 | Transaction expired as it was on HOLD for more than 7 days |
C004 | Transaction was canceled by the user. |
C005 | Transaction was canceled by the admin. |
We may add new transaction status, hold reasons and cancel reasons as and when required. The document will be updated accordingly.
Last updated