Management API v1 ‐ v3

What's New

POST /terminals/{terminalId}/reassign

Reassign a terminal

POST /companies/{companyId}/androidApps

Upload Android App

What's Changed

---

POST /terminals/scheduleActions

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Deleted property terminalIds (object)

    A list of unique IDs of the terminals that the action applies to.

POST /companies/{companyId}/webhooks

Request:

Changed content type : application/json

• Added property encryptionProtocol (object)

  SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

  If not specified, the webhook will use sslVersion: TLSv1.2.

  Enum values:

  • HTTP
  • TLSv1.2
  • TLSv1.3

• Deleted property sslVersion (object)

  SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

  If not specified, the webhook will use sslVersion: TLSv1.2.

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Added property encryptionProtocol (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

  • Deleted property sslVersion (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

GET /companies/{companyId}/webhooks/{webhookId}

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Added property encryptionProtocol (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

  • Deleted property sslVersion (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

PATCH /companies/{companyId}/webhooks/{webhookId}

Request:

Changed content type : application/json

• Added property encryptionProtocol (object)

  SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

  If not specified, the webhook will use sslVersion: TLSv1.2.

• Deleted property sslVersion (object)

  SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

  If not specified, the webhook will use sslVersion: TLSv1.2.

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Added property encryptionProtocol (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

  • Deleted property sslVersion (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

POST /merchants/{merchantId}/paymentMethodSettings

Request:

Changed content type : application/json

• Added property storeIds (object)

  The unique identifier of the store for which to configure the payment method, if any.

• Deleted property storeId (object)

  The ID of the store, if any.

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Added property storeIds (object)

    The unique identifier of the store for which to configure the payment method, if any.

  • Deleted property storeId (object)

    The ID of the store, if any.

GET /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Added property storeIds (object)

    The unique identifier of the store for which to configure the payment method, if any.

  • Deleted property storeId (object)

    The ID of the store, if any.

PATCH /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Added property storeIds (object)

    The unique identifier of the store for which to configure the payment method, if any.

  • Deleted property storeId (object)

    The ID of the store, if any.

POST /merchants/{merchantId}/stores

Request:

Changed content type : application/json

• Changed property phoneNumber (object)

  The phone number of the store, including '+' and country code in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Changed property phoneNumber (object)

    The phone number of the store, including '+' and country code in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.

GET /merchants/{merchantId}/stores/{storeId}

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Changed property phoneNumber (object)

    The phone number of the store, including '+' and country code in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.

PATCH /merchants/{merchantId}/stores/{storeId}

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Changed property phoneNumber (object)

    The phone number of the store, including '+' and country code in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.

POST /merchants/{merchantId}/webhooks

Request:

Changed content type : application/json

• Added property encryptionProtocol (object)

  SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

  If not specified, the webhook will use sslVersion: TLSv1.2.

• Deleted property sslVersion (object)

  SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

  If not specified, the webhook will use sslVersion: TLSv1.2.

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Added property encryptionProtocol (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

  • Deleted property sslVersion (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

GET /merchants/{merchantId}/webhooks/{webhookId}

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Added property encryptionProtocol (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

  • Deleted property sslVersion (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

PATCH /merchants/{merchantId}/webhooks/{webhookId}

Request:

Changed content type : application/json

• Added property encryptionProtocol (object)

  SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

  If not specified, the webhook will use sslVersion: TLSv1.2.

• Deleted property sslVersion (object)

  SSL version to access the public webhook URL specified in the url field. Possible values:

  • TLSv1.3
  • TLSv1.2
  • HTTP - Only allowed on Test environment.

  If not specified, the webhook will use sslVersion: TLSv1.2.

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Added property encryptionProtocol (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

  • Deleted property sslVersion (object)

    SSL version to access the public webhook URL specified in the url field. Possible values:

    • TLSv1.3
    • TLSv1.2
    • HTTP - Only allowed on Test environment.

    If not specified, the webhook will use sslVersion: TLSv1.2.

POST /stores

Request:

Changed content type : application/json

• Changed property phoneNumber (object)

  The phone number of the store, including '+' and country code in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Changed property phoneNumber (object)

    The phone number of the store, including '+' and country code in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.

GET /stores/{storeId}

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Changed property phoneNumber (object)

    The phone number of the store, including '+' and country code in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.

PATCH /stores/{storeId}

Return Type:

Changed response : 200 OK

OK - the request has succeeded.

• Changed content type : application/json

  • Changed property phoneNumber (object)

    The phone number of the store, including '+' and country code in the E.164 format. If passed in a different format, we convert and validate the phone number against E.164.