POST /2026-2/onboardings
Oauth2 Oauth2

Creates a new onboarding process for a specific user.

application/json

Body Required

  • cancelRedirectUrl string(uri) Required

    The URL to which the user will be redirected after a cancelled onboarding.

  • failureRedirectUrl string(uri) Required

    The URL to which the user will be redirected after a failed onboarding.

  • kind string Required

    The kind of the payment method to be created.

  • metadata object

    An optional metadata object that is passed to the underlying payment integration. The requirements may vary for each provider.

    Additional properties are allowed.

  • proxy boolean

    Determines if the payment method will be created as proxy payment method.

    Default value is false.

  • successRedirectUrl string(uri) Required

    The URL to which the user will be redirected after a successful onboarding.

  • userId string(uuid)

    The unique identifier of the user associated with the onboarding. Required if not requesting with the :authenticated scope.

Responses

  • 201 application/json

    The onboarding was successfully created.

    Hide response attribute Show response attribute object
    • data object Required

      The onboarding that was created.

      Hide data attributes Show data attributes object
      • cancelRedirectUrl string(uri) Required

        The URL to which the user will be redirected after a cancelled onboarding.

      • cancelledAt string(date-time) | null Required

        The date and time when the onboarding was cancelled.

      • clientOnboardingUrl string(uri) Required

        The URL which the user will need to visit to complete the onboarding.

      • completedAt string(date-time) | null Required

        The date and time when the onboarding was completed.

      • createdAt string(date-time) Required

        The date and time when the onboarding was created.

      • expiresAt string(date-time) | null Required

        The date and time when the onboarding will expire.

      • failedAt string(date-time) | null Required

        The date and time when the onboarding has failed.

      • failureRedirectUrl string(uri) Required

        The URL to which the user will be redirected after a failed onboarding.

      • id string(uuid) Required

        The unique identifier for the onboarding.

      • kind string Required

        The kind of the payment method to be created.

      • metadata object | null Required

        An optional metadata object that is passed to the underlying payment integration. The requirements may vary for each provider.

        Additional properties are allowed.

      • proxy boolean Required

        Determines if the payment method will be created as proxy payment method.

      • status string Required

        The current status of the onboarding process.

        Values are PENDING, COMPLETED, FAILED, or CANCELLED.

      • successRedirectUrl string(uri) Required

        The URL to which the user will be redirected after a successful onboarding.

      • updatedAt string(date-time) Required

        The date and time when the onboarding was last updated.

      • userId string(uuid) Required

        The unique identifier of the user associated with the onboarding.
  • 401

    Client authentication failed.

  • 403

    Missing one or more required scopes.

  • 500

    An internal server error occurred.

POST /2026-2/onboardings 
curl \
 --request POST 'https://api.pace.cloud/payment/2026-2/onboardings' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"cancelRedirectUrl":"https://example.com/cancel","failureRedirectUrl":"https://example.com/failure","kind":"FUEL_CARD_PROVIDER","metadata":{},"proxy":true,"successRedirectUrl":"https://example.com/success","userId":"c7bf1e9e-6ea0-445c-b3ae-e814a109416b"}'
Request examples 
{
  "cancelRedirectUrl": "https://example.com/cancel",
  "failureRedirectUrl": "https://example.com/failure",
  "kind": "FUEL_CARD_PROVIDER",
  "metadata": {},
  "proxy": true,
  "successRedirectUrl": "https://example.com/success",
  "userId": "c7bf1e9e-6ea0-445c-b3ae-e814a109416b"
}
Response examples (201) 
{
  "data": {
    "cancelRedirectUrl": "https://example.com/cancel",
    "cancelledAt": "2023-10-01T12:00:00.000Z",
    "clientOnboardingUrl": "https://example.com/onboarding",
    "completedAt": "2023-10-01T12:00:00.000Z",
    "createdAt": "2023-10-01T12:00:00.000Z",
    "expiresAt": "2023-10-01T12:00:00.000Z",
    "failedAt": "2023-10-01T12:00:00.000Z",
    "failureRedirectUrl": "https://example.com/failure",
    "id": "565aa839-876b-4f24-8de0-dd8df72eda17",
    "kind": "FUEL_CARD_PROVIDER",
    "metadata": {},
    "proxy": true,
    "status": "PENDING",
    "successRedirectUrl": "https://example.com/success",
    "updatedAt": "2023-10-01T12:00:00.000Z",
    "userId": "c7bf1e9e-6ea0-445c-b3ae-e814a109416b"
  }
}