Créer un moyen de paiement

POST /payment-method

Crée un nouveau moyen de paiement pour l'entreprise.

Types de moyens de paiement

Le champ tag définit le type de moyen de paiement et détermine les champs additionnels requis :

check : Chèque (pas de champs supplémentaires)
transfer : Virement bancaire (utilisez modality pour les coordonnées bancaires)
stripe : Stripe (public pour la clé publique, secret pour la clé secrète)
paypal : PayPal (public pour l'identifiant marchand)
paybox : Paybox (public, secret, rang, site)
epayment : Paiement électronique générique
other : Autre

Mode test

Utilisez isTest: true pour créer un moyen de paiement en mode test. Les paiements effectués avec ce moyen ne seront pas réellement débités.

Moyen par défaut

Si default: true, ce moyen sera automatiquement sélectionné pour les nouveaux documents.

application/json

Body Required

name string Required

Nom du moyen de paiement (obligatoire)
modality string

Modalités de paiement affichées sur les documents. Ex. coordonnées bancaires, délai de paiement, etc.
default boolean

Définir comme moyen par défaut

Default value is false.
tag string

Type de moyen de paiement

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

Mode test (pas de paiement réel)

Default value is false.
public string

Clé publique (Stripe, Paybox) ou identifiant marchand (PayPal)
secret string

Clé secrète (Stripe, Paybox) - Ne jamais exposer côté client
rang string

Rang Paybox (spécifique Paybox)
site string

Numéro de site Paybox (spécifique Paybox)

Responses

201 application/json

Moyen de paiement créé avec succès
Hide response attribute Show response attribute object
- newPaymentMethod object
  
  Hide newPaymentMethod attributes Show newPaymentMethod 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
400

Requête invalide - Nom manquant ou données incorrectes
403

Non autorisé - Droits insuffisants pour créer un moyen de paiement

POST /payment-method

curl \
 --request POST 'https://wuro.pro/api/v3.2/payment-method' \
 --header "X-APP-ID: $API_KEY" \
 --header "X-APP-SECRET: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"Virement bancaire","modality":"IBAN: FR76 1234 5678 9012 - BIC: BNPAFRPP","default":false,"tag":"other","isTest":false,"public":"string","secret":"string","rang":"string","site":"string"}'

Request examples

{
  "name": "Virement bancaire",
  "modality": "IBAN: FR76 1234 5678 9012 - BIC: BNPAFRPP",
  "default": false,
  "tag": "other",
  "isTest": false,
  "public": "string",
  "secret": "string",
  "rang": "string",
  "site": "string"
}

Response examples (201)

{
  "newPaymentMethod": {
    "_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
  }
}