Guides
Page de StatutTableau de bordRéserver une Démo
Commencez à taper pour rechercher...

NuPay

Ce guide explore l'intégration de NuPay par Yuno à l'aide du flux de travail Direct. Vous apprendrez comment :

  • Enregistrer NuPay comme mode de paiement client
  • Effectuer des paiements échelonnés (conditions de paiement)
  • Configurer les abonnements

Prérequis

Avant de commencer, vous avez besoin de :

  • Un compte Yuno avec accès au tableau de bord
  • Clés API et un account_id (situé dans le tableau de bord)
  • Un client créé dans Yuno (ou créez-en un à l'étape 1)

Créer et gérer des clients

Créez le client une seule fois à l'aide de votre système externe. merchant_customer_id, puis récupérer par Yuno id ou par merchant_customer_id selon les besoins.

  1. Utilisez l'endpoint  Créer un client endpoint fournissez le vôtre merchant_customer_id (l'identifiant unique du client dans votre système). La réponse renvoie id qui correspond à l'identifiant client Yuno.
  2. Utilisez Récupérer un client avec le Yuno id.
  3. Utilisez Récupérer le client par identifiant externe avec paramètre de requête merchant_customer_id.

Enregistrer le mode de paiement NuPay

Suivez ces étapes pour vous inscrire NU_PAY_ENROLLMENT à un client utilisant le flux de travail Direct.

Étape 1 : Créer un client

Si vous n'avez pas encore de client, créez-en un comme indiqué ci-dessus. Vous utiliserez le client renvoyé. id.

Étape 2 : Enregistrer le mode de paiement

Utilisez Enroll Payment Method avec les paramètres de requête suivants :

  • Type: NU_PAY_ENROLLMENT
  • account_id: UUID de votre compte (à partir du tableau de bord Yuno)
  • workflow: DIRECT

Champs de réponse attendus :

  • vaulted_token: UUID pour le mode de paiement enregistré
  • statut: READY_TO_ENROLL
  • sub_status: WAITING_ADDITIONAL_STEP
  • action: REDIRECT_URL
  • redirect_url: URL vers laquelle rediriger le client vers Nu pour l'authentification

Étape 3 : Rediriger le client

Rediriger le client vers le redirect_urlLe client termine le flux Nu. Nu informe Yuno de l'état final.

Étape 4 : Confirmer l'inscription

Utilisez Récupérer le mode de paiement enregistré par identifiant avec l'objet  vaulted_token. Une inscription réussie renvoie :

  • statut: ENROLLED
  • sub_status: ENROLLED
⚠️

L'inscription n'est effective qu'après réception de la confirmation de Nu par Yuno.

Paiements avec conditions de paiement (versements échelonnés)

Après votre inscription, vous pouvez accepter des paiements avec NuPay en utilisant les conditions de paiement.

Étape 1 : Vérifier les conditions préalables

Avoir un client Yuno id et un NuPay enregistré vaulted_token.

Étape 2 : Obtenir les conditions de paiement

Demandez les options de paiement échelonné disponibles pour NuPay à l'aide du endpoint APM installments.

curl --location 'https://api-sandbox.y.uno/v1/apm-installments' \
--header 'public-api-key: {{your_public_api_key}}' \
--header 'private-secret-key: {{your_secret_api_key}}' \
--header 'X-account-code: {{your_account_code}}' \
--header 'Content-Type: application/json' \
--data '{
  "country": "BR",
  "amount": {
    "currency": "BRL",
    "value": "250"
  },
  "customer": {
    "id": "{{customer_id}}"
  },
  "payment_method": "NU_PAY_ENROLLMENT",
  "vaulted_token": "{{vaulted_token}}"
}'

La réponse renvoie un tableau de plans de paiement échelonné, comprenant id, disponible installments, et les montants. Sélectionnez un forfait id et un nombre de versements autorisés.

Étape 3 : Créer un paiement

Utilisez Créer un paiement avec le flux de travail Direct et le type NuPay. Inclure l'identifiant du plan sélectionné et les versements dans le portefeuille. card_data.

{
  "description": "test",
  "account_id": "{{account_id}}",
  "merchant_order_id": "0000023",
  "country": "BR",
  "merchant_reference": "ref-merchant-AA01",
  "amount": {
    "currency": "BRL",
    "value": 250
  },
  "customer_payer": {
    "id": "{{customer_id}}"
  },
  "workflow": "DIRECT",
  "callback_url": "https://your-callback.com",
  "payment_method": {
    "type": "NU_PAY_ENROLLMENT",
    "vaulted_token": "{{vaulted_token}}",
    "detail": {
      "wallet": {
        "card_data": {
          "installments_plan_id": "{{plan_id}}",
          "installments": 2
        }
      }
    }
  }
}

Étape 4 : Récupérer le paiement

Utilisez « Récupérer le paiement par identifiant » pour confirmer le statut final.

Flux d'abonnement

Vous pouvez utiliser NuPay pour les frais récurrents.

  1. Créer un client
  2. Enregistrez NuPay comme mode de paiement (voir ci-dessus)
  3. Créer un abonnement avec les personnes inscrites vaulted_token en utilisant Créer un abonnement
  4. Récupérer l'abonnement à l'aide de la fonction Récupérer l'abonnement
⚠️

Limitations

  • Les abonnements avec NuPay ne prennent pas en charge les conditions de paiement (versements échelonnés).
  • La création d'abonnements directement dans une demande de paiement n'est pas prise en charge.

Endpoints

Mise à jour il y a 3 mois