BillaBear\PaymentDetailsApi

All URIs are relative to https://{customerId}.billabear.cloud/api/v1

Method	HTTP request	Description
completeFrontendPaymentDetails	POST /customer/{customerId}/payment-methods/frontend-payment-token	Complete Frontend Detail Collection
deletePaymentDetails	DELETE /payment-methods/{paymentDetailsId}	Delete
deletePaymentDetailsCustomer	DELETE /customer/{customerId}/payment-methods/{paymentDetailsId}	Delete With Customer
getPaymentDetails	GET /payment-methods/{paymentDetailsId}	Fetch
listPaymentDetails	GET /customer/{customerId}/payment-methods	List Customer's Payment Details
makeDefaultPaymentDetails	POST /payment-methods/{paymentDetailsId}/default	Make Default
makeDefaultPaymentDetailsCustomer	POST /customer/{customerId}/payment-methods/{paymentDetailsId}/default	Make Default With Customer
startFrontendPaymentDetails	GET /customer/{customerId}/payment-methods/frontend-payment-token	Start Frontend Detail Collection

completeFrontendPaymentDetails

\BillaBear\Model\PaymentDetails completeFrontendPaymentDetails($body, $customer_id)

Complete Frontend Detail Collection

Complete frontend payment details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = BillaBear\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BillaBear\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new BillaBear\Api\PaymentDetailsApi(
    // 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(),
    $config
);
$body = new \BillaBear\Model\FrontendToken(); // \BillaBear\Model\FrontendToken | 
$customer_id = "customer_id_example"; // string | The id of the customer to retrieve

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

Parameters

Name	Type	Description	Notes
body	\BillaBear\Model\FrontendToken
customer_id	string	The id of the customer to retrieve

Return type

\BillaBear\Model\PaymentDetails

Authorization

ApiKeyAuth

HTTP request headers

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

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

deletePaymentDetails

deletePaymentDetails($payment_details_id)

Delete

Delete Payment Details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = BillaBear\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BillaBear\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new BillaBear\Api\PaymentDetailsApi(
    // 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(),
    $config
);
$payment_details_id = "payment_details_id_example"; // string | The id of the payment details

try {
    $apiInstance->deletePaymentDetails($payment_details_id);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->deletePaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
payment_details_id	string	The id of the payment details

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

deletePaymentDetailsCustomer

deletePaymentDetailsCustomer($customer_id, $payment_details_id)

Delete With Customer

Delete Payment Details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = BillaBear\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BillaBear\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new BillaBear\Api\PaymentDetailsApi(
    // 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(),
    $config
);
$customer_id = "customer_id_example"; // string | The id of the customer to retrieve
$payment_details_id = "payment_details_id_example"; // string | The id of the payment details

try {
    $apiInstance->deletePaymentDetailsCustomer($customer_id, $payment_details_id);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->deletePaymentDetailsCustomer: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
customer_id	string	The id of the customer to retrieve
payment_details_id	string	The id of the payment details

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getPaymentDetails

\BillaBear\Model\PaymentDetails getPaymentDetails($payment_details_id)

Fetch

Fetch the payment cards

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = BillaBear\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BillaBear\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new BillaBear\Api\PaymentDetailsApi(
    // 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(),
    $config
);
$payment_details_id = "payment_details_id_example"; // string | The id of the payment details

try {
    $result = $apiInstance->getPaymentDetails($payment_details_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
payment_details_id	string	The id of the payment details

Return type

\BillaBear\Model\PaymentDetails

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

listPaymentDetails

\BillaBear\Model\InlineResponse2007 listPaymentDetails($customer_id)

List Customer's Payment Details

List all customers

Added in version 1.1

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = BillaBear\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BillaBear\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new BillaBear\Api\PaymentDetailsApi(
    // 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(),
    $config
);
$customer_id = "customer_id_example"; // string | The id of the customer to retrieve

try {
    $result = $apiInstance->listPaymentDetails($customer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->listPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
customer_id	string	The id of the customer to retrieve

Return type

\BillaBear\Model\InlineResponse2007

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

makeDefaultPaymentDetails

makeDefaultPaymentDetails($customer_id, $payment_details_id)

Make Default

Delete Payment Details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = BillaBear\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BillaBear\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new BillaBear\Api\PaymentDetailsApi(
    // 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(),
    $config
);
$customer_id = "customer_id_example"; // string | The id of the customer to retrieve
$payment_details_id = "payment_details_id_example"; // string | The id of the payment details

try {
    $apiInstance->makeDefaultPaymentDetails($customer_id, $payment_details_id);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->makeDefaultPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
customer_id	string	The id of the customer to retrieve
payment_details_id	string	The id of the payment details

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

makeDefaultPaymentDetailsCustomer

makeDefaultPaymentDetailsCustomer($customer_id, $payment_details_id)

Make Default With Customer

Delete Payment Details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = BillaBear\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BillaBear\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new BillaBear\Api\PaymentDetailsApi(
    // 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(),
    $config
);
$customer_id = "customer_id_example"; // string | The id of the customer to retrieve
$payment_details_id = "payment_details_id_example"; // string | The id of the payment details

try {
    $apiInstance->makeDefaultPaymentDetailsCustomer($customer_id, $payment_details_id);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->makeDefaultPaymentDetailsCustomer: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
customer_id	string	The id of the customer to retrieve
payment_details_id	string	The id of the payment details

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

startFrontendPaymentDetails

\BillaBear\Model\FrontendToken startFrontendPaymentDetails($customer_id)

Start Frontend Detail Collection

Start frontend payment details

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
$config = BillaBear\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BillaBear\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new BillaBear\Api\PaymentDetailsApi(
    // 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(),
    $config
);
$customer_id = "customer_id_example"; // string | The id of the customer to retrieve

try {
    $result = $apiInstance->startFrontendPaymentDetails($customer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->startFrontendPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
customer_id	string	The id of the customer to retrieve

Return type

\BillaBear\Model\FrontendToken

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

PaymentDetailsApi.md

Latest commit

History

PaymentDetailsApi.md

File metadata and controls

BillaBear\PaymentDetailsApi

completeFrontendPaymentDetails

Example

Parameters

Return type

Authorization

HTTP request headers

deletePaymentDetails

Example

Parameters

Return type

Authorization

HTTP request headers

deletePaymentDetailsCustomer

Example

Parameters

Return type

Authorization

HTTP request headers

getPaymentDetails

Example

Parameters

Return type

Authorization

HTTP request headers

listPaymentDetails

Example

Parameters

Return type

Authorization

HTTP request headers

makeDefaultPaymentDetails

Example

Parameters

Return type

Authorization

HTTP request headers

makeDefaultPaymentDetailsCustomer

Example

Parameters

Return type

Authorization

HTTP request headers

startFrontendPaymentDetails

Example

Parameters

Return type

Authorization

HTTP request headers