Integration Guide & API Reference

Create Intention API

URL: https://pakistan.paymob.com/v1/intention/
Method: POST
source: Merchant's server
recipient: Paymob's server
Content: JSON

authorization-header: Token <secret_key>

{
    "amount": 35000,
    "currency": "PKR",
    "payment_methods":  ["card", "Nift","Jazzcash","Easypaisa"],
    "items": [
        {
            "name": "Item name",
            "amount": 35000,
            "description": "Item description",
            "quantity": 1
        }
    ],
    "billing_data": {
        "apartment": "dumy",
        "first_name": "dumy",
        "last_name": "dumy",
        "street": "dumy",
        "building": "dumy",
        "phone_number": "+2001125773493",
        "city": "dumy",
        "country": "dumy",
        "email": "[email protected]",
        "floor": "dumy",
        "state": "dumy"
    },
     "extras": {"billing_data": {
        "apartment": "dumy",
        "first_name": "dumy",
        "last_name": "dumy",
        "street": "dumy",
        "building": "dumy",
        "phone_number": "+2001125773493",
        "city": "dumy",
        "country": "dumy",
        "email": "[email protected]",
        "floor": "dumy",
        "state": "dumy"
    }}
}

{
    "payment_keys": [
        {
            "integration": 25,
            "key": "ZXlKaGJHY2lPaUpJVXpVeE1pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SjFjMlZ5WDJsa0lqbzRNU3dpWVcxdmRXNTBYMk5sYm5Seklqb3pOVEF3TUN3aVkzVnljbVZ1WTNraU9pSkJSVVFpTENKcGJuUmxaM0poZEdsdmJsOXBaQ0k2TWpVc0ltSnBiR3hwYm1kZlpHRjBZU0k2ZXlKbWFYSnpkRjl1WVcxbElqb2laSFZ0ZVNJc0lteGhjM1JmYm1GdFpTSTZJbVIxYlhraUxDSnpkSEpsWlhRaU9pSmtkVzE1SWl3aVluVnBiR1JwYm1jaU9pSmtkVzE1SWl3aVpteHZiM0lpT2lKa2RXMTVJaXdpWVhCaGNuUnRaVzUwSWpvaVpIVnRlU0lzSW1OcGRIa2lPaUprZFcxNUlpd2ljM1JoZEdVaU9pSmtkVzE1SWl3aVkyOTFiblJ5ZVNJNkltUjFiWGtpTENKbGJXRnBiQ0k2SW1SMWJYbEFaSFZ0ZVM1amIyMGlMQ0p3YUc5dVpWOXVkVzFpWlhJaU9pSXJNakF3TVRFeU5UYzNNelE1TXlJc0luQnZjM1JoYkY5amIyUmxJam9pVGtFaUxDSmxlSFJ5WVY5a1pYTmpjbWx3ZEdsdmJpSTZJazVCSW4wc0lteHZZMnRmYjNKa1pYSmZkMmhsYmw5d1lXbGtJanBtWVd4elpTd2liM0prWlhJaU9uc2laR1ZzYVhabGNubGZibVZsWkdWa0lqcG1ZV3h6WlN3aVlXMXZkVzUwWDJObGJuUnpJam96TlRBd01Dd2lZM1Z5Y21WdVkza2lPaUpGUjFBaUxDSnBkR1Z0Y3lJNlczc2libUZ0WlNJNklrbDBaVzBnYm1GdFpTSXNJbVJsYzJOeWFYQjBhVzl1SWpvaVNYUmxiU0JrWlhOamNtbHdkR2x2YmlJc0ltRnRiM1Z1ZEY5alpXNTBjeUk2TXpVd01EQXNJbkYxWVc1MGFYUjVJam94ZlYxOUxDSnVaWGgwWDNCaGVXMWxiblJmYVc1MFpXNTBhVzl1SWpvaWNHbGZkR1Z6ZEY4d016SmhPREE1T0RWaE1HUTBaR1kzT0RFMU5HSTJaVEV6TldVMVlqUXdZeUlzSW1WNGNDSTZNVFkzTkRVMU16RXlNWDAucXlpVWhxUmZFbkVOWUxSNTA0ZHYtdVVzSTlhbFk5TVU2TVlpZXhpWTJDaW5fVU56cVE0SjZablNOYjQxaDBFUGtKRC1XdzRXbjZrSXFCaXQ1OTA2R3c=",
            "gateway_type": "MIGS"
        }
    ],
    "id": "pi_test_032a80985a0d4df78154b6e135e5b40c",
    "intention_detail": {
        "amount": 35000,
        "items": [
            {
                "name": "Item name",
                "amount": 35000,
                "description": "Item description",
                "quantity": 1
            }
        ]
    },
    "client_secret": "csk_test_32e9a7b0472a75b7d7baeb09e47a83fa",
    "payment_methods": [
        {
            "id": "pm_test_8792bf52846b47bfa9df25b32d02bc9c",
            "integration_id": "25",
            "alias": null,
            "name": "Card",
            "type": "online",
            "currency": "PKR",
            "live": false,
            "object": "paymentmethods",
            "is_enabled": true
        }
    ],
    "transactions": [],
    "special_reference": null,
    "transaction_records": [],
    "extras": {
        "creation_extras": {
            "billing_data": {
                "apartment": "dumy",
                "first_name": "dumy",
                "last_name": "dumy",
                "street": "dumy",
                "building": "dumy",
                "phone_number": "+2001125773493",
                "city": "dumy",
                "country": "dumy",
                "email": "[email protected]",
                "floor": "dumy",
                "state": "dumy"
            }
        },
        "confirmation_extras": null
    },
    "confirmed": false,
    "customer": null,
    "status": "intended",
    "created": "2023-01-24T10:38:41.685849+02:00",
    "object": "paymentintention"
}

🚧
Note
You can get secret_key and public_key from Merchant Dashboard.
secret_key :sk_test_626ba4a60a6f9cf4b0bc066ad3de884e93693afd5218ef832e99cbdf76a0fb37
public_key: pk_test_yl9JpHlmLY17jAL16yWU4y2zlpke14pO
client_secret_key: It can be obtained from the response of create intention API

Retrieve Intention API

URL: https://pakistan.paymob.com/v1/intention/element/<public_key/<client_secret_key>
Method: GET
source: Merchant's server
recipient: Paymob's server
Content: JSON

{
    "id": "pi_test_032a80985a0d4df78154b6e135e5b40c",
    "intention_detail": {
        "amount": 35000,
        "items": [
            {
                "name": "Item name",
                "amount": 35000,
                "description": "Item description",
                "quantity": 1
            }
        ]
    },
    "client_secret": "csk_test_32e9a7b0472a75b7d7baeb09e47a83fa",
    "payment_methods": [
        {
            "id": "pm_test_8792bf52846b47bfa9df25b32d02bc9c",
            "integration_id": "25",
            "alias": null,
            "name": "Card",
            "type": "online",
            "currency": "PKR",
            "live": false,
            "object": "paymentmethods"
        }
    ],
    "transactions": [],
    "special_reference": null,
    "transaction_records": [],
    "extras": {
        "creation_extras": {
            "billing_data": {
                "city": "dumy",
                "email": "[email protected]",
                "floor": "dumy",
                "state": "dumy",
                "street": "dumy",
                "country": "dumy",
                "building": "dumy",
                "apartment": "dumy",
                "last_name": "dumy",
                "first_name": "dumy",
                "phone_number": "+2001125773493"
            }
        },
        "confirmation_extras": null
    },
    "confirmed": false,
    "customer": null,
    "status": "intended",
    "created": "2023-01-24T10:38:41.685849+02:00",
    "object": "paymentintention",
    "merchant_name": "561338211",
    "merchant_id": 13,
    "user_username": "ae409abb630c4f53ad1ecfd71efa3a16",
    "user_id": 10,
    "payment_keys": {
        "live": false,
        "card": "ZXlKaGJHY2lPaUpJVXpVeE1pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SjFjMlZ5WDJsa0lqbzRNU3dpWVcxdmRXNTBYMk5sYm5Seklqb3pOVEF3TUN3aVkzVnljbVZ1WTNraU9pSkJSVVFpTENKcGJuUmxaM0poZEdsdmJsOXBaQ0k2TWpVc0ltSnBiR3hwYm1kZlpHRjBZU0k2ZXlKbWFYSnpkRjl1WVcxbElqb2laSFZ0ZVNJc0lteGhjM1JmYm1GdFpTSTZJbVIxYlhraUxDSnpkSEpsWlhRaU9pSmtkVzE1SWl3aVluVnBiR1JwYm1jaU9pSmtkVzE1SWl3aVpteHZiM0lpT2lKa2RXMTVJaXdpWVhCaGNuUnRaVzUwSWpvaVpIVnRlU0lzSW1OcGRIa2lPaUprZFcxNUlpd2ljM1JoZEdVaU9pSmtkVzE1SWl3aVkyOTFiblJ5ZVNJNkltUjFiWGtpTENKbGJXRnBiQ0k2SW1SMWJYbEFaSFZ0ZVM1amIyMGlMQ0p3YUc5dVpWOXVkVzFpWlhJaU9pSXJNakF3TVRFeU5UYzNNelE1TXlJc0luQnZjM1JoYkY5amIyUmxJam9pVGtFaUxDSmxlSFJ5WVY5a1pYTmpjbWx3ZEdsdmJpSTZJazVCSW4wc0lteHZZMnRmYjNKa1pYSmZkMmhsYmw5d1lXbGtJanBtWVd4elpTd2liM0prWlhJaU9uc2laR1ZzYVhabGNubGZibVZsWkdWa0lqcG1ZV3h6WlN3aVlXMXZkVzUwWDJObGJuUnpJam96TlRBd01Dd2lZM1Z5Y21WdVkza2lPaUpGUjFBaUxDSnBkR1Z0Y3lJNlczc2libUZ0WlNJNklrbDBaVzBnYm1GdFpTSXNJbVJsYzJOeWFYQjBhVzl1SWpvaVNYUmxiU0JrWlhOamNtbHdkR2x2YmlJc0ltRnRiM1Z1ZEY5alpXNTBjeUk2TXpVd01EQXNJbkYxWVc1MGFYUjVJam94ZlYxOUxDSnVaWGgwWDNCaGVXMWxiblJmYVc1MFpXNTBhVzl1SWpvaWNHbGZkR1Z6ZEY4d016SmhPREE1T0RWaE1HUTBaR1kzT0RFMU5HSTJaVEV6TldVMVlqUXdZeUlzSW1WNGNDSTZNVFkzTkRVMU16RXlNWDAucXlpVWhxUmZFbkVOWUxSNTA0ZHYtdVVzSTlhbFk5TVU2TVlpZXhpWTJDaW5fVU56cVE0SjZablNOYjQxaDBFUGtKRC1XdzRXbjZrSXFCaXQ1OTA2R3c="
    },
    "is_card_expired": false
}

🚧
Note
Once you done with the Intention you need to call this URL. It will open in browser's window.
Unified URL https://pakistan.paymob.com/unifiedcheckout/?publicKey=<public_key&clientSecret=<client_secret_key>