Create unreferenced refund | Payroc

using RestSharp;
var client = new RestClient("https://api.payroc.com/v1/refunds");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "8e03978e-40d5-43e8-bc93-6894a57f9324");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"channel\": \"pos\",\n  \"processingTerminalId\": \"1234001\",\n  \"order\": {\n    \"orderId\": \"OrderRef6543\",\n    \"description\": \"Refund for order OrderRef6543\",\n    \"amount\": 4999,\n    \"currency\": \"USD\"\n  },\n  \"refundMethod\": {\n    \"type\": \"card\",\n    \"cardDetails\": {\n      \"entryMethod\": \"keyed\",\n      \"keyedData\": {\n        \"dataFormat\": \"plainText\",\n        \"cardNumber\": \"4539858876047062\",\n        \"device\": {\n          \"model\": \"paxA920\",\n          \"serialNumber\": \"1850010868\"\n        },\n        \"expiryDate\": \"1230\"\n      }\n    }\n  },\n  \"customFields\": [\n    {\n      \"name\": \"yourCustomField\",\n      \"value\": \"abc123\"\n    }\n  ]\n}", ParameterType.RequestBody);
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 create an unreferenced refund. An unreferenced refund is a refund that isn’t linked to a payment.

Note: If you have the paymentId of the payment you want to refund, use our Refund Payment method. If you use our Refund Payment method, our gateway sends the refund amount to the customer’s original payment method and links the refund to the payment.

In the request, you must provide the customer’s payment details and the refund amount.

In the response, our gateway returns information about the refund and a refundId, which you need for the following methods:

Retrieve refund - View the details of the refund.
Adjust refund - Update the details of the refund.
Reverse refund - Cancel the refund if it’s in an open batch.

Use this method to create an unreferenced refund. An unreferenced refund is a refund that isn't linked to a payment. **Note:** If you have the paymentId of the payment you want to refund, use our [Refund Payment](https://docs.payroc.com/api/schema/card-payments/refunds/create-referenced-refund) method. If you use our Refund Payment method, our gateway sends the refund amount to the customer's original payment method and links the refund to the payment. In the request, you must provide the customer's payment details and the refund amount. In the response, our gateway returns information about the refund and a refundId, which you need for the following methods: - [Retrieve refund](https://docs.payroc.com/api/schema/card-payments/refunds/retrieve) - View the details of the refund. - [Adjust refund](https://docs.payroc.com/api/schema/card-payments/refunds/adjust) - Update the details of the refund. - [Reverse refund](https://docs.payroc.com/api/schema/card-payments/refunds/reverse-refund) - Cancel the refund if it's in an open batch.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

channelenumRequired

Channel that the merchant used to request the refund.

processingTerminalIdstringRequired4-50 characters

Unique identifier that we assigned to the terminal.

orderobjectRequired

Object that contains information about the refund.

refundMethodobjectRequired

Polymorphic object that contains information about the payment method that the merchant uses to refund the customer.

The value of the type parameter determines which variant you should use:

card - Payment card details
secureToken - Secure token details

operatorstringOptional0-50 characters

Operator who initiated the request.

customerobjectOptional

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

Contains parameters required for Level 2, Level 3, and CEDP transactions.

ipAddressobjectOptional

Object that contains the IP address of the device that sent the request.

customFieldslist of objectsOptional

Array of customField objects.

Response headers

locationstringOptional

URI reference to created resource.

Response

Successful request. We processed the 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 a payment.

supportedOperationslist of enumsOptional

Array of operations that you can perform on the transaction.

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

406

Not Acceptable Error

409

Conflict Error

415

Unsupported Media Type Error

500

Internal Server Error