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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

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

    /**
    * 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")
    open var payment_type:eapi_payment_type_enum? = null

    /**
    * 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")
    open var id_origin:String? = null

    /**
    * 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")
    open var id_societe:String? = null

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

    /**
    * 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")
    open var id_commande:String? = null

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

    /**
    * 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")
    open var amount:String? = null

    /**
    * email client
    */
    @ApiMember(Description="email client", IsRequired=true, Name="email")
    open var email:String? = null

    /**
    * commentaire
    */
    @ApiMember(Description="commentaire", Name="commentaire")
    open var commentaire:String? = null
}

enum class eapi_payment_target_enum
{
    Labanquepostale,
    Paybox,
    Milliet,
}

enum class eapi_payment_run_mode_enum
{
    Test,
    Live,
    ForceLive,
}

enum class eapi_payment_type_enum
{
    DirectSepa,
    Sepa,
    Cb,
    Amex,
    Comptabilite,
}

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