Librairie PHP

Archive contenant notre classe PHP ainsi qu'une documentation pour une intégration PHP

Télécharger

Intégration par API (Web Service)

  • Authentification

  • Permet de créer un token d'accès au protocole OAuth.

    Permet de créer un token d'accès au protocole OAuth.

    Données envoyées

    Token d'accès OAuth Api.Model.AuthAccessToken
    Attribut Type Requis Description
    ipAddress string Oui Adresse IP de votre utilisateur
    email string Oui E-mail utilisé par defaut pour l'inscription
    name string Oui Nom de la boutique utilisé par defaut pour l'inscription
    phoneNumber string Non Numéro de téléphone utilisé par defaut pour l'inscription

    Données retournées

    Attribut Type Description
    accessPublic string Clée d'accès publique OAuth
    accessSecret string Clée d'accès secrète OAuth
    email string E-mail utilisé par defaut pour l'inscription
    name string Nom de la boutique utilisé par defaut pour l'inscription
    phoneNumber string Numéro de téléphone utilisé par defaut pour l'inscription
    expiresIn int TTL du token d'accès

    Exemple

    POST https://paygreen.fr/api/auth/
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "ipAddress": "127.0.0.1",
        "serverAddress": "127.0.0.1",
        "email": "contact@paygreen.fr",
        "name": "name",
        "phoneNumber": "0952045779"
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "accessPublic": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "accessSecret": "xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "serverAddress": "127.0.0.1",
            "email": "contact@paygreen.fr",
            "name": "name",
            "phoneNumber": "0952045779",
            "expiresIn": "3600"
        }
    }
  • Page d'authentification OAuth

    Page permettant à vos utilisateurs de se connecter ou s'inscrire chez PayGreen utilisant le protocol OAuth

    Données envoyées

    Valeurs envoyées par GET Api.Auth.authorize
    Attribut Type Requis Description
    response_type string Non Variable OAuth concernant le style de réponse (valeur: code)
    client_id string Non Variable OAuth contenant accessPublic
    redirect_uri string Non Variable OAuth contenant l'Url de retour une fois l'utilisateur identifié

    Données retournées

    Page contenant du code HTML exploitable par un navigateur.

    Exemple

    GET https://paygreen.fr/api/auth/authorize?response_type=code&client_id=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&redirect_uri=http://example.com/mon-url-de-retour
    
  • Service de controle OAuth

    Fonction du protocole OAuth, permettant de controler le retour après authentification OAuth, puis permet de récupérer les données de la boutique selectionnée.

    Données envoyées

    Valeurs envoyées par POST Api.Auth.accessToken
    Attribut Type Requis Description
    client_id string Non Variable OAuth contenant accessPublic
    grant_type string Non Variable OAuth contenant la valeur du "grant type" OAuth (Valeur: authorization_code)
    code string Non Variable OAuth contenant le code generate après l'appel authorize OAuth

    Données retournées

    Attribut Type Description
    id string Identifiant unique d'une boutique
    name string Nom de l'enseigne / Raison social
    url string URL du site internet
    privateKey string Clée privée d'API
    availableMode array Mode de paiement
    description string Description de l'activité
    activate bool Définit si la boutique est en production
    validatedAt date Date de validation de la boutique
    createdAt date Date de création de de la boutique
    paiementType enum Type de compte de paiement en ligne
    withVad Configuration d'un compte avec VAD
    withoutVad Configuration d'un compte sans VAD

    Exemple

    POST https://paygreen.fr/api/auth/accessToken
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "37330ff88bd7f7b0082d031d6eb59bb4",
            "name": "Mon E-Commerce",
            "url": "https:\/\/paygreen.fr",
            "privateKey": "c6d3-4a3f-a848-26d89c1afa60",
            "availableMode": [
                "CASH"
            ],
            "description": "activity",
            "activate": true,
            "createdAt": "2004-02-12T15:19:21",
            "paiementType": "withoutVAD"
        }
    }
  • Example d'intégration OAuth

    Démonstration de connexion OAuth PayGreen avec script PHP

    1. Récupérer les clées d\'accès OAuth PayGreen

    $ipAddress  = $_SERVER['REMOTE_ADDR'];
    $email      = 'Mon email';
    $name       = 'Nom de ma boutique';
    $oauth      = $_SESSION['oauth_access'];
    
    $REDIRECT_URI           = 'https://paygreen.fr/index/oauth';
    $DECLARE_ENDPOINT       = 'https://paygreen.fr/api/auth';
    $AUTHORIZATION_ENDPOINT = 'https://paygreen.fr/api/auth/authorize';
    $TOKEN_ENDPOINT         = 'https://paygreen.fr/api/auth/access_token';
    
    if (empty($oauth)) {
        $subParam = [
            "ipAddress" => $ipAddress,
            "email" => $email,
            "name" => $name
        ];
    
        $opts = array(
            'http'=>array(
                'method'=>"POST",
                'header'=>"Accept: application/json\r\n" .
                          "Content-Type: application/json\r\n",
                'content' => json_encode($subParam)
              )
        );
        $context  = stream_context_create($opts);
        $result = file_get_contents($DECLARE_ENDPOINT, false, $context);
        $_SESSION['oauth_access'] = $oauth = json_decode($result);
    }
    
    

    2. Utilisation OAuth PayGreen

    Pour la gestion OAuth nous avons utilisé la librairie de Charron Pierrick & Berejeb Anis
    $CLIENT_ID     = $oauth->data->accessPublic;
    $CLIENT_SECRET = $oauth->data->accessSecret;
    
    $client = new \OAuth2\Client($CLIENT_ID, $CLIENT_SECRET, \OAuth2\Client::AUTH_TYPE_AUTHORIZATION_BASIC);
    
    if (!isset($_GET['code']))
    {
        $auth_url = $client->getAuthenticationUrl($AUTHORIZATION_ENDPOINT, $REDIRECT_URI);
        echo '<a href="'.$auth_url.'">Authentification Paygreen</a>';
        exit;
    
    } else {
        $params = array('code' => $_GET['code'], 'redirect_uri' => $REDIRECT_URI);
        $response = $client->getAccessToken($TOKEN_ENDPOINT, 'authorization_code', $params);
        $result = json_decode($response);
        print_r($result->data);
        exit;
    }
    
  • Compte avec VAD

  • Affiche la configuration

    Donne la configuration pour le compte avec numéro de Vente A Distance (VAD)

    Données envoyées

    Données retournées

    Attribut Type Description
    vadNumber int Numero de Vente A Distance
    mccNumber int Numéro MCC
    maxAmount int Montant maximal d'une transaction

    Exemple

    GET https://paygreen.fr/api/{identifiant}/payline
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "vadNumber": "1234567",
            "mccNumber": "7676",
            "maxAmount": "1500"
        }
    }
  • Paramètre un contrat VAD

    Permet de paramétrer un contrat avec VAD

    Données envoyées

    Api.Model.PaylineConfig.desc Api.Model.PaylineConfig
    Attribut Type Requis Description
    vadNumber int Oui Numero de Vente A Distance
    mccNumber int Oui Numéro MCC
    maxAmount int Oui Montant maximal d'une transaction

    Données retournées

    Attribut Type Description
    vadNumber int Numero de Vente A Distance
    mccNumber int Numéro MCC
    maxAmount int Montant maximal d'une transaction

    Exemple

    POST https://paygreen.fr/api/{identifiant}/payline
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "vadNumber": "1234567",
        "mccNumber": "7676",
        "maxAmount": "1500"
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "vadNumber": "1234567",
            "mccNumber": "7676",
            "maxAmount": "1500"
        }
    }
  • Désactive le compte avec VAD

    Api.Payline.delete.desc

    Données envoyées

    .desc Api.Model.mixed
    Attribut Type Requis Description

    Données retournées

    Aucune donnée

    Exemple

    DELETE https://paygreen.fr/api/{identifiant}/payline
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    [
    
    ]
  • Ma boutique

  • Affiche la boutique courante

    Permet de récupérer la configuration de la boutique courante

    Données envoyées

    Données retournées

    Attribut Type Description
    id string Identifiant unique d'une boutique
    name string Nom de l'enseigne / Raison social
    url string URL du site internet
    privateKey string Clée privée d'API
    availableMode array Mode de paiement
    description string Description de l'activité
    activate bool Définit si la boutique est en production
    validatedAt date Date de validation de la boutique
    createdAt date Date de création de de la boutique
    paiementType enum Type de compte de paiement en ligne
    withVad Configuration d'un compte avec VAD
    withoutVad Configuration d'un compte sans VAD

    Exemple

    GET https://paygreen.fr/api/{identifiant}/shop
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "37330ff88bd7f7b0082d031d6eb59bb4",
            "name": "Mon E-Commerce",
            "url": "https:\/\/paygreen.fr",
            "privateKey": "c6d3-4a3f-a848-26d89c1afa60",
            "availableMode": [
                "CASH"
            ],
            "description": "activity",
            "activate": true,
            "createdAt": "2004-02-12T15:19:21",
            "paiementType": "withoutVAD"
        }
    }
  • Affiche une boutique

    Permet de récupérer la configuration d'une boutique donnée

    Données envoyées

    Données retournées

    Attribut Type Description
    id string Identifiant unique d'une boutique
    name string Nom de l'enseigne / Raison social
    url string URL du site internet
    privateKey string Clée privée d'API
    availableMode array Mode de paiement
    description string Description de l'activité
    activate bool Définit si la boutique est en production
    validatedAt date Date de validation de la boutique
    createdAt date Date de création de de la boutique
    paiementType enum Type de compte de paiement en ligne
    withVad Configuration d'un compte avec VAD
    withoutVad Configuration d'un compte sans VAD

    Exemple

    GET https://paygreen.fr/api/{identifiant}/shop/{shopId}
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "37330ff88bd7f7b0082d031d6eb59bb4",
            "name": "Mon E-Commerce",
            "url": "https:\/\/paygreen.fr",
            "privateKey": "c6d3-4a3f-a848-26d89c1afa60",
            "availableMode": [
                "CASH"
            ],
            "description": "activity",
            "activate": true,
            "createdAt": "2004-02-12T15:19:21",
            "paiementType": "withoutVAD"
        }
    }
  • Mettre à jour

    Permet de mettre à jour certaine donnée de la boutique

    Données envoyées

    Modèle de donnée d'une boutique Api.Model.Shop
    Attribut Type Requis Description
    name string Oui Nom de l'enseigne / Raison social
    url string Oui URL du site internet
    availableMode array Oui Mode de paiement
    description string Oui Description de l'activité
    paiementType enum Oui Type de compte de paiement en ligne

    Données retournées

    Attribut Type Description
    id string Identifiant unique d'une boutique
    name string Nom de l'enseigne / Raison social
    url string URL du site internet
    privateKey string Clée privée d'API
    availableMode array Mode de paiement
    description string Description de l'activité
    activate bool Définit si la boutique est en production
    validatedAt date Date de validation de la boutique
    createdAt date Date de création de de la boutique
    paiementType enum Type de compte de paiement en ligne
    withVad Configuration d'un compte avec VAD
    withoutVad Configuration d'un compte sans VAD

    Exemple

    PUT https://paygreen.fr/api/{identifiant}/shop
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "name": "Mon E-Commerce",
        "url": "https:\/\/paygreen.fr",
        "availableMode": [
            "CASH"
        ],
        "description": "activity",
        "paiementType": "withoutVAD"
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "37330ff88bd7f7b0082d031d6eb59bb4",
            "name": "Mon E-Commerce",
            "url": "https:\/\/paygreen.fr",
            "privateKey": "c6d3-4a3f-a848-26d89c1afa60",
            "availableMode": [
                "CASH"
            ],
            "description": "activity",
            "activate": true,
            "createdAt": "2004-02-12T15:19:21",
            "paiementType": "withoutVAD"
        }
    }
  • Mettre à jour une boutique spécifique

    Permet de mettre à jour certaines données d'une boutique donnée 'shopId'

    Données envoyées

    Modèle de donnée d'une boutique Api.Model.Shop
    Attribut Type Requis Description
    name string Oui Nom de l'enseigne / Raison social
    url string Oui URL du site internet
    availableMode array Oui Mode de paiement
    description string Oui Description de l'activité
    paiementType enum Oui Type de compte de paiement en ligne

    Données retournées

    Attribut Type Description
    id string Identifiant unique d'une boutique
    name string Nom de l'enseigne / Raison social
    url string URL du site internet
    privateKey string Clée privée d'API
    availableMode array Mode de paiement
    description string Description de l'activité
    activate bool Définit si la boutique est en production
    validatedAt date Date de validation de la boutique
    createdAt date Date de création de de la boutique
    paiementType enum Type de compte de paiement en ligne
    withVad Configuration d'un compte avec VAD
    withoutVad Configuration d'un compte sans VAD

    Exemple

    PUT https://paygreen.fr/api/{identifiant}/shop/{shopId}
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "name": "Mon E-Commerce",
        "url": "https:\/\/paygreen.fr",
        "availableMode": [
            "CASH"
        ],
        "description": "activity",
        "paiementType": "withoutVAD"
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "37330ff88bd7f7b0082d031d6eb59bb4",
            "name": "Mon E-Commerce",
            "url": "https:\/\/paygreen.fr",
            "privateKey": "c6d3-4a3f-a848-26d89c1afa60",
            "availableMode": [
                "CASH"
            ],
            "description": "activity",
            "activate": true,
            "createdAt": "2004-02-12T15:19:21",
            "paiementType": "withoutVAD"
        }
    }
  • Action spécifique

    Permet de lancer des actions spéciales sur une boutique.

    Données envoyées

    Valeurs envoyées par PATCH Api.Shop.patchList
    Attribut Type Requis Description
    activate bool Non Permet de mettre en production

    Données retournées

    Attribut Type Description
    id string Identifiant unique d'une boutique
    name string Nom de l'enseigne / Raison social
    url string URL du site internet
    privateKey string Clée privée d'API
    availableMode array Mode de paiement
    description string Description de l'activité
    activate bool Définit si la boutique est en production
    validatedAt date Date de validation de la boutique
    createdAt date Date de création de de la boutique
    paiementType enum Type de compte de paiement en ligne
    withVad Configuration d'un compte avec VAD
    withoutVad Configuration d'un compte sans VAD

    Exemple

    PATCH https://paygreen.fr/api/{identifiant}/shop
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "activate": true
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "37330ff88bd7f7b0082d031d6eb59bb4",
            "name": "Mon E-Commerce",
            "url": "https:\/\/paygreen.fr",
            "privateKey": "c6d3-4a3f-a848-26d89c1afa60",
            "availableMode": [
                "CASH"
            ],
            "description": "activity",
            "activate": true,
            "createdAt": "2004-02-12T15:19:21",
            "paiementType": "withoutVAD"
        }
    }
  • Création

    Permet de creer une nouvelle boutique

    Données envoyées

    Modèle de donnée d'une boutique Api.Model.Shop
    Attribut Type Requis Description
    name string Oui Nom de l'enseigne / Raison social
    url string Oui URL du site internet
    availableMode array Oui Mode de paiement
    description string Oui Description de l'activité
    paiementType enum Oui Type de compte de paiement en ligne

    Données retournées

    Attribut Type Description
    id string Identifiant unique d'une boutique
    name string Nom de l'enseigne / Raison social
    url string URL du site internet
    privateKey string Clée privée d'API
    availableMode array Mode de paiement
    description string Description de l'activité
    activate bool Définit si la boutique est en production
    validatedAt date Date de validation de la boutique
    createdAt date Date de création de de la boutique
    paiementType enum Type de compte de paiement en ligne
    withVad Configuration d'un compte avec VAD
    withoutVad Configuration d'un compte sans VAD

    Exemple

    POST https://paygreen.fr/api/{identifiant}/shop
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "name": "Mon E-Commerce",
        "url": "https:\/\/paygreen.fr",
        "availableMode": [
            "CASH"
        ],
        "description": "activity",
        "paiementType": "withoutVAD"
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "37330ff88bd7f7b0082d031d6eb59bb4",
            "name": "Mon E-Commerce",
            "url": "https:\/\/paygreen.fr",
            "privateKey": "c6d3-4a3f-a848-26d89c1afa60",
            "availableMode": [
                "CASH"
            ],
            "description": "activity",
            "activate": true,
            "createdAt": "2004-02-12T15:19:21",
            "paiementType": "withoutVAD"
        }
    }
  • Compte principal

  • Affiche le compte principal

    Donne les informations sur le compte principal PayGreen.

    Données envoyées

    Données retournées

    Attribut Type Description
    id string Identifiant du compte
    name string Nom du compte
    siret string Siret principal
    type enum Type de la société du compte
    createdAt date Date de création du compte

    Exemple

    GET https://paygreen.fr/api/{identifiant}/account
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "37330ff88bd7f7b0082d031d6eb59bb5",
            "name": "Compte principale",
            "siret": "111 111 111 111111",
            "type": "COMPANY",
            "createdAt": "2004-02-12T15:19:21"
        }
    }
  • Met à jour le compte principal

    Met à jour les données du compte principal

    Données envoyées

    Modèle de donnée du compte principal PayGreen Api.Model.Account
    Attribut Type Requis Description
    name string Non Nom du compte
    siret string Non Siret principal
    type enum Non Type de la société du compte

    Données retournées

    Attribut Type Description
    id string Identifiant du compte
    name string Nom du compte
    siret string Siret principal
    type enum Type de la société du compte
    createdAt date Date de création du compte

    Exemple

    PUT https://paygreen.fr/api/{identifiant}/account
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "name": "Compte principale",
        "siret": "111 111 111 111111",
        "type": "COMPANY"
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "37330ff88bd7f7b0082d031d6eb59bb5",
            "name": "Compte principale",
            "siret": "111 111 111 111111",
            "type": "COMPANY",
            "createdAt": "2004-02-12T15:19:21"
        }
    }
  • Compte sans VAD

  • Affiche la configuration

    Donne la configuration pour le compte avec compte virtuel (sans VAD)

    Données envoyées

    Données retournées

    Attribut Type Description
    accountCreated bool Api.Model.SmoneyConfig.accountCreated
    bankAccountCreated bool Api.Model.SmoneyConfig.bankAccountCreated
    percentReserve float Api.Model.SmoneyConfig.percentReserve

    Exemple

    GET https://paygreen.fr/api/{identifiant}/smoney
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "accountCreated": ""
        }
    }
  • Paramètre un contrat sans VAD

    Permet de paramétrer un contrat sans VAD

    Données envoyées

    Api.Model.SmoneyConfig.desc Api.Model.SmoneyConfig
    Attribut Type Requis Description

    Données retournées

    Attribut Type Description
    accountCreated bool Api.Model.SmoneyConfig.accountCreated
    bankAccountCreated bool Api.Model.SmoneyConfig.bankAccountCreated
    percentReserve float Api.Model.SmoneyConfig.percentReserve

    Exemple

    POST https://paygreen.fr/api/{identifiant}/smoney
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    [
    
    ]
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "accountCreated": ""
        }
    }
  • Désactive le compte sans VAD

    Permet de desactiver la configuration d'un compte sans numero VAD

    Données envoyées

    .desc Api.Model.mixed
    Attribut Type Requis Description

    Données retournées

    Aucune donnée

    Exemple

    DELETE https://paygreen.fr/api/{identifiant}/smoney
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    [
    
    ]
  • Mes boutiques

  • Liste des boutiques

    Permet de lister toutes mes boutiques

    Données envoyées

    Données retournées

    Attribut Type Description
    id string Identifiant unique d'une boutique
    name string Nom de l'enseigne / Raison social
    url string URL du site internet
    privateKey string Clée privée d'API
    availableMode array Mode de paiement
    description string Description de l'activité
    activate bool Définit si la boutique est en production
    validatedAt date Date de validation de la boutique
    createdAt date Date de création de de la boutique
    paiementType enum Type de compte de paiement en ligne
    withVad Configuration d'un compte avec VAD
    withoutVad Configuration d'un compte sans VAD

    Exemple

    GET https://paygreen.fr/api/{identifiant}/shops
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": [
            {
                "id": "37330ff88bd7f7b0082d031d6eb59bb4",
                "name": "Mon E-Commerce",
                "url": "https:\/\/paygreen.fr",
                "privateKey": "c6d3-4a3f-a848-26d89c1afa60",
                "availableMode": [
                    "CASH"
                ],
                "description": "activity",
                "activate": true,
                "createdAt": "2004-02-12T15:19:21",
                "paiementType": "withoutVAD"
            },
            {
                "id": "37330ff88bd7f7b0082d031d6eb59bb4",
                "name": "Mon E-Commerce",
                "url": "https:\/\/paygreen.fr",
                "privateKey": "c6d3-4a3f-a848-26d89c1afa60",
                "availableMode": [
                    "CASH"
                ],
                "description": "activity",
                "activate": true,
                "createdAt": "2004-02-12T15:19:21",
                "paiementType": "withoutVAD"
            }
        ]
    }
  • Ma banque

  • Affiche mon RIB

    Permet de lister toutes mes boutiques

    Données envoyées

    Données retournées

    Attribut Type Description
    id int Api.Model.Rib.id
    bankName string Api.Model.Rib.bankName
    iban string Api.Model.Rib.iban
    bic string Api.Model.Rib.bic

    Exemple

    GET https://paygreen.fr/api/{identifiant}/bank
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": 123,
            "bankName": "Ma Banque",
            "iban": "FR7613106005002000743520962",
            "bic": "CMCIFR2A"
        }
    }
  • Création d'un RIB

    Permet de lister toutes mes boutiques

    Données envoyées

    Api.Model.Rib.desc Api.Model.Rib
    Attribut Type Requis Description
    bankName string Non Api.Model.Rib.bankName
    iban string Non Api.Model.Rib.iban
    bic string Non Api.Model.Rib.bic

    Données retournées

    Attribut Type Description
    id int Api.Model.Rib.id
    bankName string Api.Model.Rib.bankName
    iban string Api.Model.Rib.iban
    bic string Api.Model.Rib.bic

    Exemple

    POST https://paygreen.fr/api/{identifiant}/bank
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "bankName": "Ma Banque",
        "iban": "FR7613106005002000743520962",
        "bic": "CMCIFR2A"
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": 123,
            "bankName": "Ma Banque",
            "iban": "FR7613106005002000743520962",
            "bic": "CMCIFR2A"
        }
    }
  • Gestion de transaction

  • Remboursement

    Permet de rembourser une transaction

    Données envoyées

    Données retournées

    Attribut Type Description
    id string Api.Model.Transaction.id
    orderId string Api.Model.Transaction.orderId
    amount int Api.Model.Transaction.amount
    currency string Api.Model.Transaction.currency
    type string Api.Model.Transaction.type
    url string Api.Model.Transaction.url
    testMode int Api.Model.Transaction.testMode
    result Api.Model.Transaction.result
    card Api.Model.Transaction.card
    buyer Api.Model.Transaction.buyer
    orderDetails Api.Model.Transaction.orderDetails
    schedules Api.Model.Transaction.schedules
    donation Array Api.Model.Transaction.donation
    metadata array Api.Model.Transaction.metadata

    Exemple

    DELETE https://paygreen.fr/api/{identifiant}/payins/transaction/{id}
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "tr15acde62ecfc1b8a2a1706b3f17a714e",
            "orderId": "test-123",
            "amount": "9900",
            "currency": "EUR",
            "type": "CASH",
            "url": "http:\/\/paygreen.fr\/paiement\/execute\/",
            "testMode": "0",
            "result": {
                "status": "SUCCESSED",
                "threeDSecureStatus": "3DS_SUCCESSED"
            },
            "card": {
                "number": "800025XXXXXX0004",
                "expiration": "0170",
                "country": "FRA"
            },
            "buyer": {
                "id": "123654789",
                "lastName": "Pay",
                "firstName": "Green",
                "email": "contact@paygreen.fr",
                "ipAddress": "127.0.0.1"
            },
            "metadata": "{key1:value1,key2:value2}"
        }
    }
  • Details

    Donne tous les détails d'une transaction

    Données envoyées

    Données retournées

    Attribut Type Description
    id string Api.Model.Transaction.id
    orderId string Api.Model.Transaction.orderId
    amount int Api.Model.Transaction.amount
    currency string Api.Model.Transaction.currency
    type string Api.Model.Transaction.type
    url string Api.Model.Transaction.url
    testMode int Api.Model.Transaction.testMode
    result Api.Model.Transaction.result
    card Api.Model.Transaction.card
    buyer Api.Model.Transaction.buyer
    orderDetails Api.Model.Transaction.orderDetails
    schedules Api.Model.Transaction.schedules
    donation Array Api.Model.Transaction.donation
    metadata array Api.Model.Transaction.metadata

    Exemple

    GET https://paygreen.fr/api/{identifiant}/payins/transaction/get/{id}
    
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "tr15acde62ecfc1b8a2a1706b3f17a714e",
            "orderId": "test-123",
            "amount": "9900",
            "currency": "EUR",
            "type": "CASH",
            "url": "http:\/\/paygreen.fr\/paiement\/execute\/",
            "testMode": "0",
            "result": {
                "status": "SUCCESSED",
                "threeDSecureStatus": "3DS_SUCCESSED"
            },
            "card": {
                "number": "800025XXXXXX0004",
                "expiration": "0170",
                "country": "FRA"
            },
            "buyer": {
                "id": "123654789",
                "lastName": "Pay",
                "firstName": "Green",
                "email": "contact@paygreen.fr",
                "ipAddress": "127.0.0.1"
            },
            "metadata": "{key1:value1,key2:value2}"
        }
    }
  • Paiement comptant

    Permet de génerer un paiement de type comptant

    Données envoyées

    Valeurs envoyées par POST Api.Transaction.cash
    Attribut Type Requis Description
    orderId string Oui Api.Transaction.cash.orderId
    amount int Oui Api.Transaction.cash.amount
    currency string Oui Api.Transaction.cash.currency
    returned_url string Non Api.Transaction.cash.returned_url
    notified_url string Non Api.Transaction.cash.notified_url
    metadata array Non Api.Transaction.cash.metadata

    Données retournées

    Attribut Type Description
    id string Api.Model.Transaction.id
    orderId string Api.Model.Transaction.orderId
    amount int Api.Model.Transaction.amount
    currency string Api.Model.Transaction.currency
    type string Api.Model.Transaction.type
    url string Api.Model.Transaction.url
    testMode int Api.Model.Transaction.testMode
    result Api.Model.Transaction.result
    card Api.Model.Transaction.card
    buyer Api.Model.Transaction.buyer
    orderDetails Api.Model.Transaction.orderDetails
    schedules Api.Model.Transaction.schedules
    donation Array Api.Model.Transaction.donation
    metadata array Api.Model.Transaction.metadata

    Exemple

    POST https://paygreen.fr/api/{identifiant}/payins/transaction/cash
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "orderId": "123456",
        "amount": "9000",
        "currency": "EUR",
        "returned_url": "http:\/\/example.com\/retour-client",
        "notified_url": "http:\/\/example.com\/retour-server",
        "buyer": {
            "id": "123654789",
            "lastName": "Pay",
            "firstName": "Green",
            "email": "contact@paygreen.fr"
        },
        "metadata": "{key1:value1,key2:value2}"
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "tr15acde62ecfc1b8a2a1706b3f17a714e",
            "orderId": "test-123",
            "amount": "9900",
            "currency": "EUR",
            "type": "CASH",
            "url": "http:\/\/paygreen.fr\/paiement\/execute\/",
            "testMode": "0",
            "result": {
                "status": "SUCCESSED",
                "threeDSecureStatus": "3DS_SUCCESSED"
            },
            "card": {
                "number": "800025XXXXXX0004",
                "expiration": "0170",
                "country": "FRA"
            },
            "buyer": {
                "id": "123654789",
                "lastName": "Pay",
                "firstName": "Green",
                "email": "contact@paygreen.fr",
                "ipAddress": "127.0.0.1"
            },
            "metadata": "{key1:value1,key2:value2}"
        }
    }
  • Paiement récurrent

    Permet de génerer un paiement de type récurrent ou X fois sans frais

    Données envoyées

    Valeurs envoyées par POST Api.Transaction.subscription
    Attribut Type Requis Description
    orderId string Oui Api.Transaction.subscription.orderId
    amount int Oui Api.Transaction.subscription.amount
    currency string Oui Api.Transaction.subscription.currency
    returned_url string Non Api.Transaction.subscription.returned_url
    notified_url string Non Api.Transaction.subscription.notified_url

    Données retournées

    Attribut Type Description
    id string Api.Model.Transaction.id
    orderId string Api.Model.Transaction.orderId
    amount int Api.Model.Transaction.amount
    currency string Api.Model.Transaction.currency
    type string Api.Model.Transaction.type
    url string Api.Model.Transaction.url
    testMode int Api.Model.Transaction.testMode
    result Api.Model.Transaction.result
    card Api.Model.Transaction.card
    buyer Api.Model.Transaction.buyer
    orderDetails Api.Model.Transaction.orderDetails
    schedules Api.Model.Transaction.schedules
    donation Array Api.Model.Transaction.donation
    metadata array Api.Model.Transaction.metadata

    Exemple

    POST https://paygreen.fr/api/{identifiant}/payins/transaction/subscription
    Accept: application/json
    Content-Type: application/json
    Authorization: Bearer <identifiant-unique>
    
    {
        "orderId": "123456",
        "amount": "9000",
        "currency": "EUR",
        "returned_url": "http:\/\/example.com\/retour-client",
        "notified_url": "http:\/\/example.com\/retour-server",
        "buyer": {
            "id": "123654789",
            "lastName": "Pay",
            "firstName": "Green",
            "email": "contact@paygreen.fr"
        },
        "orderDetails": {
            "cycle": 40,
            "count": 3
        }
    }
    
    {
        "success": true,
        "message": "",
        "code": 0,
        "data": {
            "id": "tr15acde62ecfc1b8a2a1706b3f17a714e",
            "orderId": "test-123",
            "amount": "9900",
            "currency": "EUR",
            "type": "CASH",
            "url": "http:\/\/paygreen.fr\/paiement\/execute\/",
            "testMode": "0",
            "result": {
                "status": "SUCCESSED",
                "threeDSecureStatus": "3DS_SUCCESSED"
            },
            "card": {
                "number": "800025XXXXXX0004",
                "expiration": "0170",
                "country": "FRA"
            },
            "buyer": {
                "id": "123654789",
                "lastName": "Pay",
                "firstName": "Green",
                "email": "contact@paygreen.fr",
                "ipAddress": "127.0.0.1"
            },
            "metadata": "{key1:value1,key2:value2}"
        }
    }