Skip to main content

About PayRex API

Learn about the concepts of PayRex API resources and their interactions with each other.

This section covers information to help you understand PayRex API in depth:

  • The core concepts inside the PayRex API.
  • How PayRex resources transition from one status to another to complete transactions such as processing payments.
  • The interactions between different PayRex resources.
  • Use cases and best practices for using different resources together.

Core Concepts​

Everything is a resource​

Everything you will access within your PayRex account is a resource, whether you create it via API or not. A payment represents a Payment resource, a Refund resource represents a refunded payment, a configured webhook to receive events from PayRex is a Webhook resource, and so on.

Our low-code and no-code integrations also produce these resources. For example, creating a Payment Link via Dashboard or API will generate a Payment Link resource.

Some resources have an end-state​

It's important to note that some resources in PayRex have an 'end-state.' This means they transition to a specific status once a particular condition is met. For example, a Payment Intent resource is a tool you can use to track your customer's end-to-end payment experience. Once the payment is successful, you can transition the payment intent resource's status to succeeded, indicating that it has reached its end state.

Your PayRex integration is all about different resource interactions​

When you integrate our Payments product, you will encounter different resources such as Payment Intent, Payment Method, and Payment Resource. A Webhook and Event resource are commonly known whenever you want PayRex to notify your system about a successful payment in JSON.