Rocketfuel Blockchain
  • Welcome to Rocketfuel
  • Core Concepts
    • Overview
    • Partners
    • Merchants
    • Shoppers
    • Exchanges
    • QR Payments
    • Bank Payments
    • Invoices
    • Settlements
  • Plug-ins and SDKs
    • Bigcommerce
    • Magento
    • PrestaShop
    • WooCommerce
    • Webflow
    • Web SDK
  • Developer Guides
    • Overview
    • Quick Start
    • API Reference
      • PayIns
        • Overview
        • Encryption Algorithm
          • Public Key Based
          • Secret Key Based
        • Authentication
          • Authenticate a merchant
          • Authentication Without Email / Password
        • RocketFuel UI Integration
          • Generate Invoice Link
          • Payment Processing
            • RKFL Payment Page
            • RKFL Payment Widget
          • Transaction Lookup
            • Lookup using Auth
            • Lookup using Public Key
          • Webhooks
          • Handling Partial Payments
        • Custom UI Integration
          • Cryptocurrencies listing
          • Generate QR Code
          • QR Payment Status
          • Transactions Lookup
          • Webhooks
          • Handle Partial Payment
        • Utility APIs
          • Subscriptions/Recurring Payments
          • Store info
          • Shopper
            • Shopper manual signup
            • Verify shopper's email id
            • Shopper manual login
            • Shopper info
            • Shopper wallet balance
          • Exchange Payment
            • Exchanges listing
            • Pre-payment validation check
            • Payable amount
            • Trigger Exchange payment
          • Transaction listing
          • Order info
      • Payout
        • Overview
        • Add Payee
        • API Guide
        • Webhooks
    • Swagger API
  • Integrations
    • RocketFuel Integration
      • Objective
      • Target Audience
      • Product Feature overview
      • "How To" Guide
        • Sign up as a Merchant
        • KYC Verification
        • Using the RocketFuel API for Custom Integration
        • Using the RocketFuel Pre-built Solutions for Custom Integration
        • How to Use Testnet for Transactions
      • FAQ and Tips
  • Web UI
  • User Guide and Help Videos
    • White Label Requirements
    • ACI Merchant Onboarding Document (Certification)
    • Merchant User Guide
      • Sign-up Process
      • Sign-in Process
      • Merchant Dashboard
      • Transactions
      • Shoppers
      • Reports
      • Invoices
      • Users
      • Funds
      • Bank/ACH Payments
      • Instore
      • Settlements
      • Subscriptions
      • Release Notes
      • Verification
      • Help/FAQ
      • Plugins
        • How to Setup RocketFuel on Different plugins
        • How to Use Rocketfuel With Different SDKs
      • Settings
    • Shopper User Guide
      • Dashboard
      • Purchases
      • Profile
      • Exchange
      • Bank/ACH Payments
      • Help/FAQ
      • Settings
      • Subscriptions
    • Partner User Guide
      • Dashboard
        • How to Invite Merchants
        • How to Generate Auth Header for Merchants
      • Transactions
      • Refunds
      • Shoppers
      • Merchants
      • Reports
      • Subscriptions
      • Payment Settings
      • Settings
      • Release Notes
    • Super Partner Guide
      • Overview
      • How to Invite Partners
  • Release Notes
    • Change Log
Powered by GitBook
On this page

Was this helpful?

  1. Developer Guides
  2. API Reference
  3. Payout

Add Payee

This API allows merchants to add payees to the system. Merchants can provide necessary information such as payee's name, email, account details, or any other relevant information required for payouts.

Sample Payload Data to be Encrypted


[{
    id: "11-22-33",
    fname: "Rohan",
    lname: "Singh",
    email: "[email protected]",
    label: "TestingL",
    businessname: "Testing2",
    },
    {
    id: "11-22-34",
    fname: "Rohan",
    lname: "Singh",
    email: "[email protected]",
    label: "TestingL",
    businessname: "Testing2",
    }]

This API will take encrypted data as request payload.

POST /payout/payee

Headers

Name
Type
Description

Authorization*

String

Bearer {{token}}

Request Body

Name
Type
Description

encryptedReq*

String

Encrypted array of payee object

When all data is correct

{
  "ok": true,
  "result": {
    "success": true,
    "payees": [
      {
        "First Name": "Rohan",
        "Last Name": "Singh",
        "Email": "[email protected]",
        "Label": "TestingL",
        "Error(s)": ""
      },
      {
        "First Name": "Rohan",
        "Last Name": "Singh",
        "Email": "[email protected]",
        "Label": "TestingL",
        "Error(s)": ""
      }
    ],
    "insertedCount": 2,
    "errorMsg": ""
  }
}

When Encrypted Data is not in Correct Formate

{
  "ok": true,
  "result": {
    "success": false,
    "errorMsg": "Invalid Encrypted Data"
  }
}

When Decrypted Data is not in Correct Format (Array)

{
  "ok": true,
  "result": {
    "success": false,
    "errorMsg": "Invalid Formate of Decrypted Data"
  }
}

When Decrypted Data is missing a required key

{
  "ok": true,
  "result": {
    "success": false,
    "errorMsg": "Invalid Data: Row - 1, Key - email"
  }
}

{
  "ok": false,
  "statusCode": 500,
  "message": "Internal Server Error"
}
{
  "ok": false,
  "statusCode": 401,
  "data": {},
  "message": "Token expired"
}
PreviousOverviewNextAPI Guide

Last updated 6 months ago

Was this helpful?