Skip to main content

Payout request for buyer/account

Endpoint
Endpoint Method
Authentication
/transaction/payout
POST Yes
Authentication
Type
Token source
Server
Bearer <USAPI>/auth

USAPI

User State API

Body request
{
  "amount": <integer>,
  "store" : <boolean>
}
Properties
Properties of Data type Required notes
amount
integer yes minimum amount is 10000
store
boolean yes
Request example

Body request example

{
  "properties": "value"
}

Axios code example

insert code here
Result example

Body request example

insert code here
Error example

400 Bad Request

User balance is less than requested amount

{
    "message": "Insufficient Fund"
}

Requested amount is less than minimum amount

{
    "message": "must be >= 10000"
}

Parameter(s) required

{
    "message": "Must have required property <parameter>"
}

500 Internal Server Error

{
    "message": "Internal Error"
}