Applications

Refresh an application

Renews the hosted application URL so the seller can continue the flow. Both onboarding and change_request applications can be refreshed. The application's top-level expires_at remains unchanged. The refreshed URL is returned in flow.next_step.url; flow.next_step.expires_at is the URL's separate expiration date. Only applications in initiated, identity_verified, or submitted status whose expires_at is still in the future can be refreshed. Other states or a past expiration date return 422. Refreshing does not reactivate an expired application.

post/v2/applications/{application_id}/refresh

Request

Base URL
https://api.getpaid.io
Auth
OAuth 2
Client credentials
Token URLhttps://auth.getpaid.io/oauth/token
Scopesaccounts:read_write
TypeScript
https://skmtc.dev/getpaid/apis/getpaid-api/docs/v2/applications/:application_id/refresh/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

application_idstring id required

The unique identifier of the onboarding application.

Example:app_4fekhxdpss1et7rjp8t7rdpnw4

The ID of the application to refresh.

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

idstring id required

The unique identifier of the onboarding application.

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",
  "updated_at": "2025-09-01T22:05:48.479Z",
  "expires_at": "2025-09-01T22:05:48.479Z",
  "flow": {
    "next_step": {
      "expires_at": "2025-09-01T22:05:48.479Z"
    }
  }
}

Changes

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