Payments APIManage Payments

Retrieve Payment

Retrieves details of a specific payment using its unique ID.

Path parameters

paymentIdstringRequired
Unique identifier for the payment.

Response

Payment details retrieved successfully.
statusstring
Current status of the payment.
createdAtdatetime
Timestamp when the payment was created.
amountobject
idstring or null
Unique identifier for the payment.
processorIdstring or null
Identifier of the payment processor.
processorNamestring or null
Name of the payment processor.
processorReferencestring or null
Reference from the payment processor.
processorConfigIdstring or null
Configuration ID of the payment processor.
holderIdstring or null
Identifier of the payment holder.
workspaceIdstring or null
Workspace ID associated with the payment.
instrumentIdstring or null
Identifier of the payment instrument.
paymentMethodTypeenum or null
Type of payment method used.
metadatamap from strings to any or null
Additional metadata for the payment.

Errors