CheckoutsApi.md

zipMoney\CheckoutsApi

All URIs are relative to https://api.zipmoney.com.au/merchant/v1

Method	HTTP request	Description
checkoutsCreate	POST /checkouts	Create a checkout
checkoutsGet	GET /checkouts/{id}	Retrieve a checkout

checkoutsCreate

\zipMoney\Model\Checkout checkoutsCreate($body)

Create a checkout

Creates a zipMoney checkout. During the checkout process a customer can apply for credit decisioning in real-time. This means the checkout needs to represent a good picture of known customer details along with order information and the checkout entity represents this as a resource. For more information on how to checkout with zipMoney see the #model:Z2QcrzRGHACY8wM6G guide.

Example

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

// Configure API key authorization: Authorization
zipMoney\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// zipMoney\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new zipMoney\Api\CheckoutsApi();
$body = new \zipMoney\Model\CreateCheckoutRequest(); // \zipMoney\Model\CreateCheckoutRequest | 

try {
    $result = $api_instance->checkoutsCreate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckoutsApi->checkoutsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\zipMoney\Model\CreateCheckoutRequest		[optional]

Return type

\zipMoney\Model\Checkout

Authorization

Authorization

HTTP request headers

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

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

checkoutsGet

\zipMoney\Model\Checkout checkoutsGet($id)

Retrieve a checkout

Retrieves a previously created checkout by id.

Example

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

// Configure API key authorization: Authorization
zipMoney\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// zipMoney\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new zipMoney\Api\CheckoutsApi();
$id = "id_example"; // string | 

try {
    $result = $api_instance->checkoutsGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckoutsApi->checkoutsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string

Return type

\zipMoney\Model\Checkout

Authorization

Authorization

HTTP request headers

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

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