Revaly HomeTrust CenterStatus
API Reference
Contact Support

Notify Revaly of payment events

post
https://api.revaly.co/notify

Notify Revaly of payment-related events and status changes.

This endpoint allows external systems to notify Revaly about specific business events related to payments, refunds, customer recovery, and customer updates.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Notification request to inform Revaly of specific business events

string
enum
required

Type of business event being reported. The event type determines how Revaly processes the notification.

  • recordPayment: Record a payment transaction
  • recordRefund: Record a refund transaction
  • endOutreach: End an outreach campaign for a customer
  • updateCustomerData: Update customer information and contact details
Allowed:
data
object

Event-specific data for notification requests

Headers
string
enum
Defaults to 2.0

Selects the RAP API version for this request. New integrations should pin 2.1 (identical to 2.0 today; future refinements land there). Omit to use the base version (2.0). A value naming an unsupported version — including an empty value — returns HTTP 400; if the header is sent, it must name a supported version. See the API description for the full version policy.

Allowed:
Responses

Updated 4 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago