Skip to content

Papara

IZ Integration option

Info

This integration option supports only TRY currency.

Payment

Payment flow

  1. The customer initiates the payment on the merchant's website.
  2. The merchant sends the payment request to Overpay.
  3. Overpay sends parameters for building an HTML-form for the payment.
  4. The merchant builds an HTML-form based on the parameters from the response. The lifespan of the link in the form.action parameter is 15 minutes.
  5. The merchant redirects the customer to the form for completing the payment.
  6. The customer confirms the payment.
Request

Send a payment request with the following additional data:

Parameter Type Description
request object
return_url * required
 string A URL to return the customer to when the transaction is completed.
method object A section of the payment method information.
type
* required
 string papara
customer object A section of information about the customer.
first_name
* required
 string The customer's first name.
last_name
* required
 string The customer's last name.
email
* required
 string The customer's email address.
phone
* required
 string The customer's phone number without the special symbols.
Request example 
{
    "request": {
        "test": true,
        "amount": 202,
        "currency": "TRY",
        "description": "description",
        "return_url": "https://return.com",
        "method": {
            "type": "papara"
        },
        "customer": {
            "email": "example@example.com",
            "phone": "79991234567",
            "first_name": "Phil",
            "last_name": "Williams"
        }
    }
}
Response

Build an HTML form based on the parameters in the form object. Redirect the customer to the form to finalize the payment.

Response example 
{
  "transaction": {
    "uid": "6f8d889c-3b69-4a6c-9bc8-50c22a9090b0",
    "type": "payment",
    "status": "pending",
    "amount": 202,
    "currency": "TRY",
    "description": "description",
    "created_at": "2025-02-02T19:30:25Z",
    "updated_at": "2025-02-02T19:30:25Z",
    "method_type": "papara",
    "receipt_url": "https://backoffice.overpay.io/customer/transactions/6f8d889c-3b69-4a6c-9bc8-50c22a9090b0/33b21d418465c695a01e5aac74dd01966488c61915895bfa6423b560bfbaac1a",
    "payment": {
      "status": "pending",
      "gateway_id": 4908,
      "message": "Transaction was initialized."
    },
    "papara": {
      "type": "papara"
    },
    "customer": {
      "first_name": "Phil",
      "last_name": "Williams",
      "email": "example@example.com",
      "phone": "79991234567",
      "ip": null
    },
    "manually_corrected_at": null,
    "version": 0,
    "message": "Transaction was initialized.",
    "test": true,
    "billing_address": {
      "first_name": "Phil",
      "last_name": "Williams",
      "email": "example@example.com",
      "phone": "79991234567"
    },
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },   
    "gateway": {
      "iframe": false
    },
    "form": {
      "action": "link-to-payment-page",
      "method": "POST",
      "fields": [
        {
          "name": "amount",
          "value": "2.02",
          "type": "hidden"
        },
        {
          "name": "amountcurr",
          "value": "TRY",
          "type": "hidden"
        },
        {
          "name": "currency",
          "value": "EXT",
          "type": "hidden"
        },
        {
          "name": "number",
          "value": "6f8d889c3b694a6c9bc850c22a9090b0",
          "type": "hidden"
        },
        {
          "name": "description",
          "value": "https%3A%2F%2Fexample.com",
          "type": "hidden"
        },
        {
          "name": "trtype",
          "value": "1",
          "type": "hidden"
        },
        {
          "name": "phone",
          "value": "79991234567",
          "type": "hidden"
        },
        {
          "name": "email",
          "value": "example@example.com",
          "type": "hidden"
        },
        {
          "name": "account",
          "value": "ACC041111",
          "type": "hidden"
        },
        {
          "name": "backURL",
          "value": "https://api.overpay.io/beyag/transactions/returns/260ded068740631540a58d9f5c66b02506b6607ec397fa3689911bd7677e8616/6f8d889c-3b69-4a6c-9bc8-50c22a9090b0",
          "type": "hidden"
        },
        {
          "name": "cf1",
          "value": "first_name:Phil;last_name:Williams",
          "type": "hidden"
        },
        {
          "name": "cf2",
          "value": "",
          "type": "hidden"
        },
        {
          "name": "cf3",
          "value": "",
          "type": "hidden"
        },
        {
          "name": "signature",
          "value": "038B513F6A228978F90746AADFF4E4E1",
          "type": "hidden"
        }
      ]
    }
  }
}