Payout Events

Payout Created

payout.created is sent when a payout transaction is successfully created.

Payout Created Structure

Field	Type	Description
type	”payout.created”	Event name
timestamp	string	Timestamp of when the payout was created
object	Payout Transaction Object	The created payout transaction details

Example

{
  "id": "ev_00000000-0000-0000-0000-000000000000",
  "entityId": "00000000-0000-0000-0000-000000000000",
  "mode": "test",
  "type": "event",
  "version": "2025-01-01",
  "data": {
    "type": "payout.created",
    "object": {
      "id": "00000000-0000-0000-0000-000000000000",
      "transactionId": "test_0000000000000000",
      "clientReferenceId": "<…>",
      "beneficiary": { … },
      "amount": 123456789,
      "method": "bank-transfer",
      "sender": {
        "name": "Acme User"
      },
      "status": "pending",
      "country": "ID",
      "currency": "IDR",
      "provider": "oy",
      "connectionId": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2025-01-01T00:00:00.000000000Z",
      "updatedAt": "2025-01-01T00:00:00.000000000Z",
      "description": "Acme Example Transfer"
    },
    "timestamp": "2025-01-01T00:00:00.000000000Z"
  }
}

Payout Updated

payout.updated is sent when a payout transaction receives a status update.

Payout Updated Structure

Field	Type	Description
type	”payout.updated”	Event name
timestamp	string	Timestamp of when the payout was updated
object	Payout Transaction Object	The updated payout transaction details
previousAttributes	Partial Payout Transaction	The previous values for the payout transaction

Example

{
  "id": "ev_00000000-0000-0000-0000-000000000000",
  "entityId": "00000000-0000-0000-0000-000000000000",
  "mode": "test",
  "type": "event",
  "version": "2025-01-01",
  "data": {
    "type": "payout.updated",
    "object": {
      "id": "00000000-0000-0000-0000-000000000000",
      "transactionId": "test_000000000000000000",
      "clientReferenceId": "<…>",
      "beneficiary": { … },
      "amount": 1250000,
      "method": "bank-transfer",
      "sender": {
        "name": "Acme User"
      },
      "status": "completed",
      "country": "ID",
      "currency": "IDR",
      "provider": "oy",
      "connectionId": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2025-01-01T00:00:00.000000000Z",
      "updatedAt": "2025-01-02T00:00:00.000000000Z",
      "description": "test transfer"
    },
    "timestamp": "2025-01-02T00:00:00.000000000Z",
    "previous_attributes": {
      "status": "pending",
      "updatedAt": "2025-01-01T00:00:00.000000000Z"
    }
  }
}

Common types

Payout Transaction Object

Field	Type	Description
id	string	The Autopilot ID for the payout transaction
clientReferenceId	string	The reference ID provided by the client when creating the transaction
transactionId	string	The secondary transaction ID, as defined by the payout provider (e.g., Stripe, XpressFlow)
amount	int64	The amount of funds moved in the transaction, provided in the minor unit
beneficiary	object	The beneficiary details
country	string	The recipient’s country for the payout transaction
currency	string	The currency code in ISO 4217 format
description	string	The description of the payout transaction, as defined at the time of creation
method	string	The financial instrument used for the payout (bank-transfer, e-wallet, crypto, etc.)
provider	string	The payout provider that processed the transaction (stripe, xpressflow, oy, etc.)
connectionId	string	The entity connection ID which processed the transaction
sender	Sender	The sender details for the transaction
status	string	The status of the payout transaction
createdAt	timestamp	The timestamp when the payout transaction was created
updatedAt	timestamp	The timestamp when the payout transaction was last updated

Payout Transaction Partial

Field	Type	Description
status	string	The status of the payout transaction
updatedAt	timestamp	The timestamp when the payout transaction was last updated

Sender Object

Field	Type	Description
name	string	The sender’s name
email?	string	The sender’s email address
phoneNumber?	string	The sender’s phone number