Retrieve a Refund

GET

/v1/refunds/{id}

const url = 'https://api.parasta.io/v1/refunds/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.parasta.io/v1/refunds/example \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

required

string

Responses

200

application/json

object

required

string

payment_id

required

string

amount

required

Always equal to the original payment amount in v1 (full refund only)

integer format: int64

currency

required

string

status

required

string

Allowed values: pending succeeded failed

tx_hash

string | null

created

string format: date-time

Example

{
  "id": "re_abc123",
  "status": "pending"
}

404

Object not found

application/json

object

error

required

object

type

required

string

Allowed values: authentication_error permission_error invalid_request_error not_found_error rate_limit_error idempotency_error payment_error network_error api_error

code

required

string

message

required

string

param

string

request_id

string

Example

{
  "error": {
    "type": "authentication_error"
  }
}