MyMarkit SaaS V1 (1.0.0)

Download OpenAPI specification:Download

E-mail: contact@mymarkitinc.com URL: http://mymarkitinc.com/contact License: Apache 2.0 Terms of Service

This is an example API to demonstrate features of the OpenAPI specification.

Introduction

This API implementation guide is intended to to be a good starting point for implementing various MyMarkit SaaS products.

Company Site.

Global throttle specification for the API: Rate: 100 requests /sec, Burst: 200 requests , Quota: 2,000 requests /day, Default Timeout: 29 sec

Payment with MarkitPay (Fiat)

Universal Payment Processor with MarkitPay (Fiat).

Create a payment page with MarkitPay (Fiat)

Create a universal payment page loaded with payment methods from MarkitPay (Fiat) dashboard

SecurityApiKeyAuth

Request

Request Body schema: application/json

Payment payload

merchantId	string >= 4 characters unique merchant id
value	string non-empty total amount to pay
currency	string non-empty currency
returnURL	string non-empty the url to return to upon successful payment completion

Responses

200

401

Unauthorized

post/api/v1/payments/adyen

Request samples

application/json

{"merchantId": "WonderWebShop1",
"value": "100.15",
"currency": "EUR",
"returnURL": "https://saasdevs.net"
}

Response samples

application/json

{"transactionId": "JUWX2123",
"paymentPageUrl": "https://saasdevs.net/payments/adyen?transactionId=JUWX2123",
"createStatus": true
}

Payment with MarkitPay (Crypto)

Universal Payment Processor with MarkitPay (Crypto).

Create a payment page with MarkitPay (Crypto)

Create a universal payment page loaded with payment methods from MarkitPay (Crypto) dashboard

SecurityApiKeyAuth

Request

Request Body schema: application/json

Payment payload

merchantId	string >= 4 characters unique merchant id
value	string non-empty total amount to pay
currency	string non-empty currency
returnURL	string non-empty the url to return to upon successful payment completion

Responses

200

401

Unauthorized

post/api/v1/payments/coinbase

Request samples

application/json

{"merchantId": "WonderWebShop1",
"value": "100.15",
"currency": "USD",
"returnURL": "https://saasdevs.net"
}

Response samples

application/json

{"transactionId": "JUWX2123",
"paymentPageUrl": "https://saasdevs.net/payments/coinbase?transactionId=JUWX2123",
"createStatus": true
}

Webhook confirmation from MarkitPay (Fiat)

Webhook confirmation from Universal Payment Processor with MarkitPay (Fiat).

Create a webhook confirmation response from MarkitPay (Fiat) payment

Create a webhook JSON confirmation response page from MarkitPay (Fiat) payment

SecurityApiKeyAuth

Request

Request Body schema: application/json

webhook request body

upp-api-key	string >= 4 characters unique upp api key
upp-client-key	string >= 4 characters unique client key per customer

Responses

200

401

Unauthorized

post/user-provided-url-for-webhook-adyen

Request samples

application/json

{"upp-api-key": "12345678xyz",
"upp-client-key": "xyzw12345"
}

Response samples

application/json

{"live": "false",
"notificationItems": [{"amount": {"currency": "EUR",
"value": 1000
},
"eventCode": "AUTHORISATION",
"eventDate": "2022-06-20T03:26:47+02:00",
"merchantAccountCode": "MyMarkit_US",
"merchantReference": "Reference 46b0ad7e-fa3b-466e-823e-b04e6bbba1d4",
"operations": ["REFUND"
],
"paymentMethod": "ideal",
"pspReference": "QW2KB9G5F4BLNK82",
"reason": "",
"success": "true"
}
]
}

Webhook confirmation from MarkitPay (Crypto)

Webhook confirmation from Universal Payment Processor with MarkitPay (Crypto).

Create a webhook confirmation response from MarkitPay (Crypto) payment

Create a webhook JSON confirmation response page from MarkitPay (Crypto) payment

SecurityApiKeyAuth

Request

Request Body schema: application/json

webhook request body

upp-api-key	string >= 4 characters unique upp api key
upp-client-key	string >= 4 characters unique client key per customer

Responses

200

401

Unauthorized

post/user-provided-url-for-webhook-coinbase

Request samples

application/json

{"upp-api-key": "12345678xyz",
"upp-client-key": "xyzw12345"
}

Response samples

application/json

{"attempt_number": 1,
"id": "51dc060b-8ac3-4615-9ef1-b4e3206cdee0",
"scheduled_for": "2022-07-01T22:10:50Z",
"event": {"api_version": "2018-03-22",
"created_at": "2022-07-01T22:10:50Z",
"data": {"id": "937d2722-eac6-4e43-87ee-36320b911ad7",
"code": "8HWHNCW4",
"name": "UPP Portal",
"utxo": false,
"pricing": {"dai": {"amount": "10.432267416236208673",
"currency": "DAI"
},
"usdc": {"amount": "10.428616",
"currency": "USDC"
},
"local": {"amount": "10.00",
"currency": "EUR"
},
"tether": {"amount": "10.441616",
"currency": "USDT"
},
"bitcoin": {"amount": "0.00053858",
"currency": "BTC"
},
"dogecoin": {"amount": "158.46552382",
"currency": "DOGE"
},
"ethereum": {"amount": "0.009800000",
"currency": "ETH"
},
"litecoin": {"amount": "0.20400266",
"currency": "LTC"
},
"shibainu": {"amount": "1043905.517781834434434434",
"currency": "SHIB"
},
"bitcoincash": {"amount": "0.10269945",
"currency": "BCH"
}
},
"fee_rate": 0.01,
"logo_url": "https://res.cloudinary.com/commerce/image/upload/v1655522635/nzlih20yojcvbicpl3e1.png",
"metadata": { },
"payments": [ ],
"resource": "charge",
"timeline": [{"time": "2022-07-01T22:10:50Z",
"status": "NEW"
}
],
"addresses": {"dai": "0xd2eabd78481ea6b349d3a701847e08ba24fb7d44",
"usdc": "0xd2eabd78481ea6b349d3a701847e08ba24fb7d44",
"tether": "0xd2eabd78481ea6b349d3a701847e08ba24fb7d44",
"bitcoin": "3GwfdMbWDZYC5p9Jf93u6L3zJvExgarFHp",
"dogecoin": "DEvZDwdvhSyU5CHB9ZFXFosyrhfkcXukWE",
"ethereum": "0xd2eabd78481ea6b349d3a701847e08ba24fb7d44",
"litecoin": "MBCMuEGiH7Nej2sz9CHTzTWsDuSxCc9bth",
"shibainu": "0xd2eabd78481ea6b349d3a701847e08ba24fb7d44",
"bitcoincash": "qppy6ftf8lszm06q6jyx3pyqmcdv4cdgtgt2cenl3c"
},
"pwcb_only": false,
"cancel_url": "https://saasdevs.net/coinbase/cancel/",
"created_at": "2022-07-01T22:10:50Z",
"expires_at": "2022-07-01T23:10:50Z",
"hosted_url": "https://commerce.coinbase.com/charges/8HWHNCW4",
"brand_color": "#E3B14D",
"description": "Total Charge in Local Currency:",
"fees_settled": true,
"pricing_type": "fixed_price",
"redirect_url": "https://saasdevs.net/coinbase/success/",
"support_email": "tim@mymarkit.com",
"brand_logo_url": "https://res.cloudinary.com/commerce/image/upload/v1655522635/nzlih20yojcvbicpl3e1.png",
"exchange_rates": {"BCH-USD": "101.545",
"BTC-USD": "19363.13",
"DAI-USD": "0.99965",
"ETH-USD": "1064.11",
"LTC-USD": "51.12",
"DOGE-USD": "0.06581",
"SHIB-USD": "0.00000999",
"USDC-USD": "1.0",
"USDT-USD": "0.998755"
},
"offchain_eligible": false,
"organization_name": "MyMarkit!",
"payment_threshold": {"overpayment_absolute_threshold": {"amount": "0.10",
"currency": "USD"
},
"overpayment_relative_threshold": "0.01",
"underpayment_absolute_threshold": {"amount": "0.10",
"currency": "USD"
},
"underpayment_relative_threshold": "0.01"
},
"local_exchange_rates": {"BCH-EUR": "97.37",
"BTC-EUR": "18567.31",
"DAI-EUR": "0.96",
"ETH-EUR": "1020.38",
"LTC-EUR": "49.02",
"DOGE-EUR": "0.06",
"SHIB-EUR": "0.00",
"USDC-EUR": "0.96",
"USDT-EUR": "0.96"
}
},
"id": "b180df29-0c27-44e1-9129-3d8cab79ce18",
"resource": "event",
"type": "charge:created"
}
}

Add a single entry record to MarkitChain

Add a single entry record to MarkitChain.

Create a Blockchain ledger entry in MarkitChain

Create a Blockchain ledger entry in MarkitChain from customer request

SecurityApiKeyAuth

Request

Request Body schema: application/json

Create MarkitChain Request Body

ledger_id	integer non-empty ledger_id of the product customer wants to create
	Array of objects field data which can go up to 30 fields, subject to change

Responses

200

401

Unauthorized

post/api/v1/markitchain/post

Request samples

application/json

{"ledger_id": 12345,
"field_data": [{"name": "item_name",
"value": "LV Handbag"
},
{"name": "color",
"value": "blue"
}
]
}

Response samples

application/json

{"ledger_id": 12345,
"field_data": [{"name": "item_name",
"value": "LV Handbag"
},
{"name": "color",
"value": "blue"
}
],
"statusCode": 200,
"timeStamp": "2023-03-30T05:00:47.859379",
"transactionId": "017338d5-23bc-48f3-9d0d-f805b3dd63ae"
}

Retrieve a single entry record from MarkitChain

Retrieve a single entry record from MarkitChain.

Retrieve an entry with MarkitChain

Retrieve a single Blockchain ledger entry in MarkitChain based on ledger_id, if deprecated return json response saying 'deprecated entry found'

SecurityApiKeyAuth

Request

query Parameters

ledger_id

required

string

ledger_id of the product to be searched for

Responses

200

401

Unauthorized

get/api/v1/markitchain/entry

Request samples

curl
Node.js
JavaScript
PHP
Python

Response samples

application/json

{"ledger_id": 12345,
"field_data": [{"name": "item_name",
"value": "LV Handbag"
},
{"name": "color",
"value": "blue"
}
],
"statusCode": 200,
"timeStamp": "2023-03-30T05:00:47.859379",
"transactionId": "017338d5-23bc-48f3-9d0d-f805b3dd63ae"
}

Retrieve a collection of entry records from MarkitChain

Retrieve a collection of entry records from MarkitChain.

Retrieve a collection of entry records from MarkitChain

Retrieve a collection of Blockchain ledger entries in MarkitChain based on a collection of ledger_ids, , if any deprecated return json response saying 'deprecated entry found'

SecurityApiKeyAuth

Request

query Parameters

ledger_ids

required

string

an array of ledger_ids to be searched for

Responses

200

401

Unauthorized

get/api/v1/markitchain/entries

Request samples

curl
Node.js
JavaScript
PHP
Python

Response samples

application/json

[{"ledger_id": 12345,
"field_data": [{"name": "item_name",
"value": "LV Handbag"
},
{"name": "color",
"value": "blue"
}
]
}
]

Deprecate a single entry record on MarkitChain

Deprecate a single entry record on MarkitChain.

Deprecate a single entry record on MarkitChain

Deprecate a single entry record on the chain in MarkitChain based on ledger_id

SecurityApiKeyAuth

Request

query Parameters

ledger_id

required

string

ledger_id of the product to be deprecated

Responses

200

401

Unauthorized

delete/api/v1/markitchain/entry

Request samples

curl
Node.js
JavaScript
PHP
Python

Response samples

application/json

{"ledger_id": 12345,
"statusCode": 200,
"timeStamp": "2023-03-30T05:00:47.859379",
"transactionId": "017338d5-23bc-48f3-9d0d-f805b3dd63ae"
}