Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
ContactMethods

ContactMethod:Create

Creates a new contact method for a merchant. You can indicate per contact method if the contact details are public. If they are public they can be used in communication with end users. You can also supply a merchantCode. If a merchantCode is supplied then you need to have access to that merchant.

post/v2/contactmethods

Request body

merchantCodestring

The merchant id of your company starting with M.

Response

Created

codestring

The CM-code for a contact method.

type'email' | 'email_support' | 'phone' | 'phone_helpdesk' | 'phone_off_hours' | 'url' | 'messaging_app' | 'email_msnskype'

The type of contact method.

valuestring

The value of the contact method

descriptionstring nullable

The description of the contact method

publicboolean

Is the contact method public accessible

notificationsboolean

Does the contact method needs to receive notifications

createdAtstring date-time nullable

The date and time at which this entity was created in ISO-8601 (ATOM) notation

createdBystring nullable

The reference to an account or token whom created the entity

modifiedAtstring date-time nullable

The date and time at which this entity was modified in ISO-8601 (ATOM) notation.

modifiedBystring nullable

The reference to an account or token whom modified this entity

deletedAtstring date-time nullable

The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.

deletedBystring nullable

The reference to an account or token whom deleted the entity

Example response

{
  "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"
}