Langsung ke konten utama

Documentation Index

Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt

Use this file to discover all available pages before exploring further.

SDK PHP menyediakan cara yang kuat dan fleksibel untuk mengintegrasikan Dodo Payments ke dalam aplikasi PHP Anda. Dibangun mengikuti standar PHP modern dengan autoloading PSR-4, ini menawarkan cakupan pengujian yang luas dan dokumentasi yang mendetail.
Perpustakaan API PHP Dodo Payments saat ini dalam beta. Kami sangat antusias Anda untuk mencobanya! Silakan bagikan saran, laporan bug, atau permintaan fitur dengan mengajukan sebuah issue.

​
Instalasi

composer require "dodopayments/client 6.7.1"

composer require "dodopayments/client 5.3.0"
SDK ini membutuhkan PHP 8.1.0 atau lebih tinggi dan Composer untuk manajemen dependensi.

​
Memulai dengan Cepat

Inisialisasi klien dan buat sesi checkout: 
<?php

use Dodopayments\Client;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

$checkoutSessionResponse = $client->checkoutSessions->create(
  productCart: [["productID" => "product_id", "quantity" => 1]]
);

var_dump($checkoutSessionResponse->session_id);
Simpan kunci API Anda dengan aman menggunakan variabel lingkungan. Jangan pernah mengeksposnya di basis kode Anda atau mengunggahnya ke kontrol versi.

​
Fitur Utama

PSR-4 Compliant

Mengikuti Rekomendasi Standar PHP untuk pengembangan PHP modern

Modern PHP

Dibangun untuk PHP 8.1+ dengan deklarasi tipe dan tipe strict

Extensive Testing

Cakupan pengujian menyeluruh untuk keandalan dan stabilitas

Exception Handling

Jenis pengecualian yang jelas untuk berbagai skenario kesalahan

​
Objek Nilai

SDK menggunakan parameter bernama untuk menentukan argumen opsional. Anda dapat menginisialisasi objek nilai menggunakan konstruktor statis with: 
<?php

use Dodopayments\Customers\AttachExistingCustomer;

// Recommended: Use static 'with' constructor with named parameters
$customer = AttachExistingCustomer::with(customerID: "customer_id");
Builder juga tersedia sebagai pola alternatif: 
<?php

use Dodopayments\Customers\AttachExistingCustomer;

// Alternative: Use builder pattern
$customer = (new AttachExistingCustomer)->withCustomerID("customer_id");

​
Konfigurasi

​
Konfigurasi Ulang

Kesalahan tertentu secara otomatis dicoba ulang 2 kali secara default dengan backoff eksponensial yang singkat. Kesalahan berikut memicu percobaan ulang otomatis:
  • Kesalahan koneksi (masalah konektivitas jaringan)
  • 408 Permintaan Timeout
  • 409 Konflik
  • 429 Batas Laju
  • 500+ Kesalahan Internal
  • Timeout
Konfigurasikan perilaku ulang secara global atau per permintaan: 
<?php

use Dodopayments\Client;
use Dodopayments\RequestOptions;

// Configure default for all requests (disable retries)
$client = new Client(maxRetries: 0);

// Or, configure per-request
$result = $client->checkoutSessions->create(
  productCart: [["productID" => "product_id", "quantity" => 1]],
  requestOptions: RequestOptions::with(maxRetries: 5),
);

​
Operasi Umum

​
Buat Sesi Checkout

Hasilkan sesi checkout: 
$session = $client->checkoutSessions->create(
  productCart: [
    ["productID" => "prod_123", "quantity" => 1]
  ],
  returnUrl: "https://yourdomain.com/return"
);

header('Location: ' . $session->url);

​
Kelola Pelanggan

Buat dan ambil informasi pelanggan: 
// Create a customer
$customer = $client->customers->create(
  email: "customer@example.com",
  name: "John Doe",
  metadata: [
    "user_id" => "12345"
  ]
);

// Retrieve customer
$customer = $client->customers->retrieve("cus_123");
echo "Customer: {$customer->name} ({$customer->email})";

​
Tangani Langganan

use Dodopayments\Customers\AttachExistingCustomer;
use Dodopayments\Payments\BillingAddress;

// Create a subscription
$subscription = $client->subscriptions->create(
  billing: BillingAddress::with(
    country: 'US',
    city: 'San Francisco',
    state: 'CA',
    street: '1 Market St',
    zipcode: '94105',
  ),
  customer: AttachExistingCustomer::with(customerID: 'cus_123'),
  productID: 'pdt_456',
  quantity: 1,
);

// Charge an on-demand subscription
// productPrice is in the lowest currency denomination (e.g., 2500 = $25.00 USD)
$charge = $client->subscriptions->charge(
  $subscription->subscription_id,
  productPrice: 2500,
);
billing memerlukan setidaknya kode ISO country dua huruf. Berikan AttachExistingCustomer::with(customerID: '...') untuk melampirkan pelanggan yang sudah ada, atau NewCustomer::with(email: '...', name: '...') untuk membuatnya. productPrice adalah dalam denominasi mata uang terendah.

​
Paginasi

Bekerja dengan respons daftar yang dipaginasi: 
$page = $client->payments->list();

var_dump($page);

// Fetch items from the current page
foreach ($page->getItems() as $item) {
  var_dump($item->brand_id);
}

// Auto-paginate: fetch items from all pages
foreach ($page->pagingEachItem() as $item) {
  var_dump($item->brand_id);
}

​
Penanganan Kesalahan

Ketika pustaka tidak dapat terhubung ke API atau menerima kode status non-sukses (4xx atau 5xx), subclass dari APIException akan dilemparkan: 
<?php

use Dodopayments\Core\Exceptions\APIConnectionException;
use Dodopayments\Core\Exceptions\RateLimitException;
use Dodopayments\Core\Exceptions\APIStatusException;

try {
  $checkoutSessionResponse = $client->checkoutSessions->create(
    productCart: [["productID" => "product_id", "quantity" => 1]]
  );
} catch (APIConnectionException $e) {
  echo "The server could not be reached", PHP_EOL;
  var_dump($e->getPrevious());
} catch (RateLimitException $_) {
  echo "A 429 status code was received; we should back off a bit.", PHP_EOL;
} catch (APIStatusException $e) {
  echo "Another non-200-range status code was received", PHP_EOL;
  echo $e->getMessage();
}

​
Jenis Kesalahan

PenyebabJenis Kesalahan
HTTP 400BadRequestException
HTTP 401AuthenticationException
HTTP 403PermissionDeniedException
HTTP 404NotFoundException
HTTP 409ConflictException
HTTP 422UnprocessableEntityException
HTTP 429RateLimitException
HTTP >= 500InternalServerException
Kesalahan HTTP lainnyaAPIStatusException
TimeoutAPITimeoutException
Kesalahan jaringanAPIConnectionException
Selalu bungkus panggilan API dalam blok try-catch untuk menangani potensi kesalahan dengan baik dan memberikan umpan balik yang berarti kepada pengguna.

​
Penggunaan Lanjutan

​
Endpoint yang Tidak Terdokumentasi

Buat permintaan ke endpoint yang tidak terdokumentasi: 
<?php

$response = $client->request(
  method: "post",
  path: '/undocumented/endpoint',
  query: ['dog' => 'woof'],
  headers: ['useful-header' => 'interesting-value'],
  body: ['hello' => 'world']
);

​
Parameter yang Tidak Terdokumentasi

Kirim parameter yang tidak terdokumentasi ke endpoint mana pun atau baca properti respons yang tidak terdokumentasi: 
<?php

use Dodopayments\RequestOptions;

$checkoutSessionResponse = $client->checkoutSessions->create(
  productCart: [["productID" => "product_id", "quantity" => 1]],
  requestOptions: [
    'extraQueryParams' => ["my_query_parameter" => "value"],
    'extraBodyParams' => ["my_body_parameter" => "value"],
    'extraHeaders' => ["my-header" => "value"],
  ],
);
Parameter extra* dengan nama yang sama akan menimpa parameter yang terdokumentasi.

​
Integrasi Framework

​
Laravel

Buat layanan untuk aplikasi Laravel: 
<?php

namespace App\Services;

use Dodopayments\Client;

class PaymentService
{
    protected $client;

    public function __construct()
    {
        $this->client = new Client(
            bearerToken: config('services.dodo.api_key')
        );
    }

    public function createCheckout(array $items)
    {
        return $this->client->checkoutSessions->create(
            productCart: $items,
            returnUrl: route('checkout.return')
        );
    }
}
Tambahkan konfigurasi di config/services.php: 
'dodo' => [
    'api_key' => env('DODO_API_KEY'),
    'environment' => env('DODO_ENVIRONMENT', 'sandbox')
],

​
Symfony

Buat layanan dalam Symfony: 
<?php

namespace App\Service;

use Dodopayments\Client;

class DodoPaymentService
{
    private Client $client;

    public function __construct(string $apiKey)
    {
        $this->client = new Client(bearerToken: $apiKey);
    }

    public function createPayment(int $amount, string $currency, string $customerId): object
    {
        return $this->client->payments->create(
            amount: $amount,
            currency: $currency,
            customerID: $customerId
        );
    }
}
Daftarkan di config/services.yaml: 
services:
  App\Service\DodoPaymentService:
    arguments:
      $apiKey: "%env(DODO_API_KEY)%"

​
Sumber Daya

GitHub Repository

Lihat kode sumber dan berkontribusi

API Reference

Dokumentasi API lengkap

Discord Community

Dapatkan bantuan dan terhubung dengan pengembang

Report Issues

Laporkan bug atau minta fitur

​
Dukungan

Butuh bantuan dengan PHP SDK?

​
Berkontribusi

Kami menyambut kontribusi! Cek panduan berkontribusi untuk memulai.
Last modified on May 14, 2026