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

export enum eapi_payment_target_enum
{
    LABANQUEPOSTALE = 'LABANQUEPOSTALE',
    PAYBOX = 'PAYBOX',
    MILLIET = 'MILLIET',
}

export enum eapi_payment_run_mode_enum
{
    TEST = 'TEST',
    LIVE = 'LIVE',
    FORCE_LIVE = 'FORCE_LIVE',
}

export enum eapi_payment_type_enum
{
    DIRECT_SEPA = 'DIRECT_SEPA',
    SEPA = 'SEPA',
    CB = 'CB',
    AMEX = 'AMEX',
    COMPTABILITE = 'COMPTABILITE',
}

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

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

    /** @description 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")
    public payment_type: eapi_payment_type_enum;

    /** @description 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")
    public id_origin: string;

    /** @description 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")
    public id_societe: string;

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

    /** @description 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")
    public id_commande: string;

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

    /** @description 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")
    public amount: string;

    /** @description email client */
    // @ApiMember(Description="email client", IsRequired=true, Name="email")
    public email: string;

    /** @description commentaire */
    // @ApiMember(Description="commentaire", Name="commentaire")
    public commentaire: string;

    public constructor(init?: Partial<payment_initiate>) { (Object as any).assign(this, init); }
}

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