--- updatedAt: 2026-06-08T11:05:39.000Z agentTools: projectIndex: https://developer.pay.nl/llms.txt --- # Merchant:Undelete Undelete a merchant that was recently deleted. This can only be done within a 15 minute time window # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "PAY. Global Management System API's", "description": "A restful journey to your payments.", "termsOfService": "https://www.pay.nl/en/terms-conditions", "contact": { "email": "support@pay.nl" }, "version": "v2.0" }, "servers": [ { "url": "https://rest.pay.nl/v2", "description": "PAY. API server" } ], "paths": { "/merchants/{merchantCode}/undelete": { "post": { "tags": [ "Merchants" ], "summary": "Merchant:Undelete", "description": "Undelete a merchant that was recently deleted. This can only be done within a 15 minute time window", "parameters": [ { "name": "merchantCode", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Merchant/properties/code" } } ], "responses": { "201": { "description": "Ok.", "content": { "application/json": { "schema": { "description": "Merchant", "properties": { "merchant": { "properties": { "code": { "$ref": "#/components/schemas/Merchant/properties/code" }, "status": { "$ref": "#/components/schemas/Merchant/properties/status" }, "payoutStatus": { "$ref": "#/components/schemas/Merchant/properties/payoutStatus" }, "name": { "$ref": "#/components/schemas/Merchant/properties/name" }, "publicName": { "$ref": "#/components/schemas/Merchant/properties/publicName" }, "boardingStatus": { "$ref": "#/components/schemas/Merchant/properties/boardingStatus" }, "clearingAccounts": { "$ref": "#/components/schemas/Merchant/properties/clearingAccounts" }, "postalAddress": { "$ref": "#/components/schemas/Location" }, "visitAddress": { "$ref": "#/components/schemas/Location" }, "contactMethods": { "$ref": "#/components/schemas/Merchant/properties/contactMethods" }, "authenticationTokens": { "items": { "properties": { "code": { "type": "string" }, "secret": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "trademarks": { "items": { "properties": { "code": { "$ref": "#/components/schemas/Trademark/properties/code" }, "type": { "$ref": "#/components/schemas/Trademark/properties/type" }, "name": { "$ref": "#/components/schemas/Trademark/properties/name" }, "status": { "$ref": "#/components/schemas/Trademark/properties/status" } }, "type": "object" } }, "licenses": { "items": { "properties": { "code": { "$ref": "#/components/schemas/Person/properties/code" }, "name": { "$ref": "#/components/schemas/Person/properties/name" }, "language": { "$ref": "#/components/schemas/Person/properties/language" } }, "type": "object" } }, "service": { "properties": { "code": { "$ref": "#/components/schemas/Service/properties/id" }, "secret": { "$ref": "#/components/schemas/Service/properties/secret" }, "name": { "$ref": "#/components/schemas/Service/properties/name" }, "description": { "$ref": "#/components/schemas/Service/properties/description" }, "categoryCode": { "description": "The category (code) identifier", "type": "string", "example": "CY-1234-4321" }, "integrationCode": { "type": "string", "example": "PV-1234-4321" }, "publication": { "type": "string" } }, "type": "object" }, "createdAt": { "$ref": "#/components/schemas/Universal/properties/createdAt" }, "createdBy": { "$ref": "#/components/schemas/Universal/properties/createdBy" }, "modifiedAt": { "$ref": "#/components/schemas/Universal/properties/modifiedAt" }, "modifiedBy": { "$ref": "#/components/schemas/Universal/properties/modifiedBy" }, "deletedAt": { "$ref": "#/components/schemas/Universal/properties/deletedAt" }, "deletedBy": { "$ref": "#/components/schemas/Universal/properties/deletedBy" } }, "type": "object" } }, "type": "object" }, "examples": { "success": { "$ref": "#/components/examples/MerchantUnsuspendResponse200Successful" } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "405": { "$ref": "#/components/responses/MethodNotAllowed" }, "406": { "$ref": "#/components/responses/NotAcceptable" }, "422": { "$ref": "#/components/responses/Unprocessable" }, "429": { "$ref": "#/components/responses/RateLimiting" }, "500": { "description": "An internal error occurred" } }, "security": [ { "basicAuth": [] } ] } } }, "components": { "schemas": { "Address": { "properties": { "code": { "type": "string" }, "firstName": { "$ref": "#/components/schemas/Customer/properties/firstName" }, "lastName": { "$ref": "#/components/schemas/Customer/properties/lastName" }, "streetName": { "description": "The name of the street", "type": "string", "maxLength": 128, "minLength": 1, "example": "Visitlane" }, "streetNumber": { "description": "The street number", "type": "string", "maxLength": 32, "minLength": 1, "example": "13" }, "streetNumberExtension": { "description": "A house number extension is required to deal with appartments or other addresses sharing the same front door", "type": "string", "maxLength": 32, "minLength": 1, "example": "b1" }, "zipCode": { "description": "A zip/postal code. see https://en.wikipedia.org/wiki/List_of_postal_codes for a list of formats per country.", "type": "string", "maxLength": 16, "minLength": 1, "example": "5678CD" }, "city": { "description": "The name of a city", "type": "string", "maxLength": 128, "minLength": 1, "example": "Amsterdam" }, "regionCode": { "description": "Region code (iso-3166-2)", "type": "string", "example": "ZH" }, "countryCode": { "description": "The country code consisting of 2 uppercase letters", "type": "string", "maxLength": 2, "minLength": 2, "example": "NL" } }, "type": "object" }, "BankAccount": { "required": [ "iban", "bic", "owner" ], "properties": { "iban": { "description": "The International Bank Account Number (IBAN).", "type": "string", "example": "NL69INGB0123456789" }, "bic": { "description": "Business Identifier Codes (BIC/SWIFT).", "type": "string", "example": "INGBNL2A" }, "owner": { "description": "The owner of the bank account.", "type": "string", "maxLength": 64, "minLength": 1, "example": "John Doe" } }, "type": "object" }, "ContactMethod": { "properties": { "code": { "description": "The contact method ID of your company starting with CM.", "type": "string", "example": "CM-1234-4321" }, "type": { "description": "The type of contact method.", "type": "string", "enum": [ "email", "email_support", "phone", "phone_helpdesk", "phone_off_hours", "url", "email_msnskype" ], "example": "The type of contact method." }, "value": { "description": "The value of the contact method.", "type": "string", "example": "088-88 666 22" }, "description": { "description": "The description of the contact method.", "type": "string" }, "public": { "description": "Is the contact method public accessible", "type": "boolean", "example": "true" }, "notifications": { "description": "Does the contact method needs to receive notifications", "type": "boolean", "example": "false" } }, "type": "object" }, "Location": { "required": [ "code", "streetName", "zipCode", "city", "countryCode" ], "properties": { "code": { "$ref": "#/components/schemas/Address/properties/code" }, "streetName": { "$ref": "#/components/schemas/Address/properties/streetName" }, "streetNumber": { "$ref": "#/components/schemas/Address/properties/streetNumber" }, "zipCode": { "$ref": "#/components/schemas/Address/properties/zipCode" }, "city": { "$ref": "#/components/schemas/Address/properties/city" }, "countryCode": { "$ref": "#/components/schemas/Address/properties/countryCode" } }, "type": "object" }, "Merchant": { "properties": { "code": { "description": "The merchant id of your company starting with M.", "type": "string", "example": "M-1234-4321" }, "name": { "description": "The name of your merchant.", "type": "string", "maxLength": 128, "minLength": 2, "example": "CompanyName" }, "publicName": { "description": "The public name of your merchant.", "type": "string", "example": "CompanyName" }, "boardingStatus": { "description": "The status of the boarding process for this merchant.", "type": "string", "enum": [ "REGISTERED", "ONBOARDING", "ACCEPTED", "SUSPENDED", "OFFBOARDED" ], "example": "REGISTERED" }, "status": { "description": "Merchant state", "type": "string", "example": "ACTIVE" }, "payoutStatus": { "description": "Merchant payout state", "type": "string", "enum": [ "ENABLED", "DISABLED" ], "example": "Enabled" }, "coc": { "description": "Your Chamber of commerce registration number. This format differs per country.", "type": "string", "example": "12345678" }, "vat": { "description": "Value added tax identification number (VAT identification number).", "type": "string", "example": "NL807960147B01" }, "companyTypeId": { "description": "ID of the company type. The available company types can be retrieved with the Core Data API Companytypes (https://developer.pay.nl/reference/get_companytypes)", "type": "string", "example": "1" }, "countryCode": { "description": "The country code consisting of 2 uppercase letters", "type": "string", "example": "NL" }, "contractLanguage": { "description": "The language code supplied needs to be a locale in i18n format. The available languages can be retrieved with the Core Data API Languages (https://developer.pay.nl/reference/get_languages) where the contractLanguageAvailable flag is set to 'True'", "type": "string", "example": "nl_NL" }, "contractPackage": { "type": "string" }, "contractPackageCode": { "description": "The authorisation group code of the contract package linked to the merchant. Returns null when the merchant has no linked authorisation group.", "type": "string", "example": "AG-1234-4321", "nullable": true }, "currentProfileCode": { "description": "The active company profile code of the merchant.", "type": "string", "example": "CP-1234-4321", "nullable": true }, "contactPhone": { "description": "The primary contact phone number of the merchant.", "type": "string", "format": "phone", "example": "+31612345678" }, "contactEmail": { "description": "The primary contact email address of the merchant.", "type": "string", "format": "email", "example": "info@mycompany.nl" }, "establishmentLegalRegistrationNumber": { "description": "The legal registration number of the establishment/location of the merchant. If omitted and the country code is FR, this defaults to the CoC number.", "type": "string", "example": "12345678901234" }, "accountManager": { "description": "The email address of the active account manager.", "type": "string", "example": "account.manager@pay.nl" }, "website": { "description": "The website.", "type": "string", "format": "uri", "example": "https://www.my-website.com" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "integrations": { "type": "array", "items": { "properties": { "code": { "description": "The plugin identifier.", "type": "string", "example": "PL-3010-1000" }, "name": { "type": "string" } }, "type": "object" } }, "clearingAccounts": { "type": "array", "items": { "required": [ "code", "status", "method", "iban" ], "properties": { "code": { "type": "string" }, "status": { "type": "string", "enum": [ "APPROVED", "DENIED", "NOT_CHECKED" ] }, "method": { "type": "string", "enum": [ "iban" ] }, "iban": { "$ref": "#/components/schemas/BankAccount" } }, "type": "object" } }, "postalAddress": { "$ref": "#/components/schemas/Location" }, "visitAddress": { "$ref": "#/components/schemas/Location" }, "contactMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMethod" } }, "authenticationTokens": { "type": "array", "items": { "properties": { "authenticationTokens": { "type": "string" } }, "type": "object" } }, "trademarks": { "type": "array", "items": { "$ref": "#/components/schemas/Trademark" } }, "licenses": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } }, "services": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "secret": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "category": { "properties": { "code": { "$ref": "#/components/schemas/Category/properties/code" }, "name": { "$ref": "#/components/schemas/Category/properties/name" } }, "type": "object" }, "integration": { "properties": { "code": { "description": "The plugin identifier.", "type": "string", "example": "PL-3010-1000" }, "name": { "type": "string" } }, "type": "object" }, "website": { "description": "The website URL.", "type": "string", "example": "https://www.pay.nl" }, "urls": { "type": "array", "items": { "$ref": "#/components/schemas/WebsiteUrl" } } }, "type": "object" } }, "partner": { "type": "array", "items": { "$ref": "#/components/schemas/Partner" } }, "createdAt": { "$ref": "#/components/schemas/Universal/properties/createdAt" }, "createdBy": { "$ref": "#/components/schemas/Universal/properties/createdBy" }, "acceptedAt": { "type": "string", "format": "date-time", "readOnly": true, "example": "2016-06-04T08:15:00+01:00", "nullable": true }, "suspendedAt": { "type": "string", "format": "date-time", "example": "2016-06-04T08:15:00+01:00", "nullable": true }, "suspendedBy": { "description": "SUSPENDED_BY_DESCRIPTION", "type": "string", "example": "A-1234-4321", "nullable": true }, "modifiedAt": { "$ref": "#/components/schemas/Universal/properties/modifiedAt" }, "modifiedBy": { "$ref": "#/components/schemas/Universal/properties/modifiedBy" }, "deletedAt": { "$ref": "#/components/schemas/Universal/properties/deletedAt" }, "deletedBy": { "$ref": "#/components/schemas/Universal/properties/deletedBy" }, "reviewedAt": { "type": "string", "format": "date-time", "readOnly": true, "example": "2016-06-04T08:15:00+01:00", "nullable": true }, "nextReviewDate": { "type": "string", "format": "date-time" } }, "type": "object" }, "Person": { "properties": { "code": { "type": "string", "example": "AL-1234-4321" }, "secret": { "type": "string", "example": "2jQ5hyjpBG9duCoZQcdD1F8Tb1HxL0oAArKfbCAu" }, "name": { "type": "string" }, "accountCode": { "type": "string", "example": "A-1234-4321" }, "gender": { "description": "The subject's gender. Choose either M for male or F for female.", "type": "string", "example": "M" }, "firstName": { "description": "The forename (also known as a given name, Christian name or a first name).", "type": "string", "maxLength": 64, "minLength": 1, "example": "John", "nullable": true }, "lastName": { "description": "The surname (also known as a family name or a last name).", "type": "string", "maxLength": 128, "minLength": 1, "example": "Doe" }, "email": { "description": "An email address.", "type": "string", "format": "email", "example": "sandbox@pay.nl" }, "language": { "description": "The language code consisting of 2 uppercase letters. Can be one of the following: EN, NL, DE, FR, ES, IT. You can find all available languages here: https://paynl.readme.io/reference/languages", "type": "string", "enum": [ "NL", "EN", "DE", "FR", "IT", "ES" ], "example": "NL" }, "phone": { "description": "The subject's phone number. Optionally prepended with a + and country code", "type": "string", "example": "0031612345678" }, "visitAddress": { "$ref": "#/components/schemas/Address" }, "complianceData": { "$ref": "#/components/schemas/ComplianceDataPerson" } }, "type": "object" }, "Service": { "properties": { "id": { "description": "The ID of your service. You can find the service ID in the portal.", "type": "string", "example": "SL-####-####" }, "name": { "description": "The name of your service.", "type": "string", "example": "My first service!" }, "description": { "description": "The description of the service.", "type": "string" }, "testMode": { "description": "Indicates if the service is in testmode or not, possible values: false or true", "type": "integer" }, "secret": { "description": "The unique reference for this service.", "type": "string", "example": "bade123abf124124abefa311b" }, "createdAt": { "$ref": "#/components/schemas/Universal/properties/createdAt" } }, "type": "object" }, "Trademark": { "required": [ "name" ], "properties": { "code": { "description": "An identifier for this trademark", "type": "string", "example": "TM-0000-0000" }, "type": { "type": "string" }, "name": { "description": "A registered trademark name.", "type": "string" }, "status": { "description": "Status of the trademark.", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/Universal/properties/createdAt" }, "createdBy": { "$ref": "#/components/schemas/Universal/properties/createdBy" }, "modifiedAt": { "$ref": "#/components/schemas/Universal/properties/modifiedAt" }, "modifiedBy": { "$ref": "#/components/schemas/Universal/properties/modifiedBy" }, "deletedAt": { "$ref": "#/components/schemas/Universal/properties/deletedAt" }, "deletedBy": { "$ref": "#/components/schemas/Universal/properties/deletedBy" } }, "type": "object" }, "Universal": { "properties": { "translations": { "description": "Object containing all the translations with the property name in which the corresponds with a property on the object itself.", "type": "object", "uniqueItems": true, "example": "\n \"translations\": {\n \"name\": {\n ...\n },\n \"description\": {\n ...\n }\n }\n", "nullable": true, "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "requiredFields": { "description": "The required fields of the payment method.", "type": "array", "items": { "properties": { "fieldName": { "type": "string" }, "mandatory": { "type": "string" } }, "type": "object" } }, "createdAt": { "description": "The creation date time presented in the correct ISO-8601 (a.k.a. ATOM) notation", "type": "string", "format": "date-time", "readOnly": true, "example": "2016-06-04T08:15:00+01:00", "nullable": false }, "createdBy": { "description": "The reference to an account or token whom created the entity", "type": "string", "pattern": "^A(T)?(-\\d{4}){2}$", "readOnly": true, "example": "A-1234-4321", "nullable": false }, "modifiedAt": { "description": "The modification date time presented in the correct ISO-8601 (a.k.a. ATOM) notation", "type": "string", "format": "date-time", "readOnly": true, "example": "2016-06-04T08:15:00+01:00", "nullable": true }, "modifiedBy": { "description": "The reference to an account or token whom modified the entity", "type": "string", "pattern": "^A(T)?(-\\d{4}){2}$", "readOnly": true, "example": "A-1234-4321", "nullable": true }, "deletedAt": { "description": "The deletion date time presented in the correct ISO-8601 (a.k.a. ATOM) notation. Can be empty (null)", "type": "string", "format": "date-time", "readOnly": true, "example": "2016-06-04T08:15:00+01:00", "nullable": true }, "deletedBy": { "description": "The reference to an account or token whom deleted the entity", "type": "string", "pattern": "^A(T)?(-\\d{4}){2}$", "readOnly": true, "example": "A-1234-4321", "nullable": true } }, "type": "object" }, "Error": { "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "violations": { "type": "array", "items": { "$ref": "#/components/schemas/Violation" } } }, "type": "object" }, "Violation": { "properties": { "propertyPath": { "type": "string" }, "message": { "type": "string" }, "code": { "type": "string" } }, "type": "object" } }, "responses": { "Unauthorized": { "description": "Unauthorized. Supplied credentials are invalid" }, "Forbidden": { "description": "Forbidden. Supplied credentials have no rights" }, "NotFound": { "description": "Not found" }, "MethodNotAllowed": { "description": "Used HTTP method is not allowed" }, "NotAcceptable": { "description": "Not acceptable. The supplied content type in the accept parameter in the header is not supported" }, "Unprocessable": { "description": "Unprocessable entity, see response body for more information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "error": { "summary": "Unprocessable", "value": { "type": "https://developer.pay.nl/docs/error-codes", "title": "An error occurred", "detail": "Unable to complete request", "violations": [ { "propertyPath": null, "message": "Unable to complete request", "code": "PAY-3000" } ] } } } } } }, "RateLimiting": { "description": "Rate limit reached." } }, "examples": { "MerchantUnsuspendResponse200Successful": { "summary": "Merchant", "value": { "merchant": { "code": "M-1234-4321", "status": "INACTIVE", "payoutStatus": "ENABLED", "name": "CompanyName", "publicName": "publicName", "boardingStatus": "ACCEPTED", "clearingAccounts": [ { "code": "BA-1234-4321", "status": "NOT_CHECKED", "method": "iban", "iban": { "iban": "NL91ABNA0417164300", "bic": "INGBNL2A", "owner": "John Doe" } } ], "postalAddress": { "code": "AS-1234-43", "streetName": "Deliverylane", "streetNumber": "70", "zipCode": "5678 CD", "city": "Amsterdam", "countryCode": "NL" }, "visitAddress": { "code": "AS-1234-43", "streetName": "Deliverylane", "streetNumber": "70", "zipCode": "5678 CD", "city": "Amsterdam", "countryCode": "NL" }, "contactMethods": null, "authenticationTokens": [ { "code": "AT-1234-4321", "secret": "2jQ5hyjpBG9duCoZQcdD1F8Tb1HxL0oAArKfbCAu", "name": "PAY token" }, { "code": "AT-4321-1234", "secret": "2jQ5hyjpBG9duCoZQcdD1F8Tb1HxL0oAArKfbCAu", "name": "User token" } ], "trademarks": [ { "code": "TM-1234-1234", "type": "name", "name": "CompanyName", "status": "NOT_CHECKED" } ], "licenses": [ { "code": "AL-1234-4321", "secret": "2jQ5hyjpBG9duCoZQcdD1F8Tb1HxL0oAArKfbCAu", "name": "AL-1234-4321", "language": null } ], "service": { "code": "SL-1234-4321", "secret": "2jQ5hyjpBG9duCoZQcdD1F8Tb1HxL0oAArKfbCAu", "name": "companyName", "description": "Sells children's clothing", "categoryCode": "CY-1234-4321", "integrationCode": "PV-1234-4321", "publication": "through cashboard" }, "createdAt": "2014-04-15T11:29:03+02:00", "createdBy": "A-1234-4321", "modifiedAt": null, "modifiedBy": null, "deletedAt": null, "deletedBy": null }, "_links": [ { "href": "/merchants", "rel": "self", "type": "POST" } ] } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "externalDocs": { "description": "Official PAY. documentation", "url": "https://docs.pay.nl" } } ```