Merchant Onboarding - Native Partners (v1)

Download OpenAPI specification:Download

merchant-onboarding-native-partners

create

create a merchant

Request

Request Body schema: application/json
required

email required	string
phone	string [ 0 .. 255 ] characters
type required	string Enum: "ESTABLISHED" "NEW"
country required	string (CountryCode) Enum: "AX" "AF" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "TP" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "FX" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IT" "IM" "IL" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "KN" "LC" "VC" "WS" "BL" "MF" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SH" "PM" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VA" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "YU" "ZR" "ZM" "ZW" "SP"
price_plan required	string
platform	string
special_offer_id	string [ 0 .. 255 ] characters
	object
	object (BusinessInformationDto)
	object (StoreInformationDto)
	Array of objects (BankAccountDto)
	Array of StakeholderCompanyDto (object) or StakeholderPersonDto (object)

Responses

201

Merchant created

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/accountmanagement/v1/merchants

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"email": "string",
"phone": "string",
"type": "ESTABLISHED",
"country": "AX",
"price_plan": "string",
"platform": "string",
"special_offer_id": "string",
"custom_data": {"property1": { },
"property2": { }
},
"business_information": {"organization_is_registered": true,
"organization_entity_type": "SOLE_TRADER",
"organization_name": "string",
"organization_registration_id": "string",
"organization_registration_authority": "string",
"vat_id": "string",
"subject_to_vat": true,
"registered_address": {"street_address": "string",
"street_address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "AX"
},
"operating_address": {"street_address": "string",
"street_address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "AX"
},
"owner": {"given_name": "string",
"family_name": "string",
"date_of_birth": "2019-08-24",
"title": "string"
},
"owners": [{"given_name": "string",
"family_name": "string",
"date_of_birth": "2019-08-24",
"title": "string",
"managing_director": true,
"personal_id": "string",
"street_address": "string",
"street_address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "AX"
}
]
},
"store_information": {"stores": [{"country": "AX",
"store_name": "string",
"organization_category": "ADULT_SHOES_AND_CLOTHING",
"merchant_category_code": 0,
"homepage_url": "string",
"icon_url": "string",
"logo_url": "string",
"support_email": "string",
"support_phone": "string"
}
]
},
"bank_accounts": [{"account_number": "string",
"account_type": "IBAN",
"account_holder": "string",
"country": "AX",
"currency_code": "AUD",
"routing_number": "string",
"is_default": true
}
],
"stakeholders": [{"type": "string",
"address": {"street_address": "string",
"street_address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "AX"
},
"company_name": "string",
"registration_id": "string"
}
]
}

find_1

Get merchant account details

Request

path Parameters

merchantId

required

string

Responses

200

Existing merchant

404

Not Found

get/accountmanagement/v1/merchants/{merchantId}

Request samples

curl
JavaScript
Node.js

replace_1

replace a merchant

Request

path Parameters

merchantId

required

string

Request Body schema: application/json
required

email	string
phone	string [ 0 .. 255 ] characters
type	string Enum: "ESTABLISHED" "NEW"
country	string (CountryCode) Enum: "AX" "AF" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "TP" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "FX" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IT" "IM" "IL" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "KN" "LC" "VC" "WS" "BL" "MF" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SH" "PM" "SD" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VA" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "YU" "ZR" "ZM" "ZW" "SP"
price_plan	string
platform	string
special_offer_id	string [ 0 .. 255 ] characters
	object
	object (BusinessInformationDto)
	object (StoreInformationDto)

Responses

204

Merchant replaced

400

Bad Request

401

Unauthorized

500

Internal Server Error

put/accountmanagement/v1/merchants/{merchantId}

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"email": "string",
"phone": "string",
"type": "ESTABLISHED",
"country": "AX",
"price_plan": "string",
"platform": "string",
"special_offer_id": "string",
"custom_data": {"property1": { },
"property2": { }
},
"business_information": {"organization_is_registered": true,
"organization_entity_type": "SOLE_TRADER",
"organization_name": "string",
"organization_registration_id": "string",
"organization_registration_authority": "string",
"vat_id": "string",
"subject_to_vat": true,
"registered_address": {"street_address": "string",
"street_address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "AX"
},
"operating_address": {"street_address": "string",
"street_address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "AX"
},
"owner": {"given_name": "string",
"family_name": "string",
"date_of_birth": "2019-08-24",
"title": "string"
},
"owners": [{"given_name": "string",
"family_name": "string",
"date_of_birth": "2019-08-24",
"title": "string",
"managing_director": true,
"personal_id": "string",
"street_address": "string",
"street_address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "AX"
}
]
},
"store_information": {"stores": [{"country": "AX",
"store_name": "string",
"organization_category": "ADULT_SHOES_AND_CLOTHING",
"merchant_category_code": 0,
"homepage_url": "string",
"icon_url": "string",
"logo_url": "string",
"support_email": "string",
"support_phone": "string"
}
]
}
}

update_1

partially update a merchant

Request

path Parameters

merchantId

required

string

Request Body schema: application/json
required

email	string
phone	string [ 0 .. 255 ] characters
price_plan	string
platform	string
special_offer_id	string [ 0 .. 255 ] characters
	object
	object (UpdateBusinessInformationDto)
	object (UpdateStoreInformationDto)

Responses

204

Merchant partly updated

400

Bad Request

401

Unauthorized

500

Internal Server Error

patch/accountmanagement/v1/merchants/{merchantId}

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"email": "string",
"phone": "string",
"price_plan": "string",
"platform": "string",
"special_offer_id": "string",
"custom_data": {"property1": { },
"property2": { }
},
"business_information": {"organization_is_registered": true,
"organization_entity_type": "SOLE_TRADER",
"organization_name": "string",
"organization_registration_id": "string",
"organization_registration_authority": "string",
"vat_id": "string",
"subject_to_vat": true,
"registered_address": {"street_address": "string",
"street_address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "AX"
},
"operating_address": {"street_address": "string",
"street_address2": "string",
"postal_code": "string",
"city": "string",
"region": "string",
"country": "AX"
},
"owner": {"given_name": "string",
"family_name": "string",
"date_of_birth": "2019-08-24",
"title": "string"
}
},
"store_information": {"stores": [{"country": "AX",
"store_name": "string",
"organization_category": "ADULT_SHOES_AND_CLOTHING",
"merchant_category_code": 0,
"homepage_url": "string",
"icon_url": "string",
"logo_url": "string",
"support_email": "string",
"support_phone": "string"
}
]
}
}

updateHomepageUrl_1

update the homepage_url

Request

path Parameters

merchantId required	string
storeId required	string

Request Body schema: application/json
required

homepage_url

string

Responses

204

Homepage url updated

400

Bad Request

401

Unauthorized

500

Internal Server Error

patch/accountmanagement/v1/merchants/{merchantId}/store-information/stores/{storeId}

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"homepage_url": "string"
}

createWidgetUrl

Get the URL of the widget that will be shown in the partner's backend to collect additional merchant information

Request

path Parameters

merchantId

required

string

Responses

200

Get a new widget url

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/accountmanagement/v1/merchants/{merchantId}/widget-url-request

Request samples

curl
JavaScript
Node.js

createCredentials

Get merchant credentials

Request

path Parameters

merchantId

required

string

Responses

202

New credentials

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/accountmanagement/v1/merchants/{merchantId}/credentials-request

Request samples

curl
JavaScript
Node.js

Merchant Onboarding - Native Partners (v1)

merchant-onboarding-native-partners

create

Request Body schema: application/jsonrequired

find_1

path Parameters

replace_1

path Parameters

Request Body schema: application/jsonrequired

update_1

path Parameters

Request Body schema: application/jsonrequired

updateHomepageUrl_1

path Parameters

Request Body schema: application/jsonrequired

createWidgetUrl

path Parameters

createCredentials

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required