Pay-Out

A Pay-Out allows your platform to send funds to a user - for example, processing a Pay-Out or returning funds to a bank account.

Not all payment providers support Pay-Out. See the PSP overview for the full list.

How it works

Unlike Pay-In, there is no redirect URL. You initiate the transfer and wait for the webhook.

Endpoint

POST /v1/api/mozarto/cashier

Include the required authentication headers:

Authorization: Bearer <company-jwt>
x-user-token: Bearer <user-jwt>
Content-Type: application/json

Common request fields

Fields marked with * are required.

Field	Type	Description
`pspType` *	string	Payment provider code (e.g. `"FORUMPAY"`, `"GIGADAT"`) - see PSP pages
`type` *	string	Always `"PAYOUT"` for Pay-Out
`baseamount` *	number	Pay-Out amount as a number (e.g. `100.00`)
`currency` *	string	Currency code (e.g. `"EUR"`)
`userId` *	string	Your internal user/player identifier
`email` *	string	User's email address
`country`	string	User's country code - required for some providers
`brandId`	string	Brand identifier for multi-brand setups

Some providers require additional fields (wallet address for crypto, bank details for ACH). See each PSP page.

Response

{
  "status": "success",
  "message": "Successfully",
  "isSuccess": true,
  "data": {
    "status": "PENDING",
    "transactionId": "64a1f2b3c4d5e6f7a8b9c0d1"
  }
}

The response confirms the Pay-Out was submitted. Final confirmation (success or failure) arrives via webhook.

Implementation

Unlike Pay-In, there is no redirect URL. Show a "processing" state after submission and wait for the webhook to deliver the final outcome.

Pay-Out APIs

For the full request and response reference for each Pay-Out provider, see the Pay-Out APIs in the left sidebar. Example: ForumPay Pay-Out.

Webhook result

Mozarto calls your webhookUrl when the payout reaches a final state:

{
  "transaction_id": "64a1f2b3c4d5e6f7a8b9c0d1",
  "psp_transaction_id": "HS923856HU",
  "user_id": "user_123",
  "status": "confirmed",
  "transaction_status": "Approved",
  "message": "Payout processed successfully",
  "amount": "100.00",
  "currency": "EUR",
  "merchantReference": ""
}

`transaction_status`	Meaning	Action
`Approved`	Funds transferred successfully	Confirm to the user
`Declined`	Transfer declined by PSP	Notify the user
`Failed`	Transfer failed due to a technical error	Notify the user
`Rejected`	Payout rejected during a manual approval step	Do not debit the user; notify and stop processing

Approval flow

Some providers or account configurations require manual approval before a payout is processed. In those cases:

The payout is created with status: PENDING

An operator approves or rejects it in the Mozarto back office

On approval, the transfer is submitted and the normal webhook flow continues

On rejection, your webhookUrl receives status: REJECTED

Pay-Out Flow

Pay-Out#

How it works#

Endpoint#

Common request fields#

Response#

Implementation#

Pay-Out APIs#

Webhook result#

Approval flow#