Documentation/Lister les bénéficiaires
openapi.jsonOuvrir mon espace

Lister les bénéficiaires

GET/v1/recipients

Vers qui vous pouvez retirer.

Un bénéficiaire s’ajoute à l’écran, confirmé par le code de votre application : une clé volée ne doit pas ouvrir de porte de sortie. Cette liste n’est pas paginée.

Ce qu’on met dans l’adresse

limitentierDe 1 à 100. Par défaut 20.
starting_aftertexteL’identifiant de la dernière ligne lue : la page suivante commence après.

La demande

bash
curl https://api.payiz.app/v1/recipients \
  -H "Authorization: Bearer sk_test_…"

La réponse

json
{
  "object": "list",
  "url": "/v1/recipients",
  "has_more": false,
  "data": [
    {
      "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 · une liste d’objets recipient

object« list »Le genre de l’objet rendu : il ne change jamais.
dataliste d’objets recipientLes bénéficiaires de la page, du plus récent au plus ancien.
has_morevrai ou fauxVrai : il en reste. Rappelez avec starting_after sur la dernière ligne lue.
urltexteL’adresse qui a servi, sans les filtres.

Enchaîner les pages

Tant que has_more est vrai, rappelez avec starting_after réglé sur l’identifiant de la dernière ligne lue. Les listes vont du plus récent au plus ancien.

© 2026 PayizUne question ? L’aide est dans le rond, en bas à droite.

Lister les bénéficiaires

GET/v1/recipients

Vers qui vous pouvez retirer.

Un bénéficiaire s’ajoute à l’écran, confirmé par le code de votre application : une clé volée ne doit pas ouvrir de porte de sortie. Cette liste n’est pas paginée.

Ce qu’on met dans l’adresse

limitentierDe 1 à 100. Par défaut 20.
starting_aftertexteL’identifiant de la dernière ligne lue : la page suivante commence après.

La demande

bash
curl https://api.payiz.app/v1/recipients \
  -H "Authorization: Bearer sk_test_…"

La réponse

json
{
  "object": "list",
  "url": "/v1/recipients",
  "has_more": false,
  "data": [
    {
      "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 · une liste d’objets recipient

object« list »Le genre de l’objet rendu : il ne change jamais.
dataliste d’objets recipientLes bénéficiaires de la page, du plus récent au plus ancien.
has_morevrai ou fauxVrai : il en reste. Rappelez avec starting_after sur la dernière ligne lue.
urltexteL’adresse qui a servi, sans les filtres.

Enchaîner les pages

Tant que has_more est vrai, rappelez avec starting_after réglé sur l’identifiant de la dernière ligne lue. Les listes vont du plus récent au plus ancien.