Adyen
App · 20 actions
Read Adyen companies, merchants, stores, terminals and webhook settings; manage stores.
Actions
| Action | What it does |
|---|---|
| Create store | Create store. |
| Get api credential | Get api credential. |
| Get company | Get company. |
| Get merchant | Get merchant. |
| Get merchant terminal settings | Get merchant terminal settings. |
| Get merchant user | Get merchant user. |
| Get merchant webhook | Get merchant webhook. |
| Get payment method | Get payment method. |
| Get store | Get store. |
| Get store terminal settings | Get store terminal settings. |
| List companies | List companies. |
| List company merchants | List company merchants. |
| List merchant stores | List merchant stores. |
| List merchant users | List merchant users. |
| List merchant webhooks | List merchant webhooks. |
| List merchants | List merchants. |
| List payment methods | List payment methods. |
| List stores | List stores. |
| List terminals | List terminals. |
| Update store | Update store. |
Create store
Create store.
Inputs
- Merchant
merchant_idtextRequired - The unique identifier of the merchant account.
- Address city
address_citytext - Address city.
- Address country
address_countrytextRequired - Address country.One of:
AD(Andorra),AE(United Arab Emirates),AF(Afghanistan),AG(Antigua & Barbuda),AI(Anguilla),AL(Albania),AM(Armenia),AO(Angola),AQ(Antarctica),AR(Argentina), and 240 more. - Address line1
address_line1text - Address line1.
- Address line2
address_line2text - Address line2.
- Address line3
address_line3text - Address line3.
- Address postal code
address_postal_codetext - Address postal code.
- Address state or province
address_state_or_provincetext - Address state or province.
- Business line ids
business_line_idslist - The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with. If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.
- Description
descriptiontextRequired - Your description of the store.
- External reference id
external_reference_idtext - The unique identifier of the store, used by certain payment methods and tax authorities. Required for CNPJ in Brazil, in the format 00.000.000/0000-00 separated by dots, slashes, hyphens, or without separators. Optional for SIRET in France, up to 14 digits. Optional for Zip in Australia, up to 50 digits.
- Localized information
localized_informationobject - localized_information
- Phone number
phone_numbertextRequired - The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164.
- Reference
referencetext - Your reference to recognize the store by. Also known as the store code. Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_). If you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id).
- Shopper statement
shopper_statementtextRequired - The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt. Maximum length: 22 characters; can't be all numbers.
- Split configuration
split_configurationobject - split_configuration
- Sub merchant data
sub_merchant_dataobject - sub_merchant_data
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"self": {
"href": "example"
}
},
"address": {
"city": "example",
"country": "example",
"line1": "example",
"line2": "example",
"line3": "example",
"postalCode": "example",
"stateOrProvince": "example"
},
"businessLineIds": [],
"description": "example",
"externalReferenceId": "example",
"id": "example",
"localizedInformation": {
"localShopperStatement": []
},
"merchantId": "example",
"phoneNumber": "example",
"reference": "example",
"shopperStatement": "example",
"splitConfiguration": {
"balanceAccountId": "example",
"splitConfigurationId": "example"
},
"status": "active",
"subMerchantData": {
"email": "example",
"id": "example",
"mcc": "example",
"name": "example"
}
},
"has_more": false,
"next_cursor": null
}Get api credential
Get api credential.
Inputs
None.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"allowedOrigins": {
"href": "example"
},
"company": {
"href": "example"
},
"generateApiKey": {
"href": "example"
},
"generateClientKey": {
"href": "example"
},
"merchant": {
"href": "example"
},
"self": {
"href": "example"
}
},
"active": false,
"allowedIpAddresses": [],
"allowedOrigins": [],
"clientKey": "example",
"companyName": "example",
"description": "example",
"id": "example",
"roles": [],
"subjectDN": "example",
"username": "example"
},
"has_more": false,
"next_cursor": null
}Get company
Get company.
Inputs
- Company
company_idtextRequired - The unique identifier of the company account.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"apiCredentials": {
"href": "example"
},
"self": {
"href": "example"
},
"users": {
"href": "example"
},
"webhooks": {
"href": "example"
}
},
"dataCenters": [],
"description": "example",
"id": "example",
"name": "example",
"reference": "example",
"status": "example"
},
"has_more": false,
"next_cursor": null
}Get merchant
Get merchant.
Inputs
- Merchant
merchant_idtextRequired - The unique identifier of the merchant account.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"apiCredentials": {
"href": "example"
},
"self": {
"href": "example"
},
"users": {
"href": "example"
},
"webhooks": {
"href": "example"
}
},
"captureDelay": "example",
"companyId": "example",
"dataCenters": [],
"defaultShopperInteraction": "example",
"description": "example",
"id": "example",
"merchantCity": "example",
"name": "example",
"pricingPlan": "example",
"primarySettlementCurrency": "example",
"reference": "example",
"shopWebAddress": "example",
"status": "example"
},
"has_more": false,
"next_cursor": null
}Get merchant terminal settings
Get merchant terminal settings.
Inputs
- Merchant
merchant_idtextRequired - The unique identifier of the merchant account.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"cardholderReceipt": {
"headerForAuthorizedReceipt": "example"
},
"connectivity": {
"simcardStatus": "ACTIVATED",
"terminalIPAddressURL": {
"eventLocalUrls": [],
"eventPublicUrls": []
}
},
"dcc": {
"enableDcc": false
},
"gratuities": [],
"hardware": {
"displayMaximumBackLight": 1,
"resetTotalsHour": 1,
"restartHour": 1
},
"homeScreen": {
"hideNavigationBar": false,
"showPaymentsMenu": false,
"showSettingsMenu": false
},
"kioskMode": {
"allowedAppsInKioskMode": [],
"kioskAppOnStartup": "example"
},
"localization": {
"language": "example",
"secondaryLanguage": "example",
"timezone": "example"
},
"moto": {
"enableMoto": false,
"maxAmount": 1
},
"nexo": {
"displayUrls": {
"localUrls": [],
"publicUrls": []
},
"encryptionKey": {
"identifier": "example",
"passphrase": "example",
"version": 1
},
"eventUrls": {
"eventLocalUrls": [],
"eventPublicUrls": []
},
"nexoEventUrls": [],
"notification": {
"category": "SaleWakeUp",
"details": "example",
"enabled": false,
"showButton": false,
"title": "example"
}
},
"offlineProcessing": {
"chipFloorLimit": 1
},
"opi": {
"enablePayAtTable": false,
"payAtTableStoreNumber": "example",
"payAtTableURL": "example"
},
"passcodes": {
"adminMenuPin": "example",
"refundPin": "example",
"screenLockPin": "example",
"txMenuPin": "example"
},
"payAtTable": {
"authenticationMethod": "MAGSWIPE",
"enablePayAtTable": false,
"paymentInstrument": "Cash"
},
"payment": {
"contactlessCurrency": "example",
"hideMinorUnitsInCurrencies": []
},
"receiptOptions": {
"headerLine1": "example",
"headerLine2": "example",
"logo": "example",
"promptBeforePrinting": false,
"qrCodeData": "example"
},
"receiptPrinting": {
"merchantApproved": false,
"merchantCancelled": false,
"merchantCaptureApproved": false,
"merchantCaptureRefused": false,
"merchantRefundApproved": false,
"merchantRefundRefused": false,
"merchantRefused": false,
"merchantVoid": false,
"shopperApproved": false,
"shopperCancelled": false,
"shopperCaptureApproved": false,
"shopperCaptureRefused": false,
"shopperRefundApproved": false,
"shopperRefundRefused": false,
"shopperRefused": false,
"shopperVoid": false
},
"refunds": {
"referenced": {
"enableStandaloneRefunds": false
},
"unreferenced": {
"enableUnreferencedRefunds": false
}
},
"showCalculatedPercentageTippingAmount": false,
"signature": {
"askSignatureOnScreen": false,
"deviceName": "example",
"deviceSlogan": "example",
"skipSignature": false
},
"standalone": {
"currencyCode": "example",
"enableGratuities": false,
"enableStandalone": false
},
"storeAndForward": {
"maxAmount": [],
"maxPayments": 1,
"supportedCardTypes": {
"credit": false,
"debit": false,
"deferredDebit": false,
"prepaid": false,
"unknown": false
}
},
"surcharge": {
"askConfirmation": false,
"configurations": [],
"disclosureOnPresentCard": false,
"excludeGratuityFromSurcharge": false
},
"tapToPay": {
"merchantDisplayName": "example"
},
"terminalInstructions": {
"adyenAppRestart": false
},
"timeouts": {
"fromActiveToSleep": 1
},
"wifiProfiles": {
"profiles": [],
"settings": {
"band": "example",
"roaming": false,
"timeout": 1
}
}
},
"has_more": false,
"next_cursor": null
}Get merchant user
Get merchant user.
Inputs
- Merchant
merchant_idtextRequired - Unique identifier of the merchant.
- Account id
account_idtextRequired - Unique identifier of the user.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"self": {
"href": "example"
}
},
"accountGroups": [],
"active": false,
"apps": [],
"email": "example",
"id": "example",
"name": {
"firstName": "example",
"lastName": "example"
},
"roles": [],
"timeZoneCode": "example",
"username": "example"
},
"has_more": false,
"next_cursor": null
}Get merchant webhook
Get merchant webhook.
Inputs
- Merchant
merchant_idtextRequired - The unique identifier of the merchant account.
- Webhook id
webhook_idtextRequired - Unique identifier of the webhook configuration.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"company": {
"href": "example"
},
"generateHmac": {
"href": "example"
},
"merchant": {
"href": "example"
},
"self": {
"href": "example"
},
"testWebhook": {
"href": "example"
}
},
"acceptsExpiredCertificate": false,
"acceptsSelfSignedCertificate": false,
"acceptsUntrustedRootCertificate": false,
"accountReference": "example",
"active": false,
"additionalSettings": {
"excludeEventCodes": [],
"includeEventCodes": [],
"properties": {}
},
"certificateAlias": "example",
"communicationFormat": "http",
"description": "example",
"encryptionProtocol": "HTTP",
"filterMerchantAccountType": "allAccounts",
"filterMerchantAccounts": [],
"hasError": false,
"hasPassword": false,
"hmacKeyCheckValue": "example",
"id": "example",
"networkType": "local",
"populateSoapActionHeader": false,
"type": "example",
"url": "example",
"username": "example"
},
"has_more": false,
"next_cursor": null
}Get payment method
Get payment method.
Inputs
- Merchant
merchant_idtextRequired - The unique identifier of the merchant account.
- Payment method id
payment_method_idtextRequired - The unique identifier of the payment method.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"accel": {
"processingType": "billpay",
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"affirm": {
"publicApiKey": "example"
},
"afterpayTouch": {
"supportEmail": "example",
"supportUrl": "example"
},
"alipayPlus": {
"settlementCurrencyCode": "example"
},
"allowed": false,
"amex": {
"midNumber": "example",
"reuseMidNumber": false,
"serviceLevel": "example"
},
"ancv": {
"shopId": "example"
},
"applePay": {
"domains": []
},
"associatedPaymentMethods": [],
"bcmc": {
"enableBcmcMobile": false,
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"businessLineId": "example",
"carnet": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"cartesBancaires": {
"siret": "example",
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"clearpay": {
"supportUrl": "example"
},
"countries": [],
"cup": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"currencies": [],
"customRoutingFlags": [],
"diners": {
"midNumber": "example",
"reuseMidNumber": false,
"serviceLevel": "example",
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"discover": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"ebt": {
"fnaNumber": "example"
},
"eft_directdebit_CA": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"eftpos_australia": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"enabled": false,
"girocard": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"givex": {
"currencyCode": "example",
"password": "example",
"paymentFlow": "example",
"username": "example"
},
"googlePay": {
"merchantId": "example",
"reuseMerchantId": false
},
"id": "example",
"ideal": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"interac_card": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"jcb": {
"midNumber": "example",
"reuseMidNumber": false,
"serviceLevel": "example",
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"klarna": {
"autoCapture": false,
"disputeEmail": "example",
"region": "AU",
"supportEmail": "example"
},
"maestro": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"maestro_usa": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"mc": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"mealVoucher_FR": {
"conecsId": "example",
"siret": "example",
"subTypes": []
},
"merchantCategoryCode": "example",
"mid": "example",
"nyce": {
"processingType": "billpay",
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"paybybank_plaid": {
"logo": "example",
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"payme": {
"displayName": "example",
"logo": "example",
"supportEmail": "example"
},
"paypal": {
"directCapture": false,
"payerId": "example",
"subject": "example"
},
"payto": {
"merchantName": "example",
"payToPurpose": "example"
},
"pulse": {
"processingType": "billpay",
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"reference": "example",
"sepadirectdebit": {
"creditorId": "example",
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"shopperInteraction": "example",
"sodexo": {
"merchantContactPhone": "example"
},
"sofort": {
"currencyCode": "example",
"logo": "example"
},
"star": {
"processingType": "billpay",
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"storeIds": [],
"svs": {
"authorisationMid": "example",
"currencyCode": "example"
},
"swish": {
"swishNumber": "example"
},
"ticket": {
"requestorId": "example"
},
"twint": {
"logo": "example"
},
"type": "example",
"valuelink": {
"alternateMerchantNumber": "example",
"authorisationMid": "example",
"pinSupport": "PIN",
"terminalId": "example"
},
"verificationStatus": "valid",
"vipps": {
"logo": "example",
"subscriptionCancelUrl": "example"
},
"visa": {
"transactionDescription": {
"doingBusinessAsName": "example",
"type": "append"
}
},
"wechatpay": {
"contactPersonName": "example",
"email": "example"
},
"wechatpay_pos": {
"contactPersonName": "example",
"email": "example"
}
},
"has_more": false,
"next_cursor": null
}Get store
Get store.
Inputs
- Store
store_idtextRequired - The unique identifier of the store.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"self": {
"href": "example"
}
},
"address": {
"city": "example",
"country": "example",
"line1": "example",
"line2": "example",
"line3": "example",
"postalCode": "example",
"stateOrProvince": "example"
},
"businessLineIds": [],
"description": "example",
"externalReferenceId": "example",
"id": "example",
"localizedInformation": {
"localShopperStatement": []
},
"merchantId": "example",
"phoneNumber": "example",
"reference": "example",
"shopperStatement": "example",
"splitConfiguration": {
"balanceAccountId": "example",
"splitConfigurationId": "example"
},
"status": "active",
"subMerchantData": {
"email": "example",
"id": "example",
"mcc": "example",
"name": "example"
}
},
"has_more": false,
"next_cursor": null
}Get store terminal settings
Get store terminal settings.
Inputs
- Store
store_idtextRequired - The unique identifier of the store.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"cardholderReceipt": {
"headerForAuthorizedReceipt": "example"
},
"connectivity": {
"simcardStatus": "ACTIVATED",
"terminalIPAddressURL": {
"eventLocalUrls": [],
"eventPublicUrls": []
}
},
"dcc": {
"enableDcc": false
},
"gratuities": [],
"hardware": {
"displayMaximumBackLight": 1,
"resetTotalsHour": 1,
"restartHour": 1
},
"homeScreen": {
"hideNavigationBar": false,
"showPaymentsMenu": false,
"showSettingsMenu": false
},
"kioskMode": {
"allowedAppsInKioskMode": [],
"kioskAppOnStartup": "example"
},
"localization": {
"language": "example",
"secondaryLanguage": "example",
"timezone": "example"
},
"moto": {
"enableMoto": false,
"maxAmount": 1
},
"nexo": {
"displayUrls": {
"localUrls": [],
"publicUrls": []
},
"encryptionKey": {
"identifier": "example",
"passphrase": "example",
"version": 1
},
"eventUrls": {
"eventLocalUrls": [],
"eventPublicUrls": []
},
"nexoEventUrls": [],
"notification": {
"category": "SaleWakeUp",
"details": "example",
"enabled": false,
"showButton": false,
"title": "example"
}
},
"offlineProcessing": {
"chipFloorLimit": 1
},
"opi": {
"enablePayAtTable": false,
"payAtTableStoreNumber": "example",
"payAtTableURL": "example"
},
"passcodes": {
"adminMenuPin": "example",
"refundPin": "example",
"screenLockPin": "example",
"txMenuPin": "example"
},
"payAtTable": {
"authenticationMethod": "MAGSWIPE",
"enablePayAtTable": false,
"paymentInstrument": "Cash"
},
"payment": {
"contactlessCurrency": "example",
"hideMinorUnitsInCurrencies": []
},
"receiptOptions": {
"headerLine1": "example",
"headerLine2": "example",
"logo": "example",
"promptBeforePrinting": false,
"qrCodeData": "example"
},
"receiptPrinting": {
"merchantApproved": false,
"merchantCancelled": false,
"merchantCaptureApproved": false,
"merchantCaptureRefused": false,
"merchantRefundApproved": false,
"merchantRefundRefused": false,
"merchantRefused": false,
"merchantVoid": false,
"shopperApproved": false,
"shopperCancelled": false,
"shopperCaptureApproved": false,
"shopperCaptureRefused": false,
"shopperRefundApproved": false,
"shopperRefundRefused": false,
"shopperRefused": false,
"shopperVoid": false
},
"refunds": {
"referenced": {
"enableStandaloneRefunds": false
},
"unreferenced": {
"enableUnreferencedRefunds": false
}
},
"showCalculatedPercentageTippingAmount": false,
"signature": {
"askSignatureOnScreen": false,
"deviceName": "example",
"deviceSlogan": "example",
"skipSignature": false
},
"standalone": {
"currencyCode": "example",
"enableGratuities": false,
"enableStandalone": false
},
"storeAndForward": {
"maxAmount": [],
"maxPayments": 1,
"supportedCardTypes": {
"credit": false,
"debit": false,
"deferredDebit": false,
"prepaid": false,
"unknown": false
}
},
"surcharge": {
"askConfirmation": false,
"configurations": [],
"disclosureOnPresentCard": false,
"excludeGratuityFromSurcharge": false
},
"tapToPay": {
"merchantDisplayName": "example"
},
"terminalInstructions": {
"adyenAppRestart": false
},
"timeouts": {
"fromActiveToSleep": 1
},
"wifiProfiles": {
"profiles": [],
"settings": {
"band": "example",
"roaming": false,
"timeout": 1
}
}
},
"has_more": false,
"next_cursor": null
}List companies
List companies.
Inputs
- Page number
page_numbernumber - The number of the page to fetch.
- Page size
page_sizenumber - The number of items to have on a page, maximum 100. The default is 10 items on a page.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"first": {
"href": "example"
},
"last": {
"href": "example"
},
"next": {
"href": "example"
},
"prev": {
"href": "example"
},
"self": {
"href": "example"
}
},
"data": [],
"itemsTotal": 1,
"pagesTotal": 1
},
"has_more": false,
"next_cursor": null
}List company merchants
List company merchants.
Inputs
- Company
company_idtextRequired - The unique identifier of the company account.
- Page number
page_numbernumber - The number of the page to fetch.
- Page size
page_sizenumber - The number of items to have on a page, maximum 100. The default is 10 items on a page.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"first": {
"href": "example"
},
"last": {
"href": "example"
},
"next": {
"href": "example"
},
"prev": {
"href": "example"
},
"self": {
"href": "example"
}
},
"data": [],
"itemsTotal": 1,
"pagesTotal": 1
},
"has_more": false,
"next_cursor": null
}List merchant stores
List merchant stores.
Inputs
- Merchant
merchant_idtextRequired - The unique identifier of the merchant account.
- Page number
page_numbernumber - The number of the page to fetch.
- Page size
page_sizenumber - The number of items to have on a page, maximum 100. The default is 10 items on a page.
- Reference
referencetext - The reference of the store.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"first": {
"href": "example"
},
"last": {
"href": "example"
},
"next": {
"href": "example"
},
"prev": {
"href": "example"
},
"self": {
"href": "example"
}
},
"data": [],
"itemsTotal": 1,
"pagesTotal": 1
},
"has_more": false,
"next_cursor": null
}List merchant users
List merchant users.
Inputs
- Merchant
merchant_idtextRequired - Unique identifier of the merchant.
- Page number
page_numbernumber - The number of the page to fetch.
- Page size
page_sizenumber - The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.
- Username
usernametext - The partial or complete username to select all users that match.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"first": {
"href": "example"
},
"last": {
"href": "example"
},
"next": {
"href": "example"
},
"prev": {
"href": "example"
},
"self": {
"href": "example"
}
},
"data": [],
"itemsTotal": 1,
"pagesTotal": 1
},
"has_more": false,
"next_cursor": null
}List merchant webhooks
List merchant webhooks.
Inputs
- Merchant
merchant_idtextRequired - The unique identifier of the merchant account.
- Page number
page_numbernumber - The number of the page to fetch.
- Page size
page_sizenumber - The number of items to have on a page, maximum 100. The default is 10 items on a page.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"first": {
"href": "example"
},
"last": {
"href": "example"
},
"next": {
"href": "example"
},
"prev": {
"href": "example"
},
"self": {
"href": "example"
}
},
"accountReference": "example",
"data": [],
"itemsTotal": 1,
"pagesTotal": 1
},
"has_more": false,
"next_cursor": null
}List merchants
List merchants.
Inputs
- Page number
page_numbernumber - The number of the page to fetch.
- Page size
page_sizenumber - The number of items to have on a page, maximum 100. The default is 10 items on a page.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"first": {
"href": "example"
},
"last": {
"href": "example"
},
"next": {
"href": "example"
},
"prev": {
"href": "example"
},
"self": {
"href": "example"
}
},
"data": [],
"itemsTotal": 1,
"pagesTotal": 1
},
"has_more": false,
"next_cursor": null
}List payment methods
List payment methods.
Inputs
- Merchant
merchant_idtextRequired - The unique identifier of the merchant account.
- Store
store_idtext - The unique identifier of the store for which to return the payment methods.
- Business line id
business_line_idtext - The unique identifier of the Business Line for which to return the payment methods.
- Page size
page_sizenumber - The number of items to have on a page, maximum 100. The default is 10 items on a page.
- Page number
page_numbernumber - The number of the page to fetch.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"first": {
"href": "example"
},
"last": {
"href": "example"
},
"next": {
"href": "example"
},
"prev": {
"href": "example"
},
"self": {
"href": "example"
}
},
"data": [],
"itemsTotal": 1,
"pagesTotal": 1,
"typesWithErrors": []
},
"has_more": false,
"next_cursor": null
}List stores
List stores.
Inputs
- Page number
page_numbernumber - The number of the page to fetch.
- Page size
page_sizenumber - The number of items to have on a page, maximum 100. The default is 10 items on a page.
- Reference
referencetext - The reference of the store.
- Merchant
merchant_idtext - The unique identifier of the merchant account.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"first": {
"href": "example"
},
"last": {
"href": "example"
},
"next": {
"href": "example"
},
"prev": {
"href": "example"
},
"self": {
"href": "example"
}
},
"data": [],
"itemsTotal": 1,
"pagesTotal": 1
},
"has_more": false,
"next_cursor": null
}List terminals
List terminals.
Inputs
- Search query
search_querytext - Returns terminals with an ID that contains the specified string. If present, other query parameters are ignored.
- Otp query
otp_querytext - Returns one or more terminals associated with the one-time passwords specified in the request. If this query parameter is used, other query parameters are ignored.
- Countries
countriestext - Returns terminals located in the countries specified by their [two-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
- Merchant ids
merchant_idstext - Returns terminals that belong to the merchant accounts specified by their unique merchant account ID.
- Store ids
store_idstext - Returns terminals that are assigned to the [stores](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores) specified by their unique store ID.
- Brand models
brand_modelstext - Returns terminals of the [models](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) specified in the format *brand.model*.
- Page number
page_numbernumber - The number of the page to fetch.
- Page size
page_sizenumber - The number of items to have on a page, maximum 100. The default is 20 items on a page.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"first": {
"href": "example"
},
"last": {
"href": "example"
},
"next": {
"href": "example"
},
"prev": {
"href": "example"
},
"self": {
"href": "example"
}
},
"data": [],
"itemsTotal": 1,
"pagesTotal": 1
},
"has_more": false,
"next_cursor": null
}Update store
Update store.
Inputs
- Store
store_idtextRequired - The unique identifier of the store.
- Address city
address_citytext - Address city.
- Address line1
address_line1text - Address line1.
- Address line2
address_line2text - Address line2.
- Address line3
address_line3text - Address line3.
- Address postal code
address_postal_codetext - Address postal code.
- Address state or province
address_state_or_provincetext - Address state or province.
- Business line ids
business_line_idslist - The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__resParam_id) that the store is associated with.
- Description
descriptiontext - The description of the store.
- External reference id
external_reference_idtext - The unique identifier of the store, used by certain payment methods and tax authorities. Required for CNPJ in Brazil, in the format 00.000.000/0000-00 separated by dots, slashes, hyphens, or without separators. Optional for SIRET in France, up to 14 digits. Optional for Zip in Australia, up to 50 digits.
- Phone number
phone_numbertext - The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164.
- Split configuration
split_configurationobject - split_configuration
- Status
statustext - The status of the store. Possible values are: - **active**: This value is assigned automatically when a store is created. - **inactive**: The maximum [transaction limits and number of Store-and-Forward transactions](https://docs.adyen.com/point-of-sale/determine-account-structure/configure-features#payment-features) for the store are set to 0. This blocks new transactions, but captures are still possible. - **closed**: The terminals of the storOne of:
active,inactive,closed. - Sub merchant data
sub_merchant_dataobject - sub_merchant_data
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"self": {
"href": "example"
}
},
"address": {
"city": "example",
"country": "example",
"line1": "example",
"line2": "example",
"line3": "example",
"postalCode": "example",
"stateOrProvince": "example"
},
"businessLineIds": [],
"description": "example",
"externalReferenceId": "example",
"id": "example",
"localizedInformation": {
"localShopperStatement": []
},
"merchantId": "example",
"phoneNumber": "example",
"reference": "example",
"shopperStatement": "example",
"splitConfiguration": {
"balanceAccountId": "example",
"splitConfigurationId": "example"
},
"status": "active",
"subMerchantData": {
"email": "example",
"id": "example",
"mcc": "example",
"name": "example"
}
},
"has_more": false,
"next_cursor": null
}