PayPlug API

https://docs.payplug.com/api/
Admin
PayPlug API enables applications to create and manage payments and refunds for PayPlug accounts,...
Tokens:109,111
Snippets:1,069
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Create an installment plan

Source: https://docs.payplug.com/api/downloads/payplug_api_apiref_powershell.html

Examples of how to initiate an installment plan using either a direct cURL request or the PayPlug PHP SDK.

```bash
$ curl -X POST https://api.payplug.com/v1/installment_plans \
  -H "Authorization: Bearer sk_test_9898098098guGYUG9" \
  -H "PayPlug-Version: 2019-08-06" \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "EUR",
    "schedule": [
      {"date": "TODAY", "amount": 1000},
      {"date": "2019-03-02", "amount": 2050},
      {"date": "2019-04-03", "amount": 1026}
    ],
    "billing": {
      "title": "mr",
      "first_name": "John",
      "last_name": "Watson",
      "mobile_phone_number": "+33612345678",
      "email": "john.watson@example.net",
      "address1": "221B Baker Street",
      "postcode": "NW16XE",
      "city": "London",
      "country": "GB",
      "language": "en"
    },
    "shipping": {
      "title": "mr",
      "first_name": "John",
      "last_name": "Watson",
      "email": "john.watson@example.net",
      "address1": "221B Baker Street",
      "postcode": "NW16XE",
      "city": "London",
      "country": "GB",
      "language": "en",
      "delivery_type": "BILLING"
    },
    "hosted_payment":{
      "return_url": "https://example.net/success?id=42",
      "cancel_url": "https://example.net/cancel?id=42"
    },
    "notification_url": "https://example.net/notifications?id=42",
    "metadata":{
      "customer_id": "42"
    }
  }'
```

```php
<?php
$payment = \Payplug\InstallmentPlan::create(array(
  'currency'         => 'EUR',
  'schedule'         => array(
    array('date' => 'TODAY', 'amount' => 1000),
    array('date' => '2019-03-02', 'amount' => 2050),
    array('date' => '2019-04-02', 'amount' => 1026)
  ),
  'billing'  => array(
    'title'                => 'mr',
    'first_name'           => 'John',
    'last_name'            => 'Watson',
    'mobile_phone_number'  => '+33612345678',
    'email'                => 'john.watson@example.net',
    'address1'             => '221B Baker Street',
    'postcode'             => 'NW16XE',
    'city'                 => 'London',
    'country'              => 'GB',
    'language'             => 'en'
  ),
  'shipping'  => array(
    'title'         => 'mr',
    'first_name'    => 'John',
    'last_name'     => 'Watson',
    'email'         => 'john.watson@example.net',
    'address1'      => '221B Baker Street',
    'postcode'      => 'NW16XE',
    'city'          => 'London',
    'country'       => 'GB',
    'language'      => 'en',
    'delivery_type' => 'BILLING'
  ),
  'hosted_payment'   => array(
    'return_url'     => 'https://example.net/success?id=42',
    'cancel_url'     => 'https://example.net/cancel?id=42'
  ),
  'notification_url' => 'https://example.net/notifications?id=42',
  'metadata'         => array(
    'customer_id'    => 42
  )
));
```

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

### Retrieve an installment plan

Source: https://docs.payplug.com/api/downloads/payplug_api_apiref_powershell.html

Use these examples to fetch details for a specific installment plan by its ID.

```bash
$ curl -X GET https://api.payplug.com/v1/installment_plans/inst_2JhnPxy4ABR4YBVW4UscWx \
  -H "Authorization: Bearer sk_test_9898098098guGYUG9" \
  -H "PayPlug-Version: 2019-08-06"
```

```php
<?php
$installmentPlan = \Payplug\InstallmentPlan::retrieve('inst_2JhnPxy4ABR4YBVW4UscWx');
```

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

### Install PayPlug Python library

Source: https://docs.payplug.com/api/libraries.html

Use pip to install the official PayPlug Python library.

```bash
pip install payplug
```

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

### Install PayPlug PHP library

Source: https://docs.payplug.com/api/libraries.html

Use Composer to install the official PayPlug PHP library.

```bash
composer require payplug/payplug-php
```

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

### Oney payment simulation object example

Source: https://docs.payplug.com/api/apiref.html?python=

Example JSON response structure for an Oney payment simulation, showing installment schedules for 3-part and 4-part payment plans.

```json
{
  "x3_with_fees": {
    "down_payment_amount": 67667,
    "nominal_annual_percentage_rate": 6.04,
    "effective_annual_percentage_rate": 6.21,
    "installments": [
      {
        "date": "2019-12-29T01:00:00.000Z",
        "amount": 66667
      },
      {
        "date": "2020-01-29T01:00:00.000Z",
        "amount": 66666
      }
    ],
    "total_cost": 1000
  },
  "x4_without_fees": {
    "installments": [
      {
        "date": "2019-12-29T01:00:00.000Z",
        "amount": 50000
      },
      {
        "date": "2020-01-29T01:00:00.000Z",
        "amount": 50000
      },
      {
        "date": "2020-02-29T01:00:00.000Z",
        "amount": 50000
      }
    ],
    "total_cost": 0,
    "nominal_annual_percentage_rate": 0.0,
    "effective_annual_percentage_rate": 0.0,
    "down_payment_amount": 50000
  }
}
```

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

### Create a payment

Source: https://docs.payplug.com/api/downloads/payplug_api_apiref_powershell.html

Examples of creating a payment resource using different programming interfaces.

```bash
$ curl -X POST https://api.payplug.com/v1/payments \
  -H 'Authorization: Bearer sk_test_9898098098guGYUG9' \
  -H 'PayPlug-Version: 2019-08-06' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 3300,
    "currency": "EUR",
    "billing": {
      "title": "mr",
      "first_name": "John",
      "last_name": "Watson",
      "mobile_phone_number": "+33612345678",
      "email": "john.watson@example.net",
      "address1": "221B Baker Street",
      "postcode": "NW16XE",
      "city": "London",
      "country": "GB",
      "language": "en"
    },
    "shipping": {
      "title": "mr",
      "first_name": "John",
      "last_name": "Watson",
      "email": "john.watson@example.net",
      "address1": "221B Baker Street",
      "postcode": "NW16XE",
      "city": "London",
      "country": "GB",
      "language": "en",
      "delivery_type": "BILLING"
    },
    "hosted_payment": {
      "return_url": "https://example.net/success?id=42",
      "cancel_url": "https://example.net/cancel?id=42"
    },
    "notification_url": "https://example.net/notifications?id=42",
    "metadata": {
      "customer_id": "42"
     },
     "save_card": false,
     "force_3ds": true
  }'
```

```php
<?php
$payment = \Payplug\Payment::create(array(
  'amount'           => 3300,
  'currency'         => 'EUR',
  'save_card'        => false,
  'billing'               => array(
    'title'               => 'mr',
    'first_name'          => 'John',
    'last_name'           => 'Watson',
    'mobile_phone_number' => '+33612345678',
    'email'               => 'john.watson@example.net',
    'address1'            => '221B Baker Street',
    'postcode'            => 'NW16XE',
    'city'                => 'London',
    'country'             => 'GB',
    'language'            => 'en'
  ),
  'shipping'        => array(
    'title'         => 'mr',
    'first_name'    => 'John',
    'last_name'     => 'Watson',
    'email'         => 'john.watson@example.net',
    'address1'      => '221B Baker Street',
    'postcode'      => 'NW16XE',
    'city'          => 'London',
    'country'       => 'GB',
    'language'      => 'en',
    'delivery_type' => 'BILLING'
  ),
  'hosted_payment' => array(
    'return_url'   => 'https://example.net/success?id=42',
    'cancel_url'   => 'https://example.net/cancel?id=42'
  ),
  'notification_url' => 'https://example.net/notifications?id=42',
  'metadata'      => array(
    'customer_id' => 42
  )
));

$payment_url = $payment->hosted_payment->payment_url;
$payment_id = $payment->id;
```

```python
payment_data = {
  'amount': 3300,
  'currency': 'EUR',
  'save_card': False,
  'billing': {
    'title': 'mr',
    'first_name': 'John',
    'last_name': 'Watson',
    'email': 'john.watson@example.net',
    'address1': '221B Baker Street',
    'postcode': 'NW16XE',
    'city': 'London',
    'country': 'GB',
    'language': 'en'
  },
  'shipping': {
    'title': 'mr',
    'first_name': 'John',
    'last_name': 'Watson',
    'email': 'john.watson@example.net',
    'address1': '221B Baker Street',
    'postcode': 'NW16XE',
    'city': 'London',
    'country': 'GB',
    'language': 'en',
    'delivery_type': 'BILLING'
  },
  'hosted_payment': {
    'return_url': 'https://example.net/success?id=42',
    'cancel_url': 'https://example.net/cancel?id=42',
  },
  'notification_url': 'https://example.net/notifications?id=42',
  'metadata': {
    'customer_id': 42,
  },
}
payment = payplug.Payment.create(**payment_data)
```

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

### Install the PayPlug Library

Source: https://docs.payplug.com/api/guide-oneypopin-en.html

Include the library initialization in your pages to access PayPlug API functionality.

```php
<?php
require_once('PATH_TO_PAYPLUG/payplug_php/lib/init.php');
```

```python
import payplug
```

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

### POST /v1/installment_plans

Source: https://docs.payplug.com/api/downloads/payplug_api_apiref_powershell.html

Creates a new installment plan.

```APIDOC
## POST /v1/installment_plans

### Description
Create an installment plan.

### Method
POST

### Endpoint
/v1/installment_plans
```

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

### Payment Object Response Example

Source: https://docs.payplug.com/api/downloads/payplug_api_apiref_powershell.html

Example of the JSON response object returned after a payment is completed with card saving enabled.

```json
{
  "id": "pay_5iHMDxy4ABR4YBVW4UscIn",
  "object": "payment",
  "is_live": true,
  "amount": 3300,
  "amount_refunded": 0,
  "authorization": null,
  "currency": "EUR",
  "created_at": 1434010787,
  "refundable_after": 1449157171,
  "refundable_until": 1459157171,
  "is_paid": true,
  "paid_at": 1555073519,
  "is_refunded": false,
  "is_3ds": true,
  "installment_plan_id": null,
  "save_card": true,
  "card": {
    "last4": "1800",
    "country": "FR",
    "exp_month": 9,
    "exp_year": 2017,
    "brand": "Mastercard",
    "id": "card_e7133426b8de947b37161dfba1897dd1"
  },
  "billing": {
    "title": "mr",
    "first_name": "John",
    "last_name": "Watson",
    "email": "john.watson@example.net",
    "mobile_phone_number": null,
    "landline_phone_number": null,
    "address1": "221B Baker Street",
    "address2": null,
    "postcode": "NW16XE",
    "city": "London",
    "state": null,
    "country": "GB",
    "language": "en"
  },
  "shipping": {
    "title": "mr",
    "first_name": "John",
    "last_name": "Watson",
    "email": "john.watson@example.net",
    "mobile_phone_number": null,
    "landline_phone_number": null,
    "address1": "221B Baker Street",
    "address2": null,
    "postcode": "NW16XE",
    "city": "London",
    "state": null,
    "country": "GB",
    "language": "en",
    "delivery_type": "BILLING"
  },
  "hosted_payment": {
    "payment_url": "https://secure.payplug.com/pay/5iHMDxy4ABR4YBVW4UscIn",
    "return_url": "https://example.net/success?id=42",
    "cancel_url": "https://example.net/cancel?id=42",
    "paid_at": 1434010827,
    "sent_by": null
  },
  "notification": {
    "url": "https://example.net/notifications?id=42",
    "response_code": 200
  },
  "failure": null,
  "description": null,
  "metadata": {
    "customer_id": 42
  }
}
```

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

### List payments response example

Source: https://docs.payplug.com/api/downloads/payplug_api_apiref_powershell.html

Example JSON response structure for a successful list payments request.

```json
{
  "object": "list",
  "page": 0,
  "per_page": 10,
  "has_more": true,
  "data": [
    {
      "id": "pay_5iHMDxy4ABR4YBVW4UscIn",
      "object": "payment",
      "is_live": true,
      "amount": 3300
    }
  ]
}
```

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

### Accounting report response example

Source: https://docs.payplug.com/api/apiref.html?python=

Example of the JSON object returned when successfully retrieving an accounting report.

```json
{
  "object": "accounting_report",
  "id": "ar_6zrx929ldfIzqnX6KktHzZ",
  "is_live": true,
  "temporary_url": "some_url_to_get_the_file.com",
  "file_available_until": 156787686,
  "start_date": "2019-11-08",
  "end_date": "2020-04-15",
  "notification_url": "https://example.net/notifications?id=42"
}
```

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

### Create a payment request

Source: https://docs.payplug.com/api/guide-payment-en.html?php=

Examples of creating a payment and redirecting the customer to the hosted payment page.

```php
<?php
$email = 'john.watson@example.net';
$amount = 33;
$customer_id = '42710';

$payment = \Payplug\Payment::create(array(
  'amount'           => $amount * 100,
  'currency'         => 'EUR',
  'billing'  => array(
    'title'        => 'mr',
    'first_name'   => 'John',
    'last_name'    => 'Watson',
    'email'        => 'john.watson@example.net',
    'address1'     => '221B Baker Street',
    'postcode'     => 'NW16XE',
    'city'         => 'London',
    'country'      => 'GB',
    'language'     => 'en'
  ),
  'shipping'  => array(
    'title'         => 'mr',
    'first_name'    => 'John',
    'last_name'     => 'Watson',
    'email'         => 'john.watson@example.net',
    'address1'      => '221B Baker Street',
    'postcode'      => 'NW16XE',
    'city'          => 'London',
    'country'       => 'GB',
    'language'      => 'en',
    'delivery_type' => 'BILLING'
  ),
  'hosted_payment'   => array(
    'return_url'     => 'https://example.net/return?id='.$customer_id,
    'cancel_url'     => 'https://example.net/cancel?id='.$customer_id
  ),
  'notification_url' => 'https://example.net/notifications?id='.$customer_id,
  'metadata'         => array(
    'customer_id'    => $customer_id
    )
));

$payment_url = $payment->hosted_payment->payment_url;
$payment_id = $payment->id;
header('Location:' . $payment_url);
```

```python
payment_data = {
  'amount': 3300,
  'currency': 'EUR',
  'customer': {
    'email': 'john.watson@example.net'
  },
  'hosted_payment': {
    'return_url': 'https://example.net/return?id=42710',
    'cancel_url': 'https://example.net/cancel?id=42710',
  },
  'notification_url': 'https://example.net/notifications?id=42710',
  'metadata': {
    'customer_id': 42710,
  },
}
payment = payplug.Payment.create(**payment_data)
payment_id = str(payment.id)
```

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

### Installment Plans API

Source: https://docs.payplug.com/api/apiref.html?powershell=

Endpoints for creating, retrieving, and aborting installment plans.

```APIDOC
## POST /v1/installment_plans

### Description
Create an installment plan.

### Method
POST

### Endpoint
/v1/installment_plans

## GET /v1/installment_plans/{installment_plan_id}

### Description
Retrieve an installment plan.

### Method
GET

### Endpoint
/v1/installment_plans/{installment_plan_id}

## PATCH /v1/installment_plans/{installment_plan_id}

### Description
Abort an installment plan.

### Method
PATCH

### Endpoint
/v1/installment_plans/{installment_plan_id}
```

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

### Abort a payment

Source: https://docs.payplug.com/api/downloads/payplug_api_apiref_powershell.html

Examples showing how to abort a payment using cURL, PHP, and Python.

```bash
$ curl -X PATCH https://api.payplug.com/v1/payments/pay_5iHMDxy4ABR4YBVW4UscIn \
  -H 'Authorization: Bearer sk_test_9898098098guGYUG9' \
  -H 'PayPlug-Version: 2019-08-06' \
  -H 'Content-Type: application/json' \
  -d '{"aborted": true}'
```

```php
<?php
// Abort from a payment ID
$paymentId = 'pay_5iHMDxy4ABR4YBVW4UscIn';
$payment = \Payplug\Payment::abort($paymentId);

// Abort from a payment object
$paymentId = 'pay_5iHMDxy4ABR4YBVW4UscIn';
$payment = \Payplug\Payment::retrieve($paymentId);
$payment = $payment->abort();
```

```python
# Abort from a payment ID
payment_id = 'pay_5iHMDxy4ABR4YBVW4UscIn'
payment = payplug.Payment.abort(payment_id)

# Abort from a payment object
payment = payplug.Payment.retrieve(payment_id)
payment = payment.abort()
```

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

### Example simulation response

Source: https://docs.payplug.com/api/apiref.html?python=

The JSON structure returned after a successful simulation request.

```json
{
  "x3_with_fees": {
    "installments": [
      {
        "date": "2021-07-17T00:00:00.000Z",
        "amount": 66667
      },
      {
        "date": "2021-08-17T00:00:00.000Z",
        "amount": 66666
      }
    ],
    "total_cost": 1000,
    "nominal_annual_percentage_rate": 6.04,
    "effective_annual_percentage_rate": 6.21,
    "down_payment_amount": 67667
  },
  "x4_with_fees": {
    "installments": [
      {
        "date": "2021-07-17T00:00:00.000Z",
        "amount": 50000
      },
      {
        "date": "2021-08-17T00:00:00.000Z",
        "amount": 50000
      },
      {
        "date": "2021-09-17T00:00:00.000Z",
        "amount": 50000
      }
    ],
    "total_cost": 2000,
    "nominal_annual_percentage_rate": 8.09,
    "effective_annual_percentage_rate": 8.4,
    "down_payment_amount": 52000
  },
  "x3_without_fees": {
    "installments": [
      {
        "date": "2021-07-08T00:00:00.000Z",
        "amount": 66666
      },
      {
        "date": "2021-08-08T00:00:00.000Z",
        "amount": 66666
      }
    ],
    "total_cost": 0,
    "nominal_annual_percentage_rate": 0,
    "effective_annual_percentage_rate": 0,
    "down_payment_amount": 66668
  },
  "x4_without_fees": {
    "installments": [
      {
        "date": "2021-07-08T00:00:00.000Z",
        "amount": 50000
      },
      {
        "date": "2021-08-08T00:00:00.000Z",
        "amount": 50000
      },
      {
        "date": "2021-09-08T00:00:00.000Z",
        "amount": 50000
      }
    ],
    "total_cost": 0,
    "nominal_annual_percentage_rate": 0,
    "effective_annual_percentage_rate": 0,
    "down_payment_amount": 50000
  }
}
```

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

### Installment plan object structure

Source: https://docs.payplug.com/api/apiref.html?python=

JSON representation of an installment plan object containing billing, shipping, hosted payment, and schedule details.

```json
{
  "id": "inst_1FTGSRWYHla7eDkfTo2Usd",
  "object": "installment_plan",
  "is_live": true,
  "is_active": true,
  "currency": "EUR",
  "created_at": 1548326773,
  "is_fully_paid": false,
  "billing": {
    "title": "mr",
    "first_name": "John",
    "last_name": "Watson",
    "email": "john.watson@example.net",
    "mobile_phone_number": null,
    "landline_phone_number": null,
    "address1": "221B Baker Street",
    "address2": null,
    "postcode": "NW16XE",
    "city": "London",
    "state": null,
    "country": "GB",
    "language": "en"
  },
  "shipping": {
    "title": "mr",
    "first_name": "John",
    "last_name": "Watson",
    "email": "john.watson@example.net",
    "mobile_phone_number": null,
    "landline_phone_number": null,
    "address1": "221B Baker Street",
    "address2": null,
    "postcode": "NW16XE",
    "city": "London",
    "state": null,
    "country": "GB",
    "language": "en",
    "delivery_type": "BILLING"
  },
  "hosted_payment": {
    "payment_url": "https://secure.payplug.com/pay/1FTGSRWYHla7eDkfTo2Usd",
    "return_url": "https://example.net/success?id=42",
    "cancel_url": "https://example.net/cancel?id=42"
  },
  "notification": {
    "url": "https://example.net/notifications?id=42"
  },
  "schedule": [
    {
      "date":"2019-01-24",
      "amount": 15000,
      "payment_ids": ["pay_62VazeAbq5ttYietdC2QxR"]
    }, 
    {
      "date":"2019-02-24",
      "amount": 15000,
      "payment_ids": ["pay_12uazeAbq5ttYietdC2QxP"]
    }, 
    {
      "date":"2019-03-24",
      "amount": 10000,
      "payment_ids": []
    }
  ],
  "failure": null,
  "metadata": {
    "customer_id": 42
  }
}
```

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

### Payment response object

Source: https://docs.payplug.com/api/apiref.html?python=

Example of the JSON response returned after a successful payment update.

```json
__{
  "id": "pay_4j...",
  "is_live": true,
  "amount": 1000,
  "currency": "EUR",
  "is_paid": true,
  "paid_at": 1701351541,
  "hosted_payment": null,
  "notification": {
    "url": null,
    "response_code": null
  },
  "metadata": {
    "applepay_workflow": "cart"
  },
  "failure": null,
  "refundable_after": 1701351541,
  "refundable_until": 1716903541,
  "integration": null,
  "payment_method": {
    "type": "apple_pay",
  },
  "billing": {
    "title": null,
    "first_name": "Jake",
    "last_name": "Thedog",
    "address1": "110 Avenue de France",
    "address2": null,
    "company_name": null,
    "postcode": "75013",
    "city": "Paris",
    "state": null,
    "country": "FR",
    "email": "jake.thedog@gmail.com",
    "mobile_phone_number": null,
    "landline_phone_number": null,
    "language": "fr"
  },
  "shipping": {
    "title": null,
    "first_name": "Jake",
    "last_name": "Thedog",
    "address1": "110 Avenue de France",
    "address2": null,
    "company_name": null,
    "postcode": "75013",
    "city": "Paris",
    "state": null,
    "country": "FR",
    "email": "jake.thedog@gmail.com",
    "mobile_phone_number": "+336000000",
    "landline_phone_number": null,
    "language": "fr",
    "delivery_type": null
  }
}
```

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

### POST /v1/oney_payment_simulations

Source: https://docs.payplug.com/api/apiref.html?php=

Simulate an Oney payment to determine installment amounts and schedules.

```APIDOC
## POST /v1/oney_payment_simulations

### Description
Simulate split payments with Oney to calculate installment amounts and dates. This is useful for displaying payment schedules and fee details to customers.

### Method
POST

### Endpoint
/v1/oney_payment_simulations

### Response
#### Success Response (200)
- **x3_with_fees** (JSON object) - Simulation for a payment in 3 installments with fees.
- **x4_with_fees** (JSON object) - Simulation for a payment in 4 installments with fees.
- **x3_without_fees** (JSON object) - Simulation for a payment in 3 installments without fees.
- **x4_without_fees** (JSON object) - Simulation for a payment in 4 installments without fees.

#### Response Example
{
  "x3_with_fees": {
    "down_payment_amount": 67667,
    "nominal_annual_percentage_rate": 6.04,
    "effective_annual_percentage_rate": 6.21,
    "installments": [
      {
        "date": "2019-12-29T01:00:00.000Z",
        "amount": 66667
      },
      {
        "date": "2020-01-29T01:00:00.000Z",
        "amount": 66666
      }
    ],
    "total_cost": 1000
  }
}
```

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

### Create an Oney payment request

Source: https://docs.payplug.com/api/apiref.html?python=

Example of the data structure and method call required to initiate an Oney payment.

```python
__payment_data = {
  "authorized_amount": 50000,
  "auto_capture": True,
  "currency": "EUR",
  "payment_method": "oney_x3_with_fees",
  "billing": {
    "title": "mr",
    "first_name": "John",
    "last_name": "Watson",
    "email": "john.watson@example.net",
    "address1": "1 rue de la Boetie",
    "postcode": "75008",
    "city": "Paris",
    "country": "FR",
    "mobile_phone_number": "+33612345678",
    "language": "fr"
  },
  "shipping": {
    "title": "mr",
    "first_name": "John",
    "last_name": "Watson",
    "email": "john.watson@example.net",
    "address1": "1 rue de la Boetie",
    "postcode": "75008",
    "city": "Paris",
    "country": "FR",
    "language": "fr",
    "mobile_phone_number": "+33612345678",
    "delivery_type": "BILLING",
    "company_name": "SuperCorp"
  },
  "payment_context": {
    "cart": [
      {
          "delivery_label": "Micropple store",
          "delivery_type": "storepickup",
          "brand": "Micropple",
          "merchant_item_id": "REF-123456",
          "name": "Laser printer",
          "expected_delivery_date": "2030-06-20",
          "total_amount": 22000,
          "price": 11000,
          "quantity": 2
      }
    ]
  },
  "notification_url": "https://example.net/notifications?id=42",
  "hosted_payment": {
    "return_url": "https://example.net/return?id=42"
  }
}
payment = payplug.Payment.create(**payment_data)
```

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

### Notification Management

Source: https://docs.payplug.com/api/apiref.html

Examples of how to use the PayPlug SDK to treat incoming notifications and retrieve the accounting report.

```APIDOC
## Notification Management

### Description
When an accounting report generation is completed, PayPlug sends a notification to the provided `notification_url`. The SDK provides a `treat` method to parse this notification and retrieve the report resource.

### Usage
#### PHP
```php
$input = file_get_contents('php://input');
try {
  $resource = \Payplug\Notification::treat($input);

  if ($resource instanceof \Payplug\Resource\AccountingReport
    && $resource->temporary_url
    ) {
    // Get the accounting report file from
    // $resource->temporary_url and process it.
  }
}
catch (\Payplug\Exception\PayplugException $exception) {
  // Handle errors
}
```

#### Python
```python
request_body = request.body
try:
  resource = payplug.notifications.treat(request_body)
except payplug.exceptions.PayplugError:
  # Handle errors
  pass
else:
  if resource.object == 'accounting_report' and resource.temporary_url:
    # Get the accounting report file from
    # resource.temporary_url and process it.
```

### Object Attributes
- **id** (string) - The accounting report’s unique identifier.
- **object** (string) - Value is: `accounting_report`.
- **is_live** (boolean) - `true` for an accounting report in LIVE mode, `false` in TEST mode.
```

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

### Accounting report response example

Source: https://docs.payplug.com/api/apiref.html?python=

The JSON structure returned after successfully initiating an accounting report creation.

```json
{
  "object": "accounting_report",
  "id": "ar_6zrx929ldfIzqnX6KktHzZ",
  "is_live": true,
  "temporary_url": null,
  "file_available_until": null,
  "start_date": "2019-11-08",
  "end_date": "2020-04-15",
  "notification_url": "https://example.net/notifications?id=42"
}
```

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

### Create a payment with a saved card

Source: https://docs.payplug.com/api/apiref.html?python=

Examples for creating a payment using a saved card ID across different interfaces.

```bash
__$ curl -X POST https://api.payplug.com/v1/payments \
  -H 'Authorization: Bearer sk_test_9898098098guGYUG9' \
  -H 'PayPlug-Version: 2019-08-06' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 1000,
    "currency": "EUR",
    "payment_method": "card_e7133426b8de947b37161dfba1897dd1",
    "initiator": "PAYER",
    "billing": {
      "title": "mr",
      "first_name": "John",
      "last_name": "Watson",
      "email": "john.watson@example.net",
      "address1": "221B Baker Street",
      "postcode": "NW16XE",
      "city": "London",
      "country": "GB",
      "language": "en"
    },
    "shipping": {
      "title": "mr",
      "first_name": "John",
      "last_name": "Watson",
      "email": "john.watson@example.net",
      "address1": "221B Baker Street",
      "postcode": "NW16XE",
      "city": "London",
      "country": "GB",
      "language": "en",
      "delivery_type": "BILLING"
    }
  }'
```

```php
__<?php
$payment = \Payplug\Payment::create(array(
  'amount'         => 1000,
  'currency'       => 'EUR',
  'payment_method' => 'card_e7133426b8de947b37161dfba1897dd1',
  'initiator'      => 'PAYER',
  'billing'      => array(
    'title'      => 'mr',
    'first_name' => 'John',
    'last_name'  => 'Watson',
    'email'      => 'john.watson@example.net',
    'address1'   => '221B Baker Street',
    'postcode'   => 'NW16XE',
    'city'       => 'London',
    'country'    => 'GB',
    'language'   => 'en'
  ),
  'shipping'        => array(
    'title'         => 'mr',
    'first_name'    => 'John',
    'last_name'     => 'Watson',
    'email'         => 'john.watson@example.net',
    'address1'      => '221B Baker Street',
    'postcode'      => 'NW16XE',
    'city'          => 'London',
    'country'       => 'GB',
    'language'      => 'en',
    'delivery_type' => 'BILLING'
  ),
  'notification_url' => 'https://example.net/notifications?id=42',
  'metadata'      => array(
    'customer_id' => 42
  )
));
```

```python
__payment_data = {
  'amount': 1000,
  'currency': 'EUR',
  'payment_method': 'card_e7133426b8de947b37161dfba1897dd1',
  'initiator': 'PAYER',
  'billing': {
    'title': 'mr',
    'first_name': 'John',
    'last_name': 'Watson',
    'email': 'john.watson@example.net',
    'address1': '221B Baker Street',
    'postcode': 'NW16XE',
    'city': 'London',
    'country': 'GB',
    'language': 'en'
  },
  'shipping': {
    'title': 'mr',
    'first_name': 'John',
    'last_name': 'Watson',
    'email': 'john.watson@example.net',
    'address1': '221B Baker Street',
    'postcode': 'NW16XE',
    'city': 'London',
    'country': 'GB',
    'language': 'en',
    'delivery_type': 'BILLING'
  },
  'notification_url': 'https://example.net/notifications?id=42',
  'metadata': {
    'customer_id': 42,
  },
}
payment = payplug.Payment.create(**payment_data)
```

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

### Apple Pay Payment Response Structure

Source: https://docs.payplug.com/api/apiref.html?python=

Example JSON response returned after successfully creating an Apple Pay payment.

```json
__{
  "amount": 1000,
  "currency": "EUR",
  "is_paid": false,
  "paid_at": null,
  "hosted_payment": null,
  "notification": {
    "url": null,
    "response_code": null
  },
  "metadata": {
    "applepay_workflow": "cart"
  },
  "failure": null,
  "installment_plan_id": null,
  "authorization": null,
  "refundable_after": null,
  "refundable_until": null,
  "integration": null,
  "payment_method": {
    "type": "apple_pay",
    "merchant_session": {
      "..."
    }
  },
  "billing": {
    "title": null,
    "first_name": "John",
    "last_name": "Watson",
    "address1": null,
    "address2": null,
    "company_name": null,
    "postcode": null,
    "city": null,
    "state": null,
    "country": null,
    "email": "john.watson@example.net",
    "mobile_phone_number": null,
    "landline_phone_number": null,
    "language": "fr"
  },
  "shipping": {
    "title": null,
    "first_name": "John",
    "last_name": "Watson",
    "address1": null,
    "address2": null,
    "company_name": null,
    "postcode": null,
    "city": null,
    "state": null,
    "country": null,
    "email": "john.watson@example.net",
    "mobile_phone_number": null,
    "landline_phone_number": null,
    "language": "fr",
    "delivery_type": null
  }
}
```

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

### Oney payment response structure

Source: https://docs.payplug.com/api/apiref.html?powershell=

Example of the JSON response object returned after creating an Oney payment.

```json
{
  "billing": {
      "address1": "1 rue de la Boetie",
      "last_name": "Watson",
      "city": "Paris",
      "address2": null,
      "email": "john.watson@example.net",
      "state": null,
      "landline_phone_number": null,
      "first_name": "John",
      "title": "mr",
      "company_name": null,
      "language": "fr",
      "postcode": "75008",
      "country": "FR",
      "mobile_phone_number": "+33612345678"
  },
  "is_3ds": null,
  "shipping": {
      "address1": "1 rue de la Boetie",
      "last_name": "Watson",
      "city": "Paris",
      "address2": null,
      "email": "john.watson@example.net",
      "state": null,
      "landline_phone_number": null,
      "first_name": "John",
      "title": "mr",
      "company_name": "SuperCorp",
      "language": "fr",
      "postcode": "75008",
      "country": "FR",
      "delivery_type": "BILLING",
      "mobile_phone_number": "+33612345678"
  },
  "is_live": true,
  "notification": {
      "url": "https://example.net/notifications?id=42",
      "response_code": null
  },
  "hosted_payment": {
      "cancel_url": null,
      "payment_url": "https://secure.payplug.com/pay/4W43bXst15Yd55RE9ZszX2",
      "sent_by": null,
      "paid_at": null,
      "return_url": "https://example.net/return?id=42"
  },
  "is_refunded": false,
  "amount": 50000,
  "save_card": false,
  "currency": "EUR",
  "object": "payment",
  "card": {
      "exp_year": null,
      "last4": null,
      "metadata": null,
      "id": null,
      "country": null,
      "brand": null,
      "exp_month": null
  },
  "payment_method": {
      "is_pending": false,
      "type": "oney_x3_with_fees"
  },
  "id": "pay_4W43bXst15Yd55RE9ZszX2",
  "description": null,
  "paid_at": null,
  "metadata": null,
  "is_paid": false,
  "authorization": {
      "authorized_at": null,
      "authorized_amount": 50000,
      "expires_at": null
  },
  "installment_plan_id": null,
  "created_at": 1574951751,
  "amount_refunded": 0,
  "failure": null
}
```

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

### Create an accounting report

Source: https://docs.payplug.com/api/apiref.html?php=

Initiates the asynchronous generation of an accounting report by providing start and end dates.

```bash
curl -X POST https://api.payplug.com/v1/accounting_reports \
  -H 'Authorization: Bearer sk_test_9898098098guGYUG9' \
  -H 'PayPlug-Version: 2019-08-06' \
  -H 'Content-Type: application/json' \
  -d '{
  "start_date": "2019-11-08",
  "end_date": "2020-04-15",
  "notification_url": "https://example.net/notifications?id=42"
     }'
```

```php
<?php
$data = array(
    'start_date' => '2019-11-08',
    'end_date' => '2020-04-15',
    'notification_url' => 'https://example.net/notifications?id=42'
  );
$report = \Payplug\AccountingReport::create($data);
$report_id = $report->id;
```

```python
data = {
    "start_date": "2019-11-08",
    "end_date": "2020-04-15",
    "notification_url": "https://example.net/notifications?id=42"
}
report = payplug.AccountingReport.create(**data)
report_id = report.id
```

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

### Installment plan notification object

Source: https://docs.payplug.com/api/downloads/payplug_api_apiref_powershell.html

Example of the JSON object received via notification when an installment plan event occurs.

```json
{
  "id": "inst_1FTGSRWYHla7eDkfTo2Usd",
  "object": "installment_plan",
  "is_live": true
}
```
Tokens:
Raw