Skip to content

Latest commit

 

History

History
276 lines (208 loc) · 8.75 KB

RefundApi.md

File metadata and controls

276 lines (208 loc) · 8.75 KB
Raw

RefundApi

You can use the APIs below to interface with Xendit's RefundApi. 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\Refund\RefundApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new RefundApi();

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

Method HTTP request Description
createRefund() POST /refunds
getRefund() GET /refunds/{refundID}
getAllRefunds() GET /refunds
cancelRefund() POST /refunds/{refundID}/cancel

createRefund() Function

createRefund($idempotency_key, $for_user_id, $create_refund): \Refund\Refund
Name Value
Function Name createRefund
Request Parameters CreateRefundRequestParams
Return Type \Xendit\Refund\Refund

Request Parameters - CreateRefundRequestParams

Name Type Required Default
idempotency_key string
for_user_id string
create_refund CreateRefund

Usage Example

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

use Xendit\Configuration;
use Xendit\Refund\RefundApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new RefundApi();
$idempotency_key = "9797b5a6-54ad-4511-80a4-ec451346808b"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string
$create_refund = new \Xendit\Refund\CreateRefund(); // \Xendit\Refund\CreateRefund

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

getRefund() Function

getRefund($refund_id, $idempotency_key, $for_user_id): \Refund\Refund
Name Value
Function Name getRefund
Request Parameters GetRefundRequestParams
Return Type \Xendit\Refund\Refund

Request Parameters - GetRefundRequestParams

Name Type Required Default
refund_id string ☑️
idempotency_key string
for_user_id string

Usage Example

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

use Xendit\Configuration;
use Xendit\Refund\RefundApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new RefundApi();
$refund_id = "rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$idempotency_key = "9797b5a6-54ad-4511-80a4-ec451346808b"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string

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

getAllRefunds() Function

getAllRefunds($for_user_id, $payment_request_id, $invoice_id, $payment_method_type, $channel_code, $limit, $after_id, $before_id): \Refund\RefundList
Name Value
Function Name getAllRefunds
Request Parameters GetAllRefundsRequestParams
Return Type \Xendit\Refund\RefundList

Request Parameters - GetAllRefundsRequestParams

Name Type Required Default
for_user_id string
payment_request_id string
invoice_id string
payment_method_type string
channel_code string
limit float
after_id string
before_id string

Usage Example

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

use Xendit\Configuration;
use Xendit\Refund\RefundApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new RefundApi();
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string
$payment_request_id = "'payment_request_id_example'"; // string
$invoice_id = "'invoice_id_example'"; // string
$payment_method_type = "'payment_method_type_example'"; // string
$channel_code = "'channel_code_example'"; // string
$limit = 3.4; // float
$after_id = "'after_id_example'"; // string
$before_id = "'before_id_example'"; // string

try {
    $result = $apiInstance->getAllRefunds($for_user_id, $payment_request_id, $invoice_id, $payment_method_type, $channel_code, $limit, $after_id, $before_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling RefundApi->getAllRefunds: ', $e->getMessage(), PHP_EOL;
    echo 'Full Error: ', json_encode($e->getFullError()), PHP_EOL;
}

cancelRefund() Function

cancelRefund($refund_id, $idempotency_key, $for_user_id): \Refund\Refund
Name Value
Function Name cancelRefund
Request Parameters CancelRefundRequestParams
Return Type \Xendit\Refund\Refund

Request Parameters - CancelRefundRequestParams

Name Type Required Default
refund_id string ☑️
idempotency_key string
for_user_id string

Usage Example

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

use Xendit\Configuration;
use Xendit\Refund\RefundApi;

Configuration::setXenditKey("YOUR_API_KEY_HERE");

$apiInstance = new RefundApi();
$refund_id = "rfd-1fdaf346-dd2e-4b6c-b938-124c7167a822"; // string
$idempotency_key = "9797b5a6-54ad-4511-80a4-ec451346808b"; // string
$for_user_id = "5f9a3fbd571a1c4068aa40ce"; // string

try {
    $result = $apiInstance->cancelRefund($refund_id, $idempotency_key, $for_user_id);
    print_r($result);
} catch (\Xendit\XenditSdkException $e) {
    echo 'Exception when calling RefundApi->cancelRefund: ', $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

RefundCallback Object

Callback for successful or failed Refunds made via the Payments API

Model Documentation: RefundCallback

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\Refund\RefundCallback;

$refund_callback = new RefundCallback([
  'event' => 'refund.succeeded',
  'business_id' => '5f27a14a9bf05c73dd040bc8',
  'created' => '2020-08-29T09=>12=>33.001Z',
  'data' => [
    'id' => 'rfd-6f4a377d-a201-437f-9119-f8b00cbbe857',
    'payment_id' => 'ddpy-3cd658ae-25b9-4659-aa36-596ae41a809f',
    'invoice_id' => null,
    'amount' => 10000,
    'payment_method_type' => 'DIRECT_DEBIT',
    'channel_code' => 'BPI',
    'currency' => 'PHP',
    'status' => 'SUCCEEDED',
    'reason' => 'CANCELLATION',
    'reference_id' => 'b2756a1e-e6cd-4352-9a68-0483aa2b6a2',
    'failure_code' => null,
    'refund_fee_amount' => null,
    'created' => '2020-08-30T09=>12=>33.001Z',
    'updated' => '2020-08-30T09=>12=>33.001Z',
    'metadata' => null
  ]
]);

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

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

function simulateRefundCallback(RefundCallback $refund_callback) {
    echo $refund_callback->getId();
    // do things here with the callback
}

[Back to README]