PaaS API Docs
  • Getting Started
  • Authentication
  • Use cases
    • Remittance
      • Bonus/Discount on Remittance
    • Business Payments
    • Individual Wallet
    • Business Wallet
    • Payout
  • API References
    • Data Population
      • Spec Sheet
      • Country
      • States
      • Settlement Rates
    • User
      • User Object
        • User Verification
        • Identification Documents
        • User Verification Status
        • CIP Information Status
      • Receive User Object
      • Register a User
      • Update User
      • Business Representatives
        • Business Representatives Object
        • Add Business Representatives
        • Update Business Representatives
        • Get Business Representatives
      • Declaration
        • Declaration Object
        • Declaration
      • Initiate Verification
      • Get User by ID
      • Get Verification Status
      • Add a Receive User
      • Update a Receive User
      • Get Receive User List
    • Funds
      • User Funding Account Object
      • Funding Account Widget
        • OAuth Integration
        • Bank Verification Status
      • Wallet Object
      • Create a Wallet
      • Get Wallet Details
      • Get User Funding Account
      • Delete User Funding Account
      • Add a Receive Account
      • Update a Receive Account
      • Get Receive Accounts
    • Payout
      • Get Banks
      • Get Payers
    • Transaction (External)
      • Transaction Object
      • Create Transaction
      • Get Transaction by ID
      • Cancel Transaction
      • Transaction Delivery
      • Get Transaction Limits
    • Transaction (Wallet)
      • Wallet Transfer Object
      • Create Transfers
        • Load Wallet
        • Unload Wallet
        • Wallet to Wallet Transfer
      • Get Wallet Transfer Details
      • Get Limits
    • Transaction (Payout)
      • Payout Transaction Object
      • Create Payout Transaction
    • Webhooks
      • Subscribe
      • Integration
      • Events
    • Error Codes
  • Sandbox
    • User: Test Values
    • Funds: Test Values
    • Transaction: Test Values
  • Changelog
    • 2023
      • February 14, 2023
      • January 06, 2023
    • 2022
      • December 28, 2022
      • December 26, 2022
      • December 23, 2022
      • December 2, 2022
      • November 21, 2022
      • November 11, 2022
      • October 31, 2022
      • October 17, 2022
      • August 31, 2022
      • August 1, 2022
      • July 25, 2022
      • May 23, 2022
      • April 7, 2022
      • March 30, 2022
      • March 23, 2022
      • Feb 21, 2022
      • Feb 15, 2022
      • Jan 24, 2022
      • Jan 19, 2022
      • March 10, 2022
Powered by GitBook
On this page
  • Integration Recommendations
  • 1. User Registration
  • 2. User KYC and Transaction Limits
  • 3. Add Receive User
  • 4. Add Funding Account
  • 5. Submit transaction
  • 6. Transaction Delivery

Was this helpful?

  1. Use cases

Remittance

Read for API integration recommendations for remittance use case.

PreviousAuthenticationNextBonus/Discount on Remittance

Last updated 2 years ago

Was this helpful?

Remittance transactions include processing and delivery of person-to-person transactions. Based on your requirements and agreement with Machnet, you may deliver the transactions yourself. Regardless, these are external transactions to external receivers who may be residing in a country different from the sender.

Integration Recommendations

This section will guide you through the API endpoints for the remittance use case. Please note that these are recommendations for standard flow and can be customized as per your needs.

1. User Registration

The first step in creating the user flow is to in our system. Individual users need to be registered with the business field as false. Users can only be registered from the country which has been enabled for you as per your agreement with Machnet. Fields outlined as mandatory in the user object are required during registration.

2. User KYC and Transaction Limits

You will have to provide user information so that necessary KYC checks can be conducted on the sender. In order to run KYC on the sender, you will have to:

  1. Know what

  2. Collect and.

User's KYC verification is conducted using the following information:

  • Name

  • Date of birth

  • Gender

  • Address

  • Email

  • Phone number

3. Add Receive User

Based on the payout method and corridor of the transaction, different details of the receive user need to be collected.

4. Add Funding Account

The sender can add a funding account and proceed to create a transaction as long as their KYC status is not UNVERIFIED and IN PROGRESS.

5. Submit transaction

If the transaction amount exceeds the maximum transaction limit set for a user of a Client, the transaction will be CANCELED.

6. Transaction Delivery

If you are delivering the transaction using your own payout network and NOT using our network, you will need to update the delivery status on our system as well.

Once you have submitted the information, . Each information required for KYC and tier verification is referred to as a CIP tag and each CIP tag has their own verification status. Only when all CIP tags required for KYC verification (listed above) are verified will the KYC status of the user be verified.

Additional information may be required based on the transactions the user wants to create over a period of time. This information is outlined in your spec sheet and can also be obtained using . You can submit the additional information and update existing information collected from the user using the . Each time new information is submitted, make sure to on the user to ensure verification of all submitted information.

as the receiver of the transaction. Since remittance transactions only support C2C transaction type, all receive users in remittance transactions need to be individuals.

For Bank Deposit and Wallet transactions, the . The available banks and their details can be obtained using the . All banks which support remittance will have txn_supported_types as C2C. Funds will be directly deposited into this account. The available wallets and their details can be obtained using the .

For Cash Pickup and Home Delivery, the user will have to select a payer location. The available payer details can be obtained using the . The associated payer_id for the selected location will have to be used during transaction creation.

Once the required transaction information has been collected, the user will then have to . We support bank accounts and debit cards. These are added using a widget to ensure security. For Client approved for wallet product, user's wallet can also be used as a funding source. In order to add wallets for users, please review the .

You are now ready to . Please note that users with SEND capabilities can only create transactions within the limits set in the CIP documents. The transaction limits available to a user are based on the submitted KYC information and their verification status.

All transactions above the user's permitted limits and below the maximum transaction limit is placed on HOLD with the reason . In such cases, the user will need to provide additional information to increase their transaction limits. The verification status of those additional required fields (CIP tags) will be in REQUESTED status. Once this information is submitted, you will need to initiate KYC again for the user. If the submitted information is VERIFIED, the transaction will be forwarded for processing.

Even though a transaction has been created, a transaction will not be forwarded for payout to the beneficiary unless you send a . You can choose to send a delivery request once the funds have been debited from the sender (transaction status: PROCESSED) to contain risks or beforehand to ensure faster payments.

you check what KYC information has been provided by a user and its verification status
A user with the type "RECEIVE" will need to be added
receive user's account also has to be added
Banks API
Payers API
Payers API
link a funding source for the transaction
wallet use case guide
create the transaction
delivery request
KYC information is required for the sender
this API
initiate KYC
register the user
T004 Transaction Limit Exceeded
Update KYC information API
send the required information to Machnet
Initiate KYC process for the user