API Reference
Asset librariesConsole

Create mandate

post
https://api.truelayer-sandbox.com/v3/mandates

Create a new mandate

This API must be called using a backend bearer token.

📘

Endpoint path changes

All Payments API v3 endpoints now start with /v3/. The old endpoints still work, but you must use the new path for all new integrations.

Body Params
mandate
required
string
enum
required
Allowed:
user
object
required

Details of the end user who is making the payment. If you are using your own PISP licence, these fields are not required.

Payments over a mandate don't need user information as this was collected at mandate creation.

constraints
object

Sets the limits for the payments that can be created by the mandate.

If a payment is attempted that doesn't fit within these constraints it will fail.

These constraints are considered only for VRP mandates (not direct debit).

metadata
object

Optional field for adding custom key-value data to a resource. This object can contain a maximum of 10 key-value pairs, each with a key with a maximum length of 40 characters and a non-null value with a maximum length of 500 characters.

related_products
object

Optional field for adding related products, at least one product should be set.
Not available when creating recurring payments.

sub_merchants
object

The details related to any applicable sub-merchants, for example an underlying division of the overall business.

Headers
string
required

An idempotency key to allow safe retrying without the operation being performed multiple times.
The value should be unique for each operation, e.g. a UUID, with the same key being sent on a retry of the same request.

string
required

A JWS with detached content, signed with your private key.
See Request Signing

string
enum
Defaults to application/json; charset=UTF-8

Generated from available response content types

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json; charset=UTF-8
application/problem+json; charset=UTF-8

Updated about 2 months ago

Did this page help you?