API Change Logs

api change logs learn about the latest updates to our transaction api 2025 may 2025 28th may new api version 6 23 api version 6 23 released to support introduction of the disablenetworktokenisation field in post /paymentsession post /webpayments/preauths post /webpayments/payments post /webpayments/checkcard introduction of the following response attributes in the response body for /payments , /preauths and /checkcard disablenetworktokenisation networktokenprovisioned (boolean) networktokenused (boolean) virtualpan lastfour (string) virtualpan expirydate (string) removed support for put /webpayments/{reference} when /refund transactions are declined, decline receipts are returned rather than an error message for more information, see transaction api february 2025 25th february new api version 6 22 api version 6 22 released to support introduction of the emailaddress response attribute for receipts introduction of the carddetails ownertype response attribute for receipts introduction of the requestid response attribute on error messages it is helpful to provide the requestid to judopay's developer support team when requesting help with any issues for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut 2024 august 2024 21st august new api version 6 21 7 api version 6 21 7 released to support for mcc 6051 mcc 6051 and mcc 7299 mcc 7299 financialbeneficiaryinformation field (in the primaryaccountdetails block) bug fixes and general improvements for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut july 2024 11th july new api version 6 21 3 api version 6 21 3 released to support removal for oneusetoken authentication updates to the production sandbox environment only , with the following changes (in line with the comms log docid\ w1frrdsagpi1snygknz8z comms) the deviceidentifier attribute will return kdeviceid in receipts cardscheme , cardcategory and bank attributes, will be returned in upper case the following attributes have been removed from requests and responses line1 line2 city issuernumber is no longer included in transaction requests, following the deprecation of maestro cards please note, api version 6 21 2 has been skipped for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut june 2024 10th june new api version 6 21 1 api version 6 21 1 released to support improved handling of step up flow this ensures consumers are presented with a challenge in all cases of a soft decline configurations introduced in preparation for api updates to support the shodan platform migration for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut april 2024 24th april new api version 6 21 0 api version 6 21 0 released to support the removal of consumer consumertoken from receipts the introduction of the incremental authorisation feature the ability to set allowincrement flag in preauth and payment session requests the introduction of the new incrementalauth endpoint this is used to increment a preauth amount for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut january 2024 january 2024 api version 6 20 updated january 2024 added card scheme diners club the result and message attributes updated in transaction receipts this is to be consistent after 3d secure has been performed for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut 2023 december 2023 december 2023 api version 6 20 updated december 2023 added support for currency egp (egyptian pound) introduced support for 3d secure 2 step up flow support for 3d secure 1 dropped introduced overcapture feature (cybersource barclays merchants only) for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut may 2023 11th may new api version 6 20 api version 6 20 released to support the introduction of the shortreference field for get /webpayments/{reference} response model the introduction of the delayedauthorisation flag for post /paymentsession and post /webpayments/preauths requests the delayedauthorisation flag should not be specified on post /webpayments/payments or, post /webpayments/checkcard the introduction of the delayedauthorisation flag returned on get /webpayments/{reference} and get /transactions/{receiptid}/webpayment response models when the judo shield fraud rules are triggered after performing the 3ds2 authentication a card decline response is returned the following “message” string is returned in the decline receipt “ card declined due to fraud rules applied ” changes applicable for all api versions the currency field removed from the request model for post /transactions /collections /refunds /voids when specifying a threedsecurempi request attribute block, the threedsecure block is now populated for post /transactions /checkcard /registercard receipt response get /webpayments/{reference} will return status expired , if the associated paymentsession was used for an unsuccessful transaction attempt more than 30 minutes ago making a googlepay transaction with an incomplete googlepaywallet request block, will now return the name of the missing attribute in the model error for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut february 2023 16th february new api version 6 19 api version 6 19 released to support the introduction of the following new values in transaction receipts in the risks cv2check response attribute not submitted not processed the yourpaymentmetadata block is now returned on immediate receipts if supplied in the following transaction requests /payments /preauths /checkcard /registercard for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut 2022 november 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 reference docid\ bcxnm5keok nlnrztafut 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 reference docid\ bcxnm5keok nlnrztafut 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 reference docid\ bcxnm5keok nlnrztafut 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 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 /webpayments/payments /webpayments/preauths /webpayments/checkcard endpoints (from api version 6 14 ) for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut 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, see transaction api reference docid\ bcxnm5keok nlnrztafut 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 reference docid\ bcxnm5keok nlnrztafut 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 reference docid\ bcxnm5keok nlnrztafut 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 codes and descriptions docid zrsihomuew xnrq4pbtj 2021 october 2021 21st october new api version 6 8 api version 6 8 released to support optional threedsecurempi 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 for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut threedsecurempi block example { "threedsecurempi" { "dstransid" "string", "cavv" "string", "eci" "string", "threedsecureversion" "string" } } 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 block { "risks" { "postcodecheck" "passed", "cv2check" "passed", "merchantsuggestion" "allow" } } for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut 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 reference docid\ bcxnm5keok nlnrztafut 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 reference docid\ bcxnm5keok nlnrztafut 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 improving authentication in your payment flow docid 0yqdp4kpyoijj6unudn9f 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 amount parameter is now optional optional on the following calls 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 reference docid\ bcxnm5keok nlnrztafut the cv2 parameter is now optional 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 reference docid\ bcxnm5keok nlnrztafut february 2021 25th february new api version 6 2 api version 6 2 released to support post /transactions/registercard post /transactions/checkcard the attribute yourpaymentreference is now optional optional if yourpaymentreference is set it will be used otherwise a reference will be internally generated for more information, see transaction api reference docid\ bcxnm5keok nlnrztafut 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 request body example { "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 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 the startdate parameter is no longer mandatory for maestro cards post /transactions/payments post /transactions/preauths 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 threedsecure block { "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 resume request { "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 complete 3ds request || 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 |