$orqex->payouts(). Every method returns a typed Payout.
Create
Pass at minimum acustomer, a description, and an instrument describing the
destination. The optional reference field is a merchant-supplied idempotency key for
the payout.
PayoutMethodCode for type-safe method codes:
Retrieve
Payout resource fields
| Field | Type | Description |
|---|---|---|
id | string | Payout id (po_...) |
amount | Amount | value (major units, decimal) + currency |
status | string | pending, processing, completed, failed |
method | string|null | Payout method code (see PayoutMethodCode) |
reference | string|null | Merchant-supplied idempotency reference |
description | string|null | Human-readable description |
customer | Customer|null | Attributed customer |
instrument | PayoutInstrument|null | Destination instrument |
gateway | array | Gateway transaction details (id, reference, external_id) |
fee_amount | float|null | Payout fee in major units (decimal) |
failure | Failure|null | Structured failure details when status is failed |
metadata | array | Arbitrary key-value pairs |
initiated_at | string|null | ISO 8601 timestamp |
completed_at | string|null | ISO 8601 timestamp |
failed_at | string|null | ISO 8601 timestamp |
created_at | string|null | ISO 8601 timestamp |
Instrument types
APayoutInstrument describes the payout destination. The type field determines which
additional fields are present:
type | Fields |
|---|---|
phone | phone_number, country |
bank_account | account_name, account_number, bank_code, swift_bic, country |
crypto_address | address, network, memo_tag |
Methods
| Method | Returns |
|---|---|
create(array $params, $opts = null) | Payout |
retrieve(string $payoutId, $opts = null) | Payout |
There is no
all() method on PayoutService. To list payouts, use the
Payouts API directly or query your own records.