Payouts

Cryptocurrency Payouts

The Payout Object

Name	Type	Description
id	Number	Unique identifier for the object.
label	String	Payout label
amount	Number	Amount
address	String	Blockchain address
tag	String	Tag, memo or note
fee	String	Fee: low, medium, high
feeAmount	Number	Fee amount
isFeeIncluded	Boolean	Is fee included into payout
walletId	Number	Unique identifier for the object
walletCurrency	String	Alphabetic currency code
trackingId	String	Client-provided identifier of the payment in the external system
status	String	The status of the payout
note	String	Payout Description
createdAt	Date	Time at which the object was created

Create a Payout

POST /api/v1/payouts/create

Creates new Payout request

Headers

Name	Type	Description
Accept*	applicaiton/json

Request Body

Name	Type	Description
currency*	String	Payout currency
trackingId*	String	Client provided identifier of the payment in the external system
walletId*	String	Payout wallet id
label	String	Payout label
address*	String	Receiver blockchain address
tag	String	Address tag, memo or note
fee*	String	Low, medium or high
isFeeIncluded*	Boolean	Is fee included into payout amount
webhookUrl	String	Notifications url

200: OK Example of successful response

{
    "data": {
        "id": 8838,
        "label": "Withdrawal ACM-1",
        "amount": "1500",
        "address": "THXHyVZQpKMLiEuUYBH3nCnrtkAEYaaZMt",
        "tag": null,
        "fee": "low",
        "feeAmount": null,
        "isFeeIncluded": true,
        "walletId": "2143",
        "walletCurrency": "USDT_TRX",
        "trackingId": "A-5211",
        "status": "Created",
        "note": "Withdrawal for 1.5k for the ACM",
        "createdAt": "2023-01-07T14:52:19.000000Z"
    }
}

400: Bad Request Example of the response with errors

{
    "error": {
        "message": "Insufficient funds"
    }
}

Lists all payouts

GET /api/v1/payouts

Returns a list of previously created Payouts. The Payouts are returned in sorted order, with the most recent payout appearing first. You can optionally provide parameters to filter out the results by time created.

Query Parameters

Name	Type	Description
from	Date	Filter by created time. We use basic ISO 8601 format for mixed date-time: YYYY-MM-DDThh:mm:ss
to	Date	Filter by created time. We use basic ISO 8601 format for mixed date-time: YYYY-MM-DDThh:mm:ss
page	Number	Current page

200: OK Example of successful response

{
    "data": [
        {
            "id": 7995,
            "label": "Withdrawal 293844",
            "amount": "200000.000000000000000000",
            "address": "TQ496F9j4uobnsPqhExhyWmvCxuChXE8Qb",
            "tag": null,
            "fee": "low",
            "feeAmount": null,
            "isFeeIncluded": 1,
            "walletId": 221,
            "walletCurrency": "USDT_TRX",
            "walletCurrency": "AC_1000",
            "status": "Completed",
            "note": "initial withdrawal for 20 to check",
            "createdAt": "2023-01-04T13:58:07.000000Z"
        }
        ...
        {
            "id": 7994,
            "label": "Withdrawal 1342231XC",
            "amount": "25000.000000000000000000",
            "address": "TQ496F9j4uobnsPqhExhyWmvCxuChXE8Qb",
            "tag": null,
            "fee": "low",
            "feeAmount": "0.100000000000000000",
            "isFeeIncluded": 1,
            "walletId": 221,
            "walletCurrency": "USDT_TRX",
            "trackingId": "AC_2462",
            "status": "Completed",
            "note": "initial withdrawal for 20 to check",
            "createdAt": "2023-01-03T12:23:16.000000Z"
        }
    ],
    "links": {
        "first": "https://api.business.unixpay.com/api/v2/payouts?page=1",
        "last": "https://api.business.unixpay.com/api/v2/payouts?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://api.business.unixpay.com/api/v2/payouts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://api.business.unixpay.com/api/v2/payouts",
        "per_page": 20,
        "to": 4,
        "total": 4
    }
}

422: Unprocessable Entity Example of the response with errors

{
    "message": "The given data was invalid.",
    "errors": {
        "to": [
            "The to is not a valid date."
        ]
    }
}

Get Payout by id

GET /api/v1/payout/{id}

Retrieves the details of a Payout that has previously been created. Supply the id and the API will return the corresponding Payout information.

Path Parameters

Name	Type	Description
id*	Number	Unique identifier for the object

200: OK Example of successful response

{
    "data": {
            "id": 7995,
            "label": "Withdrawal 293844",
            "amount": "200000.000000000000000000",
            "address": "TQ496F9j4uobnsPqhExhyWmvCxuChXE8Qb",
            "tag": null,
            "fee": "low",
            "feeAmount": null,
            "isFeeIncluded": 1,
            "walletId": 221,
            "walletCurrency": "USDT_TRX",
            "trackingId": "AC_1000",
            "status": "Completed",
            "note": "initial withdrawal for 20 to check",
            "createdAt": "2023-01-04T13:58:07.000000Z"
    }
}

422: Unprocessable Entity Example of the response with errors

{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id must be a number."
        ]
    }
}