Payouts

You can add maximum of 3 accounts to receive payments

ADD PAYOUT ACCOUNT

POST https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts/

Headers

Name	Type	Description
SECRET_KEY*	String
businessId*	String
Authorization*	String	Bearer {{accessToken}}

Request Body

Name	Type	Description
accountName*	String
accountNumber*	String
bankName*	String
bankCode*	String

200: OK

{
    "status": true,
    "message": "Payout account has been succeessfully added"
}

GET PAYOUT ACCOUNTS

GET https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts

Headers

Name	Type	Description
SECRET_KEY*	String
businessId*	String
Authorization*	String	Bearer {{accessToken}}

200: OK

{
    "status": true,
    "message": "Successful",
    "data": [
        {
            "id": "5ee3ca06-3825-49c2-9b8b-97cdf172ac4a",
            "accountName": "Adetunji Bodunde",
            "accountNumber": "0117170332",
            "bankCode": "058",
            "bankName": "GTB",
            "clientId": "367f5e2a-bbc7-4865-9bd3-ed653094b6f3",
            "createdAt": "2022-02-03T12:59:58.191Z"
        }
    ]
}

EDIT PAYOUT ACCOUNT

PUT https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts/{{payoutAccountId}}

Headers

Name	Type	Description
SECRET_KEY*	String
businessId*	String
Authorization*	String	Bearer {{accessToken}}

Request Body

Name	Type	Description
accountName	String
accountNumber	String
bankName	String
bankCode	String

DELETE PAYOUT ACCOUNT

DELETE https://stella-thirdparty-api.herokuapp.com/api/v1/clients/business/payouts/{{payoutAccountId}}

Headers

Name	Type	Description
SECRET_KEY*	String
businessId*	String
Authorization*	String	Bearer {{accessToken}}

200: OK

{
    "status": true,
    "message": "Account has been deleted"
}