README

A PHP client library for the PAY.JP v2 API. This SDK provides a convenient way to interact with PAY.JP's payment processing services from PHP applications.

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 2.0.0
Package version: 1.0.1
Generator version: 7.14.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 8.1 and later.

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

composer require payjp/payjpv2-php

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/payjpv2-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure Bearer authorization with API key
$config = PAYJPV2\Configuration::getDefaultConfiguration()
    ->setAccessToken(getenv('PAYJP_API_KEY'));

$customersApi = new PAYJPV2\Api\CustomersApi(
    // 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
);

try {
    // Create a customer
    $createRequest = new \PAYJPV2\Model\CustomerCreateRequest();
    $createRequest->setEmail('test@example.com');
    $createRequest->setDescription('Test customer');

    $customer = $customersApi->createCustomer($createRequest);
    echo "Created customer: " . $customer->getId() . "\n";

    // List customers
    $customerList = $customersApi->getAllCustomers(limit: 10);
    foreach ($customerList->getData() as $c) {
        echo "  - " . $c->getId() . " (" . ($c->getEmail() ?? 'no email') . ")\n";
    }

} catch (Exception $e) {
    echo 'Exception when calling CustomersApi: ', $e->getMessage(), PHP_EOL;
}

Documentation for API Endpoints

All URIs are relative to https://api.pay.jp

Class	Method	HTTP request	Description
BalancesApi	createBalanceUrl	POST /v2/balances/{balance_id}/balance_urls	Create Balance Url
BalancesApi	getAllBalances	GET /v2/balances	Get All Balances
BalancesApi	getBalance	GET /v2/balances/{balance_id}	Get Balance
CheckoutSessionsApi	createCheckoutSession	POST /v2/checkout/sessions	Create Checkout Session
CheckoutSessionsApi	getAllCheckoutSessionLineItems	GET /v2/checkout/sessions/{checkout_session_id}/line_items	Get All Checkout Session Line Items
CheckoutSessionsApi	getAllCheckoutSessions	GET /v2/checkout/sessions	Get All Checkout Sessions
CheckoutSessionsApi	getCheckoutSession	GET /v2/checkout/sessions/{checkout_session_id}	Get Checkout Session
CheckoutSessionsApi	updateCheckoutSession	POST /v2/checkout/sessions/{checkout_session_id}	Update Checkout Session
CustomersApi	createCustomer	POST /v2/customers	Create Customer
CustomersApi	deleteCustomer	DELETE /v2/customers/{customer_id}	Delete Customer
CustomersApi	getAllCustomers	GET /v2/customers	Get All Customers
CustomersApi	getCustomer	GET /v2/customers/{customer_id}	Get Customer
CustomersApi	getCustomerPaymentMethods	GET /v2/customers/{customer_id}/payment_methods	Get Customer Payment Methods
CustomersApi	updateCustomer	POST /v2/customers/{customer_id}	Update Customer
EventsApi	getAllEvents	GET /v2/events	Get All Events
EventsApi	getEvent	GET /v2/events/{event_id}	Get Event
PaymentFlowsApi	cancelPaymentFlow	POST /v2/payment_flows/{payment_flow_id}/cancel	Cancel Payment Flow
PaymentFlowsApi	capturePaymentFlow	POST /v2/payment_flows/{payment_flow_id}/capture	Capture Payment Flow
PaymentFlowsApi	confirmPaymentFlow	POST /v2/payment_flows/{payment_flow_id}/confirm	Confirm Payment Flow
PaymentFlowsApi	createPaymentFlow	POST /v2/payment_flows	Create Payment Flow
PaymentFlowsApi	getAllPaymentFlows	GET /v2/payment_flows	Get All Payment Flows
PaymentFlowsApi	getPaymentFlow	GET /v2/payment_flows/{payment_flow_id}	Get Payment Flow
PaymentFlowsApi	getPaymentFlowRefunds	GET /v2/payment_flows/{payment_flow_id}/refunds	Get Payment Flow Refunds
PaymentFlowsApi	updatePaymentFlow	POST /v2/payment_flows/{payment_flow_id}	Update Payment Flow
PaymentMethodConfigurationsApi	getAllPaymentMethodConfigurations	GET /v2/payment_method_configurations	Get All Payment Method Configurations
PaymentMethodConfigurationsApi	getPaymentMethodConfiguration	GET /v2/payment_method_configurations/{payment_method_configuration_id}	Get Payment Method Configuration
PaymentMethodConfigurationsApi	updatePaymentMethodConfiguration	POST /v2/payment_method_configurations/{payment_method_configuration_id}	Update Payment Method Configuration
PaymentMethodsApi	attachPaymentMethod	POST /v2/payment_methods/{payment_method_id}/attach	Attach Payment Method
PaymentMethodsApi	createPaymentMethod	POST /v2/payment_methods	Create Payment Method
PaymentMethodsApi	detachPaymentMethod	POST /v2/payment_methods/{payment_method_id}/detach	Detach Payment Method
PaymentMethodsApi	getAllPaymentMethods	GET /v2/payment_methods	Get All Payment Methods
PaymentMethodsApi	getPaymentMethod	GET /v2/payment_methods/{payment_method_id}	Get Payment Method
PaymentMethodsApi	getPaymentMethodByCard	GET /v2/payment_methods/cards/{card_id}	Get Payment Method By Card
PaymentMethodsApi	updatePaymentMethod	POST /v2/payment_methods/{payment_method_id}	Update Payment Method
PaymentRefundsApi	createPaymentRefund	POST /v2/payment_refunds	Create Payment Refund
PaymentRefundsApi	getAllPaymentRefunds	GET /v2/payment_refunds	Get All Payment Refunds
PaymentRefundsApi	getPaymentRefund	GET /v2/payment_refunds/{payment_refund_id}	Get Payment Refund
PaymentRefundsApi	updatePaymentRefund	POST /v2/payment_refunds/{payment_refund_id}	Update Payment Refund
PaymentTransactionsApi	getAllPaymentTransactions	GET /v2/payment_transactions	Get All Payment Transactions
PaymentTransactionsApi	getPaymentTransaction	GET /v2/payment_transactions/{payment_transaction_id}	Get Payment Transaction
PricesApi	createPrice	POST /v2/prices	Create Price
PricesApi	getAllPrices	GET /v2/prices	Get All Prices
PricesApi	getPrice	GET /v2/prices/{price_id}	Get Price
PricesApi	updatePrice	POST /v2/prices/{price_id}	Update Price
ProductsApi	createProduct	POST /v2/products	Create Product
ProductsApi	deleteProduct	DELETE /v2/products/{product_id}	Delete Product
ProductsApi	getAllProducts	GET /v2/products	Get All Products
ProductsApi	getProduct	GET /v2/products/{product_id}	Get Product
ProductsApi	updateProduct	POST /v2/products/{product_id}	Update Product
SetupFlowsApi	cancelSetupFlow	POST /v2/setup_flows/{setup_flow_id}/cancel	Cancel Setup Flow
SetupFlowsApi	createSetupFlow	POST /v2/setup_flows	Create Setup Flow
SetupFlowsApi	getAllSetupFlows	GET /v2/setup_flows	Get All Setup Flows
SetupFlowsApi	getSetupFlow	GET /v2/setup_flows/{setup_flow_id}	Get Setup Flow
SetupFlowsApi	updateSetupFlow	POST /v2/setup_flows/{setup_flow_id}	Update Setup Flow
StatementsApi	createStatementUrl	POST /v2/statements/{statement_id}/statement_urls	Create Statement Url
StatementsApi	getAllStatements	GET /v2/statements	Get All Statements
StatementsApi	getStatement	GET /v2/statements/{statement_id}	Get Statement
TaxRatesApi	createTaxRate	POST /v2/tax_rates	Create Tax Rate
TaxRatesApi	getAllTaxRates	GET /v2/tax_rates	Get All Tax Rates
TaxRatesApi	getTaxRate	GET /v2/tax_rates/{tax_rate_id}	Get Tax Rate
TaxRatesApi	updateTaxRate	POST /v2/tax_rates/{tax_rate_id}	Update Tax Rate
TermsApi	getAllTerms	GET /v2/terms	Get All Terms
TermsApi	getTerm	GET /v2/terms/{term_id}	Get Term

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBasic

Type: HTTP basic authentication

HTTPBearer

Type: Bearer authentication

To use Bearer authentication, set your PAY.JP API key as the access token:

$config = PAYJPV2\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_PAYJP_API_KEY');

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package