Skip to main content

PayRetailers

Quick Start
  1. Sign up at payretailers.com and obtain API credentials
  2. Create a terminal in the Admin Console with the parameters below
  3. Start processing — the adapter is pre-built and ready to use

Go to PayRetailers →

Overview

PayRetailers payment integration

Provider IDpayretailers
CategoryLocal Payment Methods
Websitepayretailers.com

Authentication

  • Method: Bearer token
  • Base URL: https://api.payretailers.com/

Configuration

Required Parameters

ParameterDescription
api_keyAPI Key
secret_keySecret Key
commerce_idCommerce ID

Example Configuration

{
"provider": "payretailers",
"provider_params": {
"api_key": "your_api_key_here",
"secret_key": "your_secret_key_here",
"commerce_id": "your_commerce_id_here"
}
}

Status Mapping

Provider Status4pay StatusDescription
COMPLETEDcharged
APPROVEDcharged
PENDINGcharging
PROCESSINGcharging
EXPIREDfailed
REFUNDEDrefunded
PARTIALLY_REFUNDEDrefunding
REJECTEDrejected
CANCELLEDrejected
ERRORrejected

API Reference

MethodEndpointDescription
POSTapi/v1/payments
GETapi/v1/payments/#{payment_id}
POSTapi/v1/payments/#{payment_id}/refunds

Resources