Skip to main content
API docs by Redocly

Payment Config API (1)

Download OpenAPI specification:Download

Use this API to manage Payment configuration.

Adyen adapter configuration

Returns the configuration of the adyen adapter.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "config": [
    ]
}

Update adyen adapter configuration

Updates the configuration of the adyen adapter.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
Array of objects

Contains the list of configurations supported by the adapter.

Array
endpoint
required
string

Adyen Payments API base URL. Example: 'https://pal-test.adyen.com/pal/servlet/Payment/[version]'.

assume_refund_successful
boolean

When set to true refunds will be marked as successful in NOM without waiting for Adyen's confirmation.

assume_unreferenced_refund_successful
boolean

When set to true unreferenced refunds will be marked as successful in NOM without waiting for Adyen's confirmation.

assume_void_successful
boolean

When set to true voids (revokes of payment authorizations) will be marked as successful without waiting for Adyen's confirmation.

wait_for_auth_notification
boolean

When set to true will make the adapter wait for the authentication webhook from Adyen. Important: This might delay the checkout process when set to True.

capture_delay
required
string
Enum: "manual" "immediate"

Defines if payments should be manually captured. Should conform to what is configured on the Adyen portal.

immediate_capture_payment_methods
Array of strings

List of always-precaptured payment methods, for which capture requests should not be forwarded to the provider.

provider_name
string

Provider name as configured in fat_psp -> external_providers. Example: adyen.

merchant_accounts
required
Array of strings

The list of merchant accounts sharing this configuration.

order_placement_delay
integer <= 10

Defines the delay in seconds for placing the order if the order is still in a draft state after the payment notification has been received.

track_revoke_requests
boolean

When set to true, the adapter will track revoke requests and will correlate incoming refund events with the revoke requests, which may be necessary for immediate capture payments.

timeout
integer

API client timeout in seconds.

Responses

Request samples

Content type
application/json
{
  • "config": [
    ]
}

Audit history for Adyen Adapter configuration

Returns a list of the current and all previous values for the Adyen Adapter configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "config": [
    ]
}

Cash drawer configuration

Returns the configuration of the cash drawer.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "expose_count_expected_amount": true
}

Update cash drawer configuration

Updates the configuration of cash drawer.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
expose_count_expected_amount
boolean

When set to true the API will return the expected amount when responding to a record count request.

Responses

Request samples

Content type
application/json
{
  • "expose_count_expected_amount": true
}

Audit history for Cash Drawer configuration

Returns a list of the current and all previous values for the Cash Drawer configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "expose_count_expected_amount": [
    ]
}

FAT PSP configuration

Returns the configuration of fat psp.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{}

Update FAT PSP configuration

Updates the configuration of fat psp.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
braintree_partial_settlement_enabled
boolean

Feature flag to enable or disable the partial settlement feature.

object

Map of available external payment providers that are being called via http.

object

Map of available payment providers that are being called internally via rpc.

Responses

Request samples

Content type
application/json
{}

Audit history for FAT PSP configuration

Returns a list of the current and all previous values for the FAT PSP configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "external_providers": [
    ],
  • "internal_providers": [
    ]
}

Gift card configuration

Returns the configuration of gift card.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "provider": {},
  • "store_configurations": {
    }
}

Update gift card configuration

Updates the configuration of gift card.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
required
object

provider configuration for the tenant

object

gift card store configuration for the tenant

Responses

Request samples

Content type
application/json
{
  • "provider": {},
  • "store_configurations": {
    }
}

Audit history for Gift Card configuration

Returns a list of the current and all previous values for the Gift Card configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "provider": [],
  • "store_configurations": [
    ]
}

Payment NOM configuration

Returns the NOM configuration

Authorizations:
newStoreAccessToken

Responses

Update NOM configuration

Updates the payment configuration of NOM.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
transaction_details_urls
object

Map of key/value where the key is the provider name and the value is the base url for payment links.

Responses

Audit history for NOM configuration

Returns a list of the current and all previous values for the NOM configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{}

NewStore Checkout configuration

Returns the configuration of NewStore Checkout.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "http_timeout": 600,
  • "encryption_pass_phrase": "you can use any random value",
  • "supported_payment_methods": [
    ],
  • "tenant_url": "www.dodici.com",
  • "tenant_url_label": "Dodici",
  • "payment_methods": {
    },
  • "wallets": {
    },
  • "psps": {},
  • "enable_web_drop_in": true
}

Update NewStore Checkout configuration

Updates the configuration of NewStore Checkout.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
http_timeout
integer
Default: 10000

Maximum waiting time in milliseconds for an external HTTP request. MUST be smaller than gRPC timeout.

encryption_pass_phrase
string

Pass phrase used by the hash algorithm to generate the cart token.

supported_payment_methods
Array of strings

Payment methods that are supported by the retailer

tenant_url
string

The URL to the tenant website displayed to the customer when the payment completes.

tenant_url_label
string

The label that should be used instead of the website URL for the link when the payment completes.

object

Digital wallet configuration.

object

Payment methods configuration.

object

Payment Service Provider configuration.

enable_web_drop_in
boolean
Default: false

Indicates wether the Adyen Web DropIn should be used.

Responses

Request samples

Content type
application/json
{
  • "http_timeout": 600,
  • "encryption_pass_phrase": "you can use any random value",
  • "supported_payment_methods": [
    ],
  • "tenant_url": "www.dodici.com",
  • "tenant_url_label": "Dodici",
  • "payment_methods": {
    },
  • "wallets": {
    },
  • "psps": {},
  • "enable_web_drop_in": true
}

Audit history for NewStore Checkout configuration

Returns a list of the current and all previous values for the NewStore Checkout configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "http_timeout": [
    ],
  • "encryption_pass_phrase": [
    ],
  • "supported_payment_methods": [
    ],
  • "tenant_url": [
    ],
  • "tenant_url_label": [
    ],
  • "wallets": [
    ],
  • "psps": [],
  • "enable_web_drop_in": [
    ]
}

Payment Account configuration

Returns the configuration of Payment Account.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "default_capture_strategy": "ordered",
  • "default_refund_strategy": "ordered",
  • "available_strategies": {
    },
  • "partial_unreferenced_refund_payment_invalidation": true,
  • "add_gift_card_instrument_on_issue": true
}

Update Payment Account configuration

Updates the configuration of payment account.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
default_capture_strategy
string

the name of the default strategy for capture

default_refund_strategy
string

the name of the default strategy for refund

available_strategies
object

Mapping of strategy_name->configuration of the available strategies. For a list of available strategies, consult payment_account documentation

partial_unreferenced_refund_payment_invalidation
boolean

defines how unreferenced refunds affect existing payments. If set to true, invalidates only the amount for which the unreferenced refund was made. Otherwise, it invalidates all existing payments.

add_gift_card_instrument_on_issue
boolean

defines whether funds to process a new gift card refund are added to the account before or during the gift card issuing request.

Responses

Request samples

Content type
application/json
{
  • "default_capture_strategy": "ordered",
  • "default_refund_strategy": "ordered",
  • "available_strategies": {
    },
  • "partial_unreferenced_refund_payment_invalidation": true,
  • "add_gift_card_instrument_on_issue": true
}

Audit history for Payment Account configuration

Returns a list of the current and all previous values for the Payment Account configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "default_capture_strategy": [
    ],
  • "default_refund_strategy": [
    ],
  • "available_strategies": [
    ],
  • "partial_unreferenced_refund_payment_invalidation": [
    ]
}

Payment Capture configuration

Returns the configuration of the payment capture.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "use_charge_api": false
}

Update payment capture configuration

Updates the configuration of the payment capture.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
use_charge_api
boolean
Default: false

Define whether captures are triggered based on logistic order events or explicitly via charge API.

Responses

Request samples

Content type
application/json
{
  • "use_charge_api": false
}

Audit history for Payment Capture configuration

Returns a list of the current and all previous values for the Payment Capture configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "use_charge_api": [
    ]
}

Payment Engine configuration

Returns the configuration of payment engine.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "experimental_mode": false
}

Update payment engine configuration

Updates the configuration of payment engine.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
experimental_mode
boolean
Default: false

Enable experimental mode in payment engine.

Responses

Request samples

Content type
application/json
{
  • "experimental_mode": false
}

Audit history for Payment Engine configuration

Returns a list of the current and all previous values for the Payment Engine configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "experimental_mode": [
    ]
}

Payment options configuration

Returns the configuration of payment options.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "payment_options": [
    ],
  • "refund_options": [
    ],
  • "store_mapping": [
    ]
}

Update payment options configuration

Updates the configuration of payment options.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
payment_options
Array of strings
Items Enum: "stripe" "adyen" "adyen_terminal" "adyen_pay_by_link" "adyen_pos" "square" "cash" "gift_card" "newstore_checkout" "non_integrated" "verifone" "worldline"

The default list of payment options that can be offered in a store.

refund_options
Array of strings
Items Enum: "original" "gift_card" "e_gift_card" "credit_card" "external" "non_integrated" "worldline"

The default list of refund options that can be offered in a store.

Array of objects

Store-specific payment options configuration. It overrides the defaults for the configured store.

non_integrated_payment_methods
Array of strings

The default list of non-integrated payment methods that can be offered in a store.

object

Definition of non-integrated payment methods to be referenced globally or per store

Responses

Request samples

Content type
application/json
{
  • "payment_options": [
    ],
  • "refund_options": [
    ],
  • "store_mapping": [
    ]
}

Audit history for Payment Options configuration

Returns a list of the current and all previous values for the Payment Options configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "payment_options": [
    ],
  • "refund_options": [
    ],
  • "store_mapping": [
    ]
}

Payments watcher configuration

Returns the configuration of payments watcher.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "failed_capture_retry_enabled": true,
  • "failed_refund_retry_enabled": false,
  • "failed_revoke_retry_enabled": true,
  • "failed_add_retry_enabled": true
}

Update payments watcher configuration

Updates the configuration of payments watcher.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
failed_capture_retry_enabled
boolean

When enabled will trigger automatic retries for failed capture operations.

failed_refund_retry_enabled
boolean

When enabled will trigger automatic retries for failed refund operations.

failed_revoke_retry_enabled
boolean

When enabled will trigger automatic retries for failed revoke operations.

failed_add_retry_enabled
boolean

When enabled will trigger automatic retries for failed add financial instrument operations.

Responses

Request samples

Content type
application/json
{
  • "failed_capture_retry_enabled": true,
  • "failed_refund_retry_enabled": false,
  • "failed_revoke_retry_enabled": true,
  • "failed_add_retry_enabled": true
}

Audit history for Payments Watcher configuration

Returns a list of the current and all previous values for the Payments Watcher configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "failed_capture_retry_enabled": [
    ],
  • "failed_refund_retry_enabled": [
    ],
  • "failed_revoke_retry_enabled": [
    ],
  • "failed_add_retry_enabled": [
    ]
}

PSP Adyen configuration

Returns the configuration of PSP Adyen.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{}

Update PSP Adyen configuration

Updates the configuration of PSP Adyen.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
object

The checkout Adyen API is used by NewStore Checkout.

object

The standard Adyen API is used for payment reauthorizations.

object

Specifies how the payment reauthorization should be performed.

object

Defines the Associate App payment settings.

Responses

Request samples

Content type
application/json
{}

Audit history for PSP Adyen configuration

Returns a list of the current and all previous values for the PSP Adyen configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "checkout_api": [
    ],
  • "standard_api": [],
  • "payment_reauthorization": [
    ],
  • "pos": [
    ]
}

PSP Square configuration

Returns the configuration of PSP Square.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "api": {},
  • "store_mapping": [
    ]
}

Update PSP Square configuration

Updates the configuration of PSP Square.

Authorizations:
newStoreAccessToken
Request Body schema: application/json
object

Configuration parameters for the Square API.

Array of objects

A list of related NewStore store IDs and their corresponding Square location IDs. NewStore Store IDs should be unique.

Responses

Request samples

Content type
application/json
{
  • "api": {},
  • "store_mapping": [
    ]
}

Audit history for PSP Square configuration

Returns a list of the current and all previous values for the PSP Square configuration.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "api": [
    ],
  • "store_mapping": [
    ]
}