Card Transaction

post

https://api-integration.pxp-solutions.net/transactionservice/api/v5/transactions

This Service is used to for Card / APM processing.

This request type can be used to process card transactions using a Card Number (Plain or encrypted), a Tokenised Card Number, a Single Use Token or a Visa Checkout Call Id across all card schemes.

Optional Authentication methods include AVS/CSC, 3D Secure

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

merchantId

string

required

[Length=3] This is the customer code, a unique customer ID allocated to a customer when the service is set up

storeId

string

required

[Length=12] This is the site identifier, a unique site ID allocated to a customer when the service is set up

userId

string

required

[Length<=50] This is a username allocated to a service user when the service is set up; it refers to a service account not a person

type

string

required

This is a combination of how the card was captured and transaction type of the transaction. i.e. mailorder.sale, internet.preAuthorization. Refer to Type under Elements

amount

string

required

This is the monetary value of the transaction in minor units. See Note1

currencyCode

string

required

[Length=3] This is the currency of the transaction. This is the currency code. A three character code in accordance with ISO 4217

clientSystemInvoiceId

string

[Length<=50] This is the merchant's own unique Invoice Id for the transaction, only used when a transaction is a PreAuthorization, Top Up or Capture

clientSystemTransactionId

string

required

[Length<=50] This is the merchant's own unique reference for the transaction

providerDiscretionaryData

string

[Length<=75] This is the merchant's external facing order number with the consumer, which if supported, will be passed to the Provider as an additional descriptor.
For Vantiv by FIS, chars 1-35 are sent in user defined field 01, 36-55 in field 02 and 56-75 in field 03. If not present, the clientSystemInvoiceId is sent in this field instead. Information in this field appears in Vantiv reports

MerchantReferenceData

string

[Length<=28] This is the a merchant's order/Reference number with the consumer, which if supported, will be passed to the Provider as an additional descriptor.
For Vantiv by FIS, this data is used to populate 'G001- Merchant Reference Data' with chars 1-11 sent in Draft Locator Id and 12-28 sent as Merchant Reference Number. Information in this field appears in Vantiv reports

isFinalCapture

boolean

[True / False] If set to TRUE, the remaining authorised amount, if any, will be reveresed and returned to the card holder. (Defaulted to FALSE if not supplied)
Supported with PXP Financial Acquiring Only

forcePaymentFollowingDecline

boolean

[True / False] If set to TRUE, should an online sale be declined, it will be subsequently re-processed and forced offline.
"Authorised" will be returned if the online sale approved
"Approved" will be returned if the online sale declined, and was approved offline.
(Defaulted to FALSE if not supplied)
Supported with PXP Financial Acquiring Only

authorityMethod

string

This is the method in which the payment should gain approval.
Supported Values: "online" or "offline"
(Defaulted to "online" if not supplied)
Supported with PXP Financial Acquiring Only

originalTransactionId

string

[Length=36] This is the "id" returned from ANYpay from the original Transaction. This is required for processing reversals.

cardSchemeReference

string

Contains the Acquirer Bank Data returned in the Initial Recurring Response. Must be present in Subsequent Recurring Request

details

object

accountDetails

object

encryptionDetails

object

cardVerificationDetails

object

addressVerificationDetails

object

threeDSecureDetails

object

cardHolderNameLocationDetails

object

storedCredentialDetails

object

scaDetails

object

originalCreditDetails

object

digitalWalletDetails

object

optionalResponseFields

object

payerDetails

object

Headers

Authorization

string

Defaults to Basic QkREVGVzdDpCRERUZXN0

Content-Type

string

Defaults to application/json

Responses

200200

412412