mirror of
https://github.com/hanzo-fi/payments.git
synced 2026-10-30 20:31:20 +00:00
* 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
1.3 KiB
1.3 KiB
PayoutRequest
Request body for creating a payout (payment to external beneficiary).
Properties
| Name | Type | Description | Required |
|---|---|---|---|
| IdempotencyKey | string | Unique identifier for the payout request. Used for idempotency - if a payout with this key already exists, the existing payout is returned. | ✅ |
| Amount | string | Payout amount in minor units (integer string, e.g., "10000" for $100.00) | ✅ |
| Currency | string | Asset in UMN format (e.g., "USD/2", "BTC/8", "EUR/2") | ✅ |
| SourceAccountId | string | Source account identifier (internal account) | ✅ |
| DestinationAccountId | string | Destination account identifier (beneficiary/external account) | ✅ |
| Description | Pointer to string | Payout description/memo | |
| Metadata | Pointer to map[string]string | Additional key-value metadata |
Example
{
"idempotencyKey": "payout-123-abc",
"amount": "10000",
"currency": "USD/2",
"sourceAccountId": "acc_internal_001",
"destinationAccountId": "ben_external_002",
"description": "Vendor payment",
"metadata": {
"invoiceId": "INV-2026-001"
}
}