GET/api/v2/payments/requests/{requestId}

Get payment request by ID

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
requestId (path)unknownYesPayment request ID

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
IdunknownNo
UserIdunknownNo
CompanyIdunknownNo
AmountstringNo
CurrencystringNo
StatusPaymentStatusV2No
DescriptionstringNo
ExternalReferenceIdstringNo
CallbackUrlstringNo
SuccessUrlstringNo
FailureUrlstringNo
PaymentUrlstringNo
CreatedAtstringNo
UpdatedAtstringNo
CompletedAtstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/payments/requests/{requestId}" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.