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 bank account number.

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 GET 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.

curl
-H "Content-Type: application/json"
-H "Authorization: <Bearer token>"

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 the details of the payment

1a (Optional) – Retrieve the details of the payment with a paymentId

Send a GET request with the paymentID to our Bank Transfer Payments endpoint. Testing endpoint: https://api.uat.payroc.com/v1/bank-transfer-payments/{paymentid}
Production endpoint: https://api.payroc.com/v1/bank-transfer-payments/{paymentid}

Request parameters

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

Path parameters

Example request

Request

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

Response fields

If your request is successful, our gateway returns the details of the payment. The response contains the following fields:

Response Schema

Status Code 200

Successful request. Returns the specific payment.

Response body

Example response

Response

application/json

{
  "paymentId": "M2MJOG6O2Y",
  "processingTerminalId": "1017",
  "order": {
    "orderId": "OrderRef6543",
    "dateTime": "2024-07-02T15:30:00Z",
    "description": "Large Pepperoni Pizza",
    "amount": 4999,
    "currency": "USD",
    "breakdown": {
      "subtotal": 4347,
      "tip": {
        "type": "percentage",
        "amount": 435,
        "percentage": 10
      },
      "taxes": [
        {
          "name": "Sales Tax",
          "rate": 5,
          "amount": 217
        }
      ]
    }
  },
  "customer": {
    "contactMethods": [
      {
        "type": "email",
        "value": "[email protected]"
      }
    ],
    "notificationLanguage": "en"
  },
  "bankAccount": {
    "type": "ach",
    "secCode": "web",
    "accountType": "checking",
    "nameOnAccount": "Sarah Hazel Hopper",
    "accountNumber": "****3159",
    "routingNumber": "063100277",
    "secureToken": {
      "secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
      "customerName": "Sarah Hazel Hopper",
      "token": "296753123456",
      "status": "notValidated",
      "link": {
        "rel": "self",
        "method": "GET",
        "href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa"
      }
    }
  },
  "transactionResult": {
    "type": "payment",
    "status": "ready",
    "authorizedAmount": 4999,
    "currency": "USD",
    "responseCode": "A",
    "responseMessage": "NoError",
    "processorResponseCode": "0"
  },
  "customFields": [
    {
      "name": "yourCustomField",
      "value": "abc123"
    }
  ]
}

1b (Optional) – Retrieve the details of the payment without a paymentId

Send a GET request to our Bank Transfer Payments endpoint. To filter your results, use query parameters. Test endpoint: https://api.uat.payroc.com/v1/bank-transfer-payments
Production endpoint: https://api.payroc.com/v1/bank-transfer-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/bank-transfer-payments?processingTerminalId=1234001' \
	--header 'Authorization: Bearer <access token>'

Response fields

If your request is successful, our gateway returns a list of payments that match the query parameters. 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": "M2MJOG6O2Y",
      "processingTerminalId": "1234001",
      "order": {
        "orderId": "OrderRef6543",
        "dateTime": "2024-07-02T15:30:00Z",
        "description": "Large Pepperoni Pizza",
        "amount": 4999,
        "currency": "USD",
        "breakdown": {
          "subtotal": 4347,
          "tip": {
            "type": "percentage",
            "amount": 435,
            "percentage": 10
          },
          "taxes": [
            {
              "name": "Sales Tax",
              "rate": 5,
              "amount": 217
            }
          ]
        }
      },
      "customer": {
        "contactMethods": [
          {
            "type": "email",
            "value": "[email protected]"
          }
        ],
        "notificationLanguage": "en"
      },
      "bankAccount": {
        "type": "pad",
        "nameOnAccount": "Sarah Hazel Hopper",
        "accountNumber": "*******3159",
        "transitNumber": "76543",
        "institutionNumber": "543"
      },
      "transactionResult": {
        "type": "payment",
        "status": "ready",
        "authorizedAmount": 4999,
        "currency": "USD",
        "responseCode": "A"
      }
    },
    {
      "paymentId": "E29U8OU8Q4",
      "processingTerminalId": "1234001",
      "order": {
        "orderId": "OrderRef7654",
        "dateTime": "2024-07-02T15:30:00Z",
        "description": "test",
        "amount": 3999,
        "currency": "USD",
        "breakdown": {
          "subtotal": 3477,
          "tip": {
            "type": "percentage",
            "amount": 348,
            "percentage": 10
          },
          "taxes": [
            {
              "name": "Sales Tax",
              "rate": 5,
              "amount": 174
            }
          ]
        }
      },
      "customer": {
        "contactMethods": [
          {
            "type": "email",
            "value": "[email protected]"
          }
        ],
        "notificationLanguage": "en"
      },
      "bankAccount": {
        "type": "pad",
        "nameOnAccount": "Sarah Hazel Hopper",
        "accountNumber": "*******7890",
        "transitNumber": "76543",
        "institutionNumber": "543"
      },
      "transactionResult": {
        "type": "payment",
        "status": "ready",
        "authorizedAmount": 3999,
        "currency": "USD",
        "responseCode": "A"
      },
      "customFields": [
        {
          "name": "yourCustomField",
          "value": "abc123"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "next",
      "method": "get",
      "href": "https://api.payroc.com/v1/bank-transfer-payments?limit=2&processingTerminalId=1234001&after=E29U8OU8Q4"
    },
    {
      "rel": "previous",
      "method": "get",
      "href": "https://api.payroc.com/v1//bank-transfer-payments?limit=2&processingTerminalId=1234001&before=M2MJOG6O2Y"
    }
  ]
}

Step 2 - Refund the payment

To refund the payment, send a POST request to our Bank Transfer Payments Refund endpoint. Test endpoint: https://api.uat.payroc.com/v1/bank-transfer-payments{paymentid}/refund
Production endpoint: https://api.payroc.com/v1/bank-transfer-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/bank-transfer-payments/M2MJOG6O2Y/refund \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324' \
	--data '{"amount":4999,"description":"amount to refund"}'

Response fields

If your request is successful, our gateway refunds the payment. 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": "M2MJOG6O2Y",
  "processingTerminalId": "1234001",
  "order": {
    "orderId": "OrderRef6543",
    "dateTime": "2024-07-02T15:30:00Z",
    "description": "Refund for order OrderRef6543",
    "amount": 4999,
    "currency": "USD",
    "breakdown": {
      "subtotal": 4347,
      "tip": {
        "type": "percentage",
        "amount": 435,
        "percentage": 10
      },
      "taxes": [
        {
          "name": "Sales Tax",
          "rate": 5,
          "amount": 217
        }
      ]
    }
  },
  "customer": {
    "contactMethods": [
      {
        "type": "email",
        "value": "[email protected]"
      }
    ],
    "notificationLanguage": "en"
  },
  "bankAccount": {
    "type": "pad",
    "nameOnAccount": "Sarah Hazel Hopper",
    "accountNumber": "****7890",
    "transitNumber": "76543",
    "institutionNumber": "543",
    "secureToken": {
      "secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
      "customerName": "Sarah Hopper",
      "token": "296753123456",
      "status": "notValidated",
      "link": {
        "rel": "self",
        "method": "GET",
        "href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa"
      }
    }
  },
  "transactionResult": {
    "type": "payment",
    "status": "reversal",
    "authorizedAmount": 4999,
    "currency": "USD",
    "responseCode": "A"
  },
  "customFields": [
    {
      "name": "yourCustomField",
      "value": "abc123"
    }
  ]
}

Send a referenced refund to a bank account

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