Pre Auth
The Pre-auth endpoint enables partners to check the validity of a payment request against the set of configured rules.
Perform a pre-auth
POST https://<Platform-host>/transaction-monitoring/pre-auth
This endpoints accepts the payload similar to auth and sale endpoints and responds with a decision and list of rules that were applied to allow or decline the transaction.
Body
transaction_type*
string
The type of payment request you want to perform. sale |auth|capture|refund
merchant_id*
string
Platform merchant ID
data.card_token
string
Platform secure vault token. Only used if card is tokenized with Platform secure vault.
If using cardToken then account holder information is optional
data.cardholder_name
string
Card holder name
data.card_exp
string
MM/YY card expiration data
data.card_number
string
Primary account number (PAN)
data.currency*
string
Currency code (USD|CAD etc.)
data.transaction_amount*
string
Max Length=12 Allowed characters: 0-9 and .(dot)
Note: this value always reflects the total dollar amount for example 1.00 and 1 both will be considered $1.00 and 0.10 will be 10 cents.
data.ip_address
string
Client IP address
processing_status*
string
Overall processing status allow|decline
transaction_status*
string
The transaction status. If all rules are passed it will be preauth otherwise failed
roc_text_data*
string
Unique Platform assigned ID for this transaction. This ID is generally used to reconcile settlement data and should be passed to processing gateways
transaction_id*
string
Platform's transaction ID
triggered_rules*
array
List of configured rules and decisions
Sample Request / Response
Example Sale Request
Example Auth Request
Example Refund Request
Last updated