TItickitto
Basket

Create Careem Pay Object

Changed on

When using Tickitto as the Merchant of Record, creates and returns an object containing the careem pay details needed for the front-end to handle basket payment.

*Note: the account associated with the provided key must first be enabled for Careem Pay checkout before this request can succeed.

post/api/basket/careem_pay_object

Request

  • Base URL
    https://tickitto.tech (the document declares no server; this is the origin it was published from)
  • URL
    https://tickitto.tech/api/basket/careem_pay_object
  • Auth
    API key in header key

Query parameters

basket_idstring required
currencystring

Currency for Careem Pay transaction

Headers

X-Correlation-IDstring

Optional transaction reference provided by the client. Used to correlate API requests and responses with client flow in logs, errors etc.

Request body

first_namestring required

Customer's first name

last_namestring required

Customer's surname/family name

phone_numberstring required

Customer's phone number in E.164 format

emailstring email required

Customer's email; must be a valid email

currencystring

Customer's chosen currency

agent_pinstring

Agent identifier, currently only used for Intele

ip_locationstring

IP location of the customer

careem_user_idstring required

Careem user id.

Response

Successful Response

invoice_idstring required
amountnumber required
currencystring required
additionalobject

Changes

  • 301a3da5eb84Revision changes
    • breaking

      the response's property type changed from string to number for status

    • info

      the response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status