Strictly Public API

Schemas

Download schema

AchDataDto

routingNumber

string · required

ACH Routing Number

accountNumber

string · required

ACH Account Number

last4

string · required

Account number last4

accountType

string · required

Account type

paymentToken

string

Payment Token

driverLicenseNumber

string

Driver License Number

phoneNumber

string

Phone Number

ContactDto

email

string

Contact email address

phone

string · pattern: ^[+]?[(]?[0-9]{3}[)]…

Contact phone number

Example: (555) 555-5555

AchChargeAddressDto

firstName

string · required

First name

lastName

string · required

Last name

country

string · required

Billing country

address

string · required

Billing address

city

string · required

Billing city

state

string · required

Billing state

zipCode

string · required

Billing zip code

address2

string

Billing address line 2

phoneNumber

string

Billing phone number

ChargeAddressDto

firstName

string

Cardholder is first name

lastName

string

Cardholder is last name

country

string

Card billing country

address

string

Card billing address

address2

string

Card billing address line 2

city

string

Card billing city

state

string

Card billing state

zipCode

string

Card billing zip code

phoneNumber

string

Card billing phone number

email

string

Card billing email

CustomValuesDto

key

string

Custom Field Key

label

string

Custom Field Label

value

string

Custom Field Value

valueLabel

string

Custom Label Field Value

ChargeOrderDto

orderId

string

Order identifier

orderDescription

string

Order description

poNumber

string

Order PO

federalTaxes

number

Order federalTaxes amount

object[]

Custom Values

discount

number

A positive integer representing how much to discount in the smallest currency unit

donationAmount

number

Donation amount

donationTax

number

Donation tax amount

tipAmount

number

Tip amount

externalId

string · maxLength: 128

The caller's own identifier for this order or transaction (an integration's order id). Stored on the payment and searchable by integrations.

shipping

number · deprecated · required

Deprecated. Ignored for totals and validation; include any shipping fee in order.amount (and tax fields as applicable).

tax

number · deprecated · required

Deprecated. Legacy order tax amount (smallest currency unit).

amount

number · deprecated · required

Deprecated. Legacy order principal amount (smallest currency unit).

AchChargePublicDto

amount

number · required

A positive integer representing how much to charge in the smallest currency unit

object · required

Billing data

clientId

string

Ignored. Derived from your API key (key-hash).

overrideDefaultPaymentMethod

string

The id of the payment method to use in the charge

currency

string · enum

Three-letter ISO currency code, uppercase. Must be a supported currency

Enum values:

USD

CAD

capture

boolean

Whether to immediately capture the charge

object

Ach Information

object

Contact Information

object

Shipping data

object

Order data

sendReceipt

boolean

send Receipt info

bypassSurcharge

boolean

Ignored for ACH (ACH charges never carry a surcharge).

discount

number

Ignored for ACH; the discount is computed server-side (dual pricing).

customerId

string

Customer ID

taxes

string[]

Array of merchant tax ids (from GET /public/tax). Each tax is computed on amount and added to the total; unknown ids are rejected (404).

RefundPublicDto

amount

number · required

Integer amount in cents (1000 = $10.00). Must not exceed the remaining refundable balance; when transactionComponent is base it is the pre-tax base amount.

paymentId

string · required

ID of the payment to be refunded.

reason

string · required

Required. Free-text reason; recommended values: duplicate, fraudulent, requested_by_customer.

transactionComponent

string · enum

Transaction component to refund. Possible values are base, donation, tip. Defaults to base when not sent.

Enum values:

base

donation

tip

receipt

boolean

Send a refund receipt (email/SMS). Default false.

email

string

Email for the refund receipt. Defaults to the payment contact email.

phoneNumber

string · pattern: ^[+]?[(]?[0-9]{3}[)]…

Phone number for the refund receipt (SMS). Defaults to the payment contact phone.

Example: (555) 555-5555

VoidPublicDto

paymentId

string · required

ID of the payment to void

reason

string · enum

Void reason

Enum values:

fraud

user_cancel

icc_rejected

icc_card_removed

icc_no_confirmation

pos_timeout

rejected

insufficient_funds

payment

string · enum

Payment type hint (creditcard | electronicCheck). Currently not used by the void flow.

Enum values:

creditcard

electronicCheck

receipt

boolean

Send a void receipt (email/SMS). Default false.

email

string

Email for the void receipt. Defaults to the payment contact email.

phoneNumber

string · pattern: ^[+]?[(]?[0-9]{3}[)]…

Phone number for the void receipt (SMS). Defaults to the payment contact phone.

Example: (555) 555-5555

PaymentReceiptPdfDto

paymentId

string · required

The ID of the payment to which the PDF will be generated

clientId

string

Ignored. Derived from your API key (key-hash).

isForMerchant

boolean

Indicates if payment receipt is for merchant (true) or customer (false)

Default: true

PaymentMethodDto

type

string · required

The payment method type

accountNumber

string

The check account number

checkNumber

string

The check number

authCode

string

The check auth code

CardDto

name

string

Card name

paymentToken

string

Payment Token

vaultId

string

Vault Id

customerVaultId

string

Customer Vault Id in the procesor

number

string

Masked card number from the tokenization callback (response.card.number), e.g. 411111******1111. Required when charging with paymentToken (no vaultId); error 905 otherwise. Not needed with vaultId.

Example: 411111******1111

last4

string

card last4

network

string

card network

brand

string

Card Brand

type

string

Card type

bin

string

Card bin

zipCode

string

Zip code

ChargePublicDto

amount

number · required

A positive integer representing how much to charge in the smallest currency unit

object · required

Billing data

clientId

string

Ignored. Derived from your API key (key-hash).

overrideDefaultPaymentMethod

string

The id of the payment method to use in the charge

object

Payment Method Information

currency

string · enum

Three-letter ISO currency code, uppercase. Must be a supported currency

Enum values:

USD

CAD

capture

boolean

Whether to immediately capture the charge

object

Card Information

object

Contact Information

object

Shipping data

object

Order data

sendReceipt

boolean

send Receipt info

bypassSurcharge

boolean

Used to remove surcharge amount for exceptions

discount

number

A positive integer representing how much to discount in the smallest currency unit

marketType

string

Market Type

zipCode

string

Zip code

taxes

string[]

Taxes amount or list of taxes

CapturePublicDto

amount

number · required

Base amount to capture in cents (pre-tax, before card fee/surcharge). Tax and surcharge are computed server-side from the payment order.

paymentId

string · required

ID of the payment that must be captured.

BulkChargePayloadDto

amount

number · required

A positive integer representing how much to charge in the smallest currency unit

customerVaultId

string

Customer vault id (alias of customerId)

customerId

string

Customer vault id

bypassSurcharge

boolean

Used to remove surcharge amount for exceptions

object

Order data

BulkChargeDto

object[] · required

List of charges to run

clientId

string

Ignored. Derived from your API key (key-hash).

sendReceipt

boolean

send Receipt info

AttachmentDto

path

string · required

Path of the attachment

fullPath

string · required

Full Path of the attachment

originalName

string · required

Original name of the attachment

sizeInMB

number · required

Size of the attachment in MB

CreatePaymentLinkDto

amount

number · required

Integer amount in cents (1000 = $10.00). Note: the deprecated POST /public/payment-link endpoint interprets this value as whole dollars instead.

Example: 1000

taxes

string[]

List of tax ids to apply (send [] when none). In responses, taxes is the computed tax amount, not this list.

Example: ["653bd6ffbefb29d425276854"]

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

object[]

custom values data

object[]

Objects returned by POST .../upload-attachments.

applyDiscount

boolean

A discount may be applied to this payment link. If applicable, a discount of {%} will be deducted from credit card payments.

SendByEmailPublicDto

email

string · required

Email to send the payment link or Invoice

paymentLinkId

string · required

PaymentLink Id to send by email

SendBySmsDto

phoneNumber

string · pattern: ^[+]?[(]?[0-9]{3}[)]… · required

Phone to send the payment link or Invoice

Example: (555) 555-5555

paymentLinkId

string

Payment Link Id. Optional; ignored on routes that carry the id in the path

invoiceId

string

Invoice Id. Optional; ignored on routes that carry the id in the path

createdBy

string

Name of the user who created the payment link or Invoice. Optional; ignored on routes that carry the id in the path

TerminalPayCreatePublicDto

terminalId

string · required

Terminal id

amount

number · required

Integer amount in cents (1000 = $10.00). Base amount; surcharge/tax may be added by the processor.

receipt

boolean · required

Receipt

clientId

string

Ignored. Derived from your API key (key-hash).

orderNumber

string

Order number

email

string

User email

phone

string · pattern: ^[+]?[(]?[0-9]{3}[)]…

Phone number for the SMS receipt

Example: (555) 555-5555

object[]

Custom values ({ key, label, value }) forwarded with the transaction.

taxes

string[]

List of tax IDs (Mongo ObjectIds) to apply to this transaction

TerminalCaptureRefundDto

terminalId

string · required

Terminal id

pnRefNum

string · required

Gateway transaction id (transactions[].transactionId of the pre-auth/sale payment). BridgePay returns it synchronously; on Strictly poll the message, fetch the payment, then read it.

amount

number · max: 10000000 · required

Integer amount in cents (1000 = $10.00), max 10000000 (100,000.00). Base amount; surcharge/tax may be added by the processor.

clientId

string

Ignored. Derived from your API key (key-hash).

TerminalVoidDto

terminalId

string · required

Terminal id

pnRefNum

string · required

Gateway transaction id (transactions[].transactionId of the pre-auth/sale payment). BridgePay returns it synchronously; on Strictly poll the message, fetch the payment, then read it.

clientId

string

Ignored. Derived from your API key (key-hash).

TerminalCloseBatchDto

terminalId

string · required

Terminal id

clientId

string

Ignored. Derived from your API key (key-hash).

CloseBatchDTO

terminalId

string · required

Terminal serial number (not the terminal id used by other terminal endpoints)

CardPublicDto

name

string · required

Name on card

number

string · pattern: ^\d{6}(\d{2})?[*.]+\… · required

Masked card number from the tokenization callback (response.card.number)

Example: 411111******1111

exp

string · pattern: ^\d{4}$ · required

Expiration date in MMYY format from the tokenization callback (response.card.exp)

Example: 1233

paymentToken

string · required

Single-use payment token from the tokenization form; consumed on success. Test mode: 00000000-000000-000000-000000000000

Example: 00000000-000000-000000-000000000000

zipCode

string

Cardholder billing ZIP code (US/CA formats validated)

Example: 12345

BillingOrShippingAddressPublic

country

string

Country

address

string

Address line 1

address2

string

Address line 2

city

string

City

state

string

State

zipCode

string

Zip Code

CustomerPublicDto

firstName

string · required

First Name of the cardholder

lastName

string · required

Last Name of the cardholder

email

string · required

Customer's email (required; used for receipts and subscription notifications)

clientId

string

Ignored. Derived from your API key (key-hash).

zipCode

string

Zip Code

object[]

Customer's card

phoneNumber

string · pattern: ^[+]?[(]?[0-9]{3}[)]…

Customer's phone number

Example: (555) 555-5555

companyName

string

Cardholder's company name (If any)

object

Billing Address

object

Shipping Address

dateOfBirth

string

Date of birth

gender

string · enum

Gender (Male, Female, Unknown)

Enum values:

Male

Female

Unknown

externalId

string

External identifier of the customer (e.g. patient MRN or merchant-side id)

CustomerUpdatePublicDto

clientId

string

Ignored. Derived from your API key (key-hash).

firstName

string

First Name of the cardholder

lastName

string

Last Name of the cardholder

zipCode

string

Zip Code

object[]

Customer's card

phoneNumber

string · pattern: ^[+]?[(]?[0-9]{3}[)]…

Customer's phone number

Example: (555) 555-5555

email

string

Customer's email (required; used for receipts and subscription notifications)

companyName

string

Cardholder's company name (If any)

object

Billing Address

object

Shipping Address

dateOfBirth

string

Date of birth

gender

string · enum

Gender (Male, Female, Unknown)

Enum values:

Male

Female

Unknown

externalId

string

External identifier of the customer (e.g. patient MRN or merchant-side id)

CustomerBulkActionDto

itemList

string[] · required

Customer vault ids (customer id), not card tokens; at least one

Example: ["64a844f34aae5bbbe5123721"]

CustomerBulkUpdateRequestDto

itemList

string[] · required

Customer vault ids (customer id), not card tokens; at least one

Example: ["64a844f34aae5bbbe5123721"]

expirationTime

number · required

Life time of the request, expressed in unitOfTime

Example: 1

unitOfTime

string · enum · required

Unit of time for expirationTime

Enum values:

minute

minutes

hour

hours

day

days

week

weeks

Example: days

CustomerUpdateRequestDto

expirationTime

number · required

Life time of the request, expressed in unitOfTime

Example: 1

unitOfTime

string · enum · required

Unit of time for expirationTime

Enum values:

minute

minutes

hour

hours

day

days

week

weeks

Example: days

phoneNumber

string · pattern: ^[+]?[(]?[0-9]{3}[)]…

Customer phone number the SMS link is sent to. At least one of phoneNumber/email must be provided for anything to be sent.

Example: (555) 555-5555

email

string

Customer email address the link is sent to. At least one of phoneNumber/email must be provided for anything to be sent.

Example: [email protected]

CardBillingAddress

country

string

Country

address

string

Address line 1

address2

string

Address line 2

city

string

City

state

string

State

zipCode

string

Zip Code

CustomerCardCreateDto

paymentToken

string · required

Single-use payment token from the tokenization form; consumed on success. Required.

Example: 00000000-000000-000000-000000000000

name

string

Name of card

object

Billing Address

last4

string

Last 4 digits of the card. Server-derived from the card; any value sent is ignored

network

string

Card network (visa, mastercard...). Server-derived from the card; any value sent is ignored

number

string

Masked card number from the tokenization callback (response.card.number)

Example: 411111******1111

exp

string

Expiration date in MMYY format from the tokenization callback (response.card.exp)

Example: 1233

zipCode

string

Cardholder billing ZIP code (synced with billingAddress.zipCode; US/CA formats validated)

Example: 12345

customerVaultId

string

Ignored; the path parameter is authoritative

token

string

Gateway payment token (server-managed)

CustomValues

key

string · required

Custom value key

label

string

Custom value label

value

string

Custom value

OrderDto

object[]

Merchant-configured order fields: keys must exist in the merchant order metadata; merchant-required fields are enforced; select options and regex rules apply; label is filled from configuration.

orderDescription

string

Order Description

CustomScheduleDto

payments

number · min: 0 · max: 52 · required

Number of payments, 0–52. 0 = until terminated

Example: 12

amount

number · required

Integer amount in cents (1000 = $10.00)

Example: 5000

dayFrequency

number · min: 1

Charge every N days (> 0). Frequency mode A: send alone, without monthFrequency/dayOfMonth

Example: 7

monthFrequency

number · min: 1 · max: 24

Charge every N months, 1–24. Frequency mode B: send together with dayOfMonth

Example: 1

dayOfMonth

number · min: 1 · max: 31

Day of the month to charge, 1–31. Frequency mode B: send together with monthFrequency

Example: 15

CreatePublicSubscriptionDto

planId

string

Plan id. Required unless customSchedule is sent; takes precedence over customSchedule when both are sent

startDate

string

Start date (ISO 8601). Must be in the future; omitted = tomorrow (start of day)

Example: 2025-05-01

object

Order

customerVaultId

string

Customer vault id (the customer id). Alias of customerId; at least one of the two is required (customerId takes precedence when both are sent)

customerId

string

Customer vault id (the customer id). Alias of customerVaultId; at least one of the two is required and takes precedence over customerVaultId when both are sent

overrideDefaultPaymentMethod

string

Stored payment method id (paymentMethods[].customerVaultId) to charge instead of the default

firstAmount

number

Amount of the first payment when it differs from the plan amount. Integer amount in cents (1000 = $10.00)

surchargeFirstAmount

number

Surcharge applied to the first payment. Integer amount in cents (1000 = $10.00)

cardFeeFirstAmount

number

Card fee applied to the first payment. Integer amount in cents (1000 = $10.00)

autoRenew

boolean

Renew after the last payment cycle. Optional in practice: omitted/false = no renewal

Example: true

notificationMail

boolean

Send receipt notifications by email

Default: true

object

Inline custom plan, used when planId is omitted. amount required; payments 0–52 (0 = until terminated); exactly one frequency mode: dayFrequency alone, or monthFrequency (1–24) + dayOfMonth (1–31)

object[]

Objects returned by POST /public/subscription/upload-attachments

taxes

string[]

Merchant tax ids to apply; the tax total is added to the amount

UpdatePublicSubscriptionDto

customerVaultId

string

Customer vault id (the customer id) to move the subscription to. Alias of customerId; takes precedence over customerId when both are sent

customerId

string

Customer vault id (the customer id) to move the subscription to. Alias of customerVaultId (customerVaultId takes precedence when both are sent)

autoRenew

boolean

Renew after the last payment cycle

notificationMail

boolean

Send receipt notifications by email

object[]

Objects returned by POST /public/subscription/upload-attachments

amount

number

Integer amount in cents (1000 = $10.00). Only updatable when the subscription has a custom plan

Example: 2500

object

Custom schedule (only updatable when the subscription has a custom plan)

startDate

string

Start Date (only allowed together with customSchedule; must be a future date)

CreatePublicPlanDto

payments

number · min: 0 · max: 52 · required

Number of payments, 0–52. 0 = until terminated (the response then reports untilTerminated: true)

Example: 3

amount

number · required

Integer amount in cents (1000 = $10.00)

Example: 3000

name

string · required

Plan name

Example: API Plan

dayFrequency

number · min: 1

Charge every N days (> 0). Frequency mode A: send alone, without monthFrequency/dayOfMonth. Exactly one mode is required

Example: 5

monthFrequency

number · min: 1 · max: 24

Charge every N months, 1–24. Frequency mode B: send together with dayOfMonth

Example: 1

dayOfMonth

number · min: 1 · max: 31

Day of the month to charge, 1–31. Frequency mode B: send together with monthFrequency

Example: 15

createdBy

string · readOnly

Set by the server (creator identity); any value sent is ignored

updatedBy

string · readOnly

Set by the server (last updater identity); any value sent is ignored

TransactionListMetaDto

count

number · required

Total number of transactions matching the filters.

Example: 18

totalPages

number · required

required

Requested page. Echoed as a string when supplied in the query, a number (1) when defaulted.

Example: 1

required

Requested page size. Echoed as a string when supplied in the query, a number (10) when defaulted.

Example: 10

TransactionEntryDto

settled

boolean · required

import

boolean · required

importAt

string | null · required

voidable

boolean · required

_id

string · required

id

string · required

object

string · required

type

string · required

amount

number · required

Total charged, in cents (base amount plus surcharge).

Example: 207

baseAmount

number · required

Amount before surcharge, in cents.

Example: 200

surcharge

number · required

Surcharge applied, in cents.

Example: 7

captured

string · required

Capture flag, returned as a string.

Example: true

transactionId

string · required

Gateway transaction id.

Example: 7080914355

error

boolean · required

createdAt

string · required

transactionAt

string · required

userAgent

string · required

device

string · required

paymentId

string · required

createdBy

string · required

updatedBy

string · required

owner

string · required

ownerGroup

string | null · required

updatedAt

string · required

TransactionCardDto

name

string · required

number

string · required

Masked card number.

Example: 411111******1111

paymentToken

string · required

type

string · required

last4

string · required

network

string · required

TransactionAchDataDto

accountType

string

last4

string

Last 4 digits of the account number.

Example: 6789

firstName

string

lastName

string

companyName

string

Business accounts only.

Example: EXAMPLE

paymentToken

string

TransactionContactDto

phone

string · required

email

string · required

TransactionItemDto

id

string · required

Payment id. Use it with GET /public/payment/{id}.

Example: 6239018aceb02b001cec6be0

object · required

transactionId

string · required

Gateway transaction id.

Example: 7080914355

createdAt

string · required

updatedAt

string · required

transactionAt

string | null · required

clientId

string · required

clientName

string · required

owner

string · required

paid

boolean · required

amount

number · required

Base amount, in cents.

Example: 200

currency

string · required

settled

boolean · required

netAmount

number · required

Amount including surcharge, in cents.

Example: 207

import

boolean · required

importAt

string | null · required

status

string · required

object

Card transactions only; absent on ACH.

object

ACH transactions only; absent on card.

object

TransactionListResponseDto

object · required

object[] · required

CreateBillingDto

email

string · required

Card billing email

firstName

string

Cardholder is first name

lastName

string

Cardholder is last name

company

string

Cardholder is company

country

string

Card billing country

address

string

Card billing address

address2

string

Card billing address line 2

city

string

Card billing city

state

string

Card billing state

zipCode

string

Card billing zip code

phoneNumber

string

Card billing phone number

faxNumber

string

Card billing fax number

websiteAddress

string

Card billing web site

CreateShippingDto

firstName

string

Cardholder is first name

lastName

string

Cardholder is last name

company

string

Cardholder is company

country

string

Card billing country

address

string

Card billing address

address2

string

Card billing address line 2

city

string

Card billing city

state

string

Card billing state

zipCode

string

Card billing zip code

phoneNumber

string

Card billing phone number

faxNumber

string

Card billing fax number

email

string

Card billing email

websiteAddress

string

Card billing web site

InvoiceCreateDto

object[] · required

Line items. Each entry is { id, qty, taxes[] }: id is the catalog item id, taxes the list of tax ids (send [] when none). Prices and totals are resolved from the catalog item.

object · required

Billing data

amount

number · readOnly

Computed by the server from the items; any value sent is ignored.

terms

string · enum

Invoicing terms (days until due).

Enum values:

upon_receipt

object[]

Custom Values

customerId

string

Costumer identifier

companyName

string

Company Name

currency

string

Payment currency

orderDescription

string

Order description

tax

number · readOnly

Computed by the server from the items; any value sent is ignored.

paymentId

string

Metadata only; no effect on creation.

object

Shipping data. Required by the upstream schema; send {} when not applicable.

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

status

string

The status of the invoice

createdBy

string

Metadata only; no effect on creation.

updatedBy

string

Metadata only; no effect on creation.

applyDiscount

boolean

A discount may be applied to this invoice. If applicable, a discount of {%} will be deducted from credit card payments.

overrideDefaultPaymentMethod

string

The id of the payment method to use in the charge

InvoiceFlexibleCreateDto

object[] · required

Line items. Each entry is { id, qty, taxes[] }: id is the catalog item id, taxes the list of tax ids (send [] when none). Prices and totals are resolved from the catalog item.

object · required

Billing data

amount

number · readOnly

Computed by the server from the items; any value sent is ignored.

terms

string · enum

Invoicing terms (days until due).

Enum values:

upon_receipt

object[]

Custom Values

customerId

string

Customer identifier

companyName

string

Company Name

currency

string

Payment currency

orderDescription

string

Order description

tax

number · readOnly

Computed by the server from the items; any value sent is ignored.

paymentId

string

Metadata only; no effect on creation.

object

Shipping data. Required by the upstream schema; send {} when not applicable.

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

status

string

The status of the invoice

createdBy

string

Metadata only; no effect on creation.

updatedBy

string

Metadata only; no effect on creation.

applyDiscount

boolean

A discount may be applied to this invoice. If applicable, a discount of {%} will be deducted from credit card payments.

CategoryDto

name

string · required

Category name. Send alongside id (existing category id) or id: null to create a new category.

id

string | null

Existing category id, or null to create a new category

CreateItemDto

name

string · required

Item name shown on invoices and payment pages

type

string · required

Item type. Any non-empty string (e.g. product, service).

Example: product

description

string · required

Item description

salesPrice

number · required

Price in dollars; must not be 0; negative allowed only without taxes (discount lines).

Example: 10.5

object[] · required

Item's categories. Effectively required (send [] when none). Entries are { id: string | null, name }; id: null creates the category.

sku

string

Stock keeping unit (SKU) used to identify the item in your catalog

taxes

string[]

Tax ids applied to this item. Send [] when none. Not allowed when salesPrice is negative.

UpdateItemBodyDto

name

string

Item name shown on invoices and payment pages

type

string

Item type. Any non-empty string (e.g. product, service).

Example: product

description

string

Item description

sku

string

Stock keeping unit (SKU) used to identify the item in your catalog

salesPrice

number

Price in dollars; must not be 0; negative allowed only without taxes (discount lines).

Example: 10.5

object[]

Item's categories. Effectively required (send [] when none). Entries are { id: string | null, name }; id: null creates the category.

taxes

string[]

Tax ids applied to this item. Send [] when none. Not allowed when salesPrice is negative.

ItemBulkActionDto

itemList

string[] · required

Item ids to act on. At least one id is required.

Example: ["6243240a2da210001f8f0cb3"]

createdBy

string

Username owner performing the action

CreatePaymentRequestBillingDto

email

string · required

Card billing email

firstName

string

Cardholder is first name

lastName

string

Cardholder is last name

company

string

Cardholder is company

country

string

Card billing country

address

string

Card billing address

address2

string

Card billing address line 2

city

string

Card billing city

state

string

Card billing state

zipCode

string

Card billing zip code

phoneNumber

string

Card billing phone number

faxNumber

string

Card billing fax number

websiteAddress

string

Card billing web site

CreatePaymentRequestShippingDto

firstName

string

Cardholder is first name

lastName

string

Cardholder is last name

company

string

Cardholder is company

country

string

Card billing country

address

string

Card billing address

address2

string

Card billing address line 2

city

string

Card billing city

state

string

Card billing state

zipCode

string

Card billing zip code

phoneNumber

string

Card billing phone number

faxNumber

string

Card billing fax number

email

string

Card billing email

websiteAddress

string

Card billing web site

CreatePaymentRequestDto

amount

number · required

Integer amount in cents (1000 = $10.00). Converted to dollars in responses (amount: 200 is returned as 2).

Example: 200

object · required

Billing data

clientId

string

Ignored. Derived from your API key (key-hash).

showBilling

boolean

If Billing Address must show in Single Payment Page

showShipping

boolean

If Shipping Address must show in Single Payment Page

customerId

string

Customer identifier

currency

string

Ignored; the merchant gateway currency is used.

orderId

string

Order identifier

orderDescription

string

Order descriptions

tax

number

Integer amount in cents (1000 = $10.00). Converted to dollars in responses (tax: 10 is returned as 0.1).

Example: 10

poNumber

string

Order PO Number

object

Shipping data

products

array[]

Optional list of products.

object[]

Merchant-configured custom fields; unknown keys are rejected.

shipping

number · deprecated · required

Deprecated. Ignored for totals and validation; include any shipping fee in amount (and tax fields as applicable).

TokenizeCardDto

tokenizationKey

string · required

Merchant tokenization public key

ccnumber

string · required

The card number

ccexp

string · required

The card expiration date

cvv

string · required

The CVV of the card

name

string · required

Customer display name

email

string

Customer email

phoneNumber

string

Customer phone

ChargePosLendingPublicDto

applicationId

string · required

Id of the PRE_APPROVED POS Lending application to charge (the id field returned by the applications list). Must belong to the merchant of the API key.

Example: 689239339d9fe222940bb8fe

amount

number · required

Amount to charge in cents (smallest currency unit). Minimum 30000 ($300). Must not exceed the application's maxPreApprovedAmount nor the Avvance hard cap of 2500000 ($25,000).

Example: 50000

invoiceNumber

string

Merchant invoice/order reference forwarded to Avvance. Defaults to the application's Avvance lead id.

Example: INV-000123

sendReceipt

boolean

When true (default) Zero emails/SMSes the loan-completion link to the customer contact on the pre-approval. Set to false if you deliver the returned consumerOnboardingURL yourself.

Example: true

Default: true

currency

string

Currency. Only USD is supported.

Example: USD

Default: USD

RefundPosLendingPublicDto

paymentId

string · required

Id of the POS Lending payment to refund.

Example: 689239339d9fe222940bb8fd

amount

number · required

Amount to refund in cents (smallest currency unit). Partial refunds are allowed up to the remaining paid amount.

Example: 50000

reason

string · required

Reason for the refund.

Example: customer_request

HttpErrorDetailDto

required

Application error code. A number for service-side codes (900 = request validation failed; 101, 110 = field validation; 901–906 = charge request errors, also used as the HTTP status) and a string for gateway codes ("200"–"264" declined, "300" rejected, "400"+ processor errors). Compare it as a string (String(code)), never with a typed equality against one representation.

Example: 300

text

string · required

Human-readable reason.

Example: Transaction was rejected by gateway.

message

string[]

Only on code: 900: one entry per failed field validation.

Example: ["amount must be a positive number"]

HttpErrorResponseDto

statusCode

number · required

HTTP status code.

Example: 400

timestamp

string · required

ISO-8601 timestamp of the failure.

Example: 2022-04-11T22:54:13.822Z

path

string · required

Request path, including the /v1 prefix.

Example: /v1/public/payment/charge

object · required

message

string · required

Exception summary. Not meant for display; use response.text.

Example: Http Exception

HttpStatusErrorDetailDto

statusCode

number · required

HTTP status code, repeated.

Example: 401

message

string · required

Human-readable reason.

Example: Unauthorized

error

string · required

HTTP status text.

Example: Unauthorized

HttpStatusErrorResponseDto

statusCode

number · required

HTTP status code.

Example: 401

timestamp

string · required

ISO-8601 timestamp of the failure.

Example: 2022-04-11T22:54:13.822Z

path

string · required

Request path, including the /v1 prefix.

Example: /v1/public/transactions

object · required

message

string · required

Exception summary. Not meant for display; use response.message.

Example: Unauthorized

Schemas

AchDataDto

ContactDto

AchChargeAddressDto

ChargeAddressDto

CustomValuesDto

ChargeOrderDto

AchChargePublicDto

RefundPublicDto

VoidPublicDto

PaymentReceiptPdfDto

PaymentMethodDto

CardDto

ChargePublicDto

CapturePublicDto

BulkChargePayloadDto

BulkChargeDto

AttachmentDto

CreatePaymentLinkDto

SendByEmailPublicDto

SendBySmsDto

TerminalPayCreatePublicDto

TerminalCaptureRefundDto

TerminalVoidDto

TerminalCloseBatchDto

CloseBatchDTO

CardPublicDto

BillingOrShippingAddressPublic

CustomerPublicDto

CustomerUpdatePublicDto

CustomerBulkActionDto

CustomerBulkUpdateRequestDto

CustomerUpdateRequestDto

CardBillingAddress

CustomerCardCreateDto

CustomValues

OrderDto

CustomScheduleDto

CreatePublicSubscriptionDto

UpdatePublicSubscriptionDto

CreatePublicPlanDto

TransactionListMetaDto

TransactionEntryDto

TransactionCardDto

TransactionAchDataDto

TransactionContactDto

TransactionItemDto

TransactionListResponseDto

CreateBillingDto

CreateShippingDto

InvoiceCreateDto

InvoiceFlexibleCreateDto

CategoryDto

CreateItemDto

UpdateItemBodyDto

ItemBulkActionDto

CreatePaymentRequestBillingDto

CreatePaymentRequestShippingDto

CreatePaymentRequestDto

TokenizeCardDto

SharePosLendingApplicationPublicDto

ChargePosLendingPublicDto

RefundPosLendingPublicDto

HttpErrorDetailDto

HttpErrorResponseDto

HttpStatusErrorDetailDto

HttpStatusErrorResponseDto