Paymongo for Laravel

https://github.com/luigel/laravel-paymongo
Admin
Paymongo for Laravel is a PHP wrapper package that integrates the Paymongo payment gateway API into...
Tokens:12,529
Snippets:111
Trust Score:8.2
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies with Yarn

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/README.md

Installs the project dependencies using Yarn. Run this in the project root before starting local development.

```bash
$ yarn
```

--------------------------------

### Start local development server with Yarn

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/README.md

Starts the local development server and opens a browser window. Changes are reflected live without restarting the server.

```bash
$ yarn start
```

--------------------------------

### Install via Composer

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/getting-started.md

Run this command to install the laravel-paymongo package via Composer.

```bash
composer require luigel/laravel-paymongo
```

--------------------------------

### Get a Refund by ID

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/refunds.md

Retrieves a specific refund by providing its ID, which starts with the 'ref_' prefix.

```php
use Luigel\Paymongo\Facades\Paymongo;

$payment = Paymongo::refund()->find('ref_rBCmgwgMXZ9VH4YS2eRooPVL');
```

--------------------------------

### Create Token with Paymongo::token()->create()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/tokens.md

Creates a one-time use token representing customer credit card details. The token can only be used once to create a Payment, so separate tokens are needed for each payment attempt. The example includes card number, expiration, CVC, and billing information.

```php
use Luigel\Paymongo\Facades\Paymongo;

$token = Paymongo::token()
    ->create([
        'number' => '4343434343434345',
        'exp_month' => 12,
        'exp_year' => 25,
        'cvc' => "123",
        'billing' => [
            'address' => [
                'line1' => 'Test Address',
                'city' => 'Cebu City',
                'postal_code' => '6000',
                'country' => 'PH'
            ],
            'name' => 'Rigel Kent Carbonel',
            'email' => 'rigel20.kent@gmail.com',
            'phone' => '928392893'
        ]
    ]);
```

--------------------------------

### Get All Refunds

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/refunds.md

Retrieves a list of all previously created refunds, ordered by most recent first.

```php
use Luigel\Paymongo\Facades\Paymongo;

$payments = Paymongo::refund()->all();
```

--------------------------------

### Get all payments with Paymongo::payment()->all()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payments.md

Returns all previously created payments, with the most recent ones first. Currently, all payments are returned in one batch; pagination and limits are planned for a future API iteration.

```php
use Luigel\Paymongo\Facades\Paymongo;

$payments = Paymongo::payment()->all();
```

--------------------------------

### Get All Refunds

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/refunds.md

Returns all refunds previously created, with the most recent refunds returned first.

```APIDOC
## Get All Refunds

### Description
Returns all the refunds you previously created, with the most recent refunds returned first.

### Method
all

### Endpoint
Paymongo::refund()->all()

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$payments = Paymongo::refund()->all();
```

### Response
#### Success Response
Returns a collection of Refund models.

```

--------------------------------

### Get Customer with Paymongo::customer()->find()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Retrieves a customer by passing the customer ID to the find($id) method.

```php
use Luigel\Paymongo\Facades\Paymongo;

$customer = Paymongo::customer()->find('cus_b9ENKVqcHBfQQmv26uDYDCsD');
```

--------------------------------

### Get Customer

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Retrieve a customer by passing the customer id to the `find($id)` method.

```APIDOC
## Get Customer

### Description
Retrieve a customer by passing the customer id to the `find($id)` method.

### Method
find

### Endpoint
Paymongo::customer()->find($id)

### Parameters
#### Path Parameters
- **id** (string) - Required - The customer ID

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$customer = Paymongo::customer()->find('cus_b9ENKVqcHBfQQmv26uDYDCsD');
```

### Response
#### Success Response
Returns the customer object.

```

--------------------------------

### Get Link

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/links.md

Retrieves a payment link by its ID or reference number.

```APIDOC
## Get Link

### Description
Retrieve a payment link by passing the id or the reference number to the `find($id)` method.

### Method
find

### Endpoint
Paymongo::link()->find($id)

### Parameters
#### Path Parameters
- **id** (string) - Required - The link ID or reference number.

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::link()->find('link_wWaibr22CzEnficNhQNPUdoo');
$linkbyReference = Paymongo::link()->find('WTmSJbV');
```

### Response
Returns the link object.
```

--------------------------------

### Get Refund

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/refunds.md

Retrieves a refund by its ID. The ID prefix is 'ref_' followed by a unique hash.

```APIDOC
## Get Refund

### Description
Retrieves a refund by providing a refund ID. The prefix for the id is `ref_` followed by a unique hash representing the payment.

### Method
find

### Endpoint
Paymongo::refund()->find($refundId)

### Parameters
#### Path Parameters
- **refundId** (string) - Required - The refund ID, e.g., 'ref_rBCmgwgMXZ9VH4YS2eRooPVL'.

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$payment = Paymongo::refund()->find('ref_rBCmgwgMXZ9VH4YS2eRooPVL');
```

### Response
#### Success Response
Returns a Refund model instance.

```

--------------------------------

### Get Checkout Session by ID

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/checkouts.md

Retrieves a checkout session by passing its ID to the `find($id)` method.

```php
use Luigel\Paymongo\Facades\Paymongo;

$checkout = Paymongo::checkout()->find('cs_CbFCTDfxvMFNjwjVi26Uzhtj');
```

--------------------------------

### Get Payment Intent with find()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payment-intents.md

Retrieves a payment intent by its ID. The ID prefix is 'pi_' followed by a unique hash. Pass the payment ID to find($paymentIntentId).

```php
use Luigel\Paymongo\Facades\Paymongo;

$paymentIntent = Paymongo::paymentIntent()->find('pi_hsJNpsRFU1LxgVbxW4YJHRs6');
```

--------------------------------

### Get Payment Method with Paymongo::paymentMethod()->find()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payment-methods.md

Retrieves a payment method by its ID using the find method. Pass the payment method ID as the argument.

```php
use Luigel\Paymongo\Facades\Paymongo;

$paymentMethod = Paymongo::paymentMethod()->find('pm_wr98R2gwWroVxfkcNVZBuXg2');
```

--------------------------------

### Get Token with Paymongo::token()->find()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/tokens.md

Retrieves a token given its ID. The token ID prefix is `tok_` followed by a unique hash. Pass the token ID to the `find($id)` method.

```php
use Luigel\Paymongo\Facades\Paymongo;

$token = Paymongo::token()->find($tokenId);
```

--------------------------------

### Build static site with Yarn

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/README.md

Generates static content into the build directory, which can be served by any static hosting service.

```bash
$ yarn build
```

--------------------------------

### Run tests with Composer

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/README.md

Execute the package test suite using the composer test command.

```bash
composer test
```

--------------------------------

### Publish Config File

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/getting-started.md

Run this artisan command to publish the package configuration file to config/paymongo.php.

```bash
php artisan vendor:publish --provider="Luigel\Paymongo\PaymongoServiceProvider" --tag=config
```

--------------------------------

### Create Webhook

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/webhooks.md

Creates a new webhook by specifying the target URL and the events to listen for.

```php
use Luigel\Paymongo\Facades\Paymongo;

$webhook = Paymongo::webhook()->create([
    'url' => 'http://your-domain/webhook/source-chargeable',
    'events' => [
        'source.chargeable'
    ]
]);
```

--------------------------------

### Deploy to GitHub Pages with Yarn

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/README.md

Builds the website and pushes it to the gh-pages branch, convenient for GitHub Pages hosting. Requires setting your GitHub username and using SSH.

```bash
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```

--------------------------------

### Artisan Commands for Webhooks

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/webhooks.md

CLI commands to manage webhooks directly from the terminal.

```bash
php artisan paymongo:webhook
```

```bash
php artisan paymongo:list-webhooks
```

```bash
php artisan paymongo:toggle-webhook {webhook_id} --enable
```

```bash
php artisan paymongo:toggle-webhook {webhook_id} --disable
```

```bash
php artisan paymongo:toggle-webhook
```

--------------------------------

### Create Customer with Paymongo::customer()->create()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Creates a new customer record with billing information, useful for card vaulting. The payload should follow Paymongo's customer resource guidelines.

```php
use Luigel\Paymongo\Facades\Paymongo;

$customer = Paymongo::customer()->create([
    'first_name' => 'Juan',
    'last_name' => 'Doe',
    'phone' => '+639123456789',
    'email' => 'customer@email.com',
    'default_device' => 'phone'
]);
```

--------------------------------

### Create a payment with Paymongo::payment()->create()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payments.md

Creates a payment using a source. The payload includes amount, currency, description, statement descriptor, and the source object with its ID and type. Refer to the Paymongo documentation for payload guidelines.

```php
use Luigel\Paymongo\Facades\Paymongo;

$payment = Paymongo::payment()
    ->create([
        'amount' => 100.00,
        'currency' => 'PHP',
        'description' => 'Testing payment',
        'statement_descriptor' => 'Test Paymongo',
        'source' => [
            'id' => $source->id,
            'type' => 'source'
        ]
    ]);
```

--------------------------------

### Create Link

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/links.md

Creates a payment link for one-time payments.

```APIDOC
## Create Link

### Description
Creates a payment link that can be used for one-time payments.

### Method
create

### Endpoint
Paymongo::link()->create()

### Parameters
#### Request Body
- **amount** (float) - Required - The amount for the payment link.
- **description** (string) - Required - Description of the payment link.
- **remarks** (string) - Optional - Remarks for the payment link.

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::link()->create([
    'amount' => 100.00,
    'description' => 'Link Test',
    'remarks' => 'laravel-paymongo'
]);
```

### Response
Returns the created link object.
```

--------------------------------

### Create GCash and Grab Pay sources with Paymongo

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/sources.md

Creates a payment source for GCash or Grab Pay using the Paymongo facade. The payload requires 'type', 'amount', 'currency', and 'redirect' URLs for success and failure. Refer to Paymongo documentation for full payload guidelines.

```php
use Luigel\Paymongo\Facades\Paymongo;

$gcashSource = Paymongo::source()->create([
    'type' => 'gcash',
    'amount' => 100.00,
    'currency' => 'PHP',
    'redirect' => [
        'success' => 'https://your-domain.com/success',
        'failed' => 'https://your-domain.com/failed'
    ]
]);

$grabCarSource = Paymongo::source()->create([
    'type' => 'grab_pay',
    'amount' => 100.00,
    'currency' => 'PHP',
    'redirect' => [
        'success' => 'https://your-domain.com/success',
        'failed' => 'https://your-domain.com/failed'
    ]
]);
```

--------------------------------

### Edit Customer with find()->update()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Updates a customer by using the find($id) method and chaining the update() method, or by chaining update() to an existing customer instance.

```php
use Luigel\Paymongo\Facades\Paymongo;

$customer = Paymongo::customer()
                    ->find('cus_b9ENKVqcHBfQQmv26uDYDCsD')
                    ->update([
                        'first_name' => 'Jane'
                    ]);
```

--------------------------------

### Create a Payment Link

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/links.md

Creates a one-time payment link using the Paymongo facade.

```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::link()->create([
    'amount' => 100.00,
    'description' => 'Link Test',
    'remarks' => 'laravel-paymongo'
]);
```

--------------------------------

### Delete Customer with find()->delete()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Deletes a customer by using the find($id) method and chaining the delete() method, or by chaining delete() to an existing customer instance.

```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::customer()
                ->find('cus_b9ENKVqcHBfQQmv26uDYDCsD')
                ->delete();
```

--------------------------------

### List all Webhooks

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/webhooks.md

Retrieves a list of all previously created webhooks, ordered by most recent first.

```php
use Luigel\Paymongo\Facades\Paymongo;

$webhook = Paymongo::webhook()->all();
```

--------------------------------

### Create Customer

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Creates a customer record that holds billing information and is useful for card vaulting purposes.

```APIDOC
## Create Customer

### Description
Creates a customer record that holds billing information and is useful for card vaulting purposes.

### Method
create

### Endpoint
Paymongo::customer()->create()

### Parameters
#### Request Body
- **first_name** (string) - Required - Customer's first name
- **last_name** (string) - Required - Customer's last name
- **phone** (string) - Required - Customer's phone number
- **email** (string) - Required - Customer's email address
- **default_device** (string) - Required - Default device for the customer

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$customer = Paymongo::customer()->create([
    'first_name' => 'Juan',
    'last_name' => 'Doe',
    'phone' => '+639123456789',
    'email' => 'customer@email.com',
    'default_device' => 'phone'
]);
```

### Response
#### Success Response
Returns the created customer object.

```

--------------------------------

### Retrieve Customer's Payment Methods with find()->paymentMethods()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Retrieves the customer's payment methods by using the find($id) method and chaining the paymentMethods() method, or by chaining paymentMethods() to an existing customer instance.

```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::customer()
                ->find('cus_b9ENKVqcHBfQQmv26uDYDCsD')
                ->paymentMethods();
```

--------------------------------

### Paymongo Configuration File

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/getting-started.md

This is the default content of config/paymongo.php. It includes settings for livemode, public and secret keys, API version, webhook signatures, and amount type.

```php
<?php

return [

    'livemode' => env('PAYMONGO_LIVEMODE', false),

    /**
     * Public and Secret keys from Paymongo. You can get the keys here https://dashboard.paymongo.com/developers.
     */

    /**
     * Public keys are meant to be used for any requests coming from the frontend, such as generating tokens or sources,
     * either using Javascript or through the mobile SDKs.
     * Public keys cannot be used to trigger payments or modify any part of the transaction flow.
     * They have the prefix pk_live_ for live mode and pk_test_ for test mode.
     */
    'public_key' => env('PAYMONGO_PUBLIC_KEY', null),

    /**
     * Secret keys, on the other hand, are for triggering or modifying payments. Never share your secret keys anywhere
     * that is publicly accessible: Github, client-side Javascript code, your website or even chat rooms.
     * The prefixes for the secret keys are sk_live_ for live mode and sk_test_ for test mode.
     */
    'secret_key' => env('PAYMONGO_SECRET_KEY', null),

    /**
     * Paymongo's team continuously adding more features and integrations to the API.
     * Currently, the API supports doing payments via debit and credit cards issued by Visa and Mastercard.
     */
    'version' => env('PAYMONGO_VERSION', '2019-08-05'),

    /*
     * This class is responsible for calculating the signature that will be added to
     * the headers of the webhook request. A webhook client can use the signature
     * to verify the request hasn't been tampered with.
     */
    'signer' => \Luigel\Paymongo\Signer\DefaultSigner::class,

    /**
     * Paymongo webhooks signature secret.
     */
    'webhook_signatures' => [
        'payment_paid' => env('PAYMONGO_WEBHOOK_SIG_PAYMENT_PAID', env('PAYMONGO_WEBHOOK_SIG')),
        'payment_failed' => env('PAYMONGO_WEBHOOK_SIG_PAYMENT_FAILED', env('PAYMONGO_WEBHOOK_SIG')),
        'source_chargeable' => env('PAYMONGO_WEBHOOK_SIG_SOURCE_CHARGABLE', env('PAYMONGO_WEBHOOK_SIG')),
    ],

    /**
     * Webhook signature configuration for backwards compatibility.
     */
    'webhook_signature' => env('PAYMONGO_WEBHOOK_SIG'),

    /*
     * This is the name of the header where the signature will be added.
     */
    'signature_header_name' => env('PAYMONGO_SIG_HEADER', 'paymongo-signature'),

    /**
     * This is the amount type to automatically convert the amount in your payload.
     * The default is Paymongo::AMOUNT_TYPE_FLOAT.
     *
     * Choices are: Paymongo::AMOUNT_TYPE_FLOAT, or Paymongo::AMOUNT_TYPE_INT
     */
    'amount_type' => \Luigel\Paymongo\Paymongo::AMOUNT_TYPE_FLOAT,
];

```

--------------------------------

### Webhook Middleware Configuration

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/webhooks.md

Protects webhook routes using the paymongo.signature middleware in api.php and defines secret keys in the .env file.

```php
/** @var \Route $router */
$router->group(
    [
        'namespace' => 'Paymongo',
        'as' => 'paymongo.',
        'middleware' => 'paymongo.signature' // If you want to have only one signature key add this middleware in the group route where your webhook routes are defined.
    ],
    function () use ($router) {
    // This example is for different signature key for each webhook.
        $router->post(
            '/source-chargeable',
            'PaymongoCallbackController@sourceChargeable'
        )
            ->middleware('paymongo.signature:source_chargeable')
            ->name('source-chargeable');

        $router->post(
            '/payment-paid',
            'PaymongoCallbackController@paymentPaid'
        )
            ->middleware('paymongo.signature:payment_paid')
            ->name('payment-paid');

        $router->post(
            '/payment-failed',
            'PaymongoCallbackController@paymentFailed'
        )
            ->middleware('paymongo.signature:payment_failed')
            ->name('payment-failed');
            
        $router->post(
            '/payment-refunded',
            'PaymongoCallbackController@paymentRefunded'
        )
            ->middleware('paymongo.signature:payment_refunded')
            ->name('payment-refunded');
                    
        $router->post(
            '/payment-refund-updated',
            'PaymongoCallbackController@paymentRefundUpdated'
        )
            ->middleware('paymongo.signature:payment_refund_updated')
            ->name('payment-refund-updated');
    }
);

# then add this to you .env file

PAYMONGO_WEBHOOK_SIG_PAYMENT_PAID=<payment_paid-secret_key>
PAYMONGO_WEBHOOK_SIG_PAYMENT_FAILED=<payment_failed-secret_key>
PAYMONGO_WEBHOOK_SIG_SOURCE_CHARGABLE=<source_chargeable-secret_key>.
PAYMONGO_WEBHOOK_SIG_PAYMENT_REFUNDED=<payment_refunded-secret_key>.
PAYMONGO_WEBHOOK_SIG_PAYMENT_REFUND_UPDATED=<payment_refund_updated-secret_key>.

# you can get secret key when creating an webhook
```

--------------------------------

### Create Payment Method with Paymongo::paymentMethod()->create()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payment-methods.md

Creates a payment method with card details and billing information. The payload structure follows the Paymongo API; refer to the Paymongo documentation for the full payload specification.

```php
use Luigel\Paymongo\Facades\Paymongo;

$paymentMethod = Paymongo::paymentMethod()->create([
    'type' => 'card',
    'details' => [
        'card_number' => '4343434343434345',
        'exp_month' => 12,
        'exp_year' => 25,
        'cvc' => "123",
    ],
    'billing' => [
        'address' => [
            'line1' => 'Somewhere there',
            'city' => 'Cebu City',
            'state' => 'Cebu',
            'country' => 'PH',
            'postal_code' => '6000',
        ],
        'name' => 'Rigel Kent Carbonel',
        'email' => 'rigel20.kent@gmail.com',
        'phone' => '0935454875545'
    ],
]);
```

--------------------------------

### Create a Refund

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/refunds.md

Performs a refund to a customer's paid payment. Requires an amount, payment_id, and a valid reason constant from the Refund model.

```php
use Luigel\Paymongo\Facades\Paymongo;

$refund = Paymongo::refund()->create([
   'amount' => 10,
   'notes' => 'test refund',
   'payment_id' => $payment->id,
   'reason' => \Luigel\Paymongo\Models\Refund::REASON_DUPLICATE,
]);
```

--------------------------------

### Environment Variables for Paymongo

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/getting-started.md

Add these environment variables to your .env file. The webhook secret is from the webhook you created.

```env
# Paymongo
PAYMONGO_SECRET_KEY=
PAYMONGO_PUBLIC_KEY=
# This is the secret from the webhook you created.
PAYMONGO_WEBHOOK_SIG=

```

--------------------------------

### Create Checkout Session with Paymongo

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/checkouts.md

Creates a Paymongo checkout session with the provided payload, including billing details, line items, payment method types, and metadata. Refer to Paymongo documentation for payload guidelines.

```php
use Luigel\Paymongo\Facades\Paymongo;

$checkout = Paymongo::checkout()->create([
    'cancel_url' => 'https://paymongo.rigelkentcarbonel.com/',
    'billing' => [
        'name' => 'Juan Doe',
        'email' => 'juan@doe.com',
        'phone' => '+639123456789',
    ],
    'description' => 'My checkout session description',
    'line_items' => [
        [
            'amount' => 10000,
            'currency' => 'PHP',
            'description' => 'Something of a product.',
            'images' => [
                'https://images.unsplash.com/photo-1613243555988-441166d4d6fd?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1170&q=80'
            ],
            'name' => 'A payment card',
            'quantity' => 1
        ]
    ],
    'payment_method_types' => [
        'atome',
        'billease',
        'card',
        'dob',
        'dob_ubp',
        'gcash',
        'grab_pay', 
        'paymaya'
    ],
    'success_url' => 'https://paymongo.rigelkentcarbonel.com/',
    'statement_descriptor' => 'Laravel Paymongo Library',
    'metadata' => [
        'Key' => 'Value'
    ]
]);
```

--------------------------------

### Attach Payment Method to Payment Intent (Simple)

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payment-intents.md

Attaches a payment method to an existing payment intent. The payment method ID is passed to attach(); the second parameter (return_url) is omitted here.

```php
use Luigel\Paymongo\Facades\Paymongo;

$paymentIntent = Paymongo::paymentIntent()->find('pi_hsJNpsRFU1LxgVbxW4YJHRs6');
// Attached the payment method to the payment intent
$successfulPayment = $paymentIntent->attach('pm_wr98R2gwWroVxfkcNVZBuXg2');
```

--------------------------------

### Create Payment Intent with Paymongo::paymentIntent()->create()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payment-intents.md

Creates a payment intent with card as the allowed payment method and automatic 3D Secure request. The payload follows Paymongo's payment intent object guidelines.

```php
use Luigel\Paymongo\Facades\Paymongo;

$paymentIntent = Paymongo::paymentIntent()->create([
    'amount' => 100,
    'payment_method_allowed' => [
        'card'
    ],
    'payment_method_options' => [
        'card' => [
            'request_three_d_secure' => 'automatic'
        ]
    ],
    'description' => 'This is a test payment intent',
    'statement_descriptor' => 'LUIGEL STORE',
    'currency' => "PHP",
]);
```

--------------------------------

### Archive a Payment Link

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/links.md

Archives a payment link by chaining the archive method to the find method.

```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::link()->find('link_wWaibr22CzEnficNhQNPUdoo')->archive();
```

--------------------------------

### Create Refund

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/refunds.md

Performs a refund to a customer's paid payments in full or a partial amount to the original payment method used.

```APIDOC
## Create Refund

### Description
Performs a refund to a customer's paid payments in full or a partial amount to the original payment method used.

### Method
create

### Endpoint
Paymongo::refund()->create()

### Parameters
#### Request Body
- **amount** (numeric) - Required - The amount to refund.
- **notes** (string) - Optional - Notes for the refund.
- **payment_id** (string) - Required - The ID of the payment to refund.
- **reason** (string) - Required - The reason for the refund. Possible values: \Luigel\Paymongo\Models\Refund::REASON_DUPLICATE, \Luigel\Paymongo\Models\Refund::REASON_FRAUDULENT, \Luigel\Paymongo\Models\Refund::REASON_REQUESTED_BY_CUSTOMER, \Luigel\Paymongo\Models\Refund::REASON_OTHERS.

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$refund = Paymongo::refund()->create([
   'amount' => 10,
   'notes' => 'test refund',
   'payment_id' => $payment->id,
   'reason' => \Luigel\Paymongo\Models\Refund::REASON_DUPLICATE,
]);
```

### Response
#### Success Response
Returns a Refund model instance.

```

--------------------------------

### Unarchive Link

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/links.md

Unarchives a payment link by finding it and chaining the unarchive method.

```APIDOC
## Unarchive Link

### Description
Unarchive a payment link by using the `find($id)` method and chaining the `->unarchive()` method.

### Method
unarchive

### Endpoint
Paymongo::link()->find($id)->unarchive()

### Parameters
#### Path Parameters
- **id** (string) - Required - The link ID.

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::link()->find('link_wWaibr22CzEnficNhQNPUdoo')->unarchive();
```

### Response
Returns the unarchived link object.
```

--------------------------------

### Retrieve Customer's Payment Methods

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Retrieve the customer's payment methods by using the `find($id)` method and chaining the `->paymentMethods()` method.

```APIDOC
## Retrieve Customer's Payment Methods

### Description
Retrieve the customer's payment methods by using the `find($id)` method and chaining the `->paymentMethods()` method.

### Method
paymentMethods

### Endpoint
Paymongo::customer()->find($id)->paymentMethods()

### Parameters
#### Path Parameters
- **id** (string) - Required - The customer ID

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::customer()
                ->find('cus_b9ENKVqcHBfQQmv26uDYDCsD')
                ->paymentMethods();
```

### Response
#### Success Response
Returns the customer's payment methods.

```

--------------------------------

### Archive Link

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/links.md

Archives a payment link by finding it and chaining the archive method.

```APIDOC
## Archive Link

### Description
Archive a payment link by using the `find($id)` method and chaining the `->archive()` method.

### Method
archive

### Endpoint
Paymongo::link()->find($id)->archive()

### Parameters
#### Path Parameters
- **id** (string) - Required - The link ID.

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::link()->find('link_wWaibr22CzEnficNhQNPUdoo')->archive();
```

### Response
Returns the archived link object.
```

--------------------------------

### Unarchive a Payment Link

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/links.md

Unarchives a payment link by chaining the unarchive method to the find method.

```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::link()->find('link_wWaibr22CzEnficNhQNPUdoo')->unarchive();
```

--------------------------------

### Update Webhook

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/webhooks.md

Updates the configuration of an existing webhook, such as changing its URL.

```php
use Luigel\Paymongo\Facades\Paymongo;

$webhook = Paymongo::webhook()->find('hook_9VrvpRkkYqK6twbhuvcVTtjM')->update([
    'url' => 'https://update-domain.com/webhook'
]);
```

--------------------------------

### Retrieve a payment by ID with Paymongo::payment()->find()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payments.md

Retrieves a specific payment by passing its payment ID to the find() method. The payment ID has a prefix of 'pay_' followed by a unique hash.

```php
use Luigel\Paymongo\Facades\Paymongo;

$payment = Paymongo::payment()->find('pay_i35wBzLNdX8i9nKEPaSKWGib');
```

--------------------------------

### Edit Customer

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Edit a customer by using the `find($id)` method and chaining the `->update()` method.

```APIDOC
## Edit Customer

### Description
Edit a customer by using the `find($id)` method and chaining the `->update()` method.

### Method
update

### Endpoint
Paymongo::customer()->find($id)->update()

### Parameters
#### Path Parameters
- **id** (string) - Required - The customer ID

#### Request Body
- **first_name** (string) - Optional - Customer's first name

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$customer = Paymongo::customer()
                    ->find('cus_b9ENKVqcHBfQQmv26uDYDCsD')
                    ->update([
                        'first_name' => 'Jane'
                    ]);
```

### Response
#### Success Response
Returns the updated customer object.

```

--------------------------------

### Attach PayMaya Payment Method to Payment Intent

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payment-intents.md

Attaches a PayMaya payment method to a payment intent. Requires adding 'paymaya' to payment_method_allowed and setting the payment method type to 'paymaya'. The attach() call includes the return_url as the second parameter.

```php
$paymentIntent = Paymongo::paymentIntent()
    ->create([
        'amount' => 100,
        'payment_method_allowed' => [
            'paymaya', 'card'  // <--- Make sure to add paymaya here.
        ],
        'payment_method_options' => [
            'card' => [
                'request_three_d_secure' => 'automatic',
            ],
        ],
        'description' => 'This is a test payment intent',
        'statement_descriptor' => 'LUIGEL STORE',
        'currency' => 'PHP',
    ]);

$paymentMethod = Paymongo::paymentMethod()
    ->create([
        'type' => 'paymaya',  // <--- and payment method type should be paymaya
        'billing' => [
            'address' => [
                'line1' => 'Somewhere there',
                'city' => 'Cebu City',
                'state' => 'Cebu',
                'country' => 'PH',
                'postal_code' => '6000',
            ],
            'name' => 'Rigel Kent Carbonel',
            'email' => 'rigel20.kent@gmail.com',
            'phone' => '0935454875545',
        ],
    ]);

$attachedPaymentIntent = $paymentIntent->attach($paymentMethod->id, 'http://example.com/success'); // <--- And the second parameter should be the return_url.
```

--------------------------------

### Delete Customer

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/customers.md

Delete a customer by using the `find($id)` method and chaining the `->delete()` method.

```APIDOC
## Delete Customer

### Description
Delete a customer by using the `find($id)` method and chaining the `->delete()` method.

### Method
delete

### Endpoint
Paymongo::customer()->find($id)->delete()

### Parameters
#### Path Parameters
- **id** (string) - Required - The customer ID

### Request Example
```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::customer()
                ->find('cus_b9ENKVqcHBfQQmv26uDYDCsD')
                ->delete();
```

### Response
#### Success Response
Returns the deleted customer object.

```

--------------------------------

### Enable or Disable Webhooks

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/webhooks.md

Toggles the status of a specific webhook using its ID.

```php
use Luigel\Paymongo\Facades\Paymongo;
// Enable webhook
$webhook = Paymongo::webhook()->find('hook_9VrvpRkkYqK6twbhuvcVTtjM')->enable();

// Disable webhook
$webhook = Paymongo::webhook()->find('hook_9VrvpRkkYqK6twbhuvcVTtjM')->disable();
```

--------------------------------

### Retrieve a Payment Link

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/links.md

Retrieves a payment link by passing its ID or reference number to the find method.

```php
use Luigel\Paymongo\Facades\Paymongo;

$link = Paymongo::link()->find('link_wWaibr22CzEnficNhQNPUdoo');
$linkbyReference = Paymongo::link()->find('WTmSJbV');
```

--------------------------------

### Cancel Payment Intent with cancel()

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/payment-intents.md

Cancels an existing payment intent. First retrieves the payment intent by its ID (prefix 'pi_') using find(), then calls cancel() on it.

```php
use Luigel\Paymongo\Facades\Paymongo;

$paymentIntent = Paymongo::paymentIntent()->find('pi_hsJNpsRFU1LxgVbxW4YJHRs6');
$cancelledPaymentIntent = $paymentIntent->cancel();
```

--------------------------------

### Expire Checkout Session

Source: https://github.com/luigel/laravel-paymongo/blob/2.x/docs/docs/Usage/checkouts.md

Expires a checkout session by using the `find($id)` method and chaining the `->expire()` method.

```php
use Luigel\Paymongo\Facades\Paymongo;

$checkout = Paymongo::checkout()->find('cs_CbFCTDfxvMFNjwjVi26Uzhtj')->expire();
```
Tokens:
Raw