WS-RESTRICTED_API Host [RESTRICTED_API] : D5290-staging

<back to all web services

payment_initiate

Payment

Paiements : initier un règlement

The following routes are available for this service:
GET,POST/payment_initiate/{payment_target}/{payment_run_mode}/{payment_type}/{id_origin}/{id_societe}/{id_client}/{id_commande}/{type_paiement}/{amount}/{email}Paiements : initier un règlement
GET,POST/payment_initiate/{payment_target}/{payment_run_mode}/{payment_type}/{id_origin}/{id_societe}/{id_client}/{id_commande}/{type_paiement}/{amount}/{email}/{commentaire}Paiements : initier un règlement
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class eapi_payment_target_enum(str, Enum):
    LABANQUEPOSTALE = 'LABANQUEPOSTALE'
    PAYBOX = 'PAYBOX'
    MILLIET = 'MILLIET'


class eapi_payment_run_mode_enum(str, Enum):
    TEST = 'TEST'
    LIVE = 'LIVE'
    FORC_E__L_I_V_E = 'FORCE_LIVE'


class eapi_payment_type_enum(str, Enum):
    DIREC_T__S_E_P_A = 'DIRECT_SEPA'
    SEPA = 'SEPA'
    CB = 'CB'
    AMEX = 'AMEX'
    COMPTABILITE = 'COMPTABILITE'


# @Api(Description="Paiements : initier un règlement")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class payment_initiate:
    """
    Paiements : initier un règlement
    """

    # @ApiMember(Description="environnement cible : PAYBOX, LA BANQUE POSTALE, MILLIET", IsRequired=true, Name="payment_target")
    payment_target: Optional[eapi_payment_target_enum] = None
    """
    environnement cible : PAYBOX, LA BANQUE POSTALE, MILLIET
    """


    # @ApiMember(Description="mode : LIVE, TEST", IsRequired=true, Name="payment_run_mode")
    payment_run_mode: Optional[eapi_payment_run_mode_enum] = None
    """
    mode : LIVE, TEST
    """


    # @ApiMember(Description="type de paiement : CB, AMEX, SEPA, SEPA_DIRECT, COMPTABILITE", IsRequired=true, Name="payment_type")
    payment_type: Optional[eapi_payment_type_enum] = None
    """
    type de paiement : CB, AMEX, SEPA, SEPA_DIRECT, COMPTABILITE
    """


    # @ApiMember(Description="initiateur de la demande : web, dcp, télévente, compta, ibar, etc", IsRequired=true, Name="id_origin")
    id_origin: Optional[str] = None
    """
    initiateur de la demande : web, dcp, télévente, compta, ibar, etc
    """


    # @ApiMember(Description="numéro société : 1-J. Milliet BBC, 2-BCASH Chapelle, 3-BCASH Bagneux, 6-BCASH Clichy, etc...", IsRequired=true, Name="id_societe")
    id_societe: Optional[str] = None
    """
    numéro société : 1-J. Milliet BBC, 2-BCASH Chapelle, 3-BCASH Bagneux, 6-BCASH Clichy, etc...
    """


    # @ApiMember(Description="numéro client : 2263-David, 13846-Fabien, etc...", IsRequired=true, Name="id_client")
    id_client: Optional[str] = None
    """
    numéro client : 2263-David, 13846-Fabien, etc...
    """


    # @ApiMember(Description="numéro commande : dans le cas du DCP, sinon 0 ... OU PAS !!! (évolution pour télévente, compta, etc...)", IsRequired=true, Name="id_commande")
    id_commande: Optional[str] = None
    """
    numéro commande : dans le cas du DCP, sinon 0 ... OU PAS !!! (évolution pour télévente, compta, etc...)
    """


    # @ApiMember(Description="type : CB, AMEX, SEPA, SEPA_DIRECT", IsRequired=true, Name="type_paiement")
    type_paiement: Optional[eapi_payment_type_enum] = None
    """
    type : CB, AMEX, SEPA, SEPA_DIRECT
    """


    # @ApiMember(Description="montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro)", IsRequired=true, Name="amount")
    amount: Optional[str] = None
    """
    montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro)
    """


    # @ApiMember(Description="email client", IsRequired=true, Name="email")
    email: Optional[str] = None
    """
    email client
    """


    # @ApiMember(Description="commentaire", Name="commentaire")
    commentaire: Optional[str] = None
    """
    commentaire
    """

Python payment_initiate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment_initiate/{payment_target}/{payment_run_mode}/{payment_type}/{id_origin}/{id_societe}/{id_client}/{id_commande}/{type_paiement}/{amount}/{email} HTTP/1.1 
Host: milliet.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"payment_target":"LABANQUEPOSTALE","payment_run_mode":"TEST","payment_type":"DIRECT_SEPA","id_origin":"String","id_societe":"String","id_client":"String","id_commande":"String","type_paiement":"DIRECT_SEPA","amount":"String","email":"String","commentaire":"String"}