Skip to main content
GET
/
payments
/
bank-validation
/
truelayer
/
auth
/
init
Initiate TrueLayer OAuth flow
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/payments/bank-validation/truelayer/auth/init \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "success": true,
  "auth_url": "<string>"
}

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Query Parameters

​
providers
string

Comma-separated TrueLayer provider IDs to show (e.g. lloyds,barclays). Omit to show all supported banks.

Response

Auth URL to redirect the user to

​
success
boolean
​
auth_url
string<uri>