Sign in

v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB
Enrollment Endpoints

Enroll a payment method

post/v1/merchants/{merchant-id}/enrollments

Path parameters

merchant-idstring required

Unique identifier for the merchant

Request body

paymentMethodstring required

The payment method to be enrolled.

webhooksUrlstring

The URL to which the enrollment state changes will be notified.

Example request

{
  "paymentMethod": "WERO",
  "webhooksUrl": "https://webshop.com/webhooks/enrollment-status"
}

Response

OK

idstring

The enrollment identifier.

status'INITIATED' | 'PROVIDER_PENDING' | 'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'FAILED'

The enrollment status.

paymentMethodstring

The enrollment payment method.

createdAtstring date-time

The enrollment creation timestamp in ISO 8601 format.

updatedAtstring date-time

The enrollment update timestamp in ISO 8601 format.

Example response

{
  "id": "enrollment_XGAvKrnL8EsQjQwGj8FUc",
  "paymentMethod": "WERO",
  "createdAt": "2026-04-21T11:23:47.123Z",
  "updatedAt": "2026-04-21T11:23:47.123Z"
}