v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Payments

Credit

Process a credit without a prior payment. This endpoint credits funds to the customer's payment method.

post/v5/payments/credit

Request body

amountnumber required

Total amount to be charged. Format: x.xx

surchargenumber

Surcharge amount. Format: x.xx

convenience_feenumber

Convenience fee amount. Format: x.xx

misc_feenumber

Miscellaneous fee amount. Format: x.xx

misc_fee_namestring

Custom miscellaneous fee name. Default: Miscellaneous Fee

tipnumber

The final tip amount, included in the payment. Format: x.xx

currencystring

The ISO 4217 currency code. Example: USD

processor_idstring

If using multiple processors, route to the specified processor ID. Omit for default processor or when using a single processor.

dup_secondsinteger

Sets the time in seconds for duplicate checking on supported processors. Set to 0 to disable duplicate checking

transaction_session_idstring

A single use session ID used by Kount to link the payment and Data Collector information together

customer_receiptboolean

If set to true, when the customer is charged, they will be sent a receipt

pinless_debit_overrideboolean

Set to true if you have Pinless Debit Conversion enabled but want to opt out for this payment

industry'retail' | 'restaurant' | 'ecommerce' | 'moto' | 'lodging'

Industry type for the payment

signature_imagestring

Base64 encoded signature image

network_tokenizeboolean

Enable network tokenization

partial_payments'settle_partial' | 'payment_in_full'

settle_partial: Settles any amount of tender collected at cut off. payment_in_full: Required that any split tendered payment is collected in-full before settlement gets initiated

partial_payment_idstring

A numeric identifier which is used when submitting subsequent payments for partial payments

Response

Success

object'transaction' required

Resource type identifier

idstring required

Payment ID

typestring

Customer's payment type (e.g., 'cc', 'ck', 'cs')

amountstring

Payment amount. Format: x.xx

currencystring

Payment currency (ISO 4217)

auth_codestring

Authorization code

avs_responsestring

Address Verification Service response code

cvv_responsestring

Card Verification Value response

customer_vault_idstring

Customer vault ID associated with the payment

statusstring

Payment status

response'1' | '2' | '3'

Response code: 1 = approved, 2 = declined, 3 = error

response_textstring

Textual description of the operation's result

response_codestring

Processor response code

processor_idstring

Processor ID used for the payment

created_datestring date-time

Payment creation date in UTC ISO 8601 format

updated_datestring date-time

Payment last update date in UTC ISO 8601 format