Files
CrimsonandGitHub 61cae8af0a chore: Move all CE plugins to own go modules (#780)
* Move all public connectors to ce/plugins

* Update tooling to account for new go modules under ce

* Ensure we test all CE plugins in CI

* Move Dummypay to ce/plugins for simplicity's sake in the generation scripts

* Use versioned pkg/domain in plugins

* Ensure that renovate updates all CE plugins in a single PR when pkg/domain tags are pushed to github

* Ensure Justfile commands work over all CE plugins

* Copy ce plugin go.mods in dev.Dockerfile

* Only add a go.mod for new plugins if they are ce

* Ensure generated generic client structs are named correctly for submodule

* Add coverprofile for each ce plugin

* Add set -e for Justfile for loops over plugins

* Infer go version from flake.nix in connector template tool
2026-07-01 14:53:02 +00:00

1.6 KiB

Payout

Response model for a payout (payment to external beneficiary).

Properties

Name Type Description Required
Id string PSP-generated unique payout identifier Yes
IdempotencyKey string Client-provided unique identifier for the payout request Yes
Amount string Payout amount in minor units (integer string) Yes
Currency string Asset in UMN format (e.g., "USD/2", "BTC/8") Yes
SourceAccountId string Source account identifier Yes
DestinationAccountId string Destination account identifier Yes
Status TransactionStatus Current payout status Yes
CreatedAt time.Time Payout creation timestamp Yes
UpdatedAt Pointer to time.Time Last update timestamp
Description Pointer to string Payout description
Metadata Pointer to map[string]string Additional metadata

Example Response

{
  "id": "payout_abc123",
  "idempotencyKey": "payout-123-abc",
  "amount": "10000",
  "currency": "USD/2",
  "sourceAccountId": "acc_internal_001",
  "destinationAccountId": "ben_external_002",
  "status": "SUCCEEDED",
  "createdAt": "2026-01-14T15:00:00Z",
  "updatedAt": "2026-01-14T15:01:00Z",
  "description": "Vendor payment",
  "metadata": {
    "invoiceId": "INV-2026-001"
  }
}

[Back to Model list] [Back to API list] [Back to README]