Pricing Templates

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

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

GET/v1/pricing-templates

List all Pricing Templates

Returns a list of Pricing Templates. The Pricing Templates are sorted with the most recently created appearing first.

Query parameters

typestring (card | ach_debit | card_present | eft_debit)optional
String indicating the type to filter the result by.
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 PricingTemplaterequired

GET/v1/pricing-templates/{id}

Get a Pricing Template

Retrieves the details of an existing Pricing Template.

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

200PricingTemplate

account_idstringrequired
The ID of the Account associated with this pricing template.
account_monthly_feenumberrequired
The account monthly fee configured for this pricing template, in currency minor units.
account_monthly_minimum_feenumberrequired
The account monthly minimum fee configured for this pricing template, in currency minor units.
ach_debitDebitFeeTemplateoptional
If this is an ach_debit pricing template, this hash contains the direct debit specific pricing details.
cardCardChargeFeeTemplateoptional
If this is a card pricing template, this hash contains the card specific pricing details.
card_presentCardPresentChargeFeeTemplateoptional
If this is a card_present pricing template, this hash contains the card specific pricing details.
created_atstring date-timerequired
Time at which the object was created.
currencystring (aud | cad | dkk | eur | hkd | jpy | nzd | nok | …)required
The currency this pricing template applies to.
eft_debitDebitFeeTemplateoptional
If this is an eft_debit pricing template, this hash contains the direct debit specific pricing details.
idstringrequired
Unique identifier for the object.
namestringrequired
The name of this pricing template.
payment_method_typestring (card | ach_debit | card_present | eft_debit)required
The payment method type this pricing template applies to.
statusstring (active | archived | pending)required
The status of this pricing template
updated_atstring date-timerequired
Time at which the object was last updated.