Skip to content

Latest commit

 

History

History
670 lines (537 loc) · 23.6 KB

PaymentRequestApi.md

File metadata and controls

670 lines (537 loc) · 23.6 KB
Raw

PaymentRequestApi

You can use the APIs below to interface with Xendit's PaymentRequestApi. To start using the API, you need to configure the secret key and initiate the client instance.

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();

All URIs are relative to https://api.xendit.co, except if the operation defines another base path.

Method HTTP request Description
createPaymentRequest() POST /payment_requests Create Payment Request
getPaymentRequestByID() GET /payment_requests/{paymentRequestId} Get payment request by ID
getPaymentRequestCaptures() GET /payment_requests/{paymentRequestId}/captures Get Payment Request Capture
getAllPaymentRequests() GET /payment_requests Get all payment requests by filter
capturePaymentRequest() POST /payment_requests/{paymentRequestId}/captures Payment Request Capture
authorizePaymentRequest() POST /payment_requests/{paymentRequestId}/auth Payment Request Authorize
resendPaymentRequestAuth() POST /payment_requests/{paymentRequestId}/auth/resend Payment Request Resend Auth
simulatePaymentRequestPayment() POST /payment_requests/{paymentRequestId}/payments/simulate Payment Request Simulate Payment

createPaymentRequest() Function

createPaymentRequest($idempotency_key, $for_user_id, $with_split_rule, $payment_request_parameters): \PaymentRequest\PaymentRequest

Create Payment Request Create Payment Request

Name Value
Function Name createPaymentRequest
Request Parameters CreatePaymentRequestRequestParams
Return Type \Xendit\PaymentRequest\PaymentRequest

Request Parameters - CreatePaymentRequestRequestParams

Name Type Required Default
idempotency_key string
for_user_id string
with_split_rule string
payment_request_parameters PaymentRequestParameters

Usage Example

E-Wallet One Time Payment via Redirect URL

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$idempotency_key = "5f9a3fbd571a1c4068aa40ce"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$with_split_rule = "splitru_c676f55d-a9e0-47f2-b672-77564d57a40b"; // string
$payment_request_parameters = new Xendit\PaymentRequest\PaymentRequestParameters([
  'reference_id' => 'example-ref-1234',
  'amount' => 15000,
  'currency' => 'IDR',
  'country' => 'ID',
  'payment_method' => [
    'type' => 'EWALLET',
    'ewallet' => [
      'channel_code' => 'SHOPEEPAY',
      'channel_properties' => [
        'success_return_url' => 'https://redirect.me/success'
      ]
    ],
    'reusability' => 'ONE_TIME_USE'
  ]
]); // \Xendit\PaymentRequest\PaymentRequestParameters

try {
    $result = $apiInstance->createPaymentRequest($idempotency_key, $for_user_id, $with_split_rule, $payment_request_parameters);
        print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->createPaymentRequest: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

Fixed amount dynamic QR

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$idempotency_key = "5f9a3fbd571a1c4068aa40ce"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$with_split_rule = "splitru_c676f55d-a9e0-47f2-b672-77564d57a40b"; // string
$payment_request_parameters = new Xendit\PaymentRequest\PaymentRequestParameters([
  'reference_id' => 'example-ref-1234',
  'amount' => 15000,
  'currency' => 'IDR',
  'payment_method' => [
    'type' => 'QR_CODE',
    'reusability' => 'ONE_TIME_USE',
    'qr_code' => [
      'channel_code' => '“QRIS”'
    ]
  ],
  'metadata' => [
    'sku' => 'example-sku-1234'
  ]
]); // \Xendit\PaymentRequest\PaymentRequestParameters

try {
    $result = $apiInstance->createPaymentRequest($idempotency_key, $for_user_id, $with_split_rule, $payment_request_parameters);
        print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->createPaymentRequest: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

Fixed amount single use Virtual Account

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$idempotency_key = "5f9a3fbd571a1c4068aa40ce"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$with_split_rule = "splitru_c676f55d-a9e0-47f2-b672-77564d57a40b"; // string
$payment_request_parameters = new Xendit\PaymentRequest\PaymentRequestParameters([
  'reference_id' => 'example-ref-1234',
  'currency' => 'IDR',
  'amount' => 15000,
  'country' => 'ID',
  'payment_method' => [
    'type' => 'VIRTUAL_ACCOUNT',
    'reusability' => 'ONE_TIME_USE',
    'reference_id' => 'example-1234',
    'virtual_account' => [
      'channel_code' => 'BNI',
      'channel_properties' => [
        'customer_name' => 'Ahmad Gunawan',
        'expires_at' => '2023-01-03T17=>00=>00Z'
      ]
    ]
  ],
  'metadata' => [
    'sku' => 'example-sku-1234'
  ]
]); // \Xendit\PaymentRequest\PaymentRequestParameters

try {
    $result = $apiInstance->createPaymentRequest($idempotency_key, $for_user_id, $with_split_rule, $payment_request_parameters);
        print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->createPaymentRequest: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

Subsequent PH Direct Debit payments after account linking

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$idempotency_key = "5f9a3fbd571a1c4068aa40ce"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$with_split_rule = "splitru_c676f55d-a9e0-47f2-b672-77564d57a40b"; // string
$payment_request_parameters = new Xendit\PaymentRequest\PaymentRequestParameters([
  'reference_id' => 'example-ref-1234',
  'amount' => 1500,
  'currency' => 'PHP',
  'payment_method_id' => 'pm-9685a196-81e9-4c73-8d62-97df5aab2762',
  'metadata' => [
    'sku' => 'example-sku-1234'
  ]
]); // \Xendit\PaymentRequest\PaymentRequestParameters

try {
    $result = $apiInstance->createPaymentRequest($idempotency_key, $for_user_id, $with_split_rule, $payment_request_parameters);
        print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->createPaymentRequest: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

Subsequent tokenized E-Wallet payments after account linking

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$idempotency_key = "5f9a3fbd571a1c4068aa40ce"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$with_split_rule = "splitru_c676f55d-a9e0-47f2-b672-77564d57a40b"; // string
$payment_request_parameters = new Xendit\PaymentRequest\PaymentRequestParameters([
  'reference_id' => 'example-ref-1234',
  'amount' => 15000,
  'currency' => 'IDR',
  'payment_method_id' => 'pm-2b2c6092-2100-4843-a7fc-f5c7edac7efd',
  'metadata' => [
    'sku' => 'example-sku-1234'
  ]
]); // \Xendit\PaymentRequest\PaymentRequestParameters

try {
    $result = $apiInstance->createPaymentRequest($idempotency_key, $for_user_id, $with_split_rule, $payment_request_parameters);
        print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->createPaymentRequest: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

getPaymentRequestByID() Function

getPaymentRequestByID($payment_request_id, $for_user_id): \PaymentRequest\PaymentRequest

Get payment request by ID Get payment request by ID

Name Value
Function Name getPaymentRequestByID
Request Parameters GetPaymentRequestByIDRequestParams
Return Type \Xendit\PaymentRequest\PaymentRequest

Request Parameters - GetPaymentRequestByIDRequestParams

Name Type Required Default
payment_request_id string ☑️
for_user_id string

Usage Example

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string

try {
    $result = $apiInstance->getPaymentRequestByID($payment_request_id, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->getPaymentRequestByID: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

getPaymentRequestCaptures() Function

getPaymentRequestCaptures($payment_request_id, $for_user_id, $limit): \PaymentRequest\CaptureListResponse

Get Payment Request Capture Get Payment Request Capture

Name Value
Function Name getPaymentRequestCaptures
Request Parameters GetPaymentRequestCapturesRequestParams
Return Type \Xendit\PaymentRequest\CaptureListResponse

Request Parameters - GetPaymentRequestCapturesRequestParams

Name Type Required Default
payment_request_id string ☑️
for_user_id string
limit int

Usage Example

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$limit = 56; // int

try {
    $result = $apiInstance->getPaymentRequestCaptures($payment_request_id, $for_user_id, $limit);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->getPaymentRequestCaptures: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

getAllPaymentRequests() Function

getAllPaymentRequests($for_user_id, $reference_id, $id, $customer_id, $limit, $before_id, $after_id): \PaymentRequest\PaymentRequestListResponse

Get all payment requests by filter Get all payment requests by filter

Name Value
Function Name getAllPaymentRequests
Request Parameters GetAllPaymentRequestsRequestParams
Return Type \Xendit\PaymentRequest\PaymentRequestListResponse

Request Parameters - GetAllPaymentRequestsRequestParams

Name Type Required Default
for_user_id string
reference_id string[]
id string[]
customer_id string[]
limit int
before_id string
after_id string

Usage Example

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$reference_id = array('reference_id_example'); // string[]
$id = array('id_example'); // string[]
$customer_id = array('customer_id_example'); // string[]
$limit = 56; // int
$before_id = "'before_id_example'"; // string
$after_id = "'after_id_example'"; // string

try {
    $result = $apiInstance->getAllPaymentRequests($for_user_id, $reference_id, $id, $customer_id, $limit, $before_id, $after_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->getAllPaymentRequests: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

capturePaymentRequest() Function

capturePaymentRequest($payment_request_id, $for_user_id, $capture_parameters): \PaymentRequest\Capture

Payment Request Capture Payment Request Capture

Name Value
Function Name capturePaymentRequest
Request Parameters CapturePaymentRequestRequestParams
Return Type \Xendit\PaymentRequest\Capture

Request Parameters - CapturePaymentRequestRequestParams

Name Type Required Default
payment_request_id string ☑️
for_user_id string
capture_parameters CaptureParameters

Usage Example

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$capture_parameters = new \Xendit\PaymentRequest\CaptureParameters(); // \Xendit\PaymentRequest\CaptureParameters

try {
    $result = $apiInstance->capturePaymentRequest($payment_request_id, $for_user_id, $capture_parameters);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->capturePaymentRequest: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

authorizePaymentRequest() Function

authorizePaymentRequest($payment_request_id, $for_user_id, $payment_request_auth_parameters): \PaymentRequest\PaymentRequest

Payment Request Authorize Payment Request Authorize

Name Value
Function Name authorizePaymentRequest
Request Parameters AuthorizePaymentRequestRequestParams
Return Type \Xendit\PaymentRequest\PaymentRequest

Request Parameters - AuthorizePaymentRequestRequestParams

Name Type Required Default
payment_request_id string ☑️
for_user_id string
payment_request_auth_parameters PaymentRequestAuthParameters

Usage Example

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string
$payment_request_auth_parameters = new \Xendit\PaymentRequest\PaymentRequestAuthParameters(); // \Xendit\PaymentRequest\PaymentRequestAuthParameters

try {
    $result = $apiInstance->authorizePaymentRequest($payment_request_id, $for_user_id, $payment_request_auth_parameters);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->authorizePaymentRequest: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

resendPaymentRequestAuth() Function

resendPaymentRequestAuth($payment_request_id, $for_user_id): \PaymentRequest\PaymentRequest

Payment Request Resend Auth Payment Request Resend Auth

Name Value
Function Name resendPaymentRequestAuth
Request Parameters ResendPaymentRequestAuthRequestParams
Return Type \Xendit\PaymentRequest\PaymentRequest

Request Parameters - ResendPaymentRequestAuthRequestParams

Name Type Required Default
payment_request_id string ☑️
for_user_id string

Usage Example

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40cf"; // string

try {
    $result = $apiInstance->resendPaymentRequestAuth($payment_request_id, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->resendPaymentRequestAuth: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

simulatePaymentRequestPayment() Function

simulatePaymentRequestPayment($payment_request_id): \PaymentRequest\PaymentSimulation

Payment Request Simulate Payment Payment Request Simulate Payment

Name Value
Function Name simulatePaymentRequestPayment
Request Parameters SimulatePaymentRequestPaymentRequestParams
Return Type \Xendit\PaymentRequest\PaymentSimulation

Request Parameters - SimulatePaymentRequestPaymentRequestParams

Name Type Required Default
payment_request_id string ☑️

Usage Example

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

use Xendit\Configuration;
use Xendit\PaymentRequest\PaymentRequestApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new PaymentRequestApi();
$payment_request_id = "pr-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string

try {
    $result = $apiInstance->simulatePaymentRequestPayment($payment_request_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling PaymentRequestApi->simulatePaymentRequestPayment: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

Callback Objects

Use the following callback objects provided by Xendit to receive callbacks (also known as webhooks) that Xendit sends you on events, such as successful payments. Note that the example is meant to illustrate the contents of the callback object -- you will not need to instantiate these objects in practice

PaymentCallback Object

Callback for successful or failed payments made via the Payments API

Model Documentation: PaymentCallback

Usage Example

Note that the example is meant to illustrate the contents of the callback object -- you will not need to instantiate these objects in practice

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

use Xendit\PaymentRequest\PaymentCallback;

$payment_callback = new PaymentCallback([
  'event' => 'payment.succeeded',
  'data' => [
    'id' => 'ddpy-3cd658ae-25b9-4659-aa36-596ae41a809f',
    'amount' => 1000,
    'status' => 'SUCCEEDED',
    'country' => 'PH',
    'created' => '2022-08-12T13=>30=>40.9209Z',
    'updated' => '2022-08-12T13=>30=>58.729373Z',
    'currency' => 'PHP',
    'metadata' => [
      'sku' => 'ABCDEFGH'
    ],
    'customer_id' => 'c832697e-a62d-46fa-a383-24930b155e81',
    'reference_id' => '25cfd0f9-baee-44ca-9a12-6debe03f3c22',
    'payment_method' => [
      'id' => 'pm-951b1ad9-1fbb-4724-a744-8956ab6ed17f',
      'card' => null,
      'type' => 'DIRECT_DEBIT',
      'status' => 'ACTIVE',
      'created' => '2022-08-12T13=>30=>26.579048Z',
      'ewallet' => null,
      'qr_code' => null,
      'updated' => '2022-08-12T13=>30=>40.221525Z',
      'metadata' => [
        'sku' => 'ABCDEFGH'
      ],
      'description' => null,
      'reusability' => 'MULTIPLE_USE',
      'direct_debit' => [
        'type' => 'BANK_ACCOUNT',
        'debit_card' => null,
        'bank_account' => [
          'bank_account_hash' => 'b4dfa99c9b60c77f2e3962b73c098945',
          'masked_bank_account_number' => 'XXXXXX1234'
        ],
        'channel_code' => 'BPI',
        'channel_properties' => [
          'failure_return_url' => 'https://your-redirect-website.com/failure',
          'success_return_url' => 'https://your-redirect-website.com/success'
        ]
      ],
      'reference_id' => '620b9df4-fe69-4bfd-b9d4-5cba6861db8a',
      'virtual_account' => null,
      'over_the_counter' => null,
      'direct_bank_transfer' => null
    ],
    'description' => null,
    'failure_code' => null,
    'payment_detail' => null,
    'channel_properties' => null,
    'payment_request_id' => 'pr-5b26cae1-545b-49e9-855e-f85128f3e705'
  ],
  'created' => '2022-08-12T13=>30=>58.986Z',
  'business_id' => '5f27a14a9bf05c73dd040bc8',
  'api_version' => null
]);

You may then use the callback object in your webhook or callback handler like so,

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

function simulatePaymentCallback(PaymentCallback $payment_callback) {
    echo $payment_callback->getId();
    // do things here with the callback
}

[Back to README]