# 2checkout/php-examples architecture

> Architecture diagram of the GitHub repository 2checkout/php-examples, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/2checkout/php-examples
- Repository: https://github.com/2checkout/php-examples

## Overview

This repository is a PHP 2Checkout Payment API tutorial and binding library. A buyer enters card details in the browser; the documented JavaScript tokenizes them, then submits the token to the PHP handler, which authorizes a charge and displays the response. The library also exposes sale management, product, coupon and option APIs, plus return and INS hash verification. The flow is evidenced by the README and sampled PHP sources; the browser-to-handler integration and some other modules are documented or indexed but not sampled in full.

Main entry points: [`payment-api/lib/Twocheckout/Api/TwocheckoutUtil.php`](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutUtil.php) (Response utilities), [`payment-api/lib/Twocheckout/Api/TwocheckoutApi.php`](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutApi.php) (API requester), [`payment-api/index.html`](https://github.com/2checkout/php-examples/blob/master/payment-api/index.html) (Card form), [`payment-api/lib/Twocheckout/Api/TwocheckoutSale.php`](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutSale.php) (Sale operations)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_tutorial["Payment tutorial"]
  node_form["Card form<br/>[index.html]"]
  node_tokenizer["Tokenization"]
end

subgraph group_runtime["Payment runtime"]
  node_handler["Charge handler<br/>[payment.php]"]
  node_config["SDK configuration<br/>[Twocheckout.php]"]
  node_charge["Charge methods"]
  node_requester["API requester<br/>[TwocheckoutApi.php]"]
  node_response["Response utilities"]
  node_errors["API errors"]
  node_messages["Result messages"]
end

subgraph group_management["Merchant APIs"]
  node_sales["Sale operations"]
  node_products["Product operations"]
  node_coupons["Coupon operations"]
  node_options["Option operations"]
  node_account["Account API"]
  node_payment["Payment API"]
end

subgraph group_verification["Callback verification"]
  node_returns["Return verification"]
  node_notifications["INS verification"]
end

node_buyer(("Buyer"))
node_gateway{{"2Checkout API"}}

node_buyer -->|"enters card"| node_form
node_form -->|"requests token"| node_tokenizer
node_tokenizer -->|"tokenizes card"| node_gateway
node_tokenizer -->|"sets token"| node_form
node_form -->|"posts token"| node_handler
node_handler -->|"sets credentials"| node_config
node_handler -->|"authorizes charge"| node_charge
node_charge -->|"sends request"| node_requester
node_requester -->|"calls API"| node_gateway
node_charge -->|"formats result"| node_response
node_response -->|"raises errors"| node_errors
node_sales -->|"sends requests"| node_requester
node_sales -->|"formats result"| node_response
node_sales -->|"builds messages"| node_messages
node_products -->|"sends requests"| node_requester
node_products -->|"formats result"| node_response
node_coupons -->|"sends requests"| node_requester
node_coupons -->|"formats result"| node_response
node_options -->|"sends requests"| node_requester
node_options -->|"formats result"| node_response
node_returns -->|"builds result"| node_messages
node_returns -->|"formats result"| node_response
node_notifications -->|"builds result"| node_messages
node_notifications -->|"formats result"| node_response
node_config -.->|"provides settings"| node_requester

click node_form "https://github.com/2checkout/php-examples/blob/master/payment-api/index.html"
click node_handler "https://github.com/2checkout/php-examples/blob/master/payment-api/payment.php"
click node_config "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout.php"
click node_charge "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/TwocheckoutCharge.php"
click node_requester "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutApi.php"
click node_response "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutUtil.php"
click node_errors "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutError.php"
click node_sales "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutSale.php"
click node_products "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutProduct.php"
click node_coupons "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutCoupon.php"
click node_options "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutOption.php"
click node_account "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutAccount.php"
click node_payment "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutPayment.php"
click node_returns "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/TwocheckoutReturn.php"
click node_notifications "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/TwocheckoutNotification.php"
click node_messages "https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/TwocheckoutMessage.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_form,node_tokenizer toneBlue
class node_handler,node_config,node_charge,node_requester,node_response,node_errors,node_messages toneAmber
class node_sales,node_products,node_coupons,node_options,node_account,node_payment,node_gateway toneMint
class node_returns,node_notifications toneRose
class node_buyer toneIndigo
```

## Components

### Payment tutorial

- [Card form](https://github.com/2checkout/php-examples/blob/master/payment-api/index.html): `payment-api/index.html`
- **Tokenization**

### Payment runtime

- [Charge handler](https://github.com/2checkout/php-examples/blob/master/payment-api/payment.php): `payment-api/payment.php`
- [SDK configuration](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout.php): `payment-api/lib/Twocheckout.php`
- [Charge methods](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/TwocheckoutCharge.php): `payment-api/lib/Twocheckout/TwocheckoutCharge.php`
- [API requester](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutApi.php): `payment-api/lib/Twocheckout/Api/TwocheckoutApi.php`
- [Response utilities](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutUtil.php): `payment-api/lib/Twocheckout/Api/TwocheckoutUtil.php`
- [API errors](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutError.php): `payment-api/lib/Twocheckout/Api/TwocheckoutError.php`
- [Result messages](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/TwocheckoutMessage.php): `payment-api/lib/Twocheckout/TwocheckoutMessage.php`

### Merchant APIs

- [Sale operations](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutSale.php): `payment-api/lib/Twocheckout/Api/TwocheckoutSale.php`
- [Product operations](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutProduct.php): `payment-api/lib/Twocheckout/Api/TwocheckoutProduct.php`
- [Coupon operations](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutCoupon.php): `payment-api/lib/Twocheckout/Api/TwocheckoutCoupon.php`
- [Option operations](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutOption.php): `payment-api/lib/Twocheckout/Api/TwocheckoutOption.php`
- [Account API](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutAccount.php): `payment-api/lib/Twocheckout/Api/TwocheckoutAccount.php`
- [Payment API](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/Api/TwocheckoutPayment.php): `payment-api/lib/Twocheckout/Api/TwocheckoutPayment.php`

### Callback verification

- [Return verification](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/TwocheckoutReturn.php): `payment-api/lib/Twocheckout/TwocheckoutReturn.php`
- [INS verification](https://github.com/2checkout/php-examples/blob/master/payment-api/lib/Twocheckout/TwocheckoutNotification.php): `payment-api/lib/Twocheckout/TwocheckoutNotification.php`

### Other components

- **Buyer**
- **2Checkout API**

## Connections

- Buyer → Card form: enters card (evidence: `README.md`)
- Card form → Tokenization: requests token (evidence: `README.md`)
- Tokenization → 2Checkout API: tokenizes card (evidence: `README.md`)
- Tokenization → Card form: sets token (evidence: `README.md`)
- Card form → Charge handler: posts token (evidence: `README.md`)
- Charge handler → SDK configuration: sets credentials (evidence: `payment-api/payment.php`)
- Charge handler → Charge methods: authorizes charge (evidence: `payment-api/payment.php`)
- Charge methods → API requester: sends request (evidence: `payment-api/lib/Twocheckout/TwocheckoutCharge.php`)
- API requester → 2Checkout API: calls API (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutApi.php`)
- Charge methods → Response utilities: formats result (evidence: `payment-api/lib/Twocheckout/TwocheckoutCharge.php`)
- Response utilities → API errors: raises errors (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutUtil.php`)
- Sale operations → API requester: sends requests (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutSale.php`)
- Sale operations → Response utilities: formats result (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutSale.php`)
- Sale operations → Result messages: builds messages (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutSale.php`)
- Product operations → API requester: sends requests (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutProduct.php`)
- Product operations → Response utilities: formats result (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutProduct.php`)
- Coupon operations → API requester: sends requests (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutCoupon.php`)
- Coupon operations → Response utilities: formats result (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutCoupon.php`)
- Option operations → API requester: sends requests (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutOption.php`)
- Option operations → Response utilities: formats result (evidence: `payment-api/lib/Twocheckout/Api/TwocheckoutOption.php`)
- Return verification → Result messages: builds result (evidence: `payment-api/lib/Twocheckout/TwocheckoutReturn.php`)
- Return verification → Response utilities: formats result (evidence: `payment-api/lib/Twocheckout/TwocheckoutReturn.php`)
- INS verification → Result messages: builds result (evidence: `payment-api/lib/Twocheckout/TwocheckoutNotification.php`)
- INS verification → Response utilities: formats result (evidence: `payment-api/lib/Twocheckout/TwocheckoutNotification.php`)
- SDK configuration → API requester: provides settings (evidence: `payment-api/lib/Twocheckout.php`)
