Deposits [PayDirect]

Learn how to set up, execute, and monitor the progress of a deposit with the PayDirect API.

📘
This feature is in private beta.

A deposit is a one-time payment into your merchant account that requires your user to authorise the payment with their bank. Deposits have a limit of 1000 amount_in_minor (10 GBP/EUR) in the sandbox environment.

Choose a provider

Before you can create a deposit, you need to choose providers to filter by. To do this, use the /providers endpoint.

The /providers endpoint serves three purposes:

Tells you which banks are currently active (when a bank is temporarily unavailable, we hide them from this list until its service is restored).
Gives you the assets (for example, logos) to build out a provider selection screen.
Tells you the available schemes, auth flows, and input requirements for each provider.

Use these query parameters to filter the providers that are returned:

Field	Available Values	Mandatory	Description
`auth_flow_type`	`redirect` `embedded`	Mandatory	Will only return providers with schemes that support the listed auth flows.
`account_type`	`sort_code_account_number` `iban` `bban` `nrb`	Mandatory	Will only return providers with schemes that support the listed account identifiers.
`currency`	ISO 4217 currency codes for example, `GBP,EUR`	Mandatory	Will only return providers with schemes that support the listed currencies.
`country`	ISO 3166-1 alpha-2 country codes for example, `GB,FR`	Optional	Will only return providers from the listed countries.
`additional_input_type`	`text` `select` `text_with_image`	Optional	Will filter out any provider schemes that require `additional_inputs` field types not specified (including any on subsequent inputs as part of the embedded flow). If you leave this out, will only return provider schemes that have no required additional inputs.
`release_channel`	`live` `public_beta` `private_beta`	Optional	Determines which providers to return. If omitted, returns all `live` providers. Returns providers for the value you provide, and also any that are more mature. `live` is the most mature and `private_beta` is the least mature. For example, a value of `public_beta` returns all providers in `public_beta` and `live`.

Each available provider has these fields:

Field	Type	Description
`provider_id`	`string`	This is the provider ID that you will send us in the create payment request.
`logo_url`	`string`	This is the address of the logo asset in SVG form.
`display_name`	`string`	This is a readable name for the provider.
`country`	`string`	The ISO 3166-1 alpha-2 country code for the provider.
`divisions`	`string[]`	This array includes all divisions that are available on this provider. For example, `retail` and `business` would indicate you can use this single provider to access both retail and business accounts.
`deposit_schemes`	`DepositScheme[]`	The array lists the available schemes the provider can use, within each is described the requirements for the fields on the deposit initiation request.
`release_stage`	`string`	This indicates the product maturity of the provider. `live` and `public_beta` providers are visible to everyone, while `private_beta` providers must be enabled for the `client_id` provided in the query parameters to be visible. Possible values: `live`, `public_beta`, `private_beta`.

🚧
Note
We do not recommend that you store information from the /v2/single-immediate-payments-providers endpoint locally. This is because we update the response returned by this endpoint a few times every quarter, and sometimes information about providers will change.

`DepositScheme`

Field	Type	Description
`scheme_id`	`string`	A unique identifier for the scheme, shared across providers. This should be provided on the `deposit.scheme_id` field on the initiation request.
`fee_options` (optional)	`FeeOption[]`	If present, then fees are payable to make a payment on the scheme, and you must choose an option in this list when initiating a payment.
`requirements`	`DepositRequirements[]`	Contains at least one set of requirements. You need to meet at least one set to create a valid initiation request for the scheme.

`FeeOption`

Field	Type	Description
`fee_option_id`	`string`	A unique identifier for the fee option, shared across providers. This should be provided on the `deposit.fee_option_id` field in the initiation request.
`beneficiary_fee`	`string`	A value to indicate if the beneficiary pays any fees on the transaction, when using this fee option. Values: `free`, `payable`, `unknown`
`remitter_fee`	`string`	A value to indicate if the remitter pays any fees on the transaction, when using this fee option. Values: `free`, `payable`, `unknown`

`DepositRequirements`

Each property in the requirements object corresponds with an identically named property in the initiation request for a deposit.

The tables below show you the requirement types you need to build a valid initiation request.

Field	Child Field	Type	Description
`auth_flow`	-	AuthFlowRequirements	Which auth flows are supported, and what fields are required/available to initiate a payment for those flows.
`deposit`	`currency`	CurrencyRequirements	Which currencies are supported.
`deposit`	`beneficiary`	ParticipantRequirements	Which beneficiary details are required/supported.
`deposit`	`remitter` (optional)	`ParticipantRequirements`	Which remitter details are required/supported. If this is not present, the scheme does not support receiving remitter details.
`deposit`	`references`	ReferenceRequirements	Which reference types are required/supported.

`AuthFlowRequirements`

Field	Type	Description
`types`	`string[]`	A list of supported auth flow types. Values: `redirect`,`embedded`.
`redirect` (optional)	RedirectAuthFlowRequirements	Will be set if `redirect` is supported.
`embedded` (optional)	EmbeddedAuthFlowRequirements	Will be set if `embedded` is supported.

`RedirectAuthFlowRequirements`

Field	Type	Description
`psu_ip_address_required` (optional)	boolean	Indicates whether you need to include `auth_flow.psu_ip_address` in the initiation request.
`data_access_token_supported` (optional)	boolean	Indicates if `auth_flow.data_access_token` can be provided on the initiation request. This maintains long-lived consents across both Data API and Payment API, where the provider only allows a single active consent across both.
`additional_inputs` (optional)	`AdditionalInputs`	An optional dictionary of IDs for additional inputs that must be collected from the end user to initiate a payment. Provide these inputs using the same IDs in the `auth_flow.additional_inputs` string dictionary in the initiation request.

`EmbeddedAuthFlowRequirements`

Field	Type	Description
`additional_input_types`	`string[]`	A list of additional input field types that may be returned during the embedded authorisation flow (not including those required on initiation below). Values: `text`, `text_with_image`, `select`.
`additional_inputs` (optional)	`Additional_Inputs`	An optional dictionary of ID to additional inputs that must be collected from the end user to initiate a payment. These inputs should be provided using the same IDs in the `auth_flow.additional_inputs` string dictionary on the initiation request.

`CurrencyRequirements`

Field	Type	Description
`supported_currencies`	`string[]`	A list of ISO 4217 currency codes supported by the provider scheme.

`ParticipantRequirements`

Field	Child Field	Type	Description
`account`	`types`	`string[]`	A list of account types supported by the scheme. Values: `sort_code_account_number`, `iban`, `bban`, `nrb`.
`name` (optional)	-	`StringFieldRequirements`	An object detailing the requirements for the name. If not present, you cannot set the name on the initiation request with this scheme.
`mandatory`	-	bool	If a `remitter` is required. Not present on `beneficiary`, which is always mandatory.

`ReferenceRequirements`

Field	Child Field	Type	Description
`types`	-	`string[]`	A list of supported reference types. Values: `single`,`separate`
`single` (optional)	-	`StringFieldRequirements`	Will be set if `single` is supported. Specifies the requirements for a single reference string for the payment.
`separate` (optional)	`beneficiary`	`StringFieldRequirements`	Will be set if `separate` is supported. Specifies the requirements for the beneficiary reference string for the payment.
`separate` (optional)	`remitter`	`StringFieldRequirements`	Will be set if `separate` is supported. Specifies the requirements for the remitter reference string for the payment.

`StringFieldRequirements`

Field	Type	Requirement Description
`mandatory`	`boolean`	The corresponding field on the request is mandatory.
`min_length`	`integer`	The corresponding field on the request must be at least this many characters.
`max_length`	`integer`	The corresponding field on the request must be at most this many characters.
`regex`	`string`	The corresponding field on the request must match the regular expression.
`format`	`string`	A format to help you communicate to your client how the field will be validated. Values: `any`, `numerical`, `alphabetical`, `alphanumerical`, `email`

`AdditionalInputs`

The additional_inputs object in responses is a dictionary of input IDs to an object describing the input required. The structure of the input object differs based on the type property, and can be one of the following:

Input Type	Description	Corresponding Request Value
text	Requires the end user to enter a string value	The string value that the end user entered
text_with_image	Displays an image to the end user and requires them to enter a string value	The string value that the end user entered
select	Provides a list of options for the end user to select from	The `id` of the selected option

Text Input

Field	Type	Description
`type`	`string`	Value indicating the field type: `text`
`display_text`	`string`	Text to describe what the field is asking for (English)
`provider_description` (optional)	`string`	Text directly from the bank relating to the field
`mandatory`	`boolean`	Indicates that the input must be provided
`sensitive`	`boolean`	Indicates that the input is sensitive (so should be masked in your UI)
`min_length`	`integer`	The minimum length of the input text
`max_length`	`integer`	The maximum length of the input text
`regex`	`string`	A regular expression the input text must match
`format`	`string`	Allows you to show useful prompts to the user. Values: `any`, `numerical`, `alphabetical`, `alphanumerical`, `email`

{
  "some_input_id": {
    "type": "text",
    "display_text": "Some display text in English",
    "provider_description": "A message from the bank",
    "mandatory": true,
    "sensitive": false,
    "min_length": 5,
    "max_length": 15,
    "regex": "^[a-z ]{5,15}$",
    "format": "alphabetical"
  }
}

{
  "some_input_id": "entered value"
}

Text With Image Input

Field	Type	Description
`type`	`string`	Value indicating the field type: `text_with_image`
`display_text`	`string`	Text to describe what the field is asking for (English)
`provider_description` (optional)	`string`	Text directly from the bank relating to the field
`mandatory`	`boolean`	If the input must be provided
`sensitive`	`boolean`	If the input is sensitive (and should be masked in your UI)
`min_length`	`integer`	The minimum length of the input text
`max_length`	`integer`	The maximum length of the input text
`regex`	`string`	A regular expression the input text must match
`format`	`string`	A format to show useful prompts to the user. Values: `any`, `numerical`, `alphabetical`, `alphanumerical`, `email`
`image`	`object`	An image to display to the end user (for example, QR code). The image object can be of two types, `base64` or `uri`. If `type` is `base64`, there will be a `base64` property containing the base64 `data` and `media_type`. If `type` is `uri`, there will be a `uri` property with a URI to a hosted copy of the image.

{
  "some_input_id": {
    "type": "text_with_image",
    "display_text": "Some display text in English",
    "provider_description": "A message from the bank",
    "mandatory": true,
    "sensitive": false,
    "min_length": 5,
    "max_length": 15,
    "regex": "^[a-z ]{5,15}$",
    "format": "alphabetical",
    "image": {
      "type": "base64",
      "base64": {
        "data":
"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8vlr6PwAHHAK+MKsa+gAAAABJRU5ErkJggg==",
        "media_type": "image/png"
      }
    }
  }
}

{
  "some_input_id": "entered value"
}

Select Input

Field	Type	Description
`type`	`string`	Value indicating the field type: `select`
`display_text`	`string`	Text to describe what the field is asking for (English)
`provider_description` (optional)	`string`	Text directly from the bank relating to the field
`mandatory`	`boolean`	If the input must be provided
`options`	SelectOption[]	A list of `id`-`display_text` pairs to present to the end user as options (for example, a dropdown).

{
  "some_input_id": {
    "type": "select",
    "display_text": "Some display text in English",
    "provider_description": "A message from the bank",
    "mandatory": true,
    "options": [
      {
        "id": "option-a",
        "display_text": "First Option"
      },
      {
        "id": "option-b",
        "display_text": "Second Option"
      }
    ]
  }
}

{
  "some_input_id": "option-b"
}

`SelectOption`

Field	Type	Description
`id`	`string`	Value to be provided on the initiation request, if the option is selected
`display_text`	`string`	Text to describe the option

https://paydirect.truelayer-sandbox.com/v1/deposits/providers?auth_flow_type=redirect,embedded&account_type=sort_code_account_number,iban&additional_input_type=text,select&currency=GBP,EUR

You'll get a response like this:

{
  "results": [
    {
      "provider_id": "ob-example",
      "logo_url": "https://truelayer-client-logos.s3-eu-west-1.amazonaws.com/banks/ob-example.svg",
      "display_name": "Example OB Bank",
      "country": "GB",
      "divisions": [ "retail", "business" ],
      "deposit_schemes": [
        {
          "scheme_id": "faster_payments_service",
          "requirements": [
            {
              "auth_flow": {
                "types": [ "redirect" ],
                "redirect": {
                  "data_access_token_supported": true
                }
              },
              "deposit": {
                "currency": {
                  "supported_currencies": [ "GBP" ]
                },
                "beneficiary": {
                  "account": {
                    "types": [ "sort_code_account_number" ],
                  },
                  "name": {
                    "mandatory": true,
                    "min_length": 1,
                    "max_length": 20,
                    "regex": "[\\w\\d ]{1,20}",
                    "format": "any"
                  }
                },
                "remitter": {
                  "mandatory": false,
                  "account": {
                    "types": [ "sort_code_account_number" ],
                  },
                  "name": {
                    "mandatory": false,
                    "min_length": 1,
                    "max_length": 20,
                    "regex": "[\\w\\d ]{1,20}",
                    "format": "any"
                  }
                },
                "references": {
                  "types": [ "single", "separate" ],
                  "single": {
                    "min_length": 1,
                    "max_length": 20,
                    "regex": "[\\w\\d \\.-]{1,20}",
                    "format": "any"
                  },
                  "separate": {
                    "beneficiary": {
                      "min_length": 1,
                      "max_length": 20,
                      "regex": "[\\w\\d \\.-]{1,20}",
                      "format": "any"
                    },
                    "remitter": {
                      "min_length": 1,
                      "max_length": 20,
                      "regex": "[\\w\\d \\.-]{1,20}",
                      "format": "any"
                    }
                  }
                }
              }
            }
          ]
        }
      ],
      "release_stage": "live"
    },
    {
      "provider_id": "eur-example",
      "logo": "https://truelayer-client-logos.s3-eu-west-1.amazonaws.com/banks/eur-example.svg",
      "display_name": "Example EUR Bank",
      "country": "DE",
      "divisions": [ "retail" ],
      "deposit_schemes": [
        {
          "scheme_id": "sepa_credit_transfer_instant",
          "fee_options": [
            {
              "fee_option_id": "remitter_payable",
              "beneficiary_fee": "free",
              "remitter_fee": "payable"
            },
            {
              "fee_option_id": "beneficiary_payable",
              "beneficiary_fee": "payable",
              "remitter_fee": "free"
            }
          ],
          "requirements": [
            {
              "auth_flow": {
                "types": [ "embedded" ],
                "embedded": {
                  "additional_input_types": [ "text" ],
                  "additional_inputs": {
                    "some-upfront-input": {
                      "type": "select",
                      "mandatory": true,
                      "options": [
                        {
                          "id": "option-a",
                          "display_text": "First Option"
                        },
                        {
                          "id": "option-b",
                          "display_text": "Second Option"
                        }
                      ]
                    }
                  }
                }
              },
              "deposit": {
                "currency": {
                  "supported_currencies": [ "EUR" ]
                },
                "beneficiary": {
                  "account": {
                    "types": [ "iban" ],
                  },
                  "name": {
                    "mandatory": true,
                    "min_length": 1,
                    "max_length": 20,
                    "regex": "[\\w\\d ]{1,20}",
                    "format": "any"
                  }
                },
                "remitter": {
                  "mandatory": true,
                  "account": {
                    "types": [ "iban" ],
                  },
                  "name": {
                    "mandatory": false,
                    "min_length": 1,
                    "max_length": 20,
                    "regex": "[\\w\\d ]{1,20}",
                    "format": "any"
                  }
                },
                "references": {
                  "types": [ "single" ],
                  "single": {
                    "min_length": 1,
                    "max_length": 20,
                    "regex": "[\\w\\d \\.-]{1,20}",
                    "format": "any"
                  }
                }
              }
            }
          ]
        }
      ],
      "release_stage": "live"
    }
  ]
}

Create a deposit

📘
Note
You need to sign POST requests to /v1/users/deposits. See our page on request signing to learn how to sign POST requests to PayDirect API endpoints.

The initiation request includes the following fields:

Field	Type	Mandatory	Description
`deposit`	`DepositRequestDetails`	Mandatory	Specifies the details of the payment to be created.
`auth_flow`	`AuthFlowRequestDetails`	Mandatory	Specifies how the payment should be authorised.
`webhook_uri`	`string`	Optional	An address to which payment webhooks with the status of the payment should be sent. Has to be https.

`DepositRequestDetails`

Field	Type	Mandatory	Description
`user_id`	`uuid`	Mandatory	The unique `id` of the user whose account you want to initiate the deposit from. The user id is generated client-side. PayDirect will persist this user ID and correlate transactions associated with this user ID to deliver our services. All API calls involving this user in future should use their user ID.
`deposit_id`	`uuid`	Mandatory	The unique `id` of the payment you want to create. If two requests are received with the same ID, only the first one will be processed.
`amount_in_minor`	`number`	Mandatory	The amount to be paid, given in the smallest denomination possible for that currency (eg pennies or euro cents).
`currency`	`string`	Mandatory	The ISO 4217 code of the currency for the payment.
`provider_id`	`string`	Mandatory	The `id` of the provider, as given on our `/providers` endpoint.
`scheme_id`	`string`	Conditional	The `id` of the scheme to make the payment over. This must be one of the schemes advertised by the provider on the `/v1/deposits/providers` endpoint. If omitted, the default value of `faster_payments_service` will be used.
`fee_option_id`	`string`	Conditional	The `id` that indicates how fees will be distributed between the beneficiary and remitter. Must be a `fee_option_id` from one of the options in that scheme on the `/v1/deposits/providers` endpoint. Should not be present if the scheme is free (so there are no fees to pay).
`remitter`	`ParticipantDetails`	Optional	The details of the remitter sending the payment.
`remitter_reference`	`string`	Optional	The reference to appear on the remitters' statement.

`ParticipantDetails`

Field	Type	Mandatory	Description
`account`	`AccountIdentifierDetails`	Mandatory	The details of the account owned by the participant.
`name`	`string`	Conditional	The name on the participant's account.

`AccountIdentifierDetails`

Field	Type	Mandatory	Description
`type`	`string`	Mandatory	The type of account. Must be one of `sort_code_account_number`, `iban`, `bban`, or `nrb`. Check our `/providers` endpoint for details of what account types are supported by each provider.
`sort_code`	`string`	Mandatory if `type` is `sort_code_account_number`. Invalid otherwise.	6 digit sort code (no spaces or dashes).
`account_number`	`string`	Mandatory if `type` is `sort_code_account_number`. Invalid otherwise.	8 digit account number.
`iban`	`string`	Mandatory if `type` is `iban`. Invalid otherwise.	Valid International Bank Account Number (no spaces). Consists of a 2 letter country code, followed by 2 check digits, and then by up to 30 alphanumeric characters (also known as the BBAN).
`bban`	`string`	Mandatory if `type` is `bban`. Invalid otherwise.	Valid Basic Bank Account Number (no spaces). Consists of up to 30 alphanumeric characters, with a fixed length per country. Forms the latter part of the IBAN as described above.
`nrb`	`string`	Mandatory if `type` is `nrb`. Invalid otherwise.	Valid Polish NRB (no spaces). Consists of 2 check digits, followed by an 8 digit bank branch number, and then by a 16 digit bank account number. Equivalent to a Polish IBAN with the country code removed.

`AuthFlowRequestDetails`

Field	Type	Mandatory	Description
`type`	`string`	Mandatory	The type of authorisation flow. Must be `redirect` or `embedded`. Providers requiring additional authorisation flows may be available in future.
`return_uri`	`string`	Mandatory if `type` is `redirect`. Invalid otherwise.	The URI we will return the user to after authorising the payment. When the user is redirected to this URI, we will append a `deposit_id` query parameter specifying the payment id and a `type` query parameter with value `deposit`.
`psu_ip_address`	`string`	Conditional if `type` is `redirect`. Invalid otherwise.	The IP address of the end user.
`data_access_token`	`string`	Optional if `type` is `redirect`. Invalid otherwise.	If the provider only allows a single active consent across both AIS and PIS services, pass the data access token in this field so that you don't invalidate an existing AIS consent. We will preserve the data consent when requesting authorisation for the payment.
`additional_inputs`	`dictionary<string, string>`	Conditional	A dictionary of additional values needed on a per-provider basis. Check our `/providers` endpoint for details of the providers that require these.

So a POST /users/deposits request looks like this:

curl -X POST \
     -H "Authorization: Bearer ${access_token}" \
     -H "X-TL-Signature: ${signature}" \
     --data '{
  "user_id": "c17cae3a-98d1-44cc-aebe-8bcbffd57280",
  "deposit": {
    "deposit_id": "dcc3e785-76d3-415c-8bd7-553f17f49c4a",
    "provider_id": "eg-provider",
    "amount_in_minor": 120000,
    "currency": "GBP",
    "remitter": {
      "account": {
        "type": "sort_code_account_number",
        "sort_code": "987654",
        "account_number": "98765432"
      },
      "name": "Mike Smith"
    },
    "remitter_reference": "abcdefg123"
  },
  "auth_flow": {
    "type": "redirect",
    "return_uri": "https://client.app.com/payment_return"
  }
}' \
https://paydirect.truelayer.com/v1/users/deposits

You'll get a response like this:

{
  "result": {
    "deposit": {
      "deposit_id": "dcc3e785-76d3-415c-8bd7-553f17f49c4a",
      "status": "initiated",
      "initiated_at": "2020-10-13T10:01:23.381Z",
      "provider_id": "eg-provider",
      "scheme_id": "payment_scheme",
      "fee_option_id": "split_fee",
      "amount_in_minor": 120000,
      "currency": "GBP",
      "remitter": {
        "account": {
          "type": "sort_code_account_number",
          "sort_code": "987654",
          "account_number": "98765432"
        },
        "name": "Mike Smith"
      },
      "references": {
        "remitter": "FS-1000001"
      }
    },
    "auth_flow": {
      "type": "redirect",
      "uri": "https://www.eg-provider.com/authorize?token=0f9e8d7c",
      "expiry": "2020-11-03T23:00:00.000Z"
    }
  }
}

Handle the initiation request response

The response from the /users/deposits/ endpoint returns the following fields:

Field	Type	Description
`deposit`	`DepositResponseDetails`	Contains the details of the payment. This is a superset of the `DepositRequestDetails` object. This is the same object as that which will be returned on the `GET /v1/users/{userId}/deposits/{id}` endpoint.
`auth_flow`	`AuthFlowResponseDetails`	This provides information on how to have your user authorise the payment, and will differ in structure based on the authorisation flow.

`DepositResponseDetails`

This contains the following fields in addition to those listed in the DepositRequestDetails section:

Field	Type	Description
`initiated_at`	`string`	The time the payment was initiated, in UTC formatted as an ISO 8601 string (`YYYY-MM-DDThh:mm:ss.sssZ`).
`status`	`string`	The status of the payment. For newly initiated payments, this will be `initiated`.

`AuthFlowResponseDetails`

If the provider uses a redirect authorisation flow, the auth_flow object on the response will have the following fields:

Field	Type	Description
`type`	`string`	Value indicating this is a redirect authorisation flow: `redirect`
`uri`	`string`	The URI for the end user to authorise the payment in the bank's UI.
`expiry` (optional)	`string`	An expiry time, if one is known, after which the URI to authorise the payment will become invalid. In UTC, formatted as an ISO 8601 string (`YYYY-MM-DDThh:mm:ss.sssZ`).

{
  "type": "redirect",
  "uri": "https://example.com",
  "expiry": "2020-11-03T23:00:00.000Z"
}

After creating the payment, you will need to redirect the user to the authorisation page specified by uri.

Deposit statuses

Below are the various states a deposit can be in. You can query the status of your deposit using the GET GET /v1/users/{userId}/deposits/{id} endpoint. PayDirect will send webhook events for status transitions.

Status	Terminal	Description
`initiated`	No	The payment resource corresponding to the deposit has been created, but the user has not yet authorised the payment. The initial API response will always have this status if the API call is successful.
`cancelled`	Yes	The user has cancelled the deposit payment using the bank portal. This may also happen for some bank UIs if the payer clicks the “Back” button in their browser.
`authorisation_failed`	Yes	The user attempted to authorise the deposit payment with the bank, but failed to do so successfully.
`executing`	No	The user has successfully authorised the deposit payment using the bank portal, but the payment has not yet executed.
`rejected`	Yes	The user authorised the deposit payment, but the bank rejected it after this.
`executed`	No	TrueLayer has successfully submitted the payment to the bank and the bank has confirmed it as accepted. This does not mean that the payment will settle in the creditor’s account.
`expired`	Yes	The deposit payment was not authorised within the expiry of the initiation.
`settled`	Yes	The deposit payment has settled into your merchant account.

Get deposit example

Retrieve the details and status of a deposit at any time using the deposit_id.

curl -H "Authorization: Bearer ${access_token}" \
https://paydirect.truelayer-sandbox.com/v1/users/${userId}/deposits/${depositId}

{
  "result": {
    "deposit_id": "8361f601-cc39-43f5-a761-89ae54d7440e",
    "initiated_at": "2021-03-09T17:04:27.58",
    "status": "settled",
    "provider_id": "mock-payments",
    "amount_in_minor": 1,
    "currency": "GBP",
    "beneficiary": {
      "account": {
        "type": "sort_code_account_number",
        "sort_code": "040662",
        "account_number": "00003151"
      },
      "name": "Jane Doe"
    },
    "remitter": {
      "account": {
        "type": "sort_code_account_number",
        "sort_code": "040662",
        "account_number": "00002723"
      },
      "name": "JANE DOE"
    },
    "references": {
      "type": "single",
      "reference": "VH/4LH4Y1DJ8LCA67Z"
    },
    "settled": {
      "account_id": "5156e5af-7bf2-49a4-96b3-7fde5ec8ddfe",
      "transaction_id": "af59237f-fa61-476a-aad6-66a6c13cd40b",
      "settled_at": "2021-03-09T17:05:32.427Z"
    }
  }
}

Once a deposit has been settled, we include the settled object which contains additional information regarding the deposit.

Field	Type	Description
`settled.account_id`	uuid	The unique TrueLayer-generated `id` of the account the deposit came from.
`settled.transaction_id`	uuid	The unique `id` of the transaction, that corresponds to the `transaction_id` in the transactions returned by the `/transactions` endpoint.
`settled.settled_at`	timestamp	The date and time that the deposit settled into the account.

Updated 7 months ago

Deposits [PayDirect]

📘

Choose a provider

🚧
Note

`DepositScheme`

`FeeOption`

`DepositRequirements`

`AuthFlowRequirements`

`RedirectAuthFlowRequirements`

`EmbeddedAuthFlowRequirements`

`CurrencyRequirements`

`ParticipantRequirements`

`ReferenceRequirements`

`StringFieldRequirements`

`AdditionalInputs`

Text Input

Text With Image Input

Select Input

`SelectOption`

Create a deposit

📘
Note

`DepositRequestDetails`

`ParticipantDetails`

`AccountIdentifierDetails`

`AuthFlowRequestDetails`

Handle the initiation request response

`DepositResponseDetails`

`AuthFlowResponseDetails`

Deposit statuses

Get deposit example

📘

Choose a provider

🚧Note

DepositScheme

FeeOption

DepositRequirements

AuthFlowRequirements

RedirectAuthFlowRequirements

EmbeddedAuthFlowRequirements

CurrencyRequirements

ParticipantRequirements

ReferenceRequirements

StringFieldRequirements

AdditionalInputs

Text Input

Text With Image Input

Select Input

SelectOption

Create a deposit

📘Note

DepositRequestDetails

ParticipantDetails

AccountIdentifierDetails

AuthFlowRequestDetails

Handle the initiation request response

DepositResponseDetails

AuthFlowResponseDetails

Deposit statuses

Get deposit example

🚧
Note

`DepositScheme`

`FeeOption`

`DepositRequirements`

`AuthFlowRequirements`

`RedirectAuthFlowRequirements`

`EmbeddedAuthFlowRequirements`

`CurrencyRequirements`

`ParticipantRequirements`

`ReferenceRequirements`

`StringFieldRequirements`

`AdditionalInputs`

`SelectOption`

📘
Note

`DepositRequestDetails`

`ParticipantDetails`

`AccountIdentifierDetails`

`AuthFlowRequestDetails`

`DepositResponseDetails`

`AuthFlowResponseDetails`