Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Gateway Features
Settlement Time

Get Settlement Time

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Usage</summary> Use this request to get the settlementTime that is currently set on an existing account. You will see the result at the bottom of the response, in Universal Time Coordinated (UTC).

Note - settlement time null represents the default settlement time.

</details>
get/v4/processors/{id}

Path parameters

idstring required

The id of the processor.

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Response

Success

objectType'processor'

The type of object that was returned as a result of the request.

idinteger

The unique identifier of the processor or service instance added.

processorTypestring

The type of the processor added.

processorIdstring

The ID of the processor added.

processorNamestring

The name of the processor added.

serviceIdstring

The code name of the processor platform or service added.

merchantIdstring

The merchant's Gateway ID.

mccstring

The Merchant Category Code.

accountClassificationstring

The account classification of the processor added.

maxTicketAmountstring

The maximum amount for a single transaction run through the added processor.

maxMonthlyVolumestring

The maximum total amount that can be run through the processor in a single month.

applyToAllCardTypeboolean

Whether the maxMonthlyVolume and maxTicketAmount apply to all payment methods through the added processor or not.

enableDuplicateCheckingboolean

Whether duplicate checking is enabled or not.

allowMerchantOverrideboolean

Whether the merchant is allowed to ignore the duplicate check on a per-transaction basis or not.

duplicateTimestring

The amount of time in seconds to look back to check if a transaction is a duplicate.

status'active' | 'pending' | 'closed'

The status of the added processor or service, depending on the processor/billing authorization status.

condition'offered' | 'notOffered' | 'mandatory'

The condition of the added processor or service.

extraDetailsobject

Any extra details about the added processor.

freeTrialEndDatestring nullable

End date of free trial.

freeTrialDaysLeftstring

Days left of free trial.

hasBeenActiveboolean

Indicates whether the processor has been active or not.

createdstring

The date and time of when the processor or service was added.

updatedstring

The date and time of when the processor or service was last updated.

supportsReroutedRefundsboolean

Whether the added processor supports rerouted refunds or not.

shouldDisableFieldsboolean

Whether the added processor should disable fields or not.

disabledboolean nullable

Whether the processor is disabled or not.

refundProcessorstring nullable

The specified processor to reroute future refunds to, if this processor is disabled.

avsCvvPreCheckstring nullable

The AVS/CVV precheck method for the added processor.

skipAvsCvvboolean

Whether skipping AVS/CVV is enabled for the added processor or not.

processorFieldsobject

The processor-dependent fields for the added processor.

paymentTypesstring[]

The allowed payment types for the added processor.

currenciesstring[]

The allowed currencies for the added processor.

faceConfigurationobject

The FACe configuration for the added processor.

settlementTimestring nullable

The time settlement occurs.

settlementTimezonestring nullable

The timezone of the configured settlement time.