Post
/v3/payment_requests/{payment_request_id}/simulate
Simulate payments for a payment request with PRESENT_TO_CUSTOMER action type. This is only available in our test mode environment.
Security
HTTP
Type basic
Header parameters
api-version
string
Valid values[
"2024-11-11"
]
Path parameters
payment_request_id
stringRequired
Min length39
Max length39
Examplepr-8877c08a-740d-4153-9816-3d744ed197a5
Body parameters
object
amount
number
Amount to simulate.
Responses
200
Simulate payment for a Payment Request
object
status
string
Status of a simulation will always be PENDING
message
string
A simulated payment for the specified payment request id is being processed. You will be informed of the result via a webhook.
500
Internal server error
OneOf
Payments_API_Http500ServerError
object (Payments_API_Http500ServerError)
error_code
string
Valid values[
"SERVER_ERROR"
]
message
string
An unexpected error occured, our team has been notified and will troubleshoot the issue