$orqex->payouts(). Chaque méthode renvoie un Payout typé.
Créer
Fournissez au minimum uncustomer, une description et un instrument décrivant la
destination. Le champ optionnel reference est une clé d’idempotence fournie par le
marchand.
PayoutMethodCode pour des codes de méthode typés :
Récupérer
Champs de la ressource Payout
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant du virement (po_...) |
amount | Amount | value (unités majeures, décimal) + currency |
status | string | pending, processing, completed, failed |
method | string|null | Code de méthode de virement (voir PayoutMethodCode) |
reference | string|null | Référence d’idempotence fournie par le marchand |
description | string|null | Description lisible |
customer | Customer|null | Client associé |
instrument | PayoutInstrument|null | Instrument de destination |
gateway | array | Détails de la transaction passerelle (id, reference, external_id) |
fee_amount | float|null | Frais de virement en unités majeures (décimal) |
failure | Failure|null | Détails structurés de l’échec quand status est failed |
metadata | array | Paires clé-valeur arbitraires |
initiated_at | string|null | Horodatage ISO 8601 |
completed_at | string|null | Horodatage ISO 8601 |
failed_at | string|null | Horodatage ISO 8601 |
created_at | string|null | Horodatage ISO 8601 |
Types d’instrument
UnPayoutInstrument décrit la destination du virement. Le champ type détermine les
champs supplémentaires présents :
type | Champs |
|---|---|
phone | phone_number, country |
bank_account | account_name, account_number, bank_code, swift_bic, country |
crypto_address | address, network, memo_tag |
Méthodes
| Méthode | Renvoie |
|---|---|
create(array $params, $opts = null) | Payout |
retrieve(string $payoutId, $opts = null) | Payout |
Il n’y a pas de méthode
all() sur PayoutService. Pour lister les virements, utilisez
l’API Payouts directement ou interrogez vos propres enregistrements.