Accounts

8 endpoints. Base URL https://api.paymentsonline.io, sandbox https://api.sandbox-paymentsonline.io.

Every request needs payments-api-key and payments-account.

GET/v1/accounts

Get an Account

Retrieves the details of an existing Account.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200Account

bank_accountsarray of BankAccountrequired
Bank accounts attached to this account. Primarily used for payouts.
business_profileBusinessProfileoptional
The Business Profile for this account.
capabilitiesarray of AccountCapabilityoptional
Capabilities represent the assigned product codes to a given merchant account and their status.
created_atstring date-timerequired
Time at which the object was created.
document_requestsarray of AccountDocumentrequired
Documents that have been requested for an account, which are either in the requested or submitted status
emailstringoptional
The primary user's email address.
idstringrequired
Unique identifier for the object.
merchant_supportbooleanoptional
Whether Paydude is providing support for this account.
metadataobjectoptional
Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringoptional
The business name or individual name.
settingsAccountSettingsoptional
The account settings object.
split_pay_settingsSplitPaySettingsoptional
Split Pay settings for the account. Currently in beta and not available to all accounts.
statusstring (active | requires_pricing | funding_hold | account_review | partially_active | action_required | created | started | …)optional
The status of the account.
surcharging_settingsSurchargingSettingsoptional
Surcharging settings for the account. Currently in beta and not available to all accounts.
terminal_readersarray of TerminalReaderrequired
Terminal Readers attached to this account.
typestring (partner | merchant | reseller)required
The Paydude account type. Can be partner or merchant.
updated_atstring date-timerequired
Time at which the object was last updated.
white_label_domainstringoptional
The partner white label domain.

PATCH/v1/accounts

Update an Account

Updates an Account by setting the values of the provided parameters. Any parameters not provided remain unchanged.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Request body application/jsonrequired

bank_accountBankAccountCreateParamsoptional
A bank account to attach to this account for receiving payouts. (Note: currently this is only used for partner account payouts) By default, providing a bank account sets it as the new default bank account for its currency.
batch_safety_net_window_hoursnumberoptional
Per-merchant safety-net deadline for manual batch close. If a Batch is still open at opened_at + window, the platform auto-closes it. Processor implementations must not exceed their Kestrel-declared maxSafetyNetWindowHours.
emailstringoptional
The primary user's email address.
metadataobjectoptional
Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value (i.e. '' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.
namestringoptional
The business name or individual name.
settingsAccountSettingsCreateParamsoptional
Account Settings
split_pay_settingsSplitPaySettingsoptional
Split Pay settings for the account. Currently in beta and not available to all accounts.
surcharging_settingsSurchargingSettingsoptional
Surcharging settings for the account. Currently in beta and not available to all accounts.
white_label_domainstringoptional
The custom domain the partner chooses to reflect on all of its merchant accounts as part of the white label settings. It must use the Paydude-hosted zone for the current environment, or an active reseller partner zone when enabled. *Note: This feature is only available to Partner accounts.*

Responses

200Account

bank_accountsarray of BankAccountrequired
Bank accounts attached to this account. Primarily used for payouts.
business_profileBusinessProfileoptional
The Business Profile for this account.
capabilitiesarray of AccountCapabilityoptional
Capabilities represent the assigned product codes to a given merchant account and their status.
created_atstring date-timerequired
Time at which the object was created.
document_requestsarray of AccountDocumentrequired
Documents that have been requested for an account, which are either in the requested or submitted status
emailstringoptional
The primary user's email address.
idstringrequired
Unique identifier for the object.
merchant_supportbooleanoptional
Whether Paydude is providing support for this account.
metadataobjectoptional
Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringoptional
The business name or individual name.
settingsAccountSettingsoptional
The account settings object.
split_pay_settingsSplitPaySettingsoptional
Split Pay settings for the account. Currently in beta and not available to all accounts.
statusstring (active | requires_pricing | funding_hold | account_review | partially_active | action_required | created | started | …)optional
The status of the account.
surcharging_settingsSurchargingSettingsoptional
Surcharging settings for the account. Currently in beta and not available to all accounts.
terminal_readersarray of TerminalReaderrequired
Terminal Readers attached to this account.
typestring (partner | merchant | reseller)required
The Paydude account type. Can be partner or merchant.
updated_atstring date-timerequired
Time at which the object was last updated.
white_label_domainstringoptional
The partner white label domain.

POST/v1/accounts/capabilities

Add an Account Capability

Adds an Account capability. Account capabilities can only be managed before the onboarding application is submitted.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Request body application/jsonrequired

pricing_template_idstringrequired
The PricingTemplate id defining the capability to add to the account. Merchant accounts may only have 1 capability per payment_method_type.

Responses

201

DELETE/v1/accounts/capabilities/{id}

Delete an Account Capability

Deletes an Account capability. Account capabilities can only be managed before the onboarding application is submitted.

Path parameters

idstringrequired

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

204

POST/v1/accounts/capabilities/{id}

Update an Account Capability

Updates an Account capability. Account capabilities can only be managed before the onboarding application is submitted.

Path parameters

idstringrequired

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Request body application/jsonrequired

pricing_template_idstringrequired
The PricingTemplate id defining the capability to add to the account. Merchant accounts may only have 1 capability per payment_method_type.

Responses

201

DELETE/v1/accounts/connected

Delete a Connected Account

Deletes a connected Account. This cannot be undone.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

204

400

GET/v1/accounts/connected

List all Connected Accounts

Returns a list of merchant Accounts. The Accounts are sorted with the most recently created appearing first. If the provided account type is merchant, the list is empty.

Query parameters

metadataobjectoptional
metadata key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: ?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b.
statusarray of string (active | requires_pricing | funding_hold | account_review | partially_active | action_required | created | started | …)optional
Only return Connected Accounts whose status is included in this array. Examples: /v1/accounts/connected?status=active,partially_active and /v1/accounts/connected?status=account_review.
qstringoptional
The partial search of text fields. Supports searching by account.name, account.business_profile.legal_name, account.id, account.email, user.name, user.email
partner_application_statusarray of string (created | started | submitted)optional
Only return Connected Partner Accounts whose partner application status is included in this array. Examples: /v1/accounts/connected?partner_application_status=created,started and /v1/accounts/connected?partner_application_status=submitted.
processing_capabilitiesarray of string (card | card_present | debit)optional
Only return Connected Partner Accounts who have an active capability with the specified processing capabilities. Examples: /v1/accounts/connected?processing_capabilities=card,debit and /v1/accounts/connected?processing_capabilities=card.
sortstringoptional
The sort parameters, value:direction. Possible values: name, created_at. Possible directions: asc, desc For example name:asc. Default: created_at:desc
typestring (partner | merchant | reseller)optional
Only return Connected Accounts where the type matches the specified value.
offsetnumberoptional
The (zero-based) offset of the first item in the collection to return.
limitnumberoptional
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200PaginatedDto | object

has_morebooleanrequired
Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
limitnumberoptional
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.
offsetnumberoptional
The (zero-based) offset of the first item in the collection to return.
totalnumberoptional
The total items count.
itemsarray of Accountrequired

POST/v1/accounts/connected

Create a Connected Account

Creates a connected Account associated with your partner/parent Account.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Request body application/jsonrequired

This endpoint accepts one of the following shapes.

merchant account parameters

emailstringrequired
The primary user's email address.
metadataobjectoptional
Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value (i.e. '' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.
namestringoptional
The business name or individual name.
pricing_template_idsarray of stringoptional
An array of Pricing Template ids to associate with the merchant account. This is ignored for partner accounts. Only 1 pricing template per payment_method_type is allowed. For example, only 1 card and 1 ach_debit template may be submitted for a given merchant. You cannot specify 2 templates of type card for a single merchant. You should create a separate merchant account in that case. *Note: Pass an empty array to configure without pricing for now, pricing must be specified before an onboarding application is made available*
product_code_idsarray of stringoptional
*Deprecated: Use pricing_template_ids to specify merchant pricing.* An array of ProductCode ids to associate with the merchant account. This is ignored for partner accounts. Only 1 capability per payment_method_type is allowed. For example, only 1 card and 1 ach_debit may be submitted for a given merchant. You cannot specify 2 capabilities of type card for a single merchant. You should create a separate merchant account in that case. *Note: If your account contains multiple capabilities for a given payment method type, then you must explicitly specify the one you want to use. If your account only contains a single capability per payment method type then those values will be the default. If your account is enabled to process in both the United States and Canada, new merchant accounts will be configured with US capabilities if no value is specified for product_code_ids.*
split_pay_settingsSplitPaySettingsoptional
Split Pay settings for the account. Currently in beta and not available to all accounts.
surcharging_settingsSurchargingSettingsoptional
Surcharging settings for the account. Currently in beta and not available to all accounts.

partner account parameters

emailstringrequired
The primary user's email address.
namestringrequired
The business name or individual name.
split_pay_settingsSplitPaySettingsoptional
Split Pay settings for the account. Currently in beta and not available to all accounts.
surcharging_settingsSurchargingSettingsoptional
Surcharging settings for the account. Currently in beta and not available to all accounts.

Create a merchant account

{
  "name": "Merchant Account",
  "email": "merchant@email.test"
}

Responses

201Account

bank_accountsarray of BankAccountrequired
Bank accounts attached to this account. Primarily used for payouts.
business_profileBusinessProfileoptional
The Business Profile for this account.
capabilitiesarray of AccountCapabilityoptional
Capabilities represent the assigned product codes to a given merchant account and their status.
created_atstring date-timerequired
Time at which the object was created.
document_requestsarray of AccountDocumentrequired
Documents that have been requested for an account, which are either in the requested or submitted status
emailstringoptional
The primary user's email address.
idstringrequired
Unique identifier for the object.
merchant_supportbooleanoptional
Whether Paydude is providing support for this account.
metadataobjectoptional
Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringoptional
The business name or individual name.
settingsAccountSettingsoptional
The account settings object.
split_pay_settingsSplitPaySettingsoptional
Split Pay settings for the account. Currently in beta and not available to all accounts.
statusstring (active | requires_pricing | funding_hold | account_review | partially_active | action_required | created | started | …)optional
The status of the account.
surcharging_settingsSurchargingSettingsoptional
Surcharging settings for the account. Currently in beta and not available to all accounts.
terminal_readersarray of TerminalReaderrequired
Terminal Readers attached to this account.
typestring (partner | merchant | reseller)required
The Paydude account type. Can be partner or merchant.
updated_atstring date-timerequired
Time at which the object was last updated.
white_label_domainstringoptional
The partner white label domain.