PayFit AccessToken
CertifiedExchange a PayFit authorization code
PayFit AccessToken
Exchange a PayFit authorization code
Exchanges an OAuth 2.0 authorization code at POST https://oauth.payfit.com/token using application/x-www-form-urlencoded. No API key is sent. The access token is valid for the company that approved the integration. Kestra encrypts the access token output only when kestra.encryption.secret-key is configured. Without that key, the execution output contains the token in clear text.
type: io.kestra.plugin.payfit.auth.AccessTokenExamples
Exchange a partner authorization code
id: payfit_access_token
namespace: company.team
tasks:
- id: token
type: io.kestra.plugin.payfit.auth.AccessToken
clientId: "{{ secret('PAYFIT_CLIENT_ID') }}"
clientSecret: "{{ secret('PAYFIT_CLIENT_SECRET') }}"
code: "{{ inputs.code }}"
redirectUri: "https://example.com/payfit/callback"
Properties
clientId *string
OAuth client id
clientSecret *string
OAuth client secret
code *string
Authorization code returned to the redirect URI
redirectUri *string
Redirect URI used when the authorization code was issued
grantType string
authorization_codeOAuth grant type. Defaults to authorization_code
oauthUrl string
https://oauth.payfit.comOAuth base URL. Defaults to https://oauth.payfit.com
options
HTTP client options
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
Outputs
accessToken string
Access token to send as a bearer token on Partner API requests, encrypted in the execution outputs
companyId string
Company id, when PayFit returns one with the token
expiresIn integer
Lifetime in seconds, when PayFit returns expires_in
scope string
Granted scopes
tokenType string
Token type
