A merchant can use the payment details of a card payment to run a referenced refund. To run a referenced refund, the merchant should first retrieve the payment information in one of the following ways:

Use the paymentId.
Search for the payment using payment information such as the card number.

If the merchant runs a refund on a payment that is in an open batch, our gateway automatically cancels the payment.

Integration steps

Step 1. Retrieve information about the original payment.
(Optional) Step 1a. Retrieve information about the payment using the paymentId.
(Optional) Step 1b. Retrieve information about the payment without the paymentId.
Step 2. Refund the payment.

Before you begin

Bearer tokens

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

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

You need to generate a new Bearer token before the previous Bearer token expires.

Example request

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

Example response

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

{
"access_token": "eyJhbGc....adQssw5c",
"expires_in": 3600,
"scope": "service_a service_b",
"token_type": "Bearer"
}

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. Retrieve information about the original payment

1a – (Optional) Retrieve information with the paymentId Send a GET request with the paymentID to the Payments endpoint. Test endpoint: https://api.uat.payroc.com/v1/payments/{paymentId}
Production endpoint: https://api.payroc.com/v1/payments/{paymentId}

Path parameters

Example request

Request

curl --request get \
	--url https://api.payroc.com/v1/payments/abc123 \
	--header 'Authorization: Bearer <access token>'

Response fields

If your request is successful, we retrieve the card payment information and return a response. The response contains the following fields:

Response Schema

Status Code 200

Successful request. Returns the payment.

Response body

Example response

Response

application/json

{
  "paymentId": "KP77BIWR96",
  "processingTerminalId": "1023",
  "operator": "Postman",
  "order": {
    "orderId": "order123",
    "dateTime": "2023-07-26T16:42:25.018Z",
    "description": "Example payment",
    "amount": 100,
    "currency": "USD"
  },
  "customer": {
    "firstName": "Robert",
    "lastName": "Red",
    "billingAddress": {
      "address1": "billing address",
      "address2": "billing address2",
      "address3": "billing address3",
      "city": "Los Angeles",
      "state": "California",
      "country": "US",
      "postalCode": "90005"
    },
    "shippingAddress": {
      "recipientName": "shipping recipientName",
      "address": {
        "address1": "shipping address1",
        "address2": "shipping address2",
        "address3": "shipping address3",
        "city": "San Diego",
        "state": "California",
        "country": "US",
        "postalCode": "91911"
      }
    }
  },
  "card": {
    "type": "MasterCard",
    "entryMethod": "keyed",
    "cardNumber": "500165******0000",
    "expiryDate": "0328",
    "securityChecks": {
      "cvvResult": "M",
      "avsResult": "Y"
    }
  },
  "supportedOperations": [
    "capture",
    "fullyReverse",
    "partiallyReverse",
    "incrementAuthorization",
    "adjustTip",
    "setAsPending"
  ],
  "transactionResult": {
    "type": "sale",
    "status": "ready",
    "approvalCode": "OK3",
    "authorizedAmount": 100,
    "currency": "USD",
    "responseCode": "A",
    "responseMessage": "OK3"
  }
}

1b (Optional) – Retrieve information without the payment ID Send a GET request to the Payments endpoint. Test endpoint: https://api.uat.payroc.com/v1/payments
Production endpoint: https://api.payroc.com/v1/payments

Request parameters

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

Query parameters

Example request

Request

curl --request get \
	--url https://api.payroc.com/v1/payments \
	--header 'Authorization: Bearer <access token>'

Response fields

If your request is successful, we retrieve a list of card payments and return a response. The response contains the following fields:

Response Schema

Status Code 200

Successful request. Returns a list of payments.

Response body

Example response

Response

application/json

{
  "limit": 2,
  "count": 2,
  "hasMore": true,
  "data": [
    {
      "paymentId": "IFA1T74OBS",
      "processingTerminalId": "1001",
      "operator": "Automatic Payment",
      "order": {
        "orderId": "684255528917",
        "dateTime": "2023-05-16T16:45:29.000Z",
        "description": "recurring order",
        "amount": 100,
        "currency": "EUR"
      },
      "card": {
        "type": "Visa Credit",
        "cardholderName": "Joe Bloggs",
        "cardNumber": "453985******7062",
        "expiryDate": "0129",
        "secureToken": {
          "secureTokenId": "FirefoxSecureCard1001",
          "customerName": "Joe Bloggs",
          "token": "2967533500670317",
          "status": "notValidated",
          "link": {
            "rel": "self",
            "method": "GET",
            "href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/FirefoxSecureCard1001"
          }
        },
        "securityChecks": {
          "cvvResult": "M",
          "avsResult": "X"
        }
      },
      "supportedOperations": [
        "fullyReverse",
        "setAsPending"
      ],
      "transactionResult": {
        "type": "sale",
        "status": "ready",
        "approvalCode": "475318",
        "authorizedAmount": 100,
        "currency": "EUR",
        "responseCode": "A",
        "responseMessage": "APPROVAL"
      }
    },
    {
      "paymentId": "CW4BA4MUH0",
      "processingTerminalId": "1001",
      "operator": "Automatic Payment",
      "order": {
        "orderId": "684255528143",
        "dateTime": "2023-05-16T16:45:28.000Z",
        "description": "yearly avant-gard cinema subscription",
        "amount": 1000,
        "currency": "EUR"
      },
      "card": {
        "type": "Visa Debit",
        "cardholderName": "Joe Bloggs",
        "cardNumber": "400006******0006",
        "expiryDate": "0129",
        "secureToken": {
          "secureTokenId": "FirefoxSecureCard1001",
          "customerName": "Joe Bloggs",
          "token": "2967533500670317",
          "status": "notValidated",
          "link": {
            "rel": "self",
            "method": "GET",
            "href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/FirefoxSecureCard1001"
          }
        },
        "securityChecks": {
          "cvvResult": "M",
          "avsResult": "X"
        }
      },
      "supportedOperations": [
        "fullyReverse",
        "setAsPending"
      ],
      "transactionResult": {
        "type": "sale",
        "status": "ready",
        "approvalCode": "475318",
        "authorizedAmount": 1000,
        "currency": "EUR",
        "responseCode": "A",
        "responseMessage": "APPROVAL"
      }
    }
  ],
  "links": [
    {
      "rel": "next",
      "method": "get",
      "href": "https://api.payroc.com/v1/payments?processingTerminalId=1001&limit=2&after=CW4BA4MUH0"
    },
    {
      "rel": "previous",
      "method": "get",
      "href": "https://api.payroc.com/v1/payments?processingTerminalId=1001&limit=2&before=IFA1T74OBS"
    }
  ]
}

Step 2. Refund the payment

To refund a card transfer payment, send a POST request to the Payments endpoint. Test endpoint: https://api.uat.payroc.com/v1/payments/{paymentId}/refund
Production endpoint: https://api.payroc.com/v1/payments/{paymentId}/refund

Request parameters

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

Path parameters

Header parameters

Body parameters

Example request

Request

curl --request post \
	--url https://api.payroc.com/v1/payments/abc123/refund \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: abc123' \
	--data '{"amount":100,"description":"refund - defective item"}'

Response fields

If your request is successful, we refund the card payment and return a response. The response contains the following fields:

Response Schema

Status Code 200

Successful request. We refunded the payment.

Response body

Example response

Response

application/json

{
  "paymentId": "JTWWI49L6U",
  "processingTerminalId": "1023",
  "operator": "Adam Smith",
  "order": {
    "orderId": "86f",
    "dateTime": "2024-01-16T16:57:18.000Z",
    "description": "Example payment",
    "amount": 100,
    "currency": "USD"
  },
  "customer": {
    "firstName": "Robert",
    "lastName": "Red",
    "billingAddress": {
      "address1": "billing address",
      "address2": "billing address2",
      "address3": "billing address3",
      "city": "Los Angeles",
      "state": "California",
      "country": "US",
      "postalCode": "90005"
    },
    "shippingAddress": {
      "recipientName": "shipping recipientName",
      "address": {
        "address1": "shipping address1",
        "address2": "shipping address2",
        "address3": "shipping address3",
        "city": "San Diego",
        "state": "California",
        "country": "US",
        "postalCode": "91911"
      }
    }
  },
  "card": {
    "type": "MasterCard",
    "entryMethod": "keyed",
    "cardNumber": "500165******0000",
    "expiryDate": "0328",
    "securityChecks": {
      "cvvResult": "M",
      "avsResult": "Y"
    }
  },
  "refunds": [
    {
      "refundId": "BI77XQFQ05",
      "dateTime": "2024-01-16T17:00:41.000Z",
      "amount": -60,
      "currency": "USD",
      "status": "ready",
      "link": {
        "rel": "self",
        "method": "GET",
        "href": "https://api.payroc.com/v1/refunds/BI77XQFQ05"
      }
    }
  ],
  "supportedOperations": [
    "refund"
  ],
  "transactionResult": {
    "type": "sale",
    "status": "complete",
    "approvalCode": "OK13",
    "authorizedAmount": 100,
    "currency": "USD",
    "responseCode": "A",
    "responseMessage": "OK13"
  }
}

Test cases

Before you run test cases, read the Payments page in Test Your Integration.

Refund a card payment

Send a POST request to the following endpoint: POST https://api.uat.payroc.com/v1/payments/{paymentId}/refund

Note: To settle a payment, the terminal must first close the batch and then our gateway settles the payments within an hour. To adjust when the terminal closes a batch, use the terminal settings in the Merchant Portal.

Example response

{
	"paymentId": "C8Y177VHWR",
	"processingTerminalId": "3204001",
	"order": {
		"orderId": "Test_006",
		"dateTime": "2023-05-24T15:21:01+01:00",
		"amount": 4000,
		"currency": "USD",
		"standingInstructions": {
			"sequence": "subsequent",
			"processingModel": "recurring"
		}
	},
	"card": {
		"type": "Visa Credit",
		"entryMethod": "keyed",
		"cardNumber": "444433******1111",
		"expiryDate": "1226",
		"secureToken": {
			"secureTokenId": "MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA",
			"customerName": "",
			"token": "2967538502417872",
			"status": "cvv_validated",
			"link": {
				"rel": "self",
				"method": "GET",
				"href": "https://api.uat.payroc.com/v1/processing-terminals/3204001/secure-tokens/MREF_1a93f3a6-9029-419f-9e87-3e2db6f0ae85uA"
			}
		},
		"securityChecks": {
			"cvvResult": "M",
			"avsResult": "Y"
		}
	},
	"refunds": [
		{
			"refundId": "G6T6S6KF74",
			"dateTime": "2023-05-25T11:12:55+01:00",
			"amount": -4000,
			"currency": "USD",
			"status": "ready",
			"link": {
				"rel": "self",
				"method": "GET",
				"href": "https://api.uat.payroc.com/v1/refunds/G6T6S6KF74"
			}
		}
	],
	"transactionResult": {
		"type": "sale",
		"status": "ready",
		"approvalCode": "OK14486",
		"authorizedAmount": 4000,
		"currency": "USD",
		"responseCode": "A",
		"responseMessage": "OK14486",
		"cardSchemeReferenceId": "JxDfFMHyOE2lyQJ2MnFp"
	}
}

Run a referenced refund for a card payment

Example request

Example response

Path parameters

Response Schema

Status Code 200

Response body

Query parameters

Response Schema

Status Code 200

Response body

Path parameters

Header parameters

Body parameters

Response Schema

Status Code 200

Response body