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
idstringOptional

Unique identifier for the payment.

processorIdstringOptional

Identifier of the payment processor.

processorNamestringOptional

Name of the payment processor.

processorReferencestringOptional

Reference from the payment processor.

processorConfigIdstringOptional

Configuration ID of the payment processor.

holderIdstringOptional

Identifier of the payment holder.

workspaceIdstringOptional

Workspace ID associated with the payment.

instrumentIdstringOptional

Identifier of the payment instrument.

paymentMethodTypeenumOptional

Type of payment method used.

metadatamap from strings to anyOptional

Additional metadata for the payment.

Errors