TRtruelayer
Payments

Get payment

Returns payment details.

This API can be called:

  • using the resource_token associated with the payment you are trying to fetch;
  • using a backend bearer token.

Note: Some fields are required when OAuth2 token is used.

get/v3/payments/{id}

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/payments/{id}
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.truelayer.com/connect/token scopes: payments
    • or HTTP bearer

Path parameters

idstring required

Unique ID for the Payment

Example:0afd1f6a-f611-48ce-9488-321129bb3a70

ID of the payment

Response

Payment

OR
OR
OR
OR
OR
OR

Example response

{
  "id": "0afd1f6a-f611-48ce-9488-321129bb3a70",
  "currency": "GBP",
  "user": {
    "id": "f9b48c9d-176b-46dd-b2da-fe1a2b77350c"
  },
  "payment_method": {
    "provider_selection": {
      "filter": {
        "countries": [
          "GB"
        ],
        "release_channel": "general_availability",
        "customer_segments": [
          "retail"
        ],
        "provider_ids": [
          "mock-payments-gb-redirect"
        ],
        "excludes": {
          "provider_ids": [
            "ob-exclude-this-bank"
          ]
        }
      },
      "provider_id": "eg-provider",
      "branch_selection": {
        "branch_id": "branch-a"
      },
      "scheme_id": "payment_scheme"
    },
    "beneficiary": {
      "reference": "payment-ref",
      "statement_reference": "payment-ref"
    }
  },
  "metadata": {
    "prop1": "value1",
    "prop2": "value2"
  },
  "related_products": {
    "signup_plus": {}
  },
  "sub_merchants": {
    "ultimate_counterparty": {
      "url": "https://truelayer.com",
      "mcc": "1234",
      "address": {
        "address_line1": "40 Finsbury Square",
        "address_line2": "The Gilbert",
        "city": "London",
        "state": "London",
        "zip": "EC2A 1PX",
        "country_code": "GB"
      }
    }
  },
  "failed_attempts": [
    {
      "attempt_number": 1,
      "failed_at": "2026-01-27T16:44:56.007136Z",
      "failure_reason": "provider_rejected"
    }
  ]
}

Changes

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