Product Link Creation

A guide to use our product API.

In case you need to generate product links using an API instead of generating it from your Accept dashboard, kindly check the guide below for our product link request and response.

URL: https://accept.paymobsolutions.com/api/ecommerce/products

Method: POST

Source: Merchant's server

Recipient: Accept's server

Content-Type: JSON

Example Request:

{
"auth_token":"AUTH_TOKEN_FROM_STEP_1",
"product_name":"Product_NAME",
"amount_cents":"4000",
"currency":"EGP",
"inventory":"1",
"delivery_needed":"false",
"integrations":[Card_int_ID,wallet_int_ID,kiosk_int_ID],
"allow_quantity_edit":"false",
"product_description":"Product_Description"
}

Parameter

Value to be entered

auth_token

The authentication token you receive in the first request. Check the first request in the payment API flow.

product_name

The name of your product.

amount_cents

The price in cents of the product.

currency

The currency used in the invoice. By default, it will be EGP.

inventory

The stock of your product in your inventory.

integrations

The payment methods that will be listed in the invoice link. You should enter the integration ID of every payment method.

allow_quantity_edit

If the stock will be reduced when a product is paid for.

delivery_needed

Determines if you use our delivery. By default, it will be "false".

product_description

The description of your product.

Example Response:

{
    "id": 36448,
    "product_name": "test_product2",
    "product_description": "test_product2",
    "created_at": "2021-10-06T15:13:52.052242",
    "delivery_needed": false,
    "merchant": {
        "id": 15527,
        "created_at": "2020-07-19T16:42:55.700882",
        "phones": [
            "01064664770"
        ],
        "company_emails": [
            "[email protected]"
        ],
        "company_name": "amgdwafik paymob",
        "state": "",
        "country": "EGY",
        "city": "cairo",
        "postal_code": "",
        "street": ""
    },
    "collector": null,
    "amount_cents": 1000,
    "currency": "EGP",
    "initial_amount_cents": null,
    "vat_amount_cents": null,
    "shipping_amount_cents": null,
    "inventory": 100,
    "merchant_product_id": null,
    "active": true,
    "product_url": "https://accept.paymobsolutions.com/standalone?ref=p_P4n",
    "allow_quantity_edit": false,
    "integrations": [
        {
            "is_live": false,
            "host": null,
            "created_at": "2020-07-19T17:44:54.387677",
            "gateway_type": "VALU",
            "transaction_processed_callback": "https://webhook.site/0f2e8cb8-7d9f-4e27-9873-7156e3867716",
            "transaction_response_callback": "https://accept.paymobsolutions.com/api/acceptance/post_pay",
            "is_deprecated": false,
            "id": 27696,
            "merchant_id": 15527,
            "currency": "EGP",
            "is_auth": false,
            "allowed_aggregators": [
                "aman",
                "masary"
            ],
            "is_shopify": false,
            "integration_type": "online",
            "settlement_type": "AGG",
            "is_standalone": false,
            "is_pos": false
        },
        {
            "is_live": false,
            "host": null,
            "created_at": "2020-07-19T16:42:55.709737",
            "gateway_type": "VPC",
            "transaction_processed_callback": "https://wdhqostg01:5010/Paymob/Processresponse",
            "transaction_response_callback": "https://accept.paymobsolutions.com/api/acceptance/post_pay",
            "is_deprecated": false,
            "id": 27689,
            "merchant_id": 15527,
            "currency": "EGP",
            "is_auth": false,
            "allowed_aggregators": [
                "aman",
                "masary"
            ],
            "is_shopify": false,
            "integration_type": "online",
            "settlement_type": "AGG",
            "is_standalone": false,
            "is_pos": false
        }
    ],
    "merchant_staff_tag": null,
    "pickup_data": null,
    "image_url": null
}

Parameter

Definition

id

The ID of the created product.

product_url

The URL of the standalone product link.


Did this page help you?