RESTful API · Web payments

Our RESTful API is the core of our payment processing platform, it powers our mobile SDKs and web payments and makes it easy for you to integrate payments into your app's back-office or administrative system.

This reference covers using the raw RESTful API for web payments, if you want to integrate Judopay into your project we recommend using our web payments mobile optimised UI rather than creating your own REST client from scratch.

Environment management

All the elements and examples listed in this table are built pointing to the sandbox environment. This environment allows you to process test transactions while developing your app. Check our testing sandbox environment guide for further detail.

Note: Please note only sandbox API tokens and test cards will work only in the sandbox. Check our Dashboard guide if you don't know where to find them.

In case you are ready to go live, delete the '-sandbox' from the reference and use your live token and secret. Access to your live credentials by following our Access to your token and secret guide and attend the best live environment practices for your reference.

https://gw1.judopay.com/

Table of content

POST GET
Card payment List of all transactions
Pre-authorization List individual transactions
  Filtered list of transactions

Card payment

POST · Charge a card using a card’s full details (16-digit card number, expiry date and CV2). See Card payments for a full description.

Request

Request

HTTP Header

POST https://gw1.judopay-sandbox.com/webpayments/payments
API-Version: 5.2
Accept: application/json
Authorization: Basic {authstring}

You should replace {authstring} with the base64 encoding of your API token (username) then a colon and then your API secret (password).

Example : >
curl -X POST https://gw1.judopay-sandbox.com/webpayments/payments
-H "API-Version: 5.2"
-H "Content-Type: application/json"
-u Token:Secret
{
  "judoId": "1234-4567",
  "amount": 12.34,
  "partnerServiceFee": 12.34,
  "yourConsumerReference": "consumer0053252",
  "yourPaymentReference": "payment12412312",
  "yourPaymentMetaData": ,
  "clientIpAddress": "127.0.0.1",
  "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)..."
}

For JSON reference, please see: API reference · Request fields.

Response

OK (200)

HTTP Header

The judoPay Web API returns a response with the HTTP status code 200 (OK) when we’ve been able to successfully parse the web payment request and return a response

The response contains the URL and reference you will need to access the payment form on judo’s servers.

Status code: 200
Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Example : >
{
"postUrl": "https://pay.judopay-sandbox.com/",
"reference": "4gcBAAMAGAASAAAADA66kRor6ofknGqU3A6i-759FprFGPH3ecVcW5ChMQK0f3pLBQ"
}
JSON Reference : >
Property Type Notes
postUrl string
up to 2048
The url of the payment form to post the reference
reference string
up to 70
The reference for the web payment you are requesting

Not modified (304)

HTTP Header

Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. This means that there is no need to retransmit the resource, since the client still has a previously-downloaded copy.

Status code: 304

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "3D-Secure was not successful for this transaction.",
"errorType": "60",
"modelErrors": []
}
JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Bad request (400)

HTTP Header

There are many causes of a bad request response, however the judoPay API returns a JSON document detailing any detected problems.

Status code: 400
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we're unable to process your request. Please check your details and try again.",
"errorType": "1",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Forbidden (403)

HTTP Header

The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. "you don't have necessary permissions for the resource".

Status code: 403

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the API version you are targeting is invalid. Please review this and try again.",
"errorType": "40",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Not found (404)

HTTP Header

The requested resource could not be found. Subsequent requests by the client are permissible.

Status code: 404

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the transaction specified was not found.",
"errorType": "19",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Method not allowed (405)

HTTP Header

A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.

Status code: 405

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but this application has already gone live and cannot be updated via this endpoint.",
"errorType": "20002",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Conflict (409)

HTTP Header

Indicates that the request could not be processed because of conflict in the request.

Status code: 409

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry,we were unable to process your payment at this time. Your card has not been charged.",
"errorType": "11",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Unsupported media type (415)

HTTP Header

The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.

Status code: 415

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the content-type was not specified or is currently unsupported. Currently only application/json is supported.",
"errorType": "80",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Internal server error (500)

HTTP Header

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

Status code: 500

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we encountered an error while authenticating your request. Please check your authentication details and try again. If this issue continues, please contact customer services.",
"errorType": "81",
"modelErrors": []
}
JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Pre-authorization

POST · Reserve funds on a card. See Reserve and collect funds for a full description.

Note: If a pre-authorization is not collected, it will expire within the next three days, releasing the reserved funds for that particular transaction.

Request

Request

HTTP Header

POST https://gw1.judopay-sandbox.com/webpayments/preauths
API-Version: 5.2 
Accept: application/json 
Authorization: Basic {authstring}

You should replace {authstring} with the base64 encoding of your API token (username) then a colon and then your API secret (password).

Example : >
curl -X POST https://gw1.judopay-sandbox.com/webpayments/preauths
-H "API-Version: 5.2"
-H "Content-Type: application/json"
-u Token:Secret
{
"judoId": "1234-4567",
"amount": 12.34,
"partnerServiceFee": 12.34,
"yourConsumerReference": "consumer0053252",
"yourPaymentReference": "payment12412312",
"yourPaymentMetaData": ,
"clientIpAddress": "127.0.0.1",
"clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)..."
}

For JSON reference, please see: API reference · Request fields.

Response

OK (200)

HTTP Header

The judoPay Web API returns a response with the HTTP status code 200 (OK) when we’ve been able to successfully parse the web pre-authorization request and return a response

The response contains the URL and reference you will need to access the transaction form on judo’s servers.

Status code: 200
Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Example : >
{
"postUrl": "https://pay.judopay-sandbox.com/",
"reference": "4gcBAAMAGAASAAAADA66kRor6ofknGqU3A6i-759FprFGPH3ecVcW5ChMQK0f3pLBQ"
}
JSON Reference : >
Property Type Notes
postUrl string
up to 2048
The url of the payment form to post the reference
reference string
up to 70
The reference for the web payment you are requesting

Not modified (304)

HTTP Header

Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. This means that there is no need to retransmit the resource, since the client still has a previously-downloaded copy.

Status code: 304

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "3D-Secure was not successful for this transaction.",
"errorType": "60",
"modelErrors": []
}
JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Bad request (400)

HTTP Header

There are many causes of a bad request response, however the judoPay API returns a JSON document detailing any detected problems.

Status code: 400
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we're unable to process your request. Please check your details and try again.",
"errorType": "1",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Forbidden (403)

HTTP Header

The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. "you don't have necessary permissions for the resource".

Status code: 403

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the API version you are targeting is invalid. Please review this and try again.",
"errorType": "40",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Not found (404)

HTTP Header

The requested resource could not be found. Subsequent requests by the client are permissible.

Status code: 404

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the transaction specified was not found.",
"errorType": "19",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Method not allowed (405)

HTTP Header

A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.

Status code: 405

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but this application has already gone live and cannot be updated via this endpoint.",
"errorType": "20002",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Conflict (409)

HTTP Header

Indicates that the request could not be processed because of conflict in the request.

Status code: 409

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry,we were unable to process your payment at this time. Your card has not been charged.",
"errorType": "11",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Unsupported media type (415)

HTTP Header

The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.

Status code: 415

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the content-type was not specified or is currently unsupported. Currently only application/json is supported.",
"errorType": "80",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Internal server error (500)

HTTP Header

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

Status code: 500

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we encountered an error while authenticating your request. Please check your authentication details and try again. If this issue continues, please contact customer services.",
"errorType": "81",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

List of all transactions

GET · A number of the Judopay API resources support paging and sorting. The paging for these resources is controlled using the following query-string parameters:

URL Parameter Description
pageSize The number of records to display per-page
default: 10
offset The start point in the sorted list of records from which the results set will start. For example, "?pageSize=10&offset=20" will return the second page of results
default: 0
sort Determines how Judopay sorts the list. The list can be displayed as time-descending and time-ascending
default: time-descending

Paging is most useful on the transaction resources, where you can get a list of the last 15 transactions processed:

GET /transactions?pageSize=15&offset=0&sort=time-descending

Or the first 5 payments you processed:

GET /transactions/payments?pageSize=5&offset=0&sort=time-ascending

Request

Request

HTTP Header

GET /webpayments/
Host: gw1.judopay-sandbox.com
Api-Version: 5.2
Content-Type: application/json
Authorization: Basic {authstring}
Cache-Control: no-cache

You should replace {authstring} with the base64 encoding of your API token (username) then a colon and then your API secret (password).

Example : >
curl -X GET https://gw1.judopay-sandbox.com/webpayments/
-H "API-Version: 5.2"
-H "Content-Type: application/json"
-u Token:Secret
Response

OK (200)

HTTP Header

Status code: 200
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Content-Length: X

Where the value of X depends on the size of your result set

Example : >
    {
    "resultCount": 21,
    "pageSize": 10,
    "offset": 0,
    "results": [
        {
            "amount": 1.01,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-11-13T14:47:52.1183+00:00",
            "judoId": "100337815",
            "partnerServiceFee": 1.01,
            "paymentCancelUrl": "http://www.marca.com/",
            "paymentSuccessUrl": "http://www.20minutos.es/",
            "reference": "3wcAAAsAAAANAAAADgAAAJ_C3aHop-cZcb5PTdUGOH8ceQ1_wn8fP46UmY_CWYMZ8jcUgA",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "001",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "003"
        },
        {
            "amount": 12.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-10-05T12:43:20.8551+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAoAAAAFAAAACwAAAE316Z5n9lZd___vYrRE6pFonJX9RkRy2ExVwj-Ov2-EdSEDcQ",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 12.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-10-05T12:42:45.0445+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAoAAAAFAAAACwAAAL6MDOSeJ6fyyB67Mp0H-dMqmlYmQp-n8VMBsyEFpHPoNF-kng",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 12.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-10-05T12:38:47.5898+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAoAAAAFAAAACwAAABA5NdBXXL1JwVfcPBzwj6pLJDzHR2wB5JxcHCaZfnfmO3yz-Q",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 12.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-10-05T12:38:04.5825+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAoAAAAFAAAACwAAALlRNtopwel0ADHnpSZdGCEES7jIRW0KYVTycv6jxtXktvPqEg",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-09-28T15:24:34.9324+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAkAAAAcAAAADQAAAMjnXjty_f7_1Mj8Js_35YnvanV8BRJB8O1f5cepGLZDmB-0Ug",
            "status": "Open",
            "transactionType": "PREAUTH",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-09-28T15:24:32.7402+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAkAAAAcAAAADQAAAFkGxLgYGO2DOBRz0gOSjldKs8sQh2LdkuhNXW-Qp0IXxATFBg",
            "status": "Open",
            "transactionType": "PREAUTH",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 0.01,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-09-28T15:24:27.1627+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAkAAAAcAAAADQAAADQuPfGr_LYCs6Rx6qvKQDKECdSqOB8SUSNLPq_xLXNCcqyogg",
            "status": "Open",
            "transactionType": "PREAUTH",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 10,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "86.6.233.47",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-08-10T10:05:57.0983+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 0,
            "paymentCancelUrl": "https://www.msn.com/",
            "paymentSuccessUrl": "https://www.google.co.uk/",
            "reference": "3wcAAAgAAAAKAAAACAAAAKL2NUyH_TcaghE961KBQbpp0oYJI0Pa6R_eZoxWgb94sIg6ZA",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "00001",
            "yourPaymentMetaData": {
                "invoiceNumber": "000001",
                "customerNumber": "CITI123456"
            },
            "yourPaymentReference": "00001"
        },
        {
            "amount": 120.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-07-07T10:13:51.6359+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "paymentCancelUrl": "http://www.google.com",
            "paymentSuccessUrl": "http://www.justeat.com",
            "reference": "3wcAAAcAAAAHAAAACAAAAGU9w4anwHy5Y852O2NWnNzRt5pJm86T1V7IF5Che4RfMli62Q",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "001",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "002"
        }
    ]
}

Not modified (304)

HTTP Header

Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. This means that there is no need to retransmit the resource, since the client still has a previously-downloaded copy.

Status code: 304

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "3D-Secure was not successful for this transaction.",
"errorType": "60",
"modelErrors": []
}
JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Bad request (400)

HTTP Header

There are many causes of a bad request response, however the judoPay API returns a JSON document detailing any detected problems.

Status code: 400

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we're unable to process your request. Please check your details and try again.",
"errorType": "1",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Forbidden (403)

HTTP Header

The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. "you don't have necessary permissions for the resource".

Status code: 403

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the API version you are targeting is invalid. Please review this and try again.",
"errorType": "40",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Not found (404)

HTTP Header

The requested resource could not be found. Subsequent requests by the client are permissible.

Status code: 404

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the transaction specified was not found.",
"errorType": "19",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Method not allowed (405)

HTTP Header

A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.

Status code: 405

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but this application has already gone live and cannot be updated via this endpoint.",
"errorType": "20002",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Conflict (409)

HTTP Header

Indicates that the request could not be processed because of conflict in the request.

Status code: 409

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry,we were unable to process your payment at this time. Your card has not been charged.",
"errorType": "11",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Unsupported media type (415)

HTTP Header

The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.

Status code: 415

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the content-type was not specified or is currently unsupported. Currently only application/json is supported.",
"errorType": "80",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Internal server error (500)

HTTP Header

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

Status code: 500

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we encountered an error while authenticating your request. Please check your authentication details and try again. If this issue continues, please contact customer services.",
"errorType": "81",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

List individual transaction

GET

Request

Request

HTTP Header

GET /webpayments/{reference}
Host: gw1.judopay-sandbox.com
Api-Version: 5.2
Content-Type: application/json
Authorization: Basic {authstring}
Cache-Control: no-cache

You should replace {authstring} with the base64 encoding of your API token (username) then a colon and then your API secret (password).

Example : >
curl -X GET https://gw1.judopay-sandbox.com/webpayments/3wcAAAsAAAAXAAAACgAAAE1e7ta8PUJeaAfqws3Kt-wnasdBun0ZGfGcTkfQYnb5UKhILA
-H "API-Version: 5.2"
-H "Content-Type: application/json"
-u Token:Secret

Response

OK (200)

HTTP Header

Status code: 200
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Content-Length: X

Where the value of X depends on the size of your result set

Example : >
    {
    "amount": 1.01,
    "cardAddress": {
        "countryCode": 826
    },
    "clientIpAddress": "127.0.0.1",
    "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
    "companyName": "trading",
    "currency": "GBP",
    "expiryDate": "2015-11-13T14:47:52.1183+00:00",
    "judoId": "100337815",
    "partnerServiceFee": 1.01,
    "paymentCancelUrl": "http://www.marca.com/",
    "paymentSuccessUrl": "http://www.20minutos.es/",
    "reference": "3wcAAAsAAAANAAAADgAAAJ_C3aHop-cZcb5PTdUGOH8ceQ1_wn8fP46UmY_CWYMZ8jcUgA",
    "allowedCardTypes": [
        1,
        2,
        3,
        8,
        10,
        11,
        12,
        13
    ],
    "response": {
        "postUrl": "https://pay.judopay-sandbox.com/v1",
        "reference": "3wcAAAsAAAANAAAADgAAAJ_C3aHop-cZcb5PTdUGOH8ceQ1_wn8fP46UmY_CWYMZ8jcUgA"
    },
    "status": "Expired",
    "transactionType": "SALE",
    "yourConsumerReference": "001",
    "yourPaymentMetaData": {},
    "yourPaymentReference": "003",
    "webPaymentOperation": 0
}

Not modified (304)

HTTP Header

Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. This means that there is no need to retransmit the resource, since the client still has a previously-downloaded copy.

Status code: 304

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "3D-Secure was not successful for this transaction.",
"errorType": "60",
"modelErrors": []
}
JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Bad request (400)

HTTP Header

There are many causes of a bad request response, however the judoPay API returns a JSON document detailing any detected problems.

Status code: 400

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we're unable to process your request. Please check your details and try again.",
"errorType": "1",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Forbidden (403)

HTTP Header

The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. "you don't have necessary permissions for the resource".

Status code: 403

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the API version you are targeting is invalid. Please review this and try again.",
"errorType": "40",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Not found (404)

HTTP Header

The requested resource could not be found. Subsequent requests by the client are permissible.

Status code: 404

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the transaction specified was not found.",
"errorType": "19",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Method not allowed (405)

HTTP Header

A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.

Status code: 405

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but this application has already gone live and cannot be updated via this endpoint.",
"errorType": "20002",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Conflict (409)

HTTP Header

Indicates that the request could not be processed because of conflict in the request.

Status code: 409

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry,we were unable to process your payment at this time. Your card has not been charged.",
"errorType": "11",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Unsupported media type (415)

HTTP Header

The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.

Status code: 415

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the content-type was not specified or is currently unsupported. Currently only application/json is supported.",
"errorType": "80",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Internal server error (500)

HTTP Header

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

Status code: 500

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we encountered an error while authenticating your request. Please check your authentication details and try again. If this issue continues, please contact customer services.",
"errorType": "81",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Filtered list of transactions

GET · A number of the Judopay API resources support paging and sorting. The paging for these resources is controlled using the following query-string parameters:

URL Parameter Description
pageSize The number of records to display per-page
default: 10
offset The start point in the sorted list of records from which the results set will start. For example, "?pageSize=10&offset=20" will return the second page of results
default: 0
sort Determines how Judopay sorts the list. The list can be displayed as time-descending and time-ascending
default: time-descending

Paging is most useful on the transaction resources, where you can get a list of the last 15 transactions processed:

GET /transactions/preauths?pageSize=15&offset=0&sort=time-descending

Or the first 5 payments you processed:

GET /transactions/payments?pageSize=5&offset=0&sort=time-ascending

Request

Request

HTTP Header

GET /webpayments/{payments / preauths}
Host: gw1.judopay-sandbox.com
Api-Version: 5.2
Content-Type: application/json
Authorization: Basic {authstring}
Cache-Control: no-cache

You should replace {authstring} with the base64 encoding of your API token (username) then a colon and then your API secret (password).

Example : >
curl -X GET https://gw1.judopay-sandbox.com/webpayments/{payments / preauths}
-H "API-Version: 5.2"
-H "Content-Type: application/json"
-u Token:Secret

Response

OK (200)

HTTP Header

Status code: 200
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Content-Length: X

Where the value of X depends on the size of your result set

Example : >
{
    "resultCount": 21,
    "pageSize": 10,
    "offset": 0,
    "results": [
        {
            "amount": 1.01,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-11-13T14:47:52.1183+00:00",
            "judoId": "100337815",
            "partnerServiceFee": 1.01,
            "paymentCancelUrl": "http://www.marca.com/",
            "paymentSuccessUrl": "http://www.20minutos.es/",
            "reference": "3wcAAAsAAAANAAAADgAAAJ_C3aHop-cZcb5PTdUGOH8ceQ1_wn8fP46UmY_CWYMZ8jcUgA",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "001",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "003"
        },
        {
            "amount": 12.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-10-05T12:43:20.8551+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAoAAAAFAAAACwAAAE316Z5n9lZd___vYrRE6pFonJX9RkRy2ExVwj-Ov2-EdSEDcQ",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 12.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-10-05T12:42:45.0445+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAoAAAAFAAAACwAAAL6MDOSeJ6fyyB67Mp0H-dMqmlYmQp-n8VMBsyEFpHPoNF-kng",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 12.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-10-05T12:38:47.5898+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAoAAAAFAAAACwAAABA5NdBXXL1JwVfcPBzwj6pLJDzHR2wB5JxcHCaZfnfmO3yz-Q",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 12.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-10-05T12:38:04.5825+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAoAAAAFAAAACwAAALlRNtopwel0ADHnpSZdGCEES7jIRW0KYVTycv6jxtXktvPqEg",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-09-28T15:24:34.9324+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAkAAAAcAAAADQAAAMjnXjty_f7_1Mj8Js_35YnvanV8BRJB8O1f5cepGLZDmB-0Ug",
            "status": "Open",
            "transactionType": "PREAUTH",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-09-28T15:24:32.7402+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAkAAAAcAAAADQAAAFkGxLgYGO2DOBRz0gOSjldKs8sQh2LdkuhNXW-Qp0IXxATFBg",
            "status": "Open",
            "transactionType": "PREAUTH",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 0.01,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-09-28T15:24:27.1627+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "reference": "3wcAAAkAAAAcAAAADQAAADQuPfGr_LYCs6Rx6qvKQDKECdSqOB8SUSNLPq_xLXNCcqyogg",
            "status": "Open",
            "transactionType": "PREAUTH",
            "yourConsumerReference": "consumer0053252",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "payment12412312"
        },
        {
            "amount": 10,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "86.6.233.47",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-08-10T10:05:57.0983+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 0,
            "paymentCancelUrl": "https://www.msn.com/",
            "paymentSuccessUrl": "https://www.google.co.uk/",
            "reference": "3wcAAAgAAAAKAAAACAAAAKL2NUyH_TcaghE961KBQbpp0oYJI0Pa6R_eZoxWgb94sIg6ZA",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "00001",
            "yourPaymentMetaData": {
                "invoiceNumber": "000001",
                "customerNumber": "CITI123456"
            },
            "yourPaymentReference": "00001"
        },
        {
            "amount": 120.34,
            "cardAddress": {
                "countryCode": 826
            },
            "clientIpAddress": "127.0.0.1",
            "clientUserAgent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64)...",
            "companyName": "trading",
            "currency": "GBP",
            "expiryDate": "2015-07-07T10:13:51.6359+01:00",
            "judoId": "100337815",
            "partnerServiceFee": 12.34,
            "paymentCancelUrl": "http://www.google.com",
            "paymentSuccessUrl": "http://www.justeat.com",
            "reference": "3wcAAAcAAAAHAAAACAAAAGU9w4anwHy5Y852O2NWnNzRt5pJm86T1V7IF5Che4RfMli62Q",
            "status": "Open",
            "transactionType": "SALE",
            "yourConsumerReference": "001",
            "yourPaymentMetaData": {},
            "yourPaymentReference": "002"
        }
    ]
}

Not modified (304)

HTTP Header

Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. This means that there is no need to retransmit the resource, since the client still has a previously-downloaded copy.

Status code: 304

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "3D-Secure was not successful for this transaction.",
"errorType": "60",
"modelErrors": []
}
JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Bad request (400)

HTTP Header

There are many causes of a bad request response, however the judoPay API returns a JSON document detailing any detected problems.

Status code: 400

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we're unable to process your request. Please check your details and try again.",
"errorType": "1",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Forbidden (403)

HTTP Header

The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. "you don't have necessary permissions for the resource".

Status code: 403

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the API version you are targeting is invalid. Please review this and try again.",
"errorType": "40",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Not found (404)

HTTP Header

The requested resource could not be found. Subsequent requests by the client are permissible.

Status code: 404

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the transaction specified was not found.",
"errorType": "19",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Method not allowed (405)

HTTP Header

A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.

Status code: 404

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the transaction specified was not found.",
"errorType": "19",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Conflict (409)

HTTP Header

Indicates that the request could not be processed because of conflict in the request.

Status code: 409

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry,we were unable to process your payment at this time. Your card has not been charged.",
"errorType": "11",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Unsupported media type (415)

HTTP Header

The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.

Status code: 415

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, but the content-type was not specified or is currently unsupported. Currently only application/json is supported.",
"errorType": "80",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.

Internal Server Error (500)

HTTP Header

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

Status code: 500

Cache-Control: no-cache 
Pragma: no-cache 
Content-Type: application/json; charset=utf-8 
Expires: -1 
Content-Length: X 

Where the value of X depends on the size of your result set

Body : >
{
"errorMessage": "Sorry, we encountered an error while authenticating your request. Please check your authentication details and try again. If this issue continues, please contact customer services.",
"errorType": "81",
"modelErrors": []
}

This is an example of error message. You can consult all the rest of error messages here.

JSON Reference : >
Property Type Notes
errorMessage date a user friendly error message
errorType integer enumeration Code describing the error. Please see below for different error codes
modelErrors Array description of each model error

You can consult all the error messages by Http Status Code here.