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: "[e-mail]",
    label: "TestingL",
    businessname: "Testing2",
    },
    {
    id: "11-22-34",
    fname: "Rohan",
    lname: "Singh",
    email: "[e-mail]",
    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

200: OK

When all data is correct

{
  "ok": true,
  "result": {
    "success": true,
    "payees": [
      {
        "First Name": "Rohan",
        "Last Name": "Singh",
        "Email": "[e-mail]",
        "Label": "TestingL",
        "Error(s)": ""
      },
      {
        "First Name": "Rohan",
        "Last Name": "Singh",
        "Email": "[e-mail]",
        "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"
  }
}

500: Internal Server Error

{
  "ok": false,
  "statusCode": 500,
  "message": "Internal Server Error"
}

401: Unauthorized

{
  "ok": false,
  "statusCode": 401,
  "data": {},
  "message": "Token expired"
}