TRtruelayer
General

Submit payments return parameters

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

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

Headers

Idempotency-Keystring

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.

Request body

querystring

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.

fragmentstring

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.

Example request

{
  "query": "key1=val1&key2=val2",
  "fragment": "key1=val1&key2=val2"
}

Response

Resource

Example response

{
  "resource": {
    "payment_id": "0cd1b0f7-71bc-4d24-b209-95259dadcc20"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.