Skip Navigation
Log In Sign Up

Retrieve a Payment Method

·

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

Request

GET https://tupel.com/api/methods/{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 method to retrieve.

Notes

  • This endpoint returns all details for a specific payment method, including the associated entity information.
  • The payment method must belong to your organization to be accessible.
  • For security purposes, only the last 4 digits of the account number are provided in the last4 field.
  • When retrieving a payment method before creating a loan, verify that the payment method's currency matches the loan currency.
  • You can use the retrieved payment method UID in other API calls, such as when creating a loan.
  • Payment methods are essential for setting up automated repayment collection for loans.

Example Request

curl -X GET https://tupel.com/api/methods/2qP3o/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Response

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

Error Responses

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

Example Error Response

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