WS-RESTRICTED_API Host [RESTRICTED_API] : D5290-staging

<back to all web services

payment_bank

Payment

Paiements : appel des formulaires de règlements (PAYBOX, LA BANQUE POSTALE, etc...)

The following routes are available for this service:
GET,POST/payment_bank/{payment_target}/{payment_run_mode}/{payment_type}/{reference}/{amout}/{email}Paiements : appel des formulaires de règlements
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum eapi_payment_target_enum : string
{
    case LABANQUEPOSTALE = 'LABANQUEPOSTALE';
    case PAYBOX = 'PAYBOX';
    case MILLIET = 'MILLIET';
}

enum eapi_payment_run_mode_enum : string
{
    case TEST = 'TEST';
    case LIVE = 'LIVE';
    case FORCE_LIVE = 'FORCE_LIVE';
}

enum eapi_payment_type_enum : string
{
    case DIRECT_SEPA = 'DIRECT_SEPA';
    case SEPA = 'SEPA';
    case CB = 'CB';
    case AMEX = 'AMEX';
    case COMPTABILITE = 'COMPTABILITE';
}

/** @description Paiements : appel des formulaires de règlements (PAYBOX, LA BANQUE POSTALE, etc...) */
// @Api(Description="Paiements : appel des formulaires de règlements (PAYBOX, LA BANQUE POSTALE, etc...)")
class payment_bank implements JsonSerializable
{
    public function __construct(
        /** @description environnement cible : PAYBOX, LA BANQUE POSTALE, MILLIET */
        // @ApiMember(Description="environnement cible : PAYBOX, LA BANQUE POSTALE, MILLIET", IsRequired=true, Name="payment_target")
        /** @var eapi_payment_target_enum|null */
        public ?eapi_payment_target_enum $payment_target=null,

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

        /** @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")
        /** @var eapi_payment_type_enum|null */
        public ?eapi_payment_type_enum $payment_type=null,

        /** @description référence du paiement : 'uuid' */
        // @ApiMember(Description="référence du paiement : 'uuid'", IsRequired=true, Name="reference")
        /** @var string */
        public string $reference='',

        /** @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="amout")
        /** @var string */
        public string $amout='',

        /** @description email client */
        // @ApiMember(Description="email client", IsRequired=true, Name="email")
        /** @var string */
        public string $email=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['payment_target'])) $this->payment_target = JsonConverters::from('eapi_payment_target_enum', $o['payment_target']);
        if (isset($o['payment_run_mode'])) $this->payment_run_mode = JsonConverters::from('eapi_payment_run_mode_enum', $o['payment_run_mode']);
        if (isset($o['payment_type'])) $this->payment_type = JsonConverters::from('eapi_payment_type_enum', $o['payment_type']);
        if (isset($o['reference'])) $this->reference = $o['reference'];
        if (isset($o['amout'])) $this->amout = $o['amout'];
        if (isset($o['email'])) $this->email = $o['email'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->payment_target)) $o['payment_target'] = JsonConverters::to('eapi_payment_target_enum', $this->payment_target);
        if (isset($this->payment_run_mode)) $o['payment_run_mode'] = JsonConverters::to('eapi_payment_run_mode_enum', $this->payment_run_mode);
        if (isset($this->payment_type)) $o['payment_type'] = JsonConverters::to('eapi_payment_type_enum', $this->payment_type);
        if (isset($this->reference)) $o['reference'] = $this->reference;
        if (isset($this->amout)) $o['amout'] = $this->amout;
        if (isset($this->email)) $o['email'] = $this->email;
        return empty($o) ? new class(){} : $o;
    }
}

PHP payment_bank 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_bank/{payment_target}/{payment_run_mode}/{payment_type}/{reference}/{amout}/{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","reference":"String","amout":"String","email":"String"}