Server API version 1.0
Node.js

icon-search-large

Test connection

GET https://{domainname}/v1/{merchantId}/services/testconnection

Services

Under services you find several calls that can be used to support your payment flow:

  • Test your connection to us
  • Convert an amount from one currency to another
  • Convert between different bank account notations
  • Retrieve the card type and country where the card was issued based on the IIN of the card

Request

You can use this call to verify your connection to our platform. If you receive an OK result you know that your connection with us is working correctly, your authentication credentials are correct and your account is setup correctly in our system.

The request does not have any additional input parameters.

Request example

SDK: Node.js

This scenario you will probably use the most

  • connectSdk.services.testconnection("merchantId", null, function (error, sdkResponse) {
      // if sdkResponse is not null, it has the following properties:
      // - status: the HTTP status code
      // - body: the response body
      // - isSuccess: true if the call was successful,
      //              or false if the Ingenico ePayments platform returned an error response
    });
    

Responses

Please find below an overview of the possible responses.

Response 200 - OKTestConnection

When you get a 200 response your connection test was successful.

Properties
Property Type Required Details
result string no read close
close

Description

OK result on the connection to GC

Response example

SDK: Node.js

This scenario you will probably use the most

  • {
        "result" : "OK"
    }
    

Response 403 - UnauthorizedErrorResponse

When something is wrong with your credentials you will get a 403 response. This could happen when you are trying to access a merchantId that is not linked to your account.

Properties
Property Type Required Details
errorId string yes read close
close

Description

Unique reference, for debugging purposes, of this error response
errors array of object yes read close
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the E-Payment platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the E-Payment platform or between E-Payment and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.

Response example

SDK: Node.js

This scenario you will probably use the most

  • {
        "errorId" : "3b8c849b-e805-4c61-bd4d-baa2cb9ff8d0-0000119f",
        "errors" : [
            {
                "code" : "9007",
                "message" : "ACCESS_TO_MERCHANT_NOT_ALLOWED"
            }
        ]
    }
    
icon_top_1