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 'package:servicestack/servicestack.dart';

enum eapi_payment_target_enum
{
    LABANQUEPOSTALE,
    PAYBOX,
    MILLIET,
}

enum eapi_payment_run_mode_enum
{
    TEST,
    LIVE,
    FORCE_LIVE,
}

enum eapi_payment_type_enum
{
    DIRECT_SEPA,
    SEPA,
    CB,
    AMEX,
    COMPTABILITE,
}

/**
* Paiements : initier un règlement
*/
// @Api(Description="Paiements : initier un règlement")
class payment_initiate implements IConvertible
{
    /**
    * environnement cible : PAYBOX, LA BANQUE POSTALE, MILLIET
    */
    // @ApiMember(Description="environnement cible : PAYBOX, LA BANQUE POSTALE, MILLIET", IsRequired=true, Name="payment_target")
    eapi_payment_target_enum? payment_target;

    /**
    * mode : LIVE, TEST
    */
    // @ApiMember(Description="mode : LIVE, TEST", IsRequired=true, Name="payment_run_mode")
    eapi_payment_run_mode_enum? payment_run_mode;

    /**
    * type de paiement : CB, AMEX, SEPA, SEPA_DIRECT, COMPTABILITE
    */
    // @ApiMember(Description="type de paiement : CB, AMEX, SEPA, SEPA_DIRECT, COMPTABILITE", IsRequired=true, Name="payment_type")
    eapi_payment_type_enum? payment_type;

    /**
    * initiateur de la demande : web, dcp, télévente, compta, ibar, etc
    */
    // @ApiMember(Description="initiateur de la demande : web, dcp, télévente, compta, ibar, etc", IsRequired=true, Name="id_origin")
    String? id_origin;

    /**
    * numéro société : 1-J. Milliet BBC, 2-BCASH Chapelle, 3-BCASH Bagneux, 6-BCASH Clichy, 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")
    String? id_societe;

    /**
    * numéro client : 2263-David, 13846-Fabien, etc...
    */
    // @ApiMember(Description="numéro client : 2263-David, 13846-Fabien, etc...", IsRequired=true, Name="id_client")
    String? id_client;

    /**
    * numéro commande : dans le cas du DCP, sinon 0 ... OU PAS !!! (évolution pour télévente, compta, 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")
    String? id_commande;

    /**
    * type : CB, AMEX, SEPA, SEPA_DIRECT
    */
    // @ApiMember(Description="type : CB, AMEX, SEPA, SEPA_DIRECT", IsRequired=true, Name="type_paiement")
    eapi_payment_type_enum? type_paiement;

    /**
    * montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro)
    */
    // @ApiMember(Description="montant du paiement dans sa plus petite unité monétaire (le centime pour l'euro)", IsRequired=true, Name="amount")
    String? amount;

    /**
    * email client
    */
    // @ApiMember(Description="email client", IsRequired=true, Name="email")
    String? email;

    /**
    * commentaire
    */
    // @ApiMember(Description="commentaire", Name="commentaire")
    String? commentaire;

    payment_initiate({this.payment_target,this.payment_run_mode,this.payment_type,this.id_origin,this.id_societe,this.id_client,this.id_commande,this.type_paiement,this.amount,this.email,this.commentaire});
    payment_initiate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        payment_target = JsonConverters.fromJson(json['payment_target'],'eapi_payment_target_enum',context!);
        payment_run_mode = JsonConverters.fromJson(json['payment_run_mode'],'eapi_payment_run_mode_enum',context!);
        payment_type = JsonConverters.fromJson(json['payment_type'],'eapi_payment_type_enum',context!);
        id_origin = json['id_origin'];
        id_societe = json['id_societe'];
        id_client = json['id_client'];
        id_commande = json['id_commande'];
        type_paiement = JsonConverters.fromJson(json['type_paiement'],'eapi_payment_type_enum',context!);
        amount = json['amount'];
        email = json['email'];
        commentaire = json['commentaire'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'payment_target': JsonConverters.toJson(payment_target,'eapi_payment_target_enum',context!),
        'payment_run_mode': JsonConverters.toJson(payment_run_mode,'eapi_payment_run_mode_enum',context!),
        'payment_type': JsonConverters.toJson(payment_type,'eapi_payment_type_enum',context!),
        'id_origin': id_origin,
        'id_societe': id_societe,
        'id_client': id_client,
        'id_commande': id_commande,
        'type_paiement': JsonConverters.toJson(type_paiement,'eapi_payment_type_enum',context!),
        'amount': amount,
        'email': email,
        'commentaire': commentaire
    };

    getTypeName() => "payment_initiate";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'milliet.io', types: <String, TypeInfo> {
    'eapi_payment_target_enum': TypeInfo(TypeOf.Enum, enumValues:eapi_payment_target_enum.values),
    'eapi_payment_run_mode_enum': TypeInfo(TypeOf.Enum, enumValues:eapi_payment_run_mode_enum.values),
    'eapi_payment_type_enum': TypeInfo(TypeOf.Enum, enumValues:eapi_payment_type_enum.values),
    'payment_initiate': TypeInfo(TypeOf.Class, create:() => payment_initiate()),
});

Dart 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"}