Submit payments return parameters

post

https://api.truelayer-sandbox.com/v3/payments-provider-return

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

📘
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

Either query or fragment need to be present.

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.

Headers

Idempotency-Key

string

An idempotency key to allow safe retrying without the operation being performed multiple times.
The value should be unique for each operation (we strongly advise to use a UUID v4), with the same key being sent on a retry of the same request.
If a UUID can't be used, we advise to also include your client id in the idempotency key.

string

enum

Defaults to application/json; charset=UTF-8

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json; charset=UTF-8

application/problem+json; charset=UTF-8

Endpoint path changes

200Resource

400Invalid Parameters

404Resource Not Found

409Idempotency-Key Concurrency Conflict

422Idempotency-Key Reuse

500Unknown Error

502Provider Error