Server API version 1.0
Java

Results for

icon-search-large No search results yet
Enter your search query above

Get payment product networks

GET https://{domainname}/v1/{merchantId}/products/{paymentProductId}/networks

Products

Products is your entry on all things related to payment products. You will be able to retrieve all relevant payment products, based on your configuration and provided filters, their associated fields and potential directories. You can retrieve all of the information in one call or do calls on individual payment products. The data returned is designed to give you all the required information to build up your interface towards your consumers in a dynamic fashion. By doing it like that you know that you will be ready for future changes and new payment products without much effort.

Request

Mobile payment methods such as Apple Pay and Android Pay use existing networks such as "VISA" for the actual payments. The consumer's (mobile) device should only show the cards in the consumer's wallet that use one of the available networks. This endpoint lists all the networks that can be used in the current payment context for such payment products. Which networks are returned for a specific payment product depends on a couple of things:

  • the query parameters listed below
  • which networks the payment product itself supports
  • which of these are configured in the Connect back office

Query parameters

Query parameters for this method

  Property Type Required Repeat Description
countryCode string yes no
ISO 3166-1 alpha-2 country code
currencyCode string yes no
Three-letter ISO currency code representing the currency for the amount
amount integer no no
Amount in cents and always having 2 decimals
isRecurring boolean no no
This allows you to filter networks based on their support for recurring or not
  • true
  • false

Request example

SDK: Java

This scenario you will probably use the most

  • NetworksParams query = new NetworksParams();
    query.setCountryCode("US");
    query.setCurrencyCode("USD");
    query.setAmount(1000L);
    query.setIsRecurring(true);
    
    PaymentProductNetworksResponse response = client.merchant("merchantId").products().networks(320, query);
    

Responses

Please find below an overview of the possible responses.

Response 200 - OKPaymentProductNetworksResponse

An array of networks is returned. The strings that represent the networks in the array are identical to the strings that the payment product vendors use in their documentation. For instance: "Visa" for Apple Pay, and "VISA" for Android Pay.

    Property Type Required Description
networks array of string no
Array containing network entries for a payment product. The strings that represent the networks in the array are identical to the strings that the payment product vendors use in their documentation. For instance: "Visa" for Apple Pay, and "VISA" for Android Pay.

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "networks" : [
            "amex",
            "discover",
            "masterCard",
            "visa"
        ]
    }
    

Response 400 - Bad requestErrorResponse

     Property Type Required Description
errorId string yes

Unique reference, for debugging purposes, of this error response

array yes
List of one or more errors
object no SDK object type: APIError
category string no

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 Connect 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 Connect platform or between Connect and any of the payment platforms or third party systems.

code string yes

Error code

httpStatusCode integer no

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

id string no

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

message string no

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

propertyName string no

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'.

requestId string no

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
        "errors" : [
            {
                "code" : "20000000",
                "propertyName" : "bankAccountBban.accountNumber",
                "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
            }
        ]
    }
    

Response 404 - Not foundErrorResponse

When no networks can be found matching the input criteria a HTTP 404 response is returned.

     Property Type Required Description
errorId string yes

Unique reference, for debugging purposes, of this error response

array yes
List of one or more errors
object no SDK object type: APIError
category string no

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 Connect 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 Connect platform or between Connect and any of the payment platforms or third party systems.

code string yes

Error code

httpStatusCode integer no

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

id string no

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

message string no

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

propertyName string no

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'.

requestId string no

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "errorId" : "3caa7750-a076-48b2-9402-3cb9eea613a6-00001532",
        "errors" : [
            {
                "code" : "1421",
                "message" : "NO_NETWORKS_FOUND"
            }
        ]
    }
    
icon_top_1