Introduzione
Questa sezione descrive il TID Welfare Platform API del gateway di pagamento.
TID Welfare Platform L'API è facile da implementare nel tuo software aziendale. La nostra API è un URL ben formattato, accetta richieste cURL, restituisce risposte JSON.
You can use the API in test mode, which does not affect your live data. The API key is use to authenticate the request and determines the request is valid payment or not. For test mode just use the sandbox URL and In case of live mode use the live URL from section Inizia Pagamento .
Valute Supportate
Questa sezione descrive le valute supportate TID Welfare Platform
TID Welfare Platform allows to make transaction with below currencies. Any new currency may update in future.
| Nome Valuta | Simbolo Valuta | Codice Valuta |
|---|---|---|
| Euro | € | EUR |
Ottieni la chiave API
Questa sezione spiega come ottenere la chiave API.
Accedi al tuo TID Welfare Platform Account commerciante If you don't have any ? Clicca Qui
Il passo successivo è trovare il API Key menù nella barra laterale della dashboard. Clicca il menù
Puoi trovare le chiavi API dove è Chiave Pubblica e Chiave Segreta Utilizzare queste chiavi per avviare la richiesta API. Puoi generare una nuova chiave API cliccando Genera Chiave API il pulsante. Ricorda di non condividere queste Chiavi con nessuno.
Inizia Pagamento
Questa sezione descrive il processo di inizializzazione del pagamento.
Per avviare il pagamento segui il codice di esempio e fai attenzione ai parametri. Dovrai effettuare una richiesta con i seguenti endpoints API.
Live End Point: https://welfare.devworks.it/payment/initiate
Test End Point: https://welfare.devworks.it/sandbox/payment/initiate
Mail Modalità Test: test_mode@mail.com
Verification Code modalità test: 222666
Richiedi modalità: POST
Richiedi end point con i seguenti parametri.
| Nome Parametro | Tipo Parametro | Descrizione |
|---|---|---|
| public_key | string (50) | Necessario La tua Chiave Pubblica API |
| identifier | string (20) | Necessario L'identificatore serve fondamentalmente per identificare il pagamento alla fine |
| currency | string (4) | Necessario Il Codice Valuta deve essere scritto in maiuscolo. es. USD,EUR |
| amount | decimal | Necessario Importo di pagamento. |
| details | string (100) | Necessario Dettagli del tuo pagamento o delle tue transazioni. |
| ipn_url | string | Necessario L'URL delle notifiche istantanee di pagamento. |
| success_url | string | Necessario URL di reindirizzamento del pagamento effettuato correttamente. |
| cancel_url | string | Necessario URL di reindirizzamento della cancellazione del pagamento. |
| site_logo | string/url | Necessario Il logo della tua Azienda. |
| checkout_theme | string | Opzionale Checkout form theme dark/light. Default theme is light |
| customer_name | string (30) | Necessario Nome del Cliente. |
| customer_email | string (30) | Necessario Email del Cliente. |
<?php
$parameters = [
'identifier' => 'DFU80XZIKS',
'currency' => 'USD',
'amount' => 100.00,
'details' => 'Purchase T-shirt',
'ipn_url' => 'http://example.com/ipn_url.php',
'cancel_url' => 'http://example.com/cancel_url.php',
'success_url' => 'http://example.com/success_url.php',
'public_key' => 'your_public_key',
'site_logo' => 'https://welfare.devworks.it/assets/images/logoIcon/logo.png',
'checkout_theme' => 'dark',
'customer_name' => 'John Doe',
'customer_email' => 'john@mail.com',
];
//live end point
$url = 'https://welfare.devworks.it/payment/initiate';
//test end point
$url = 'https://welfare.devworks.it/sandbox/payment/initiate';
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS, $parameters);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
//$result contains the response back.
?>
//Error Response.
{
"error": "true",
"message": "Invalid api key"
}
//Success Response.
{
"success": "ok",
"message": "Payment Initiated. Redirect to url.",
"url":"http://example.com/initiate/payment/checkout?payment_id=eJSAASDxdrt4DASDASVNASJA7893232432cvmdsamnvASF"
}Convalida Pagamento e IPN
Questa sezione descrive il processo per ricevere la notifica di pagamento istantaneo.
Per avviare il pagamento segui il codice di esempio e fai attenzione ai parametri. Dovrai effettuare una richiesta con i seguenti endpoints API.
End Point: L'ipn url della tua applicazione aziendale.
Richiedi modalità: POST
Otterrai i seguenti parametri.
| Nome Parametro | Descrizione |
|---|---|
| status | Stato del pagamento. |
| identifier | L'identificatore serve fondamentalmente per identificare il pagamento alla fine |
| signature | Una firma hash per verificare il tuo pagamento |
| data | I dati contengono alcune informazioni di base con addebiti, importo, valuta, ID transazione di pagamento. |
<?php
//Receive the response parameter
$status = $_POST['status'];
$signature = $_POST['signature'];
$identifier = $_POST['identifier'];
$data = $_POST['data'];
// Generate your signature
$customKey = $data['amount'].$identifier;
$secret = 'YOUR_SECRET_KEY';
$mySignature = strtoupper(hash_hmac('sha256', $customKey , $secret));
$myIdentifier = 'YOUR_GIVEN_IDENTIFIER';
if($status == "success" && $signature == $mySignature && $identifier == $myIdentifier){
//your operation logic
}
?>