Create Payout Transaction

Read on how to create payout transactions in our system

To create a payout transaction, you must specifytxn_type as PAYOUT. Unlike other transaction types, sender and receiver details can be provided in the request body of the transaction API.

A client that has been approved for Payout only service will need a specific user_id from Machnet which they will have to provide in the request body.

POST /users/{{user_id}}/transactions

Bank Deposit (C2C) 

curl --location --request POST '{{url}}/users/{{user_id}}/transactions' \
--header 'X-Client-Id: client_id' \
--header 'X-Client-Secret: client_secret' \
--header 'Content-Type: application/json' \
--data-raw '{
   "from_amount": 10,
   "exchange_rate": 3700,
   "to_amount": 37800,
   "fee_amount": 0,
   "note": "Sample Note",
   "to_currency": "COP",
   "from_currency": "USD",
   "custom_purpose": "home",
   "purpose": "OTHER",
   "txn_type":"PAYOUT",
   "ip_address": "10.10.10.5",
   "to": {
       "payout_method": "BANK_DEPOSIT",
       "branch_id": 153,
       “bank_id”:110,
       “bank_name”:”Digital Bank”,
       "address_line1": "500 El Camino Real Santa Clara",
       "first_name": "Pablolito",
       "last_name": "Doe",
       "mobile_phone": "233541859101",
       "email": "[email protected]",
       "account_type":"SAVINGS",
       "account_number":"2662030100",
       "rtn_number":"026009593",
       "destination_country": "CO",
       "city": "california",
       "country": "US",
       "state": "CA"
   },
   "from": {
       "first_name": "first",
       "last_name":"last",
       "country": "US",
       "date_of_birth": "2000-01-01",
       "gender": "Male",
       "address_line1": "500 8 El Camino Real Santa Clara",
       "city": "california",
       "mobile_phone": "1234567890",
       "email": "[email protected]",
       "state": "CA"
   }
}’

Bank Deposit (B2B)

curl --location --request POST '{{url}}/users/{{user_id}}/transactions' \
--header 'X-Client-Id: client_id' \
--header 'X-Client-Secret: client_secret' \
--header 'Content-Type: application/json' \
--data-raw '{
   "from_amount": 100,
   "exchange_rate": 3700,
   "to_amount": 370000,
   "fee_amount": 0,
   "note": "Sample Note",
   "to_currency": "COP",
   "from_currency": "USD",
   "custom_purpose": "home",
   "purpose": "OTHER",
   "txn_type":"PAYOUT",
   "physical_documents": [
       {
           "document_type": "INVOICE",
           "document_value": "data:image/jpg;base64,SUQs=="
       }
   ],
   "ip_address": "10.10.10.5",
   "to": {
       "payout_method": "BANK_DEPOSIT",
       "branch_id": 153,
       “bank_id”:110,
       “bank_name”:”Digital Bank”,
       "business":true,
       "address_line1": "500 El Camino Real Santa Clara",
       "first_name": "Pablolito",
       "last_name": "Doe",
       "mobile_phone": "233541859101",
       "email": "[email protected]",
       "account_type":"SAVINGS",
       "account_number":"2662030100",
       "rtn_number":"026009593",
       "destination_country": "CO",
       "city": "california",
       "country": "US",
       "state": "CA",
       "virtual_documents": [
           {
               "document_type": "EIN_NUMBER",
               "document_value": "123456"
           }
       ]
   },
   "from": {
       "first_name": "first",
       "country": "US",
       "business": true,
       "date_of_birth": "2000-01-01",
       "gender": "Male",
       "address_line1": "500 8 El Camino Real Santa Clara",
       "city": "california",
       "mobile_phone": "1234567890",
       "email": "[email protected]",
       "state": "CA",
       "physical_documents": [
           {
               "document_type": "CERTIFICATE_OF_INCORPORATION",
               "document_value": "data:image/jpg;base64,SUQs=="
           },
           {
               "document_type": "EIN",
               "document_value": "data:image/jpg;base64,SUQs=="
           }
       ],
       "virtual_documents": [
           {
               "document_type": "EIN_NUMBER",
               "document_value": "123456"
           }
       ],
       "mailing_address": {
           "address_line1": "500 8 El Camino Real Santa Clara",
           "city": "california",
           "country": "US",
           "zipcode": 90305
       }
   }
}’

Bank Deposit (B2C)

curl --location --request POST '{{url}}/users/{{user_id}}/transactions' \
--header 'X-Client-Id: client_id' \
--header 'X-Client-Secret: client_secret' \
--header 'Content-Type: application/json' \
--data-raw '{
   "from_amount": 100,
   "exchange_rate": 3700,
   "to_amount": 370000,
   "fee_amount": 0,
   "note": "Sample Note",
   "to_currency": "COP",
   "from_currency": "USD",
   "custom_purpose": "home",
   "purpose": "OTHER",
   "txn_type":"PAYOUT",
   "physical_documents": [
       {
           "document_type": "INVOICE",
           "document_value": "data:image/jpg;base64,SUQs=="
       }
   ],
   "ip_address": "10.10.10.5",
   "to": {
       "payout_method": "BANK_DEPOSIT",
       "branch_id": 153,
       “bank_id”:110,
       “bank_name”:”Digital Bank”,
       "address_line1": "500 El Camino Real Santa Clara",
       "first_name": "Paolo",
       "last_name": "Sharma",
       "mobile_phone": "233541859101",
       "email": "[email protected]",
       "account_type":"SAVINGS",
       "account_number":"2662030100",
       "rtn_number":"026009593",
       "destination_country": "CO",
       "city": "california",
       "state": "CA"
   },
   "from": {
       "first_name": "Machnet",
       "country": "US",
       "business": true,
       "date_of_birth": "2000-01-01",
       "gender": "Male",
       "address_line1": "500 8 El Camino Real Santa Clara",
       "city": "california",
       "mobile_phone": "237676641000",
       "email": "[email protected]",
       "state": "CA",
       "physical_documents": [
           {
               "document_type": "CERTIFICATE_OF_INCORPORATION",
               "document_value": "data:image/jpg;base64,SUQs=="
           },
           {
               "document_type": "EIN",
               "document_value": "data:image/jpg;base64,SUQs=="
           }
       ],
       "virtual_documents": [
           {
               "document_type": "EIN_NUMBER",
               "document_value": "123456"
           }
       ],
       "mailing_address": {
           "address_line1": "500 8 El Camino Real Santa Clara",
           "city": "california",
           "country": "US",
           "zipcode": 90305
       }
   }
}’

Wallet

curl --location --request POST '{{url}}/users/{{user_id}}/transactions' \
--header 'X-Client-Id: client_id' \
--header 'X-Client-Secret: client_secret' \
--header 'Content-Type: application/json' \
--data-raw '{
   "from_amount": 2.01,
   "exchange_rate": 1,
   "to_amount": 2.01,
   "fee_amount": 0,
   "note": "Sample Note",
   "to_currency": "GHS",
   "from_currency": "USD",
   "purpose": "FAMILY_SUPPORT",
   "ip_address": "10.10.10.5",
   "txn_type": "PAYOUT",
   "to": {
       "payout_method": "WALLET",
       "payer_id": 39,
       "address_line1": "500 El Camino Real Santa Clara",
       "first_name": "Mahendra",
       "last_name": "Doe",
       "mobile_phone": "263775892100",
       "email": "[email protected]",
       "destination_country": "GH"
   },
   "from": {
       "first_name": "first",
       "last_name": "last",
       "country": "US",
       "date_of_birth": "2000-01-01",
       "gender": "Male",
       "address_line1": "500 8 El Camino Real Santa Clara",
       "city": "california",
       "mobile_phone": "1234567890",
       "email": "[email protected]",
       "state": "CA"
   }
}’

Cash Pickup

 curl --location --request POST '{{url}}/users/{{user_id}}/transactions' \
--header 'X-Client-Id: client_id' \
--header 'X-Client-Secret: client_secret' \
--header 'Content-Type: application/json' \
--data-raw '{
   "from_amount": 21.1,
   "exchange_rate": 1,
   "to_amount": 21.1,
   "fee_amount": 0,
   "note": "Sample Note",
   "to_currency": "GHS",
   "from_currency": "USD",
   "purpose": "EDUCATION",
   "ip_address": "10.10.10.5",
   "txn_type": "PAYOUT",
   "to": {
       "payout_method": "CASH_PICKUP",
       "payer_id": 9,
       "address_line1": "Sekondi-Takoradi",
       "first_name": "Paololito",
       "last_name": "Doe",
       "mobile_phone": "233541859100",
       "email": "[email protected]",
       "destination_country": "GH"
   },
   "from": {
       "first_name": "first",
       "last_name": "last",
       "country": "US",
       "date_of_birth": "2000-01-01",
       "gender": "Male",
       "address_line1": "500 8 El Camino Real Santa Clara",
       "city": "california",
       "mobile_phone": "1234567890",
       "email": "[email protected]",
       "state": "CA"
   }
}'
PreviousPayout Transaction ObjectNextWebhooks

Last updated

Was this helpful?