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 directory

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

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

Certain payment products have directories that the consumer needs to pick from. The most well known example is the list of banks for iDeal that the consumer needs to select their bank from. iDeal is however not the only payment product for which this applies. If you have filtered out the fields in the GET payment products call you can retrieve only the directory entries associated with a single payment product using this call. If you are looking to get all details on all payment products including the entries of possible directories we encourage you to use the Retrieve payment products API call without the fields filter. Usually the performance penalty is bigger when you need to do multiple calls with a small response package than one call with a bigger response package. You are however free to choose the best solution for your use case.

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 of the transaction

Request example

SDK: Ruby

This scenario you will probably use the most

  • query = Products::DirectoryParams.new
query.country_code = 'NL'
query.currency_code = 'EUR'

response = client.v1.merchant('merchantId').products.directory(809, query)

Responses

Please find below an overview of the possible responses.

Response 200 - OKDirectory

An array of the directory entries is returned that can be used to populate the GUI element that allows the consumer to make the selection

Properties
Property Type Required Details
close

Description

List of entries in the directory
close
  • SDK Object type
    DirectoryEntry
close

Description

Country name of the issuer, used to group issuers per country
Note: this is only filled if supported by the payment product.
close

Description

Unique ID of the issuing bank of the customer
close

Description

To be used to sort the issuers.
  • short - These issuers should be presented at the top of the list
  • long - These issuers should be presented after the issuers marked as short
Note: this is only filled if supported by the payment product. Currently only iDeal (809) support this. Sorting within the groups should be done alphabetically.
close

Description

Name of the issuing bank, as it should be presented to the customer

Response example

SDK: Ruby

This scenario you will probably use the most

  • {
    "entries" : [
        {
            "countryNames" : [
                "Nederland"
            ],
            "issuerId" : "ABNANL2A",
            "issuerList" : "short",
            "issuerName" : "ABN Amro Bank"
        },
        {
            "countryNames" : [
                "Nederland"
            ],
            "issuerId" : "ASNBNL21",
            "issuerList" : "long",
            "issuerName" : "ASN Bank"
        }
    ]
}

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

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 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: Ruby

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 directory 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

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 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: Ruby

This scenario you will probably use the most

  • {
    "errorId" : "3caa7750-a076-48b2-9402-3cb9eea613a6-00001532",
    "errors" : [
        {
            "code" : "210390",
            "message" : "NO DIRECTORY FOUND"
        }
    ]
}