Jump to Content

Documentation API Reference Changelog

API Reference

Documentation API Reference Changelog

Protocol details

HTTP Protocol
URLs
Common Parameters
- Payment Gateway
- Boarding Platform
Security
Important note about transaction states

Payment Gateway

TRANSACTION
GETTXSTATUS
- GETTXSTATUS requestpost
- GETTXSTATUS response
GETTXSTATUSBYMERCHANTTXID
- GETTXSTATUSBYMERCHANTTXID requestpost
- GETTXSTATUSBYMERCHANTTXID response
REFUND
- REFUND requestpost
- REFUND response
GETREFUNDSTATUS
- GETREFUNDSTATUS requestpost
- GETREFUNDSTATUS response
GETREFUNDSTATUSBYMERCHANTREFUNDID
- GETREFUNDSTATUSBYMERCHANTREFUNDID requestpost
- GETREFUNDSTATUSBYMERCHANTREFUNDID response
REQUESTDATA
- REQUESTDATA requestpost
- REQUESTDATA response
CANCELTX
- CANCELTX requestpost
- CANCELTX response
Dynamic Descriptor
Notifications
Errors
- REQUESTFAILREASON

BOARDING PLATFORM

/submit
- Input parameters
- Output parameters
/getstatus
- Input parameters
- Output parameters
/amend
- Input parameters
- Output parameters
/addpaymentmethod
- Input parameters
- Output parameters
/amendpaymentmethod
- Input parameters
- Output parameters
/promoteplatform
- Input parameters
- Output parameters
/updatepricinggroup
- Input parameters
- Output parameters
Notifications

Protocol details

HTTP Protocol
URLs
Common Parameters
- Payment Gateway
- Boarding Platform
Security
Important note about transaction states

Payment Gateway

TRANSACTION
GETTXSTATUS
- GETTXSTATUS requestpost
- GETTXSTATUS response
GETTXSTATUSBYMERCHANTTXID
- GETTXSTATUSBYMERCHANTTXID requestpost
- GETTXSTATUSBYMERCHANTTXID response
REFUND
- REFUND requestpost
- REFUND response
GETREFUNDSTATUS
- GETREFUNDSTATUS requestpost
- GETREFUNDSTATUS response
GETREFUNDSTATUSBYMERCHANTREFUNDID
- GETREFUNDSTATUSBYMERCHANTREFUNDID requestpost
- GETREFUNDSTATUSBYMERCHANTREFUNDID response
REQUESTDATA
- REQUESTDATA requestpost
- REQUESTDATA response
CANCELTX
- CANCELTX requestpost
- CANCELTX response
Dynamic Descriptor
Notifications
Errors
- REQUESTFAILREASON

BOARDING PLATFORM

/submit
- Input parameters
- Output parameters
/getstatus
- Input parameters
- Output parameters
/amend
- Input parameters
- Output parameters
/addpaymentmethod
- Input parameters
- Output parameters
/amendpaymentmethod
- Input parameters
- Output parameters
/promoteplatform
- Input parameters
- Output parameters
/updatepricinggroup
- Input parameters
- Output parameters
Notifications

URLs

Payment Gateway


Test system	https://simpleapitest.ppro.com
Live system	https://simpleapi.ppro.com

Boarding Platform


Live system	https://boardingapi.girogate.de

Table of Contents
- Payment Gateway
- Boarding Platform