Getting Started

Create QuickLink

Outcome: Create a QuickLink through API

Authorization

You should send a valid auth token as a Bearer Token.

Common Errors

400 Bad Request

JSON

 { 
    "message": "Reference ID already exists." 
}

Solution: Make sure to pass a unique reference_id each time.

Passing Wrong Auth Token Or Not Passing Auth Token

401 Unauthorized

JSON

 { 
    "detail": "incorrect credentials" 
}

Solution: Make sure to pass a valid and non-expired Auth Token each time.

Passing an expiry date in the past

400 Bad Request

JSON

 { 
    "message": "expires_at - expires_at can't be in the past.", 
    "errors": { 
        "expires_at": [ 
            "expires_at can't be in the past." 
        ] 
    } 
}

Solution: Make sure to pass an expiry date in the future.

Passing an integration ID not in the same status (Test/Live) of is_live parameter

404 Not Found

JSON

 { 
    "detail": "Integration ID/Name does not exist in our system . You can find the list of Integration ID’/Names from Merchant Dashboard under Developers → Payment Integrations Tab" 
}

Solution: Make sure that the passed integration ID is in the same status of is_live parameter

Header Parameters

Authorizationstring Required

Bearer token authentication. Format: "Token YOUR_SECRET_KEY"

Body Parameters

payment_link_imagestring

Image file to be displayed on the payment link page. Supported formats include common image types (e.g., PNG, JPG).

amount_centsstring Required

Transaction amount in cents (e.g., 5500 = 55.00).

expires_atstring

Expiration date and time for the payment link in ISO 8601 format (YYYY-MM-DDTHH:MM: SS).

reference_idstring

Merchant-defined unique reference for the payment link, used for tracking

payment_methodsstring Required

ID(s) of the allowed payment methods for this payment link. To enable multiple methods, repeat this parameter with each payment method’s integration ID.

emailstring

The customer’s email address is associated with the payment link.

is_livestring Required

Indicates whether the payment link is created in live mode (true) or test mode (false).

full_namestring

Customer’s full name.

phone_numberstring

Customer’s phone number in international format (e.g., +201XXXXXXXXX).

descriptionstring

Description or note displayed for the payment link.

Response

200

Object

Successful response

Response Attributes

idnumber

Unique identifier for the transaction

currencystring

Currency code (e.g., EGP, USD)

client_infoobject

Show child attributes

reference_idstring

shorten_urlstring

amount_centsnumber

Transaction amount in cents

payment_link_imagestring

descriptionstring

Description of the item

created_atstring

Timestamp when the record was created

expires_atstring

client_urlstring

originnumber

merchant_staff_tagstring

Staff tag for merchant tracking

statestring

State or province

paid_atstring

redirection_urlstring

notification_urlstring

ordernumber

Order details associated with this transaction

400

Object

400 Bad Request Solution: Make sure to pass a unique reference_id each time.

Response Attributes

messagestring

401

Object

401 Unauthorized Solution: Make sure to pass a valid and non-expired Auth Token each time.

Response Attributes

detailstring

404

Object

Passing an integration ID not in the same status (Test/Live) of is_live parameter 404 Not Found <b>Solution: </b> Make sure that the passed integration ID is in the same status of is_live parameter