Process Transaction

post

https://api.preczn.com/v1/transactions

Query Params

tokenize

boolean

Return a token for provided specified method.

merchantToken

boolean

Associate token directly with specified merchant.

Body Params

merchantId

string

The ID of the merchant for which to process the transaction.

Required for verify, auth, sale, and drawdown transaction types.

type

string

enum

required

Transaction type.

Allowed:

payment

Object containing details of the payment method from which the transaction is being made. Please note the required parameters will vary depending on the payment method submitted.

Required for verify, auth, sale, and drawdown transaction types.

amount

number

The amount to charge for this transaction, specified in integer value of lowest currency denomination (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

Required for auth, sale, and drawdown transaction types.

tax

number

The portion of the amount field charged as tax, specified in integer value of lowest currency denomination (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

fee

number

The portion of the amount field charged as a fee, specified in integer value of lowest currency denomination (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

firstName

string

length ≤ 100

The payment account holders first name.

lastName

string

length ≤ 100

The payment account holders last name.

phone

string

length ≤ 20

The payment account holders phone number.

string

length ≤ 100

The payment account holders email address.

billingAddress

object

The payment account holders billing address.

achMandate

string

length ≤ 500

ACH mandate/authorization text - customer consent for ACH debit. Required for Braintree ACH verify transactions.

accountBusinessName

string

length ≤ 255

Business name for corporate/business bank accounts. Required for Braintree ACH verify transactions with corporate account types.

shippingAddress

object

The shipping address for a transaction which requires shipping of goods.

ipCreated

string

Public IP address from which this transaction originated.

order

string

length ≤ 255

A value echoed back in the response which is often used to associate the transaction with an order ID in your system.

orderDeliveryDate

string

The anticipated UTC date and time the purchased goods/services should be delivered.

transactionId

string

The transaction ID for which to run a follow-up transaction.

Required for capture, refund, and void transaction types.

invoice

string

length ≤ 100

A value echoed back in the response which is often used to associate the transaction with an Invoice Number in your system.

freightTax

number

The amount charged as freight tax for Level III processing, specified in integer value of lowest currency denomination (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

dutyTax

number

The amount charged as duty tax for Level III processing, specified in integer value of lowest currency denomination (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

items

array of objects

Line item data associated with this transaction for Level III processing.

items

currency

string

length ≤ 3

Defaults to USD

ISO-4217 3-character currency code.

metadata

object

A flat object consisting of no more than 20 keys each of a max length of 20 characters, with only string values of a max length of 255 characters.

description

string

length ≤ 1000

Any string used to describe the transaction.

merchantInfo

object

Merchant information to be included with the transaction's merchant descriptor data, for supported connections.

totalJobAmount

number

The total amount of the job, specified in integer value of lowest currency denomination (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

Required for drawdown transaction type.

drawType

string

enum

Draw type.

Required for drawdown transaction type.

Allowed:

channel

string

length ≤ 1000

Channel

processor

string

enum

The processor to use for this transaction.

Headers

idempotency-key

string

Transaction Idempotency Key

Responses

200Transaction succesfully processed.

400Request not serviced due to invalid format.

401Invalid API key.

403Forbidden to process a transaction for the provided merchantId.

404Transaction not found for provided transactionId.

500Unable to service request due to server-side error. Please reattempt transaction, idempotency key strongly advised.

defaultAll responses include the following headers.