PaymentMethods

List GET

Example with mandatory parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/documents/paymentmethods/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Example with all allowed parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/documents/paymentmethods/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Request

Response

Name	Type	Example	Description
id	int	12345	ID
title	string	Em Dinheiro	Description
change	int `1` - Yes `0` - No		Whether it allows change
type	string `NU` - Numerário `CC` - Cartão de Crédito `CD` - Cartão de Débito `CO` - Cartão Oferta `CS` - Compensação de Saldos C/C `DE` - Cartão de Pontos `TR` - Ticket Restaurante `MB` - Referência MB `OU` - Outro `CH` - Cheque Bancário `LC` - Letra Comercial `TB` - Transferência Bancária `PR` - Permuta de Bens `DNP` - Pagamento em conta corrente - entre 15 e 90 dias ou numa data específica `MBWAY` - MB WAY `ZARPH` - Zarph `ALICE` - Alice		Official type
status	string `on` - Active (default) `off` - Inactive		Whether is usable
order	int	1	Display order in a list
stores	collection		Store IDs where it is available. If empty, it will be available in all stores

Detail GET

Example with mandatory parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/documents/paymentmethods/12345/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Example with all allowed parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/documents/paymentmethods/12345/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Request

Response

Name	Type	Example	Description
id	int	12345	ID
title	string	Em Dinheiro	Description
change	int `1` - Yes `0` - No		Whether it allows change
type	string `NU` - Numerário `CC` - Cartão de Crédito `CD` - Cartão de Débito `CO` - Cartão Oferta `CS` - Compensação de Saldos C/C `DE` - Cartão de Pontos `TR` - Ticket Restaurante `MB` - Referência MB `OU` - Outro `CH` - Cheque Bancário `LC` - Letra Comercial `TB` - Transferência Bancária `PR` - Permuta de Bens `DNP` - Pagamento em conta corrente - entre 15 e 90 dias ou numa data específica `MBWAY` - MB WAY `ZARPH` - Zarph `ALICE` - Alice		Official type
status	string `on` - Active (default) `off` - Inactive		Whether is usable
order	int	1	Display order in a list
stores	collection		Store IDs where it is available. If empty, it will be available in all stores

Create POST

Example with all allowed parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/documents/paymentmethods/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$method  = 'POST';
$params  = array(
    'title'  => 'Em Dinheiro', 
    'change' => 1, 
    'type'   => 'NU', 
    'status' => 'on', 

);
$content = json_encode($params);
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $content);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($curl, CURLOPT_HTTPHEADER,
    array(
        "Content-type: application/json",
        "Content-Length: " . strlen($content),
    )
);
$result = curl_exec($curl);
?>

Request

Name	Type	Example	Description
title	string	Em Dinheiro	Description
change	int `1` - Yes (default) `0` - No		Whether it allows change
type	string `NU` - Numerário `CC` - Cartão de Crédito `CD` - Cartão de Débito `CO` - Cartão Oferta `CS` - Compensação de Saldos C/C `DE` - Cartão de Pontos `TR` - Ticket Restaurante `MB` - Referência MB `OU` - Outro `CH` - Cheque Bancário `LC` - Letra Comercial `TB` - Transferência Bancária `PR` - Permuta de Bens `DNP` - Pagamento em conta corrente - entre 15 e 90 dias ou numa data específica `MBWAY` - MB WAY `ZARPH` - Zarph `ALICE` - Alice		Official type
status	string `on` - Active (default) `off` - Inactive		Whether is usable

Response

Name	Type	Example	Description
order	int	1	Display order in a list
id	int	12345	ID
title	string	Em Dinheiro	Description
change	int `1` - Yes `0` - No		Whether it allows change
type	string `NU` - Numerário `CC` - Cartão de Crédito `CD` - Cartão de Débito `CO` - Cartão Oferta `CS` - Compensação de Saldos C/C `DE` - Cartão de Pontos `TR` - Ticket Restaurante `MB` - Referência MB `OU` - Outro `CH` - Cheque Bancário `LC` - Letra Comercial `TB` - Transferência Bancária `PR` - Permuta de Bens `DNP` - Pagamento em conta corrente - entre 15 e 90 dias ou numa data específica `MBWAY` - MB WAY `ZARPH` - Zarph `ALICE` - Alice		Official type
status	string `on` - Active (default) `off` - Inactive		Whether is usable
stores	collection		Store IDs where it is available. If empty, it will be available in all stores

API (v1.1)

List GET

Example with mandatory parameters

Example with all allowed parameters

Request

Response

Detail GET

Example with mandatory parameters

Example with all allowed parameters

Request

Response

Create POST

Example with all allowed parameters

Request

Response