Change Logs
Learn about the latest updates to our Transaction API:
2022
November 2022
23rd November
New:
API Version 6.18
API version 6.18 released to support:
-
The introduction of delayedAuthorisation flag in
/transactions/preauths
request.For more information, see Transaction API.
September 2022
27th September
New:
API Version 6.17
API version 6.17 released to support:
-
The introduction of cardHolderName in
/transactions/savecard
request and response.For more information, see Transaction API /savecard.
May 2022
25th May
New:
API Version 6.16
API version 6.16 released to support:
-
The introduction of the following fields in the receipt response:
-
paymentNetworkTransactionId
recurringPaymentType
-
For more information, see Transaction API.
April 2022
25th April
New:
API Version 6.15
API version 6.15 released to support:
-
Merchants with the ability to chose the pages to be displayed during the 3DS 2 journey when using Judopay’s Web Payments solution, with:
-
The introduction of the following optional flags on
/webpayments/payments
,/webpayments/preauths
,/webpayments/checkcard
endpoints:-
hideBillingInfo
-
hideReviewInfo
-
-
-
Validation on the cardAddress block containing the following attributes:
-
address
-
town
-
state
-
countryCode
on
/paymentSession
creation request and/webpayments/payments
,/webpayments/preauths
,/webpayments/checkcard
endpoints: (from API Version 6.14). -
For more information, see Transaction API.
6th April
New:
API Version 6.14
API version 6.14 released to support:
-
Calls to create paymentSessions will now validate:
-
cardAddress
-
mobileNumber
-
phoneCountryCode
-
emailAddress
-
For more information on validation rules, see Transaction API.
March 2022
10th March
New:
API Version 6.13
API version 6.13 released to support:
-
For 3DS 2 transactions:
-
emailAddress is no longer mandatory.
-
-
All enums are now case insensitive.
-
The introduction of the
relatedPaymentNetworkTransactionId
field which can be submitted with MIT and Recurring transactions. -
The Judopay Portal:
-
Re-introduction of
yourPaymentMetaData
in CSV downloads.
-
Please note, API Version 6.12 has been skipped.
For more information, see Transaction API.
February 2022
14th February
New:
API Version 6.11
API version 6.11 released to support:
-
Merchants with the ability to specify custom redirect URLs for:
-
successUrl and cancelUrl attributes in:
-
POST
/paymentsession
-
POST
/webpayments/payments
-
POST
/webpayments/preauths
-
POST
/webpayments/checkcard
-
-
-
Cards registered in the USA and Canada:
-
Added the
state
attribute to cardAddress in the request and receipt models.
-
For more information, see Transaction API.
January 2022
27th January
New:
API Version 6.10
API version 6.10 released to support:
-
New endpoint that can be used to cancel open paymentSessions:
-
PUT
/paymentsession/{reference}/cancel
-
Empty body sent on request.
-
-
3DS 2 authentication failures:
-
Additional error codes returned (codes: 176-188).
-
For more information, see Error Codes and Descriptions
-
Enhancements
-
POST
/transactions/savecard
-
Now allows cardToken request attributes to contain:
-
- (hyphen)
-
_ (underscore)
-
-
-
Attributes in the cardAddress request object cannot contain:
-
\ (backslash)
-
-
For 3DS 2 transactions:
-
mobileNumber is no longer mandatory.
-
For more information, see Transaction API.
2021
October 2021
21st October
New:
API Version 6.8
API version 6.8 released to support:
OptionalthreeDSecureMpi block for the following endpoints:
-
/payments
-
/preauths
-
/checkcard
-
/registercard
If 3D Secure 2 authentication is performed outside of Judopay, the threeDSecureMpi block allows for the authentication results to be passed into the request.
{
...
"threeDSecureMpi": {
"dsTransId": "string",
"cavv": "string",
"eci": "string",
"threeDSecureVersion": "string"
}
}
For more information, see Transaction API.
September 2021
9th September
New:
API Version 6.7
API version 6.7 released to support:
-
The
cardHolderName
attribute as supplied on the request is now included in the cardDetails block for the following receipt responses:-
Initial receipts for 3DS2 and no 3DS transactions.
-
Receipts returned with GET
/transactions/{receiptId}
for 3DS2 transactions.
-
-
Receipts returned with GET
/transactions/{receiptId}
now include the risks block as returned in the initial receipts:
{
...
"risks": {
"postCodeCheck": "PASSED",
"cv2Check": "PASSED",
"merchantSuggestion": "Allow"
}
}
For more information, see Transaction API.
July 2021
20th July
New:
API Version 6.6
API version 6.6 released to support:
-
Electronic Commerce Indicator (ECI) returned in the PaymentReceipt model (ThreeDSecure Object) for the following endpoints:
-
/payments
-
/preauths
-
/checkcard
-
/resume3ds
-
/complete3ds
-
The ECI value indicates the level of authentication that was performed on the transaction by the issuer.
For more information, see Transaction API.
June 2021
28th June
New:
API Version 6.6
API version 6.6 released to support:
-
The
primaryAccountDetails
block. This can be set on requests when creating a Payment-Session.
-
This is intended for use by MCC 6012 merchants.
-
The following information can be submitted using
primaryAccountDetails
:-
Name
-
AccountNumber
-
DateOfBirth
-
PostCode
-
-
For more information, see Transaction API.
April 2021
21st April
New:
API Version 6.4
API version 6.4 released to support the additional authentication requirements and reduce friction in the 3D Secure 2 payment flow:
-
Mobile Authentication
-
Judopay's Mobile SDK for 3D Secure 2 will be coming soon.
-
-
Exemption Flags
-
Merchants can request specific customer initiated transactions be exempt from Strong Customer Authentication.
-
Adding exemption flags reduces friction for your customers and associated checkout dropouts.
-
For more information on exemptions to SCA and exemption flags, see Exemptions to Strong Customer Authentication
-
March 2021
16th March
New:
API Version 6.3
API version 6.3 released to support:
-
The transaction
authCode
is returned in the:-
Initial transaction receipt (If this is returned by the Gateway).
-
GET
/transactions/{receiptId}
call response.
-
-
GET
/transactions/{receiptId}
returns the:-
acquirer
-
-
For Web Payment Transactions:
-
GET
/transactions/{receiptId}
returns the:-
webPaymentReference
-
-
All API Versions
Optional Parameters:
-
The
parameter is now optional on the following calls:amount
-
POST
/transactions/refunds
-
POST
/transactions/voids
-
POST
/transactions/collections
-
-
When the amount is not specified, the full value of the auth amount will be used.
-
For more information, see Transaction API.
-
-
The
CV2
parameter is now optional on the following calls:-
POST
/transactions/checkcard
-
POST
/transactions/registercard
-
-
When the API Token is set to: cv2 optional
New Parameter for 3D Secure 2:
-
The
phoneCountryCode
parameter is added to:-
POST
/transactions/checkcard
-
POST
/transactions/registercard
-
For more information, see Transaction API.
February 2021
1st February
New
API version 6.1
API Version 6.1 released to support the new payment methods added to Judopay's Hosted Payments Page:
-
POST
/webpayments/checkcard
-
Verify your consumer's card without reserving funds on their account.
-
Performs a zero amount pre-authorisation (0 Auth).
-
Supported for Web Payments - Version 2
-
Enhancement
-
Maestro Cards For calls to:
-
POST
/transactions/payments
-
POST
/transactions/preauths
-
-
the startDate parameter is no longer mandatory for Maestro cards.
25th February
New:
API Version 6.2
API version 6.2 released to support:
-
POST
/transactions/registercard
-
POST
/transactions/checkcard
-
The attribute
yourPaymentReference
is nowoptional
. -
If
yourPaymentReference
is set it will be used. Otherwise a reference will be internally generated.
-
For more information, see Transaction API.
All API Versions
Improvements:
-
POST
/transactions/registercard
-
POST
/transactions/checkcard
-
These endpoints now support the same 3D Secure 2 and MIT request body attributes as POST
/transactions/preauths
:
-
{
...
"initialRecurringPayment": false,
"recurringPayment": true,
"recurringPaymentType": "MIT",
"relatedReceiptId": "651775758628454400",
"cardHolderName": "John Doe",
"mobileNumber": "07999999999",
"emailAddress": "example@domain.com"
"threeDSecure":
{
"authenticationSource": "BROWSER",
"methodNotificationUrl": "https://api.judopay.com/order/3ds/methodNotification",
"challengeNotificationUrl": "https://api.judopay.com/order/3ds/challengeNotification"
}
}
For 3D Secure 2 Transactions
-
methodNotificationUrl
-
challengeNotificationUrl
-
These attributes within the threeDSecure object are now optional.
-
If these URLs are not set, then default Judopay-hosted URLs will be used.
-
-
The default URLs will trigger calls to the:
-
POST
/transactions/{receiptId}/resume3ds
-
POST
/transactions/{receiptId}/complete3ds
endpoints.
January 2021
19th January
New:
API Version 6.0
-
API Version 6.0 released to advertise support for payment requests using 3DSecure 2 authentication.
-
For 3DSecure 2, new attributes are required on:
-
POST
/transactions/payments
-
POST
/transactions/preauths
-
{
...
"cardHolderName": "John Doe",
"mobileNumber": "07999999999",
"emailAddress": "example@domain.com"
"threeDSecure":
{
"authenticationSource": "BROWSER",
"methodNotificationUrl": "https://api.judopay.com/order/3ds/methodNotification",
"challengeNotificationUrl": "https://api.judopay.com/order/3ds/challengeNotification",
"methodCompletion": "No"
}
}
After the device details check:
PUT /transactions/{receiptid}/resume3ds
{
"cV2": "xxx",
"threeDSecure": {
"methodCompletion": "Yes",
}
}
After the challenge is completed:
PUT /transactions/{receiptid}/complete3ds
Using 3DSecure 2 in Sandbox (non production) environments, a GlobalPayments test card will be selected for authentication using the supplied CardHolderName:
|| CardHolderName || Test Card Number || Transaction Result ||
| FL-SUCCESS | 4263970000005262 | AUTHENTICATION_SUCCESSFUL |
| FL-ATTEMPT-NO-SUCCESS | 4012001037167778 | AUTHENTICATION_ATTEMPTED_BUT_NOT_SUCCESSFUL |
| FL-FAILED | 4012001037461114 | AUTHENTICATION_FAILED |
| FL-ISSUER-REJECTED | 4012001038443335 | AUTHENTICATION_ISSUER_REJECTED |
| FL-AUTH-ERROR | 4012001037484447 | AUTHENTICATION_COULD_NOT_BE_PERFORMED |
| CHALLENGE | 4012001038488884 | CHALLENGE_REQUIRED |
See, Sandbox Environment.