Actions
cancel-payment
Cancel a payment. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
confirm-mandate-funds
Confirm that the PSU has the given funds. This API can be called using the mandate_token associated with the mandate or using a backend bearer token.
create-mandate
Create a new mandate. This API must be called using a backend bearer token.
create-payment
Create a new payment. This API must be called using a backend bearer token.
create-payment-link
Create a new payment link. This API must be called using a backend bearer token.
create-payment-refund
Refund a merchant account payment, either fully or partially.
create-payout
Pay out from one of your merchant accounts.
custom_api_call
Make a custom API call to a specific endpoint
get-constraints
Retrieve the constraints defined on the mandate, as well as the current utilization of those constraints within the periods.
get-mandate
Returns a mandate with the stated ID. This endpoint can be called either by the regular `backend token` or the `mandate token` for that mandate.
get-merchant-account-payment-sources
Get the payment sources from which the merchant account has received payments.
get-operating-account
Get the details of a single merchant account.
get-payment
Returns payment details. This API can be called using either the `resource_token` associated with the payment or a backend bearer token.
get-payment-link
Retrieves payment link details. This API must be called using a backend bearer token.
get-payment-link-payments
List all the payments associated with the payment link. This API must be called using a backend bearer token.
get-payment-provider
Returns payment provider details. This API can be called without the need for authentication.
get-payment-refund
Returns refund details for a specific payment.
get-payment-refunds
Returns all refunds of a payment.
get-payout
Returns payout details.
list-mandate
List all the mandates associated with the client. This API must be called using a backend bearer token.
list-operating-accounts
List all your TrueLayer merchant accounts. There might be more than one account per currency.
merchant-account-disable-sweeping
Disable automatic sweeping for a merchant account.
merchant-account-get-sweeping
Get the automatic sweeping settings for a merchant account.
merchant-account-get-transactions
Get the transactions of a single merchant account. If pagination is missing, add a header `tl-enable-pagination: true` to enable pagination.
merchant-account-setup-sweeping
Set the automatic sweeping settings for a merchant account. At regular intervals, any available balance in excess of the configured `max_amount_in_minor` is withdrawn to a pre-configured IBAN.
revoke-mandate
Revoke a mandate. This API must be called using a backend bearer token.
save-user-account-payment
Save the account details associated with a payment for subsequent re-use. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
search-payment-providers
Returns a list of payment providers.
start-mandate-authorization-flow
Start the authorization flow for a mandate. This API can be called using either the mandate_token associated with the mandate or a backend bearer token.
start-payment-authorization-flow
Start the authorization flow for a payment. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
start-payout-authorization-flow
Start the authorization flow for a payout. This API can be called using the `resource_token` associated with the payout you are trying to fetch.
submit-consent
Submit the consent given by the user. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
submit-consent-mandate
Submit the consent given by the user. This API can be called using either the mandate_token associated with the mandate or a backend bearer token.
submit-form
Submit form details filled by the PSU. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
submit-mandate-provider-selection
Submit the provider details selected by the PSU. This API can be called using either the mandate_token associated with the mandate or a backend bearer token.
submit-payments-provider-return-parameters
Submit direct return query and fragment parameters returned from the provider.
submit-provider-selection
Submit the provider details selected by the PSU. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
submit-scheme-selection
Submit the scheme details selected by the PSU. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
submit-user-account-selection
Submit the user account selection option given by the user. This API can be called using the `resource_token` associated with the payment or a backend bearer token.
