Skip to main content
POST
/
wallets
/
payouts
/
initiate
Initiate a payout
curl --request POST \
  --url https://api.nuwebgroup.com/v1/wallets/payouts/initiate \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "walletTransactions",
      "id": 1,
      "attributes": {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "customerId": 1,
        "walletId": 123,
        "type": 1,
        "typeSlug": "cashout-external",
        "typeName": "External cashout",
        "amount": 725,
        "oldBalance": 128,
        "newBalance": 853,
        "createdAt": "2021-11-26T11:59:00.000000Z",
        "updatedAt": "2021-11-26T11:59:00.000000Z",
        "confirmedAt": "2021-11-26T11:59:00.000000Z"
      },
      "relationships": {
        "wallets": {
          "type": "wallets",
          "id": 4
        }
      }
    }
  ],
  "included": [
    {
      "type": "wallets",
      "id": 1,
      "attributes": {
        "id": 1,
        "company_id": 1,
        "user_id": 9,
        "currency_id": 32,
        "currency_code": "GBP",
        "currency_name": "Pounds",
        "currency_symbol": "£",
        "available_balance": 853,
        "refundable_balance_online": 500,
        "refundable_balance_offline": 853,
        "createdAt": "2021-01-01T12:00:00.000000Z",
        "updatedAt": "2021-01-01T12:00:00.000000Z"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.nuwebgroup.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Headers

​
X-NU-COMPANY-ID
integer

The ID of the company this operation should be performed against.

​
Accept-Language
string

Sets the preferred language for localised response content (e.g. en, fr, de). If the requested language is not supported by the company, the company fallback language will be assumed.

Query Parameters

​
walletId
integer

A wallet ID from which to initiate a payout.

​
customerId
integer

A customer ID from which to initiate a payout. Must be provided alongside currency parameter. Will be ignored if walletId is specifided.

​
currencyId
string

The currency ID for the payout. Must be provided alongside customerId parameter. Will be ignored if walletId is specifided.

​
amount
integer
required

The total payout amount, in the currency's smallest denomination.

​
uuid
string

A unique UUID for this payout, to ensure idempotency between requests.

Response

Successfully initiated a wallet payout

​
data
object
​
included
object[]