Lire un bénéficiaire
GET/v1/recipients/{id}
Un bénéficiaire, et quand il devient utilisable.
La demande
bash
curl https://api.payiz.app/v1/recipients/ben_01j9xd7mk4s2pvb8ya3c \ -H "Authorization: Bearer sk_test_…"
La réponse
json
{
"object": "recipient",
"id": "ben_01j9xd7mk4s2pvb8ya3c",
"name": "Adjoa Mensah",
"phone": "+229 01 •• •• 34 00",
"operator": "mtn",
"country": "BEN",
"default": true,
"usable_at": 1789912892,
"created": 1789826492,
"livemode": false
}Ce qu’on reçoit
200 · un objet recipient
object« recipient »Le genre de l’objet rendu : il ne change jamais.
idtexteUn identifiant préfixé « ben_ », par exemple ben_01j9x3kq7m4tzv8qhw2n.
nametexteLe nom du bénéficiaire, tel qu’il a été enregistré.
phonetexteMasqué : un numéro ne sort jamais en clair.
operatortexteLe code de l’opérateur dans son pays, par exemple « mtn ».
countrytexteLe code ISO 3166-1 alpha-3.
defaultvrai ou fauxLe bénéficiaire proposé d’office pour un retrait.
usable_atentier ou nullUn bénéficiaire neuf attend sa carence avant le premier retrait.
createdentier ou nullDes secondes depuis 1970, ou null.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.
object« recipient »Le genre de l’objet rendu : il ne change jamais.
idtexteUn identifiant préfixé « ben_ », par exemple ben_01j9x3kq7m4tzv8qhw2n.
nametexteLe nom du bénéficiaire, tel qu’il a été enregistré.
phonetexteMasqué : un numéro ne sort jamais en clair.
operatortexteLe code de l’opérateur dans son pays, par exemple « mtn ».
countrytexteLe code ISO 3166-1 alpha-3.
defaultvrai ou fauxLe bénéficiaire proposé d’office pour un retrait.
usable_atentier ou nullUn bénéficiaire neuf attend sa carence avant le premier retrait.
createdentier ou nullDes secondes depuis 1970, ou null.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.
© 2026 PayizUne question ? L’aide est dans le rond, en bas à droite.