Skip to content

Latest commit

 

History

History
267 lines (189 loc) · 9.57 KB

CardsApi.md

File metadata and controls

267 lines (189 loc) · 9.57 KB

Swagger\Client\CardsApi

All URIs are relative to https://rest.paycomet.com

Method HTTP request Description
addUser POST /v1/cards Tokenizes a card. Either card number and CVC2 or jetToken are required. For you to send directly the card data you should be PCI certified or the accepting the requirement to submit quarterly SAQ-AEP and get ASV scans. For most users is strongly recommended getting the jetToken with JETIFRAME or using GET integration to register the cards instead of REST.
editUser POST /v1/cards/edit Changes the expiry date, cvc2 or both
infoUser POST /v1/cards/info Get card info
physicalAddCard POST /v1/cards/physical Tokenize a card by physical encrypted data
removeUser POST /v1/cards/delete Removes a card

addUser

\Swagger\Client\Model\InlineResponse2001 addUser($body, $paycomet_api_token)

Tokenizes a card. Either card number and CVC2 or jetToken are required. For you to send directly the card data you should be PCI certified or the accepting the requirement to submit quarterly SAQ-AEP and get ASV scans. For most users is strongly recommended getting the jetToken with JETIFRAME or using GET integration to register the cards instead of REST.

This method supposes the registration of the card in PAYCOMET, it is not valid for subsequent charges with the exception of MIT. To register the card against the processor for subsequent recurring charges, it is necessary to charge for a secure environment, regardless of the amount.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\CardsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\V1CardsBody(); // \Swagger\Client\Model\V1CardsBody | 
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Token actions privilege required)

try {
    $result = $apiInstance->addUser($body, $paycomet_api_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardsApi->addUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\V1CardsBody [optional]
paycomet_api_token string PAYCOMET API key (Token actions privilege required) [optional]

Return type

\Swagger\Client\Model\InlineResponse2001

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editUser

\Swagger\Client\Model\InlineResponse2001 editUser($body, $paycomet_api_token)

Changes the expiry date, cvc2 or both

edit_user

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\CardsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\CardsEditBody(); // \Swagger\Client\Model\CardsEditBody | 
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Token actions privilege required)

try {
    $result = $apiInstance->editUser($body, $paycomet_api_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardsApi->editUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\CardsEditBody [optional]
paycomet_api_token string PAYCOMET API key (Token actions privilege required) [optional]

Return type

\Swagger\Client\Model\InlineResponse2001

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

infoUser

\Swagger\Client\Model\InlineResponse2002 infoUser($body, $paycomet_api_token)

Get card info

Info about an user card.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\CardsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\CardsInfoBody(); // \Swagger\Client\Model\CardsInfoBody | 
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Query privilege required)

try {
    $result = $apiInstance->infoUser($body, $paycomet_api_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardsApi->infoUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\CardsInfoBody [optional]
paycomet_api_token string PAYCOMET API key (Query privilege required) [optional]

Return type

\Swagger\Client\Model\InlineResponse2002

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

physicalAddCard

\Swagger\Client\Model\InlineResponse2004 physicalAddCard($body, $paycomet_api_token)

Tokenize a card by physical encrypted data

cards_physical

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\CardsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\CardsPhysicalBody(); // \Swagger\Client\Model\CardsPhysicalBody | 
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Token actions privilege required)

try {
    $result = $apiInstance->physicalAddCard($body, $paycomet_api_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardsApi->physicalAddCard: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\CardsPhysicalBody [optional]
paycomet_api_token string PAYCOMET API key (Token actions privilege required) [optional]

Return type

\Swagger\Client\Model\InlineResponse2004

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeUser

\Swagger\Client\Model\InlineResponse2003 removeUser($body, $paycomet_api_token)

Removes a card

Deletes the user.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\CardsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\CardsDeleteBody(); // \Swagger\Client\Model\CardsDeleteBody | 
$paycomet_api_token = "paycomet_api_token_example"; // string | PAYCOMET API key (Token actions privilege required)

try {
    $result = $apiInstance->removeUser($body, $paycomet_api_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CardsApi->removeUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\CardsDeleteBody [optional]
paycomet_api_token string PAYCOMET API key (Token actions privilege required) [optional]

Return type

\Swagger\Client\Model\InlineResponse2003

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]