---
title: "Submit payments return parameters"
method: POST
path: "/v3/payments-provider-return"
tags: ["General"]
---

# Submit payments return parameters

`POST /v3/payments-provider-return`

## Request

- Base URL: `https://api.truelayer-sandbox.com`
- URL: `https://api.truelayer-sandbox.com/v3/payments-provider-return`
- Auth: none required

Submit direct return query and fragment parameters returned from the provider.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `query` string: Submit the query parameters attached to the GET request received by the third-party when redirected back to your `redirect.direct_return_uri` set in the start authorization flow action.
  - `fragment` string: Submit the fragment parameters attached to the GET request received by the third-party when redirected back to the `redirect.direct_return_uri` set in the start authorization flow action.

## Response `200`

Resource

- ProviderReturnParametersResponse
  - `resource` union, required: The resource associated to the parameters submitted.
    - object: The Payment associated to the parameters submitted.
      - `type` 'payment', required: The resource type.
      - `payment_id` string, required: ID of the payment
    - object: The mandate associated to the parameters submitted.
      - `type` 'mandate', required: The resource type.
      - `mandate_id` string, required: ID of the mandate

## Other responses

- `400`: Invalid Parameters
- `404`: Resource Not Found
- `409`: Idempotency-Key Concurrency Conflict
- `422`: Idempotency-Key Reuse
- `500`: Unknown Error
- `502`: Provider Error

---

[API](https://skmtc.dev/truelayer/apis/payments-api-v3.md) - [All operations](https://skmtc.dev/truelayer/apis/payments-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/truelayer/apis/payments-api-v3/revisions/a7c585fc9b84?raw)