Payments.md

Payments

A list of all methods in the Payments service. Click on the method name to view detailed information about that method.

Methods	Description
list_payments
create_one_time_payment_handler
get_payment_handler

list_payments

• HTTP Method: GET
• Endpoint: /payments

Parameters

Name	Type	Required	Description
$createdAtGte	string	❌	Get events after this created time
$createdAtLte	string	❌	Get events created before this time
$pageSize	int	❌	Page size default is 10 max is 100
$pageNumber	int	❌	Page number default is 0
$customerId	string	❌	Filter by customer id
$status	Models\IntentStatus	❌	Filter by status

Return Type

Models\GetPaymentsListResponse

Example Usage Code Snippet

<?php

use Dodopayments\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$status = Models\IntentStatus::Succeeded;

$response = $sdk->payments->listPayments(
  createdAtGte: "created_at_gte",
  createdAtLte: "created_at_lte",
  pageSize: 1,
  pageNumber: 3,
  customerId: "customer_id",
  status: $status
);

print_r($response);

create_one_time_payment_handler

• HTTP Method: POST
• Endpoint: /payments

Parameters

Name	Type	Required	Description
input	Models\CreateOneTimePaymentRequest	✅

Return Type

Models\CreateOneTimePaymentResponse

Example Usage Code Snippet

<?php

use Dodopayments\Client;
use Dodopayments\Models\BillingAddress;
use Dodopayments\Models\CustomerRequest;
use Dodopayments\Models\OneTimeProductCartItemReq;
use Dodopayments\Models\CreateOneTimePaymentRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$countryCodeAlpha2 = Models\CountryCodeAlpha2::Af;

$billingAddress = new Models\BillingAddress(
  city: "city",
  country: $countryCodeAlpha2,
  state: "state",
  street: "street",
  zipcode: "zipcode"
);

COMPLEX_MODEL_NOT_IMPLEMENTED


$oneTimeProductCartItemReq = new Models\OneTimeProductCartItemReq(
  amount: 2,
  productId: "product_id",
  quantity: 1
);

$input = new Models\CreateOneTimePaymentRequest(
  billing: $billingAddress,
  customer: $customerRequest,
  metadata: [],
  paymentLink: true,
  productCart: [],
  returnUrl: "return_url"
);

$response = $sdk->payments->createOneTimePaymentHandler(
  input: $input
);

print_r($response);

get_payment_handler

• HTTP Method: GET
• Endpoint: /payments/{payment_id}

Parameters

Name	Type	Required	Description
$paymentId	string	✅	Payment Id

Return Type

Models\PaymentResponse

Example Usage Code Snippet

<?php

use Dodopayments\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->payments->getPaymentHandler(
  paymentId: "payment_id"
);

print_r($response);