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

Was this helpful?

  1. API References
  2. Transaction (Payout)

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": "rkin@test.com",
       "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": "em@email.com",
       "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": "rkin@test.com",
       "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": "em@email.com",
       "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": "rkin@test.com",
       "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": "em@email.com",
       "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": "rkin@test.com",
       "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": "em@email.com",
       "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": "rkin@test.com",
       "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": "em@email.com",
       "state": "CA"
   }
}'

Bank Deposit (C2C)

{
   "bonus_amount": 0,
   "created_at": "2022-07-29T10:59:05.359647",
   "custom_purpose": "home",
   "delivery_status": "NONE",
   "exchange_rate": 3700,
   "fee_amount": 0,
   "from": {
       "address_line1": "500 8 El Camino Real Santa Clara",
       "business": false,
       "city": "california",
       "country": "US",
       "date_of_birth": "2000-01-01",
       "email": "em@email.com",
       "first_name": "first",
       "gender": "Male",
       "last_name": "last",
       "mobile_phone": "1234567890",
       "physical_documents": [],
       "state": "CA",
       "virtual_documents": []
   },
   "from_amount": 10,
   "from_currency": "USD",
   "id": "0955e835-e1e5-46eb-881d-dde8dadc2c58",
   "ip_address": "10.10.10.5",
   "note": "Sample Note",
   "physical_documents": [],
   "purpose": "OTHER",
   "status": "NONE",
   "to": {
       "account_number": "2662030100",
       "account_type": "SAVINGS",
       "address_line1": "500 El Camino Real Santa Clara",
       "branch_id": "153",
       “bank_id”:110,
       “bank_name”:”Digital Bank”,
       "business": false,
       "calculation_mode": "SENDER_AMOUNT",
       "city": "california",
       "destination_country": "CO",
       "email": "rkin@test.com",
       "first_name": "Pablolito",
       "last_name": "Doe",
       "mobile_phone": "233541859101",
       "payout_method": "BANK_DEPOSIT",
       "rtn_number": "026009593",
       "state": "CA",
       "virtual_documents": []
   },
   "to_amount": 37000,
   "to_currency": "COP",
   "user_id": "19c1a9ed-e3db-4293-b2c2-48c59fe8e199"
}

Bank Deposit (B2B)

{
   "bonus_amount": 0,
   "created_at": "2022-07-29T10:57:23.392928",
   "custom_purpose": "home",
   "delivery_status": "NONE",
   "exchange_rate": 3700,
   "fee_amount": 0,
   "from": {
       "address_line1": "500 8 El Camino Real Santa Clara",
       "business": true,
       "city": "california",
       "country": "US",
       "date_of_birth": "2000-01-01",
       "email": "em@email.com",
       "first_name": "first",
       "gender": "Male",
       "mailing_address": {
           "address_line1": "500 8 El Camino Real Santa Clara",
           "city": "california",
           "country": "US",
           "zipcode": "90305"
       },
       "mobile_phone": "1234567890",
       "physical_documents": [
           {
               "document_type": "CERTIFICATE_OF_INCORPORATION",
               "id": "2f081250-89eb-4fba-9a82-cc29e0e707b1"
           },
           {
               "document_type": "EIN",
               "id": "95a875fd-d175-44c1-a66f-073397bbeb92"
           }
       ],
       "state": "CA",
       "virtual_documents": [
           {
               "document_type": "EIN_NUMBER",
               "document_value": "123456",
               "id": "b8bfbc92-22dd-477d-9249-2004d6bedf1f"
           }
       ]
   },
   "from_amount": 100,
   "from_currency": "USD",
   "id": "748a6fd9-7269-4fbd-a177-cffa13bb3014",
   "ip_address": "10.10.10.5",
   "note": "Sample Note",
   "physical_documents": [
       {
           "document_type": "INVOICE",
           "id": "68bb6f18-6276-41a4-b9bd-41391cb0c4d5"
       }
   ],
   "purpose": "OTHER",
   "status": "NONE",
   "to": {
       "account_number": "2662030100",
       "account_type": "SAVINGS",
       "address_line1": "500 El Camino Real Santa Clara",
       "branch_id": "153",
       “bank_id”:110,
       “bank_name”:”Digital Bank”,
       "business": true,
       "calculation_mode": "SENDER_AMOUNT",
       "city": "california",
       "destination_country": "CO",
       "email": "rkin@test.com",
       "first_name": "Pablolito",
       "last_name": "Doe",
       "mobile_phone": "233541859101",
       "payout_method": "BANK_DEPOSIT",
       "rtn_number": "026009593",
       "state": "CA",
       "virtual_documents": [
           {
               "document_type": "EIN_NUMBER",
               "document_value": "123456",
               "id": "b8bfbc92-22dd-477d-9249-2004d6bedf1f"
           }
       ]
   },
   "to_amount": 370000,
   "to_currency": "COP",
   "user_id": "fdb20851-e27e-4653-9346-81f04a8cafd4"
}

Bank Deposit (B2C)

{
   "bonus_amount": 0,
   "created_at": "2022-07-29T10:58:29.932733",
   "custom_purpose": "home",
   "delivery_status": "NONE",
   "exchange_rate": 3700,
   "fee_amount": 0,
   "from": {
       "address_line1": "500 8 El Camino Real Santa Clara",
       "business": true,
       "city": "california",
       "country": "US",
       "date_of_birth": "2000-01-01",
       "email": "em@email.com",
       "first_name": "Machnet",
       "gender": "Male",
       "mailing_address": {
           "address_line1": "500 8 El Camino Real Santa Clara",
           "city": "california",
           "country": "US",
           "zipcode": "90305"
       },
       "mobile_phone": "237676641000",
       "physical_documents": [
           {
               "document_type": "CERTIFICATE_OF_INCORPORATION",
               "id": "2c0302fe-ee45-4e30-94f5-927ac2d70119"
           },
           {
               "document_type": "EIN",
               "id": "e286639d-ad27-44bb-882d-d20648cadf2d"
           }
       ],
       "state": "CA",
       "virtual_documents": [
           {
               "document_type": "EIN_NUMBER",
               "document_value": "123456",
               "id": "b8bfbc92-22dd-477d-9249-2004d6bedf1f"

           }
       ]
   },
   "from_amount": 100,
   "from_currency": "USD",
   "id": "d674d919-ac80-4564-811d-4ae0c95c5d34",
   "ip_address": "10.10.10.5",
   "note": "Sample Note",
   "physical_documents": [
       {
           "document_type": "INVOICE",
           "id": "2892d026-abaf-4cda-bbfe-8cf93b808250"
       }
   ],
   "purpose": "OTHER",
   "status": "NONE",
   "to": {
       "account_number": "2662030100",
       "account_type": "SAVINGS",
       "address_line1": "500 El Camino Real Santa Clara",
       "branch_id": "153",
       “bank_id”:110,
       “bank_name”:”Digital Bank”,
       "business": false,
       "calculation_mode": "SENDER_AMOUNT",
       "city": "california",
       "destination_country": "CO",
       "email": "rkin@test.com",
       "first_name": "Paolo",
       "last_name": "Sharma",
       "mobile_phone": "233541859101",
       "payout_method": "BANK_DEPOSIT",
       "rtn_number": "026009593",
       "state": "CA",
       "virtual_documents": []
   },
   "to_amount": 370000,
   "to_currency": "COP",
   "user_id": "19c1a9ed-e3db-4293-b2c2-48c59fe8e199"
}

Wallet

{
   "bonus_amount": 0,
   "created_at": "2022-07-29T10:56:16.326256",
   "delivery_status": "NONE",
   "exchange_rate": 1,
   "fee_amount": 0,
   "from": {
       "address_line1": "500 8 El Camino Real Santa Clara",
       "business": false,
       "city": "california",
       "country": "US",
       "date_of_birth": "2000-01-01",
       "email": "em@email.com",
       "first_name": "first",
       "gender": "Male",
       "last_name": "last",
       "mobile_phone": "1234567890",
       "physical_documents": [],
       "state": "CA",
       "virtual_documents": []
   },
   "from_amount": 2.01,
   "from_currency": "USD",
   "id": "3379 cfcb-fb73-43c1-8670-60a448914787",
   "ip_address": "10.10.10.5",
   "note": "Sample Note",
   "physical_documents": [],
   "purpose": "FAMILY_SUPPORT",
   "status": "NONE",
   "to": {
       "address_line1": "500 El Camino Real Santa Clara",
       "business": false,
       "calculation_mode": "SENDER_AMOUNT",
       "destination_country": "GH",
       "email": "rkin@test.com",
       "first_name": "Mahendra",
       "last_name": "Doe",
       "mobile_phone": "263775892100",
       "payer_id": 39,
       "payout_method": "WALLET",
       "virtual_documents": []
   },
   "to_amount": 2.01,
   "to_currency": "GHS",
   "user_id": "19c1a9ed-e3db-4293-b2c2-48c59fe8e199"
}

Cash Pickup

{
   "bonus_amount": 0,
   "created_at": "2022-07-29T10:55:08.422724",
   "delivery_status": "NONE",
   "exchange_rate": 1,
   "fee_amount": 0,
   "from": {
       "address_line1": "500 8 El Camino Real Santa Clara",
       "business": false,
       "city": "california",
       "country": "US",
       "date_of_birth": "2000-01-01",
       "email": "em@email.com",
       "first_name": "first",
       "gender": "Male",
       "last_name": "last",
       "mobile_phone": "1234567890",
       "physical_documents": [],
       "state": "CA",
       "virtual_documents": []
   },
   "from_amount": 21.1,
   "from_currency": "USD",
   "id": "91516ee8-c6e1-4549-aad6-04f9d3930bff",
   "ip_address": "10.10.10.5",
   "note": "Sample Note",
   "physical_documents": [],
   "purpose": "EDUCATION",
   "status": "NONE",
   "to": {
       "address_line1": "Sekondi-Takoradi",
       "business": false,
       "calculation_mode": "SENDER_AMOUNT",
       "destination_country": "GH",
       "email": "rkin@test.com",
       "first_name": "Paololito",
       "last_name": "Doe",
       "mobile_phone": "233541859100",
       "payer_id": 9,
       "payout_method": "CASH_PICKUP",
       "virtual_documents": []
   },
   "to_amount": 21.1,
   "to_currency": "GHS",
   "user_id": "19c1a9ed-e3db-4293-b2c2-48c59fe8e199"
}
PreviousPayout Transaction ObjectNextWebhooks

Last updated 2 years ago

Was this helpful?