Sign in
Payment Requests

Retrieve Payment requests

PayRequests API

get/api/v1/payment-requests/{id}/

Path parameters

idstring required

A unique string value identifying this Pay Request.

Response

request_idstring required
sent_status'PENDING' | 'SENT' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'FAILED'
  • PENDING - Pending
  • SENT - Request sent
  • DELIVERED - Email delivered
  • OPENED - Email opened
  • CLICKED - Paylink clicked
  • FAILED - Failed
reasonstring required

Payment reason

autosend_remider0 | 1 | 2 | 3 | 7
  • 0 - Do not send
  • 1 - After a day
  • 2 - After two days
  • 3 - After three day
  • 7 - After a week
autosend_remider_datetimestring date-time nullable
reminder_sentboolean
archivedboolean
failed_detailsstring nullable
created_atstring date-time nullable required
updated_atstring date-time nullable required

Changes