GEgetpaid
Applications

Cancel an application

Cancels a duplicate or abandoned application. Both onboarding and change_request applications can be cancelled.

Applications in approved, completed, or already cancelled status cannot be cancelled and return a validation error.

The response returns the updated application with status set to cancelled and the hosted flow cleared. For change requests, cancellation closes the open workflow so a new change request can be created for the same seller account.

post/v2/applications/{application_id}/cancel

Request

Path parameters

application_idstring id required

The unique identifier of the onboarding application.

Example:app_4fekhxdpss1et7rjp8t7rdpnw4

The ID of the application to cancel.

Headers

Getpaid-Idempotency-Keystring required
Example:5c255194-30ec-11ed-a261-0242ac120002

A unique idempotency key to allow safe retrying. See Getpaid API idempotency for more details.

Response

OK

idstring id required

The unique identifier of the onboarding application.

status'initiated' | 'identity_verified' | 'submitted' | 'screened' | 'approved' | 'completed' | 'cancelled' | 'expired' required

The status of the onboarding application.

referencestring

An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.

created_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

updated_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

expires_atstring date-time required

UTC timestamp in ISO 8601 format with milliseconds (RFC 3339). Always includes the 'Z' UTC indicator.

Example response

{
  "id": "app_4fekhxdpss1et7rjp8t7rdpnw4",
  "reference": "ORD-202510-0232",
  "account": {
    "id": "acc_44678r08jtm8zbt227tzhc4nw5"
  },
  "business": {
    "legal_name": "Garage Germany AG",
    "country": "DE",
    "registered_address": {
      "line1": "Immermannstraße",
      "line2": "Haus 2, Wohnung 3A",
      "street_number": "40",
      "city": "Düsseldorf",
      "region": "Nordrhein-Westfalen",
      "postal_code": "40210"
    },
    "registration_number": {
      "type": "vat",
      "value": "DE123456789"
    }
  },
  "applicant": {
    "email": "jane.doe@company.com",
    "first_name": "Markus",
    "last_name": "Doe"
  },
  "flow": {
    "next_step": {
      "expires_at": "2025-09-01T22:05:48.479Z"
    }
  },
  "created_at": "2025-09-01T22:05:48.479Z",
  "updated_at": "2025-09-01T22:05:48.479Z",
  "expires_at": "2025-09-01T22:05:48.479Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.