GET /payment-methods

Récupère la liste de tous les moyens de paiement configurés pour l'entreprise.

Les moyens de paiement sont utilisés sur les factures et devis pour indiquer au client comment régler sa facture.

Types de moyens de paiement (tags)

  • check : Chèque
  • transfer : Virement bancaire
  • paybox : Paiement Paybox
  • stripe : Paiement Stripe
  • paypal : Paiement PayPal
  • epayment : Paiement électronique générique
  • other : Autre moyen de paiement

Moyen de paiement par défaut

Un seul moyen peut être défini comme "default" et sera automatiquement sélectionné lors de la création de nouveaux documents.

Query parameters

  • state string

    Filtrer par état (active/inactive)

    Values are active or inactive.

  • tag string

    Filtrer par type de moyen de paiement

    Values are paybox, epayment, check, stripe, paypal, transfer, or other.

Responses

  • 200 application/json

    Liste des moyens de paiement

    Hide response attributes Show response attributes object
    • paymentMethods array[object]

      Tableau des moyens de paiement

      Hide paymentMethods attributes Show paymentMethods attributes object
      • _id string

        Unique identifier for the payment method

      • company string

        Reference to the company

      • default boolean

        Whether this is the default payment method

      • isTest boolean

        Whether this is a test payment method

        Default value is false.

      • modality string

        Additional information about the payment method

      • name string

        Name of the payment method

      • public string

        Public information

      • rang string

        Paybox specific field

      • secret string

        Secret information

      • site string

        Paybox specific field

      • state string

        State of the payment method

        Values are active or inactive. Default value is active.

      • tag string

        Type of payment method

        Values are paybox, epayment, check, stripe, paypal, transfer, or other. Default value is other.

      • nbInvoices integer

        Number of invoices using this payment method

      • nbQuotes integer

        Number of quotes using this payment method

    • total integer

      Nombre total de moyens de paiement

  • 403

    Non autorisé - Accès aux moyens de paiement refusé

GET /payment-methods
curl \
 --request GET 'https://wuro.pro/api/v3.2/payment-methods' \
 --header "X-APP-ID: $API_KEY" \
 --header "X-APP-SECRET: $API_KEY"
Response examples (200)
{
  "paymentMethods": [
    {
      "_id": "string",
      "company": "string",
      "default": true,
      "isTest": false,
      "modality": "string",
      "name": "string",
      "public": "string",
      "rang": "string",
      "secret": "string",
      "site": "string",
      "state": "active",
      "tag": "other",
      "nbInvoices": 42,
      "nbQuotes": 42
    }
  ],
  "total": 42
}