This site requires javascript to be enabled.

  • Search AI-powered
    Search results are AI-generated and are not guaranteed to be accurate, complete, or up-to-date. They are not a substitute for legal or professional advice. Refer to our terms of use for more details.
    Search AI-powered

Results for

xxx

Get payment product networks

GET https://{domainname}/client/v1/{customerId}/products/{paymentProductId}/networks

Products

Through this API you can retrieve details of the payment products that are configured for your account.

Request

Mobile payment methods such as Apple Pay and Google 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 Details
countryCode string yes no read close
close

Description

ISO 3166-1 alpha-2 country code
currencyCode string yes no read close
close

Description

Three-letter ISO currency code representing the currency for the amount
amount integer no no read close
close

Description

Amount in cents and always having 2 decimals
isRecurring boolean no no read close
close

Description

This allows you to filter networks based on their support for recurring or not
  • true
  • false

Request example

SDK: JSON

This scenario you will probably use the most

  • countryCode=NL&currencyCode=EUR&amount=1000&isRecurring=true

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 Google Pay.

Properties
Property Type Required Details
close

Description

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 Google Pay.

Response example

SDK: JSON

This scenario you will probably use the most

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

Response 400 - Bad requestErrorResponse

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close
  • 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 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.
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'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: JSON

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.

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close
  • 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 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.
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'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: JSON

This scenario you will probably use the most

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