Judopay Documentation

Change Logs

Learn about the latest updates to our 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 amount parameter is now 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 details, see /Collections /Voids /Refunds.

  • 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 details, see /Checkcard /Registercard.

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.

    • If yourPaymentReference is set it will be used. Otherwise a reference will be internally generated.

See, /Registercard and /Checkcard for more information.

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.

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.

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, Verify your 3D Secure 2 Integration.