POST
Créer un compte de retrait

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corps

application/json
settlementPaymentMethodId
string<uuid>
requis

Identifiant du moyen de paiement (rail de cash-out) sur lequel ouvrir le compte de retrait. À récupérer via GET /v1/settlement-accounts/payment-methods (mobile money, virement bancaire… selon le pays/devise).

Exemple:

"3f9a1c2e-6b4d-4a1e-9c8f-2b7d5e0a1f34"

receptionAddress
string
requis

Adresse de réception des fonds : numéro mobile money, IBAN ou numéro de compte selon le moyen de paiement. Validée contre le format attendu par ce moyen de paiement ; les espaces sont automatiquement retirés (« 01 96 12 34 56 » est accepté).

Maximum string length: 255
Exemple:

"22961234567"

label
string

Libellé libre pour identifier ce compte de retrait dans votre tableau de bord.

Maximum string length: 120
Exemple:

"MoMo principal"

isDefault
boolean
défaut:false

Définit ce compte comme destination de retrait par défaut. Le précédent compte par défaut est alors automatiquement déclassé.

Exemple:

true

Réponse

Compte de retrait créé.

id
string
requis

Identifiant unique du compte de retrait.

receptionAddress
string
requis

Adresse de réception (numéro mobile, IBAN, …).

label
object | null
requis

Libellé personnel du compte choisi par le marchand.

isDefault
boolean
requis

Compte par défaut pour les settlements.

settlementPaymentMethodId
string
requis

Identifiant du moyen de paiement associé.

createdAt
string
requis

Date de création — ISO 8601.

maturedAt
string
requis

Date à partir de laquelle ce compte devient éligible au reversement AUTOMATIQUE — ISO 8601. N'affecte jamais un settlement manuel.

isMatured
boolean
requis

Vrai si maturedAt est déjà passé.

revokedAt
object | null
requis

Date de révocation — ISO 8601, ou null si le compte est actif.

settlementPaymentMethod
object

Détails du moyen de paiement associé.

paymentMethod
object

Alias historique de settlementPaymentMethod (mêmes champs sans id).