Strictly / PayWithZero 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

Contact phone number

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

shipping

number

Order shipping amount

tax

number

Order taxes amount

federalTaxes

number

Order federalTaxes amount

amount

number

Order amount

object[]

Custom Values

discount

number

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

AchChargePublicDto

clientId

string · required

Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying

amount

number · required

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

object · required

Billing data

overrideDefaultPaymentMethod

string

The id of the payment method to use in the charge

currency

string

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

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

Used to remove surcharge amount for exceptions

discount

number

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

customerId

string

Customer ID

taxes

string[]

Taxes amount or list of taxes

RefundPublicDto

amount

number · required

The amount to refund, which must be less than or equal to the original amount.

paymentId

string · required

ID of the payment to be refunded.

reason

string · required

Reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer.

VoidPublicDto

paymentId

string · required

ID of the charge that must be voided.

reason

string

Reason that make void.

payment

string

Reason that make void.

receipt

boolean

To send or not to send an email after void a payment

CardPublicDto

name

string · required

Name on card

number

string · required

Card number

exp

string · required

Expiration date

paymentToken

string · required

The representative token of the card

zipCode

string

Zip code

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

clientId

string · required

Client identifier

firstName

string · required

First Name of the cardholder

lastName

string · required

Last Name of the cardholder

email

string · required

Customer's email

zipCode

string

Zip Code

object[]

Customer's card

phoneNumber

string

Customer's phone number

companyName

string

Cardholder's company name (If any)

object

Billing Address

object

Shipping Address

dateOfBirth

string

Date of birth

gender

string

Gender

CustomerUpdatePublicDto

clientId

string

Client identifier

firstName

string

First Name of the cardholder

lastName

string

Last Name of the cardholder

zipCode

string

Zip Code

object[]

Customer's card

phoneNumber

string

Customer's phone number

email

string

Customer's email

companyName

string

Cardholder's company name (If any)

object

Billing Address

object

Shipping Address

dateOfBirth

string

Date of birth

gender

string

Gender

CustomerBulkActionDto

itemList

string[] · required

Bulk Action list of items

CustomerBulkUpdateRequestDto

itemList

string[] · required

Bulk Action list of items

expirationTime

number

Life time of the request

unitOfTime

string

Unit of time (minutes, days, hours, weeks)

CustomerUpdateRequestDto

expirationTime

number · required

Life time of the request

unitOfTime

string · required

Unit of time (minutes, days, hours, weeks)

phoneNumber

string

Customer phone number

email

string

Customer email address

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

name

string

Name of card

object

Billing Address

last4

string

Last4 of card

network

string

Type of card (visa, mastercard...)

number

string

Number of card

exp

string

Exp date of card

zipCode

string

Merchant Zipcode

customerVaultId

string

Customer Vault Id

paymentToken

string

Payment token

token

string

Payment token BP

CategoryDto

name

string

Category name

CreateInvoiceItemDto

name

string · required

Item name

clientId

string · required

Client identifier

description

string · required

Item descriptions

type

string · required

Item type

qty

number · required

Item quantity

salesPrice

number · required

Item sales price

total

number · required

Items total

sku

string · required

Item type

discount

number

Items discount

taxes

array[]

Item taxes

Default: null

object[]

Item's categories

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

List of items

object · required

Billing data

amount

number

Amount of invoicing

terms

string

Invoicing terms

object[]

Custom Values

customerId

string

Costumer identifier

companyName

string

Company Name

currency

string

Payment currency

orderDescription

string

Order description

shipping

number

Total shipping amount

tax

number

Total tax amount

paymentId

string

Payment identifier

object

Shipping data

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

status

string

The status of the invoice

createdBy

string

From what application was created

updatedBy

string

From what application was updated

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

List of items

object · required

Billing data

amount

number

Amount of invoicing

terms

string

Invoicing terms

object[]

Custom Values

customerId

string

Customer identifier

companyName

string

Company Name

currency

string

Payment currency

orderDescription

string

Order description

shipping

number

Total shipping amount

tax

number

Total tax amount

paymentId

string

Payment identifier

object

Shipping data

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

status

string

The status of the invoice

createdBy

string

From what application was created

updatedBy

string

From what application was updated

applyDiscount

boolean

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

SendBySmsDto

phoneNumber

string · required

Phone to send the payment link or Invoice

paymentLinkId

string

Payment Link Id

invoiceId

string

Invoice Id

createdBy

string

Name of the user who created the payment link or Invoice

CreateItemDto

name

string · required

Item name

type

string · required

Item type

description

string · required

Item description

salesPrice

number · required

Item sales price

sku

string

Item SKU

object[]

Item's categories

taxes

string[]

Item's taxes

ItemBulkActionDto

itemList

string[] · required

Bulk Action list of items

createdBy

string

Username owner of the action

PaymentReceiptPdfDto

clientId

string · required

Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying

paymentId

string

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

isForMerchant

boolean

Indicates if payment receipt is for merchant or customer

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

card number

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

clientId

string · required

Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying

amount

number · required

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

object · required

Billing data

overrideDefaultPaymentMethod

string

The id of the payment method to use in the charge

object

Payment Method Information

currency

string

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

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

The amount to capture, which must be less than or equal to the original amount.

paymentId

string

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's id

customerId

string

Customer's id

bypassSurcharge

boolean

Used to remove surcharge amount for exceptions

object

Order data

BulkChargeDto

clientId

string · required

Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying

object · required

Customer's vault id

sendReceipt

boolean

send Receipt info

CreatePaymentLinkDto

amount

number · required

Pay amount

taxes

string[]

Taxes amount or list of taxes

showBilling

boolean

Show Billing

showShipping

boolean

Show Shipping

object[]

custom values data

attachments

string[]

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

PaymentLink Id to send by email

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

CreatePaymentRequestProductDto

productId

string · required

Product identifier

name

string · required

Product name

description

string · required

Product descriptions

cost

number · required

Product cost

total

number · required

Product tax

photo

string · required

Product photo url

quantity

number

Product quantity

tax

number

Product tax

discount

number

Product discount

CreatePaymentRequestDto

clientId

string · required

Client owned paymentRequest

amount

number · required

Order amount

object · required

Billing data

object · required

List of products

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

Currency

orderId

string

Order identifier

orderDescription

string

Order descriptions

shipping

number

Order shipping

tax

number

Order taxes

poNumber

string

Order PO Number

object

Shipping data

CreatePublicPlanDto

payments

number · required

Number of Payments

amount

number · required

Plan amount

name

string · required

Plan name

dayFrequency

number

Plan day frequency

monthFrequency

number

Plan month frequency

dayOfMonth

number

Plan day of month

createdBy

string

From what application was created

updatedBy

string

From what application was updated

CustomValues

key

string · required

Custom value key

label

string

Custom value label

value

string

Custom value

OrderDto

object[]

Custom Values

orderDescription

string

Order Description

CustomScheduleDto

payments

number · required

Custom Number of Payments

amount

number · required

Custom Plan amount

dayFrequency

number

Custom Plan day frequency

monthFrequency

number

Custom Plan month frequency

dayOfMonth

number

Custom Plan day of month

CreatePublicSubscriptionDto

autoRenew

boolean · required

Autorenew

planId

string

Plan Id

startDate

string

Start Date

object

Order

customerVaultId

string

Customer ID

customerId

string

Customer ID

firstAmount

number

First Amount

surchargeFirstAmount

number

surcharge First Amount

cardFeeFirstAmount

number

Surcharge fee First Amount

notificationMail

boolean

Notification Email after autoRenew

object

Custom schedule

attachments

string[]

Attachments

taxes

string[]

Taxes amount or list of taxes

UpdatePublicSubscriptionDto

customerVaultId

string

Costumer Id

customerId

string

Costumer Id

autoRenew

boolean

Autorenew

notificationMail

boolean

Notification Email after autoRenew

attachments

string[]

Attachments

TerminalPayCreatePublicDto

receipt

boolean · required

Receipt

terminalId

string

terminal Id

clientId

string

Client Id

amount

number

Amount to pay

orderNumber

string

Order number

email

string

User email

phone

string

Phone number doing the payment

object[]

Custom Values

TerminalCaptureRefundDto

clientId

string · required

Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying

amount

number · required

Amount to pay

terminalId

string

terminal Id

pnRefNum

string

The transaction ID of the payment

TerminalVoidDto

clientId

string · required

Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying

terminalId

string

terminal Id

pnRefNum

string

The transaction ID of the payment

TerminalCloseBatchDto

clientId

string · required

Webpage/Application that belongs to a company registered with Zero-Platform, not the current user paying

terminalId

string

terminal Id

CloseBatchDTO

TokenizeCardDto

tokenizationKey

string · required

Merchant tokenization public key

ccnumber

string

The card number

ccexp

string

The card expiration date

cvv

string

The CVV of the card