If a customer requests a refund and the payment is still in an open batch, the merchant can use their POS to look up the bank transfer payment and cancel the transaction. To find the paymentId of the bank transfer payment that the merchant wants to reverse, they can retrieve a list of all the bank transfer payments that meet the search criteria that the merchant provides. They can then find the transaction that they want in the list of returned results.

If the merchant runs a referenced refund on a bank transfer payment that is in an open batch, our gateway automatically reverses the payment.

Integration steps

Step 1. (Optional) List bank transfer payments.
Step 2. Reverse the bank transfer 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. (Optional) List bank transfer payments

To retrieve a list of bank transfer payments, send a GET request to our Bank Transfer Payments endpoint. Use our filters to narrow down the search results. 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, we retrieve a list of the bank transfer 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": "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. Reverse the bank transfer payment

To reverse a bank transfer payment, send a POST request to the Bank Transfer Payments endpoint.
If the merchant wants to reverse only part of the transaction, send the amount that they want to reverse in the amount parameter. Test endpoint: https://api.uat.payroc.com/v1/bank-transfer-payments/{paymentId}/reverse
Production endpoint: https://api.payroc.com/v1/bank-transfer-payments/{paymentId}/reverse

Request parameters

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

Path parameters

Header parameters

Example request

Request

curl --request post \
	--url https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse \
	--header 'Authorization: Bearer <access token>' \
	--header 'Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324'

Response fields

If your request is successful, we reverse the bank transfer payment and return a response. The response contains the following fields:

Response Schema

Status Code 200

Successful request. We voided the payment.

Response body

Example response

Response

application/json

{
  "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",
        "percentage": 10
      },
      "taxes": [
        {
          "name": "VAT",
          "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"
  },
  "transactionResult": {
    "type": "payment",
    "status": "reversal",
    "authorizedAmount": 4999,
    "currency": "USD",
    "responseCode": "A"
  },
  "customFields": [
    {
      "name": "yourCustomField",
      "value": "abc123"
    }
  ]
}

Reverse a bank transfer payment

Example request

Example response

Query parameters

Response Schema

Status Code 200

Response body

Path parameters

Header parameters

Response Schema

Status Code 200

Response body