Run an unreferenced refund

A merchant can use their POS to initiate an unreferenced refund on their payment device.

Integration steps

To run an unreferenced refund using Payroc Cloud, integrate with the following:

Step 1. Create a refund instruction.
Step 2. View the status of a refund instruction.
Step 3. View the details of the refund.

Before you begin

Bearer tokens

Use our Identity Service to generate a Bearer token to include in the header of your requests. To generate a Bearer token, complete the following steps:

1. Include your API key in the x-api-key parameter in the header of a POST request.
2. Send your request to https://identity.payroc.com/authorize.

Example request

$
curl --location --request POST  'https://identity.payroc.com/authorize' --header 'x-api-key: <api key>'

If your request is successful, we return a response that contains your Bearer token, information about its scope, and when it expires.

Example response

1
{
2
  "access_token": "eyJhbGc....adQssw5c",
3
  "expires_in": 3600,
4
  "scope": "service_a service_b",
5
  "token_type": "Bearer"
6
}

Headers

To create the header of each POST request, you must include the following parameters:

• Content-Type: Include application/json as the value for this parameter.
• Authorization: Include your Bearer token in this parameter.
• Idempotency-Key: Include a UUID v4 to make the request idempotent.

$
curl
>
-H "Content-Type: application/json"
>
-H "Authorization: <Bearer token>"
>
-H "Idempotency-Key: <UUID v4>"

Errors

If your request is unsuccessful, we return an error. For more information about errors, see Errors.

Step 1. Create a refund instruction

To send a refund instruction to a device, send a POST request to the Devices endpoint.

Request parameters

To create the body of your request, use the following parameters:

Example request

1
curl -X POST https://api.payroc.com/v1/devices/ \
2
     -H "Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324" \
3
     -H "Authorization: Bearer <token>" \
4
     -H "Content-Type: application/json" \
5
     -d '{
6
  "processingTerminalId": "1234001",
7
  "order": {
8
    "amount": 2899,
9
    "currency": "AED",
10
    "orderId": "OrderRef6543"
11
  }
12
}'

Response fields

If your request is successful, we send the refund instruction to the device.

The response contains the following fields:

Example response

1
{
2
  "refundInstructionId": "a37439165d134678a9100ebba3b29597",
3
  "link": {
4
    "rel": "self",
5
    "method": "GET",
6
    "href": "https://api.payroc.com/v1/refund-instructions/a37439165d134678a9100ebba3b29597"
7
  },
8
  "status": "inProgress"
9
}

Step 2. View the status of a refund instruction

To check for updates to the status or view the details of the refund, send a GET request to the Refund Instructions endpoint.

Before our gateway sends a response, it waits for up to 30 seconds for the status of the instruction to change. We recommend that you keep the session open until the status of the instruction changes or the request times out.

If the status of the instruction doesn’t change, send another GET request. Our gateway waits up to 30 seconds for the status of the instruction to change. Continue to send GET requests until the status changes.

Request parameters

To create the body of your request, use the following parameters:

Example request

1
curl https://api.payroc.com/v1/refund-instructions/ \
2
     -H "Authorization: Bearer <token>"

Response fields

If your request is successful, we return the details of the refund instruction.

If the status of the refund instruction is inProgress, our gateway waits up to a minute for the status to change before it returns a response.

Example response

1
{
2
  "refundInstructionId": "a37439165d134678a9100ebba3b29597",
3
  "link": {
4
    "rel": "refund",
5
    "method": "GET",
6
    "href": "https://api.payroc.com/v1/refunds/CD3HN88U9F"
7
  },
8
  "status": "completed"
9
}

Step 3. View the details of the refund

To check whether the processor approved or declined the refund, send a GET request to the Refunds endpoint.

Request parameters

To create the body of your request, use the following parameters:

Example request

1
curl https://api.payroc.com/v1/refunds/ \
2
     -H "Authorization: Bearer <token>"

Response fields

If your request is successful, we return the details of the refund.

Example response

1
{
2
  "refundId": "CD3HN88U9F",
3
  "processingTerminalId": "1234001",
4
  "order": {
5
    "amount": 4999,
6
    "currency": "USD",
7
    "description": "Refund for order OrderRef6543",
8
    "orderId": "OrderRef6543",
9
    "dateTime": "2024-07-02T15:30:00Z"
10
  },
11
  "card": {
12
    "type": "Visa Credit",
13
    "entryMethod": "keyed",
14
    "cardNumber": "453985******7062",
15
    "expiryDate": "1225"
16
  },
17
  "transactionResult": {
18
    "type": "refund",
19
    "status": "ready",
20
    "responseCode": "A",
21
    "responseMessage": "OK5",
22
    "approvalCode": "000000",
23
    "authorizedAmount": -4999,
24
    "currency": "USD"
25
  },
26
  "customFields": [
27
    {
28
      "name": "yourCustomField",
29
      "value": "abc123"
30
    }
31
  ]
32
}

Before you test your integration

To test your integration with a payment device, first complete the following tasks:

• Get the serial number of the payment device.
• Connect the payment device to the internet.

Test cases

Create a refund instruction for when the card isn’t present

Step 1. Create a refund instruction

Send a POST request to the Devices test endpoint:

https://api.uat.payroc.com/v1/devices/{serialNumber}/refund-instructions

Example request

1
{
2
    "operator": "jbloggs",
3
    "processingTerminalId": "1021",
4
    "order": {
5
        "orderId": "4fd4-99bc",
6
        "currency": "USD",
7
        "amount": 1000
8
    },
9
    "customizationOptions": {
10
        "entryMethod": "manualEntry"
11
    }
12
}

Step 2. Retrieve the status of the refund instruction

Send a GET request to the Refund Instructions test endpoint:

https://api.uat.payroc.com/v1/refund-instructions/{refundInstructionId}

If the status of the refund instruction is inProgress, our gateway waits up to a minute for the status to change before it returns a response. Send GET requests until the value for status changes to completed.

Example response

1
{
2
  "refundInstructionId": "3743a9165d134678a9100ebba3b29597",
3
  "status": "completed",
4
  "link": {
5
    "rel": "refunds",
6
    "method": "GET",
7
    "href": "https://api.payroc.com/v1/refunds/DD6ZDQU7L27"
8
  }
9
}

Step 3. Retrieve the status of the refund instruction

Send a GET request to the Refunds test endpoint:

https://api.uat.payroc.com/v1/refunds/{refundId}

Use the refundID that you received in the response from Step 2.

Example response

1
{
2
  "paymentId": "DD6ZDQU7L2",
3
  "processingTerminalId": "1021",
4
  "operator": "Postman",
5
  "order": {
6
    "orderId": "4fd4-99bc",
7
    "dateTime": "2023-07-26T16:42:25.018Z",
8
    "description": "Example payment",
9
    "amount": 1000,
10
    "currency": "USD"
11
  },
12
  "customer": {
13
    "shippingAddress": {}
14
  },
15
  "card": {
16
    "type": "MasterCard",
17
    "entryMethod": "keyed",
18
    "cardNumber": "500165******0000",
19
    "expiryDate": "0328",
20
    "securityChecks": {
21
      "cvvResult": "M",
22
      "avsResult": "Y"
23
    }
24
  },
25
  "transactionResult": {
26
    "type": "sale",
27
    "status": "ready",
28
    "approvalCode": "OK3",
29
    "authorizedAmount": 1000,
30
    "currency": "USD",
31
    "responseCode": "A",
32
    "responseMessage": "OK3"
33
  }
34
}