Skip Navigation
Log In Sign Up

Retrieve a Payment

·

Retrieve detailed information about a specific payment by its unique identifier.

Request

GET https://tupel.com/api/payments/{uid}/

Authentication

This endpoint requires basic authentication with your Organization ID and API Key.

Path Parameters

  • uid string Required
    The unique identifier of the payment to retrieve.

Notes

  • This endpoint returns all details for a specific payment transaction.
  • The payment must be associated with your organization to be accessible.
  • The response includes important transaction details like amount, status, currency information, and payment provider.
  • The fx_rate object provides foreign exchange information if the payment involved currency conversion.
  • Any attachments related to the payment, such as receipts or confirmation documents, are included in the attachments array.
  • The delivered_at field will be null if the payment has not yet been delivered (e.g., for PENDING status payments).
  • The reason field indicates whether the payment is for PRINCIPAL or FEE.
  • The provider field shows which payment service provider was used (STRIPE, WISE or GOCARDLESS).

Example Request

curl -X GET https://tupel.com/api/payments/9sK8jH7gF/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Response

A successful request returns a 200 OK status code and a complete Payment in the response body.

Error Responses

Status Code Description
401 Unauthorized - Authentication failed. Check your Organization ID and API Key.
403 Forbidden - Insufficient permissions to access the specified payment.
404 Not Found - The specified payment could not be found.

Example Error Response

{
  "detail": [
    {
      "type": "not_found",
      "loc": ["path", "uid"],
      "msg": "Payment with id 9sK8jH7gF not found."
    }
  ]
}