Sign in

v1

latestOpenAPI 3.1.02026-07-26270268.6 KB

Create QR Code

post/api/v2/meezaPayment/image/base64

Request body

merchantPublicKeystring required

The unique identifier for the session given added by the merchant. Must be a valid UUID.

sessionIdstring required

A session ID, is a unique identifier that a server generates as part of the create session API call and assigns to a merchant transaction for the duration of the session (15 min).

customerEmailstring

Email of customer. Must be a valid email.

merchantReferenceIdstring

The unique identifier for the session given added by the merchant. Must be a valid UUID.

BillingAddressCountryCodestring

Country Code for billing address. Must be valid ISO-3-Alpha code

BillingAddressCitystring

Name of city in billing address

BillingAddressStreetAndNumberstring

Name of street in billing address

BillingAddressPostalCodestring

Postal Code in billing address

ShippingAddressCountryCodestring

Country Code for shipping address. Must be valid ISO-3-Alpha code

ShippingAddressCitystring

Name of city in shipping address

ShippingAddressStreetAndNumberstring

Name of street in shipping address

ShippingAddressPostalCodestring

Postal code in shipping address

PlatformIntegrationTypestring

Type of integration

PlatformNamestring
PlatformVersionstring
PlatformPluginVersionstring
PlatformPartnerIdstring
StatementDescriptorNamestring

An object that contains the statement descriptor information for the payment. This information will appear on the customer's bank statement. This contains the customer name.

StatementDescriptorPhonestring

An object that contains the statement descriptor information for the payment. This information will appear on the customer's bank statement. This contains the phone number.

language'en' | 'ar'

Language for Hosted Payment Page

customstring

This object allows you to attach any custom parameter to the payment. The value that you provide in the metadata.custom parameter will be returned to you after the payment in the callback.

callbackUrlstring

The URL where the payment gateway should send the callback after the transaction is completed. It must have a valid SSL certificate and start with 'https://'

customerReferenceIdstring

Identification Number, assigned to the Customer for the purposes of identifying the Customer when the Customer accesses the payment service.

createCustomerboolean

If this is set to true, a customer account is created on Geidea platform. This must be set to false, when customer ID is not null. When this is set to true, customerReferenceId must not be passed.

orderIdstring

This is a unique identifier for this order to discern it from others order you created. If orderId is not sent with the request, an orderId is created by the server and returned in the response. The orderid can be used to refer to this order in subsequent transactions and in retrieving meta data about the order. The orderId must always be unique for every order created under your merchant profile. This must be a valid GUID. You can pass null if you do not wish to pass any value.

customerPhoneNumberstring

Customer's phone number eg: "511111111". If phoneCountryCode is passed, phoneNumber must be passed. One of email or phoneNumber must be present.

customerPhoneCountryCodestring

Country code of customer's phone number eg: "+971". If phoneNumber is passed, phoneCountryCode must be passed.

source'HPP' | 'Internet'

Source of capturing the transaction, like, HPP

Response

200

imagestring
typestring
messagestring
paymentIntentIdstring
responseMessagestring
detailedResponseMessagestring
languagestring
responseCodestring
detailedResponseCodestring

Example response

{
  "image": "iVBORw0KGgoAAAANSUhEUgAAAYEAAAGBCAIAAAAPO5pzAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAO7UlEQVR4nO3dSY4bSRAEQAmY/39Zc69DAolYvEiaXbs2NluORFQo8r9///79AQj57w9AjgwCkmQQkCSDgCQZBCTJICBJBgFJMghIkkFAkgwCkmQQkCSDgCQZBCTJICBJBgFJMghIkkFAkgwCkmQQkFTKoL9///5Z8Rh6/bjv+aeVK1+5msx9vtHcJ7r66ZWrT3R17tWl3mnu6567VOW+V6yDgCQZBCTJICBJBgFJnRnUWCy8qqVVCn6Vc9eqv2sl+bPzfa9+z+dzz/edM/c2o3Jwo9S/0DPrICBJBgFJMghIkkFA0mAGrTW/ztXwGgtvcyXMVK9zY4n6fKPzQzYW7FN/SKk28Ze0p1sHAUkyCEiSQUCSDAKSPjKDKjXLyrlXT5UauPGSsutVifrqUo0qvexz30LjY3yEj8wg4GvIICBJBgFJMghI+sIMSo2Xvip+Vx4jVXecG6jSeN/zuWvjw9cmxnyBL8wg4IPIICBJBgFJMghIGsygVEvu3ESCytjjxt7utQ3zzlc+mxsC3djcfDbX6d7onUNvrlgHAUkyCEiSQUCSDAKSOjNobS+6K41TI64KjY1Fyrlm38qV534ba3tJvuSp5v42zge/hHUQkCSDgCQZBCTJICCplEEv6bOslCErP20sf1Z8xKZ3cwOk514yrD3V2dzf80tYBwFJMghIkkFAkgwCkgYz6CNGHzROjL4aqVGZNzzXNn02N3059Xkrl1rb4/BsbnDN3AuKB+sgIEkGAUkyCEiSQUDSSzOoUuKqlAPnpvNeTYw+n3t15atq95XKoI+zxktVzM3PnqscXx38klEeL80g4EfIICBJBgFJMghI2sugxg0CGyvWlWEOD5Vqd+Mehy+ZCjK3H2RF4/Tlxq0W5x7jfPDVja4udcU6CEiSQUCSDAKSZBCQVMqgxlkHD40tqpXqYOPUiEqf9MPaUOSzSvf2J27TWNH4u7o69+qpUn9X1kFAkgwCkmQQkCSDgKTODJqrdzZuH9h4cKWQ/DDXZXs+92FtVHNjw+6Vq8Ema13yV+YKyak55dZBQJIMApJkEJAkg4CkvT0OU0MG1iYoz7WZro16aNxdb22zvbn3Bo3fUWNX8UtazBtZBwFJMghIkkFAkgwCkgYzqLEcWLlvY9Fu7jFeUrNMjUw5m/tDmhvGMjdS46zxzU/l4CvWQUCSDAKSZBCQJIOApFif9Nw4jsql5vbem9unsPGZ1+qsZ43PPDcFZW3jybmHbJxxXmEdBCTJICBJBgFJMghI2uuTbhzlcTUmYq4Z9CWDq9dmaMz14D40bofZ+Guf+7wPc28G1srMV6yDgCQZBCTJICBJBgFJL82g1NyPK2tDr9dqpS+pd76kA7ty7tyGiHOTqh/WavAvzSDgR8ggIEkGAUkyCEgqZdBceWztUqkxz+cbnc9t3Jqu0pI7t+ffXEF3brfIs7UG5cYJ6GuveqyDgCQZBCTJICBJBgFJnRk0N/mhcQj02mTf1D6FFXMV+rV5FJWqc+rVx8NLmrnXXtdYBwFJMghIkkFAkgwCkkoZtLZxXeOVz+c2Vn8rH2Fu+PTcpeZmlZzNNaBfecl+kI3t6fY4BH6CDAKSZBCQJIOApMHZHQ9zVbrUNn5Xj7G2p2NjYfVs7Y3E1W/jqkQ9997gfN8rjWPLr260VsC2DgKSZBCQJIOAJBkEJA1mUKWUOLdv39VPrzR+hLU28bn7Nn7d5/telZkrv/aXfClXU5/XNtqssA4CkmQQkCSDgCQZBCQNzu6Y22xvrYNzbS5E48CNqys3lorPKu3pc9XQuXnSFZW9JM+XOp+bmmJuHQQkySAgSQYBSTIISOqc3fFQqXhVStTnSz00tlyvzf24UhltcXXlxoMrFfqr+75kf8QrqZ0m50rU1kFAkgwCkmQQkCSDgKTODLqqllXKgS/Z1+3qIa9cNQrPzdCYGy/90FgbXjP3R3i+0Uv6782TBr6EDAKSZBCQJIOApMEMqhQLG3usz9aGQM9VBysaS9RzjcKNvc6N1e6rUnHlV7f2quds7vu1DgKSZBCQJIOAJBkEJHVm0Ny+fan9Aht7f89e0ux7/uncb2NuskfjiJirG1X+gNe61efGgFyxDgKSZBCQJIOAJBkEJA3O7niYmyddsdbc3Ngp2zhvpLEHt/HgK3P7FDZutPnQ+MdwPnducktj27R1EJAkg4AkGQQkySAgaa9PunJwpYDdWM9ea2C9mhh9vtHcYOPKTxu3pWwsjs71ha+9VZh7L3T1VFesg4AkGQQkySAgSQYBSaUMmuuUbWwGvTp3rTd0bd++tZ3qrlQq5Ws7IFau/JLdIq8OnutlP7MOApJkEJAkg4AkGQQklTJobs+/xl3f1iqaV/3Zc5vPNc7ebqzQz/3ar7rkK0/1MNdzfL5R45XXJuScWQcBSTIISJJBQJIMApL2Mig1E7pybmN7a6U42jhFoVLunbNWdj3ft1I4b2wjnvu8V+euNc1bBwFJMghIkkFAkgwCkjpnd8y1TV9d6iy11WKlnfchNUF5rjH6LLUBZOPBL3n1cb5UZaCKedLAp5JBQJIMApJkEJA0OLujojJEIjUi+urKjQ/ZWDtsLNifrW21mBo+3Tghe631OTV63DoISJJBQJIMApJkEJA0mEFzAygazQ29vrpR44iJuXJv5eCrcyt7WDY2r6ek/vvBXCf0mXUQkCSDgCQZBCTJICCpM4M+cQ7u3Jjnqy0Pz+emfrGNl1qb63y+8tx9r4axNPYrX/30zDxp4BfJICBJBgFJMghI6sygxsEIjS2bc9XQuT3wGgvJcz3WjQXdudHFc2Mx1gaqXN33rDJRZO6prIOAJBkEJMkgIEkGAUmdexw+NM5naCwlPqxdaq0kP1dlT5XVzxpHiDQWZVPf4Fnq3DPrICBJBgFJMghIkkFA0t4ehy/Zxm/u4LO5nuOHuekNjaOL13b1e5gr985tprjW2115TVRhHQQkySAgSQYBSTIISHppBjWO1J3rDV2rDl7dt9L721iUPV+5sdrdWEef+0IrB5/PTY21afTSDAJ+hAwCkmQQkCSDgKTO2R3v7A09S5XlUmNPrh4j1a69Vlde6/xulPqA5yubJw18KhkEJMkgIEkGAUmdGXQuU13VDte2pmvc1e9srn5/dd+HuTJzqlTcOKf8I3blrDzV1WOYJw18JxkEJMkgIEkGAUmd86Qby8yVuuNZ455/c0/VaK55vXKpqxs1loof5oZPz736WNs8co11EJAkg4AkGQQkySAgaTCD5jbbO5vbAXGtbXquTfyh8Xd1/unc5oIPjXM/GnudG7/flzRkm90BfAkZBCTJICBJBgFJe/Okz+c+pIrQlRtVzp0rQr9kD7zGwdVz38L54IfKpJrGPum1odf2OAS+kwwCkmQQkCSDgKTBedIPV0W7lzSSPqyNTVjrhE6Zm3My96LgylrleK7j3Dxp4CfIICBJBgFJMghIGpwnPdfPWiklru1yd3XfxoOvLtXYCX0+9+qpGjXOhD77iFklZ6n3FdZBQJIMApJkEJAkg4CkvQy6KlI2lj/PN7qyNifh6lIv2U7vJSX5td0xz1e+utTanp2Vc+fK6tZBQJIMApJkEJAkg4Ckt8yTnmsFTmlsYG0ciX0+d23/vKuD53p/17rGz5e6sjZRZO0fnXUQkCSDgCQZBCTJICBpcJ70XPdnatp0ag5Go7ny9vlGVx3YL/kW5h7y6uC53UCvHmOOdRCQJIOAJBkEJMkgIKlznnTl4LkJDKnu7auD5yq4V0/VWLJ9+Ii3CmeNn/fK2pcyNz78zDoISJJBQJIMApJkEJA0OLtjrWa5Vv+bK6xePdVZ4zM3vhlo/GOYG0BxfozGAnblmStfylrt/4p1EJAkg4AkGQQkySAgaXB2x0OlCpsqUZ+9ZMO8q3PXKppncyX5yqXWRpdc3XfuvYF50gAyCIiSQUCSDAKSOjOoMoDi6sqVcxsbhV8ykGFuWsVa5XitYXfu+137M1v7t2CeNPATZBCQJIOAJBkEJA1mUGrq89r2cg9zH+F8o7Wt6dYK9nP3nStvV7qK13bHfMkA6QfrICBJBgFJMghIkkFA0lv2OHyYa6qeGyHyUGlCbXzIs8rv+Z2F8yuNYzEeUiXqyiju1FdmHQQkySAgSQYBSTIISOrc47BirjzWeO6VtQrf2mjqxvLnlY/oKW/s3V97jKtz51gHAUkyCEiSQUCSDAKS9uZJV6ZNz23zdj54bt7w+VKNc3/XyvmNj9G4peVcI/hD4zzptanPqbHWD9ZBQJIMApJkEJAkg4CkvXnSVz99qGwBeNZYSlzbTfBhbtzy1blnjQNGGgebpGacn889P8baBPS1zm/rICBJBgFJMghIkkFA0l4GzRXe5op254e8+ulcJ/Tc8OnG2Sznx7i6b2OTcWMX9doriLmPcHUjfdLAl5BBQJIMApJkEJD00j0O51pU11qfz9bGLTf2o1cutTYH43ypq5/O7QjY2M1cOfglw6etg4AkGQQkySAgSQYBSW/Z4/Dsqhw4t6nh3FDkxtJ4ZWD23EiNuYngjZXUxo+/9oWerc11qbAOApJkEJAkg4AkGQQkDe5xWNHYVlsZUNBobj+5ueEka+OWKwdXnup87lyJ+urcuYnR54PX3jhZBwFJMghIkkFAkgwCkgYzaK541lgtq1Ss16rdldbnxhutFSnP1nbHnBvkMvfXnpqQXWEdBCTJICBJBgFJMghI+oYMSnX3VrqZrzQOCZl7qsau4sZi8Nrw6UZrPeWNj1HxDRkEfC4ZBCTJICBJBgFJP5dBjYXkuc0UH+bqyqnW2Iq1qd5X5jZTTLWn65MGfoIMApJkEJAkg4CkwQyaq2nNdfc2bgLXOBL7bG6AdKXJeG4sxtW5a13jc9sWrrU+2+MQ+EUyCEiSQUCSDAKSOjPonfOGK72wjfMorg5uHF7ROCL6JftBzg1UmevAPt+3Ym2A9FxLvXUQkCSDgCQZBCTJICCplEEfMephbS+6uSt/4keY+4CN41ZSj9HoC25kHQQkySAgSQYBSTIISJJBQJIMApJkEJAkg4AkGQQkySAgSQYBSTIISJJBQJIMApJkEJAkg4AkGQQkySAgSQYBSf8DYA9MbvqTcjwAAAAASUVORK5CYII=",
  "type": "image/png",
  "message": "00020101021226330016A00000073210000101096755837755204179953038185406850.005802EG5910SphinxTeam600320662300522F7u8fse7bUn1jAjcaRR_3Q060064200002ar0110SphinxTeam6304F6E2",
  "paymentIntentId": "7ebcbb17-bbc7-496d-f58c-08dc69147fdd",
  "responseMessage": "Success",
  "detailedResponseMessage": "The operation was successful",
  "language": "EN",
  "responseCode": "000",
  "detailedResponseCode": "000"
}