Skip to main content
POST
/
wallets
/
cashout
Create Wallet Cashout
curl --request POST \
  --url https://api.nuwebgroup.com/v1/wallets/cashout \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "wallets",
      "id": 1,
      "attributes": {
        "id": 1,
        "companyId": 123,
        "userId": 1,
        "currencyId": 1,
        "currencyName": "Pounds",
        "currencyCode": "GBP",
        "currencySymbol": "£",
        "availableBalance": 124
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

​
customerId
integer
required

A customer ID, to retrieve wallet transactions for a specific customer.

​
currencyId
integer
required

The currency ID of the wallet that is to be cashed out.

​
amount
integer

The amount of money to cash out of the wallet. Where this is not provided, the full wallet balance will be used.

​
online
boolean
default:false

Whether an online cashout should be performed.

​
uuid
string

When provided, we will use this parameter to ensure requests are idempotent.

​
source
object

The type of source mechanism for the funds being used for the cashout.

​
include
string

Additional resources that can be returned in the response, which should be provided in comma separated format: latestTransaction, latestRefund.

Response

Successfully cashed out a wallet.

​
data
object