Merchants Payshap | API Developer Portal

Summary

Product for all merchant payshap related APIs

Description

Product for all merchant payshap related APIs

APIs

Download API Specs (zip)

Merchant Proxy Management API

1.0.0

The Merchant Proxy Management API API allows trusted client applications to manage merchant participation in the Payshap ecosystem — including viewing ShapIDs, registering & deregistering ShapIDs, viewing historical transactions, and fetching QR codes associated with a merchant.

All endpoints operate within the context of a merchant already known to the bank.

REST

Online
Merchant Request to Pay API

1.0.0

The Merchant Request to Pay API allows trusted client applications to manage request-to-pay (RTP) operations within the Payshap ecosystem — including initiating RTPs by proxy or account, retrieving RTP details and history, listing RTPs with filtering, and managing decline/cancel reason codes.

All endpoints operate within the context of an authenticated merchant.

REST

Online

Plans

In order to subscribe, you must sign in.

Basic Plan

100 calls per minute

Select

Basic Plan
- Merchant Proxy Management API 1.0.0
- Merchant Request to Pay API 1.0.0
View details

APIs

Title	Version	Type	Rate limits
Merchant Proxy Management API	1.0.0	REST	100 calls per minute
GET /token			100 calls per minute
SUMMARY /token			100 calls per minute
PARAMETERS /token			100 calls per minute
GET /merchants			100 calls per minute
PARAMETERS /merchants			100 calls per minute
GET /merchants/registered			100 calls per minute
PARAMETERS /merchants/registered			100 calls per minute
GET /merchants/unregistered			100 calls per minute
PARAMETERS /merchants/unregistered			100 calls per minute
POST /proxies/deregistration			100 calls per minute
PARAMETERS /proxies/deregistration			100 calls per minute
PARAMETERS /proxies/{merchantNumber}			100 calls per minute
GET /proxies/{merchantNumber}			100 calls per minute
POST /proxies			100 calls per minute
GET /proxies			100 calls per minute
PARAMETERS /proxies			100 calls per minute
SUMMARY /transactions			100 calls per minute
POST /transactions			100 calls per minute
PARAMETERS /transactions			100 calls per minute
DESCRIPTION /transactions			100 calls per minute
SUMMARY /qr-codes			100 calls per minute
GET /qr-codes			100 calls per minute
POST /qr-codes			100 calls per minute
PARAMETERS /qr-codes			100 calls per minute
GET /proxies/{proxyId}/resolved			100 calls per minute
POST /proxies/{proxyId}/resolved			100 calls per minute
Merchant Request to Pay API	1.0.0	REST	100 calls per minute
GET /token			100 calls per minute
PARAMETERS /token			100 calls per minute
GET /{rtpId}			100 calls per minute
DELETE /{rtpId}			100 calls per minute
PARAMETERS /{rtpId}			100 calls per minute
GET /{rtpId}/history			100 calls per minute
PARAMETERS /{rtpId}/history			100 calls per minute
POST /proxy			100 calls per minute
GET /list			100 calls per minute
POST /account			100 calls per minute
GET /reasons			100 calls per minute

Contact information

Card Digital Web Team

APIs

Plans

Basic Plan

Basic Plan

Contact information