Payouts API

Create payouts to beneficiaries, check payout status, and manage transfers.

Create Payout (Production)

POST/api/v1/production/payout

Requires API Key

Creates a payout to a beneficiary.

Request Body

{
  "orderId": "POUT-12345",
  "amount": 500.00,
  "currency": "USD",
  "merchantProfileId": 1,
  "beneficiaryId": "BEN-123",
  "description": "Monthly payout"
}

Request Parameters

Parameter	Type	Required	Description
orderId	string	Yes	Unique order identifier
amount	number	Yes	Payout amount (minimum 0.01)
currency	string	Yes	Currency code (3 letters)
merchantProfileId	number	No	Merchant Profile ID. Defaults to PRIMARY if not provided
beneficiaryId	string	Yes	Beneficiary ID
description	string	No	Payout description

Success Response

200

{
  "success": true,
  "data": {
    "payoutId": "POUT-12345",
    "orderId": "POUT-12345",
    "status": "PENDING",
    "amount": 500,
    "currency": "USD",
    "beneficiaryId": "BEN-123",
    "createdAt": "2024-01-01T12:00:00Z"
  }
}

Create Payout (Sandbox)

POST/api/v1/sandbox/payout

Requires API Key

Creates a payout in sandbox mode for testing.

Request Body

Same request body as production endpoint.

{
  "orderId": "POUT-12345",
  "amount": 500.00,
  "currency": "USD",
  "merchantProfileId": 1,
  "beneficiaryId": "BEN-123",
  "description": "Monthly payout"
}

Get Payout Status (Production)

GET/api/v1/production/payout/:id/status

Requires API Key

Returns the current status of a payout.

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Payout ID or Order ID

Success Response

200

{
  "success": true,
  "data": {
    "payoutId": "POUT-12345",
    "orderId": "POUT-12345",
    "status": "SUCCESS",
    "amount": 500,
    "currency": "USD",
    "beneficiaryId": "BEN-123",
    "completedAt": "2024-01-01T12:05:00Z"
  }
}

Get Payout Status (Sandbox)

GET/api/v1/sandbox/payout/:id/status

Requires API Key

Returns the current status of a payout in sandbox mode.

Path Parameters

Same as production endpoint.