v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
ContactMethods

ContactMethods:Browse

Get the details of a specific contact method. Note you need to have access to the merchant if the contact method is not available under your own merchant registration.

get/v2/contactmethods

Query parameters

eqstring

Get results that equal the given value

Provides filtering based on merchant code.

{
  "eq": "M-1234-4321"
}

Response

OK

totalinteger nullable

The total items the collection contains

Example response

{
  "contactMethods": [
    {
      "code": "CM-1234-4321",
      "type": "email",
      "value": "sandbox@pay.nl",
      "description": "The email address for the sandbox environment.",
      "public": true,
      "merchant": {
        "code": "M-1234-4321",
        "name": "GMS Demo Merchant",
        "status": "ACTIVE",
        "incorporationCountry": "NL"
      },
      "createdAt": "2024-06-04T08:15:00+01:00",
      "createdBy": "A-1234-4321",
      "modifiedAt": "2024-06-04T08:15:00+01:00",
      "modifiedBy": "A-1234-4321",
      "deletedAt": "A-1234-4321",
      "deletedBy": "A-1234-4321"
    }
  ],
  "total": 10
}