Marketplace Partner APIs

read_kpi_sets

read KPI sets

manage_targeted_offers

manage targeted offers

city
optional

Example : "Praha"

string

country_code
optional

Example : "CZ"

string

house
optional

Example : "626/80"

string

street
optional

Example : "V Olšinách"

string

zip_code
optional

Example : "10 100 00"

string

acquirer_code
optional

Identifies the acquirer organisation using a permanent and unique code (combined from ISO-3166-1 numeric code for the country and a sequence number).

string

company_active_from
optional

Example : "2016-03-17"

string (date)

company_key
optional

Example : "F53CFC9E103659533996DDBE53F8E4E2"

string

company_legal_form
optional

Example : "sro"

string

company_ud
optional

Example : "COMP-140692"

string

country_code
optional

Example : "SK"

string

currency
optional

Example : "EUR"

string

mid
optional

Example : "MPLLOC000000000000057"

string

mid_active_from
optional

Example : "2016-03-17"

string (date)

mid_mcc_code
optional

Example : "7891"

string

mid_mcc_text
optional

Example : "Hotels"

string

number_of_lost_disputes
optional

Example : 1

integer

number_of_transactions
optional

Example : 665

integer

number_of_won_disputes
optional

Example : 7

integer

snapshot_date
optional

string (date)

turnover
optional

Example : "234525.26"

string (decimal)

value_of_lost_disputes
optional

Example : "268.90"

string (decimal)

value_of_won_disputes
optional

Example : "1355.70"

string (decimal)

code
optional

integer (int32)

message
optional

string

type
optional

string

created
optional

Example : "2019-01-01T06:00:00.000Z"

string (date-time)

id
optional

Example : "79b63426-94e1-11e9-bb23-c3d8a01a3776"

string (uuid)

modified
optional

Example : "2019-03-15T09:30:00.000Z"

string (date-time)

slug
optional

Example : "flexible-financing-v1"

string

status
optional

Example : "PUBLISHED"

enum (PLANNED, PUBLISHED, RETIRED)

created
optional

Example : "2019-01-01T06:00:00.000Z"

string (date-time)

id
optional

Example : "79b63426-94e1-11e9-bb23-c3d8a01a3776"

string (uuid)

modified
optional

Example : "2019-03-15T09:30:00.000Z"

string (date-time)

schema
optional

JSON schema describing expected structure of product-offer parameters.
Example : { "$schema" : "http://json-schema.org/draft-07/schema#", "$id" : "https://api.mygp.cz/v1/catalog/flexible-financing-v1/schema.json", "title" : "flexible-financing-v1 product-offer schema", "type" : "object", "properties" : { "offered_amount" : { "type" : "string" }, "maximum_amount" : { "type" : "string" }, "total_amount" : { "type" : "string" }, "currency" : { "type" : "string" }, "factor_rate" : { "type" : "string" }, "term" : { "type" : "string" } }, "required" : [ "offered_amount", "maximum_amount", "total_amount", "currency", "factor_rate", "term" ] }

object

slug
optional

Example : "flexible-financing-v1"

string

status
optional

Example : "PUBLISHED"

enum (PLANNED, PUBLISHED, RETIRED)

activated
optional

Example : "2018-05-12"

string (date)

active
optional

Example : true

boolean

business_id
optional

Example : "7587485784"

string

closed
optional

Example : ""

string (date)

company_id
optional

Example : "COMP-921533213"

string

company_name
optional

Example : "Global Payments s.r.o."

string

contact_address
optional

Address

country_code
optional

Example : "CZ"

string

language_code
optional

Example : "CZ"

string

registered_address
optional

Address

sales_name
optional

Example : "Felicity Decker"

string

services
optional

Example : [ { "code" : "EET", "status" : "ACTIVE" }, { "code" : "MyGP", "status" : "NOT_ACTIVE" } ]

< SimpleServiceInfo > array

status
optional

Example : "ACTIVE"

enum (NEW, ACTIVE, INACTIVE)

tax_id
optional

Example : "CZ1234567890"

string

updated
optional

Example : "2020-09-27T10:16:12"

string (date-time)

decision_status
optional

Example : "GRANTED"

enum (GRANTED, DECLINED)

name
required

Example : "general"

string

decision_status
required

Example : "GRANTED"

enum (GRANTED, DECLINED)

name
required

Example : "general"

string

status_from
required

Example : "YYYY-MM-DD"

string (date)

valid_until
optional

Example : "YYYY-MM-DD"

string (date)

offer_id
optional

Arbitrary offer ID that can be used by the submitting partner to uniquely identify the offer.
Example : "O93730028"

string

parameters
optional

Container for offer-specific payload.
Example : { "offered_amount" : "700000.00", "maximum_amount" : "700000.00", "total_amount" : "763000.00", "currency" : "CZK", "factor_rate" : "1.09", "term" : "4" }

object

product_ref
optional

Identifies product-offer schema to be used for validation of parameters payload.
Example : "flexible-financing-offer#v1"

string

valid_from
optional

The earliest date when the offer can be accepted by the customer.
Example : "2019-06-01"

string (date)

valid_until
optional

The last date when offer can be accepted by the customer.
Example : "2019-06-30"

string (date)

count
optional

Example : 1

integer (int64)

next
optional

Example : "https://api.mygp.cz/v1/accounts?limit=10&offset=10"

string (url)

previous
optional

string (url)

results
optional

Example : [ { "id" : "6573467568", "business_id" : "99999991", "account_type" : "P", "iban" : "CZ2720100000002609999888", "currency" : "CZK", "bank" : "FIOBCZPP", "status" : "ACTIVE", "active_since" : "2020-07-11", "active_until" : "" } ]

< ShortAccountInfo > array

count
optional

Total number of results available to retrieve.
Example : 1

integer (int64)

next
optional

URL to retrieve next batch of results.

string (url)

previous
optional

URL to retrieve previous batch of results.

string (url)

results
optional

Collection of results retrieved with this batch.
Example : [ { "id" : "79b63426-94e1-11e9-bb23-c3d8a01a3776", "slug" : "flexible-financing-v1", "status" : "PUBLISHED", "created" : "2019-01-01T06:00:00.000Z", "modified" : "2019-03-15T09:30:00.000Z" } ]

< CatalogProductOfferRef > array

count
optional

Example : 2

integer (int64)

next
optional

Example : "https://api.mygp.cz/v1/companies?limit=10&offset=10"

string (url)

previous
optional

string (url)

results
optional

Example : [ { "business_id" : "7587485784", "company_id" : "COMP-00042341", "tax_id" : "CZ12345678", "company_name" : "Happy Koala Ltd.", "country_code" : "CZ", "language_code" : "CZ", "registered_address" : { "street" : "V Olšinách", "house" : "626/80", "zip_code" : "10 100 00", "city" : "Praha", "country_code" : "CZ" }, "contact_address" : { "street" : "V Olšinách", "house" : "626/80", "zip_code" : "10 100 00", "city" : "Praha", "country_code" : "CZ" }, "eet" : "ACTIVE", "mygp" : "ACTIVE", "sales_name" : "John Doe", "status" : "ACTIVE", "active_since" : "2017-11-08", "active_until" : "", "kyc_status" : "COMPLETE", "updated" : "2019-07-01T01:00:00.000Z" } ]

< ShortCompanyInfo > array

count
optional

Example : 2

integer (int64)

next
optional

Example : "https://api.mygp.cz/v1/companies/7587485784/locations?limit=10&offset=10"

string (url)

previous
optional

string (url)

results
optional

Example : [ { "mid" : "7587485784", "location_name" : "Main Street Shop", "location_type" : "outlet", "created" : "2019-07-01T01:00:00.000Z", "modified" : "2019-07-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/locations/7587485784" }, { "mid" : "6357485222", "location_name" : "www.mainstreetshop.com", "location_type" : "ecommerce", "created" : "2019-07-01T01:00:00.000Z", "modified" : "2019-07-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/locations/6357485222" } ]

< ShortLocationInfo > array

count
optional

Example : 2

integer (int64)

next
optional

Example : "https://api.mygp.cz/v1/locations?limit=10&offset=10"

string (url)

previous
optional

string (url)

results
optional

Example : [ { "mid" : "7587485784", "location_name" : "Main Street Shop", "location_type" : "outlet", "created" : "2019-07-01T01:00:00.000Z", "modified" : "2019-07-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/locations/7587485784" }, { "mid" : "6357485222", "location_name" : "www.mainstreetshop.com", "location_type" : "ecommerce", "created" : "2019-07-01T01:00:00.000Z", "modified" : "2019-07-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/locations/6357485222" } ]

< ShortLocationInfo > array

active_since
optional

Example : "2014-10-07"

string (date)

active_until
optional

Example : "2019-08-19"

string (date)

birth_number
optional

Example : "10040067328"

string

email
optional

Example : "mailbox@example.org"

string

first_name
optional

Example : "Alan"

string

id
optional

Example : "942387299"

string

id_number
optional

Example : "AB9992223"

string

id_type
optional

Example : "IDC"

string

is_owner
optional

Example : false

boolean

is_statutory
optional

Example : true

boolean

last_name
optional

Example : "Turing"

string

phone
optional

Example : "+4287878399"

string

position
optional

Example : "CEO"

string

salutation
optional

Example : "Mr"

string

status
optional

Example : "ACTIVE"

enum (NEW, ACTIVE, INACTIVE)

title_after
optional

Example : "PhD"

string

title_before
optional

Example : "RtH"

string

updated
optional

Example : "2019-07-02T01:00:00.000Z"

string (date-time)

count
optional

Example : 12

integer (int64)

next
optional

resource URL for the next batch of persons
Example : "https://api.mygp.cz/v1/companies/NCC1701/persons?limit=10&offset=10"

string (url)

previous
optional

resource URL for the previous batch of persons

string (url)

results
optional

Example : [ { "id" : "6573467568", "salutation" : "Mr", "title_before" : "", "first_name" : "James", "last_name" : "Kirk", "title_after" : "", "phone" : "+42012341234", "email" : "test@example.com", "position" : "Captain", "birth_number" : "1234567", "id_number" : "P3546359", "id_type" : "IDC", "is_statutory" : true, "is_owner" : false, "status" : "ACTIVE", "active_since" : "2020-07-11", "active_until" : "", "invitation_url" : "https://mygp.cz/onboarding/invitation/xyz123abc456" } ]

< ShortPersonInfo > array

count
optional

Example : 1

integer (int64)

next
optional

Example : "https://api.mygp.cz/v1/persons?limit=10&offset=10"

string (url)

previous
optional

string (url)

results
optional

Example : [ { "id" : "6573467568", "salutation" : "Mr", "title_before" : "", "first_name" : "James", "last_name" : "Kirk", "title_after" : "", "phone" : "+42012341234", "email" : "test@example.com", "position" : "Captain", "birth_number" : "1234567", "id_number" : "P3546359", "id_type" : "IDC", "is_statutory" : true, "is_owner" : false, "status" : "ACTIVE", "active_since" : "2020-07-11", "active_until" : "", "invitation_url" : "https://mygp.cz/onboarding/invitation/xyz123abc456" } ]

< ShortPersonInfo > array

count
optional

Example : 2

integer (int64)

next
optional

resource URL for the next batch of subscription records
Example : "https://api.mygp.cz/v1/companies/432809567206/subscriptions?limit=10&offset=10"

string (url)

previous
optional

resource URL for the previous batch of subscription records

string (url)

results
optional

Example : [ { "id" : "adcaac2d-26c0-4728-b2a9-4286bbd3e324", "status" : "ACTIVE", "created" : "2019-07-02T01:00:00.000Z", "modified" : "2019-07-02T01:00:00.000Z", "offer_id" : "6d5a1ef3-57fb-4739-abe7-fb1ecdac84af" }, { "id" : "fed2bd00-77f4-4346-a950-08d094c2a446", "status" : "ACTIVE", "created" : "2019-07-01T01:00:00.000Z", "modified" : "2019-07-01T01:00:00.000Z", "offer_id" : "645211e9-98db-48d7-a16c-768eb1d3db4a" } ]

< ShortSubscriptionInfo > array

created
optional

string (date-time)

modified
optional

string (date-time)

offer_id
optional

Arbitrary offer ID that can be used by the submitting partner to uniquely identify the offer.
Example : "O93730028"

string

parameters
optional

Container for product-specific offer payload.
Example : { "offered_amount" : "700000.00", "maximum_amount" : "700000.00", "total_amount" : "763000.00", "currency" : "CZK", "factor_rate" : "1.09", "term" : "4" }

object

product_ref
optional

Identifies product specification to be used for validation of parameters payload.
Example : "flexible-financing#v1"

string

status
optional

enum (OPEN, ACCEPTED, LAPSED, REVOKED)

valid_from
optional

The earliest date when the offer can be accepted by the customer.
Example : "2019-06-01"

string (date)

valid_until
optional

The last date when offer can be accepted by the customer.
Example : "2019-06-30"

string (date)

count
optional

Total number of results available to retrieve.
Example : 6

integer (int64)

next
optional

URL to retrieve next batch of results.

string (url)

previous
optional

URL to retrieve previous batch of results.
Example : "null"

string (url)

results
optional

Example : [ { "id" : "O93730028", "status" : "OPEN", "valid_from" : "2019-06-22", "valid_until" : "2019-06-30", "created" : "2019-06-21T09:55:32.113Z", "modified" : "2019-06-21T09:55:32.113Z" }, { "id" : "O93730016", "status" : "REVOKED", "valid_from" : "2019-06-01", "valid_until" : "2019-06-30", "created" : "2019-05-30T08:20:25.567Z", "modified" : "2019-06-21T09:55:31.348Z" }, { "id" : "O93730003", "status" : "LAPSED", "valid_from" : "2019-05-01", "valid_until" : "2019-05-31", "created" : "2019-04-29T08:16:55.138Z", "modified" : "2019-04-29T08:16:55.138Z" }, { "id" : "O93729971", "status" : "LAPSED", "valid_from" : "2019-04-01", "valid_until" : "2019-04-30", "created" : "2019-03-30T09:55:12.231Z", "modified" : "2019-03-30T09:55:12.231Z" }, { "id" : "O93729964", "status" : "LAPSED", "valid_from" : "2019-03-01", "valid_until" : "2019-03-30", "created" : "2019-02-27T09:23:27.831Z", "modified" : "2019-02-27T09:23:27.831Z" }, { "id" : "O93729950" } ]

< TargetedOfferInfo > array

count
optional

Example : 2

integer (int64)

next
optional

Example : "https://api.mygp.cz/v1/locations/88587548578/terminals?limit=10&offset=10"

string (url)

previous
optional

string (url)

results
optional

Example : [ { "terminal_number" : "1234567891", "terminal_type" : "ICT220DTINTCL_ETH", "created" : "2019-07-01", "modified" : "2019-07-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/terminals/1234567891" }, { "terminal_number" : "1234567892", "terminal_type" : "ICT220DTINTCL_ETH", "created" : "2019-10-12", "modified" : "2019-11-03T08:35:13.000Z", "self" : "https://api.mygp.cz/v1/terminals/1234567892" } ]

< ShortTerminalInfo > array

count
optional

Example : 2

integer (int64)

next
optional

Example : "https://api.mygp.cz/v1/terminals?limit=10&offset=10"

string (url)

previous
optional

string (url)

results
optional

Example : [ { "terminal_number" : "1234567891", "terminal_type" : "ICT220DTINTCL_ETH", "created" : "2019-07-01", "modified" : "2019-07-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/terminals/1234567891" }, { "terminal_number" : "1234567892", "terminal_type" : "ICT220DTINTCL_ETH", "created" : "2019-10-12", "modified" : "2019-11-03T08:35:13.000Z", "self" : "https://api.mygp.cz/v1/terminals/1234567892" } ]

< ShortTerminalInfo > array

count
optional

Example : 11

integer (int64)

next
optional

string (url)

previous
optional

Example : "https://api.mygp.cz/v1/kpi-sets/2019-06?limit=10&offset=0"

string (url)

results
optional

< AnonymisedKpiSnapshot > array

created
optional

string (date-time)

id
optional

string

modified
optional

string (date-time)

count
optional

Example : 15

integer (int64)

next
optional

Example : "https://api.mygp.cz/v1/kpi-sets?limit=10&offset=10"

string (url)

previous
optional

string (url)

results
optional

Example : [ { "id" : "2019-06", "created" : "2019-07-01T01:00:00.000Z", "modified" : "2019-07-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2019-06" }, { "id" : "2019-05", "created" : "2019-06-01T01:00:00.000Z", "modified" : "2019-06-05T08:33:22.111Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2019-05" }, { "id" : "2019-04", "created" : "2019-05-01T01:00:00.000Z", "modified" : "2019-05-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2019-04" }, { "id" : "2019-03", "created" : "2019-04-01T01:00:00.000Z", "modified" : "2019-04-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2019-03" }, { "id" : "2019-02", "created" : "2019-03-01T01:00:00.000Z", "modified" : "2019-03-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2019-02" }, { "id" : "2019-01", "created" : "2019-02-01T01:00:00.000Z", "modified" : "2019-02-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2019-01" }, { "id" : "2018-12", "created" : "2019-01-01T01:00:00.000Z", "modified" : "2019-01-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2018-12" }, { "id" : "2018-11", "created" : "2018-12-01T01:00:00.000Z", "modified" : "2018-12-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2018-11" }, { "id" : "2018-10", "created" : "2018-11-01T01:00:00.000Z", "modified" : "2018-11-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2018-10" }, { "id" : "2018-09", "created" : "2018-10-01T01:00:00.000Z", "modified" : "2018-10-01T01:00:00.000Z", "self" : "https://api.mygp.cz/v1/kpi-sets/2018-09" } ]

< KpiSetIndex > array

activated
optional

Example : "2018-05-12"

string (date)

address
optional

Address

business_id
optional

Example : "7587485784"

string

is_seasonal
optional

Example : false

boolean

location_name
optional

Example : "Main Street Shop"

string

location_type
optional

Example : "outlet"

enum (outlet, ecommerce)

mcc
optional

Example : "8012"

string

mid
optional

Example : "88587548578"

string

services
optional

Example : [ { "code" : "eCommerce", "status" : "ACTIVE" }, { "code" : "easy2sell", "status" : "NOT_ACTIVE" }, { "code" : "DCC", "status" : "NOT_ACTIVE" }, { "code" : "gptom", "status" : "NOT_ACTIVE" } ]

< SimpleServiceInfo > array

updated
optional

Example : "2020-09-27T10:16:12"

string (date-time)

variable_symbol_code
optional

Example : "IVB"

string

account_type
optional

Example : "P"

string

active_since
optional

Example : "2020-07-11"

string (date)

active_until
optional

Example : ""

string (date)

bank
optional

Example : "FIOBCZPP"

string

business_id
optional

Example : "12345678"

string

currency
optional

Example : "CZK"

string

iban
optional

Example : "CZ2720100000002609999888"

string

id
optional

Example : "GPEACC000000009999888"

string

status
optional

Example : "ACTIVE"

enum (NEW, ACTIVE, INACTIVE)

active_since
optional

Example : "2018-05-12"

string (date)

active_until
optional

Example : ""

string

business_id
optional

Example : "7587485784"

string

company_id
optional

Example : "COMP-00042341"

string

company_name
optional

Example : "Global Payments s.r.o."

string

contact_address
optional

Address

country_code
optional

Example : "CZ"

string

eet
optional

Example : "ACTIVE"

enum (ACTIVE, NOT_INACTIVE)

kyc_status
optional

Example : "COMPLETE"

enum (COMPLETE, INCOMPLETE)

language_code
optional

Example : "CZ"

string

mygp
optional

Example : "ACTIVE"

enum (ACTIVE, NOT_INACTIVE)

registered_address
optional

Address

sales_name
optional

Example : "John Doe"

string

status
optional

Example : "ACTIVE"

enum (ACTIVE, NOT_INACTIVE)

tax_id
optional

Example : "CZ12345678"

string

updated
optional

Example : "2020-09-27T10:16:12"

string (date-time)

activated
optional

Example : "2018-05-12"

string (date)

location_name
optional

Example : "Main Street Shop"

string

location_type
optional

Example : "outlet"

enum (outlet, ecommerce)

mid
optional

Example : "558848578"

string

self
optional

Example : "https://api.mygp.cz/v1/locations/558848578"

string (url)

updated
optional

Example : "2020-09-27T10:16:12"

string (date-time)

active_since
optional

Example : "2020-07-11"

string (date)

active_until
optional

Example : ""

string (date)

birth_number
optional

Example : "1234567"

string

business_id
optional

Example : "12345678"

string

email
optional

Example : "test@example.com"

string

first_name
optional

Example : "Alan"

string

id
optional

Example : "942387299"

string