Retrieve Refund Status

Merchants can utilize this API endpoint to retrieve the status of a refund request. This allows merchants to obtain information regarding the progress.

Pre-requisite

When integrating with Codapay's API, ensure you adhere to the following standards:

1. Use HTTPS protocol.

2. TLS 1.2 or higher

3. Include an Authorization header, API Key, and Partner ID

Reference

Environment	Endpoint Base URL
Sandbox	Coming soon
Production	https://api-tc.codapayments.com/v1/

Endpoint

POST {Base URL}/refunds

Current Environment Availability

Environment	Is Available?
Sandbox	Coming soon
Production	Yes

Codapay's APIs support REST web services. By default, the endpoints displayed are RESTful.

Request Parameters

Parameter Name	Data Type	Description	Constraint	Is Required?
refund.id	String	Unique identifier for the refund	Must be a valid refund ID	Yes

Response Parameters

The returned object is the refund object that contains a comprehensive record of your refund request.

Parameter Name	Data Type	Description
id	String	Unique identifier for the refund
created_at	String	Timestamp of when the refund was created
status_code	String	Status of the refund request. For more information on the possible refund statuses, refer to this.
finalized_at	String	Timestamp of when the refund was finalized, if applicable
type	String	Type of refund request (e.g., full)
txn_id	String	Transaction ID associated with the refund
amount_value	String	Amount of the refund
amount_currency	String	Currency of the refund amount
customer_email	String	Customer's email, if provided