Retrieve refund | Payroc

using RestSharp;
var client = new RestClient("https://api.payroc.com/v1/refunds/CD3HN88U9F");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);

{
  "refundId": "CD3HN88U9F",
  "processingTerminalId": "1234001",
  "order": {
    "orderId": "OrderRef6543",
    "description": "Refund for order OrderRef6543",
    "amount": 4999,
    "currency": "USD",
    "dateTime": "2024-07-02T15:30:00Z"
  },
  "card": {
    "type": "Visa Credit",
    "cardNumber": "453985******7062",
    "expiryDate": "1230",
    "entryMethod": "keyed"
  },
  "transactionResult": {
    "status": "ready",
    "responseCode": "A",
    "type": "refund",
    "approvalCode": "000000",
    "authorizedAmount": -4999,
    "currency": "USD",
    "responseMessage": "OK5"
  },
  "customFields": [
    {
      "name": "yourCustomField",
      "value": "abc123"
    }
  ]
}

Use this method to retrieve information about a refund.

To retrieve a refund, you need its refundId. Our gateway returned the refundId in the response of the Refund Payment method or the Create Refund method.

Note: If you don’t have the refundId, use our List Refunds method to search for the refund.

Our gateway returns the following information about the refund:

Order details, including the refund amount and when we processed the refund.
Payment card details, including the masked card number, expiry date, and payment method.
Cardholder details, including their contact information and shipping address.

If the refund is a referenced refund, our gateway also returns details about the payment that the refund is linked to.

Use this method to retrieve information about a refund. To retrieve a refund, you need its refundId. Our gateway returned the refundId in the response of the [Refund Payment](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund) method or the [Create Refund](https://docs.payroc.com/api/schema/card-payments/refunds/create-unreferenced-refund) method. **Note:** If you don't have the refundId, use our [List Refunds](https://docs.payroc.com/api/schema/card-payments/refunds/list) method to search for the refund. Our gateway returns the following information about the refund: - Order details, including the refund amount and when we processed the refund. - Payment card details, including the masked card number, expiry date, and payment method. - Cardholder details, including their contact information and shipping address. If the refund is a referenced refund, our gateway also returns details about the payment that the refund is linked to.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

refundIdstringRequired=10 characters

Unique identifier that our gateway assigned to the refund.

Response

Successful request. Returns the specific refund.

refundIdstring=10 characters

Unique identifier that our gateway assigned to the refund.

processingTerminalIdstring4-50 characters

Unique identifier that we assigned to the terminal.

orderobject

Object that contains information about the refund.

cardobject

Object that contains the details of the payment card.

transactionResultobject

Object that contains information about the transaction response details.

operatorstringOptional0-50 characters

Operator who requested the refund.

customerobjectOptional

Object that contains the customer's contact details and address information.

paymentobjectOptional

Object that contains information about the payment that the refund is linked to.

Note: We don’t return this object for unreferenced refunds.

supportedOperationslist of enumsOptional

Array of operations that you can perform on the transaction. Our gateway can return any of the following values:

capture - Capture the payment.
refund - Refund the payment.
fullyReverse - Fully reverse the transaction.
partiallyReverse - Partially reverse the payment.
incrementAuthorization - Increase the amount of the authorization.
adjustTip - Adjust the tip post-payment.
addSignature - Add a signature to the payment.
setAsReady - Set the transaction’s status to ready.
setAsPending - Set the transaction’s status to pending.

customFieldslist of objectsOptional

Array of customField objects.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

500

Internal Server Error

Use this method to retrieve information about a refund.

To retrieve a refund, you need its refundId. Our gateway returned the refundId in the response of the Refund Payment method or the Create Refund method.

Note: If you don’t have the refundId, use our List Refunds method to search for the refund.

Our gateway returns the following information about the refund:

Order details, including the refund amount and when we processed the refund.
Payment card details, including the masked card number, expiry date, and payment method.
Cardholder details, including their contact information and shipping address.

If the refund is a referenced refund, our gateway also returns details about the payment that the refund is linked to.