OLD - DONT USE - Definitions
The below API definitions are for the following OpusPAY functions
-
-
-
-
Process Recurring Payment (TBD)
1. Process Payment
Header
|
Attribute
|
Description
|
Type
|
Required
|
|
Merchant API Key
|
OpusPAY API Key for merchant
|
String
|
Y
|
|
Merchant API Password
|
OpusPAY API Password for merchant
|
String
|
Y
|
Request Body
|
Request
|
Description
|
Type
|
Required
|
|
Amount
|
Amount to be paid for invoice
|
Double
|
Y
|
|
CurrencyCode
|
Currency in which the invoice is being paid
|
String
|
Y
|
|
InvoiceNo
|
Invoice no.
|
String
|
Y
|
|
ApplicationID
|
Id of the external application making a call to the OpusPAY Payment API
|
String
|
Y
|
|
MerchantID
|
Unique key for the merchant to integrate their external application with OpusPAY Payment API
|
String
|
Y
|
|
Token
|
Unique token generated by the external application sent to OpusPAY Payment API (This maybe not required - Charith)
|
String
|
Y
|
|
Payment Method
|
Credit Card, ACH, Not Present etc.
|
String
|
Y
|
|
DeviceID
|
Unique device id of the card reader
|
String
|
N
|
|
User
|
User initiating the transaction at the external application for audit purposes (This maybe not required - Charith)
|
String
|
N
|
|
Callback URL - success
|
Notification URL for the external application to update the payment status.
|
String
|
Y
|
|
Callback URL -error
|
Notification URL for the external application to update the payment status.
|
String
|
Y
|
Response Body
|
Response
|
Description
|
Type
|
Required
|
|
Status
|
Status of the Response for e.g. Successful, Bad Request etc. Either one from Status or Status Code is needed.
|
String
|
Y
|
|
Status Code
|
Status Code of the Response. for e.g. 200, 401 etc. Either one from Status or Status Code is needed.
|
String
|
Y
|
|
Status Message
|
Descriptive message about the response.
|
String
|
Y
|
|
Payment Reference / Token (confirm)
|
Payment Reference / token issued by OpusPAY to transaction in byondpro.
|
String
|
Y
|
|
Redirect URL
|
Returned URL for payment link etc.
|
String
|
N
|
2. Get Payment Details
Header
|
Attribute
|
Description
|
Type
|
Required
|
|
Merchant API Key
|
OpusPAY API Key for merchant
|
String
|
Y
|
|
Merchant API Password
|
OpusPAY API Password for merchant
|
String
|
Y
|
Request Body
|
Request
|
Description
|
Type
|
Required
|
|
TransactionID
|
TransactionID / Token issued by a Gateway for a transaction
|
String
|
Y
|
Response Body
|
Response
|
Description
|
Type
|
Required
|
|
Id
|
TransactionID issued by the Gateway
|
String
|
Y
|
|
Created Time
|
|
String
|
Y
|
|
Card Expiry
|
Expiry date of card used for transaction
|
String
|
Y
|
|
Currency
|
|
String
|
Y
|
3. Process Refund
Header
|
Attribute
|
Description
|
Type
|
Required
|
|
Merchant API Key
|
OpusPAY API Key for merchant
|
String
|
Y
|
|
Merchant API Password
|
OpusPAY API Password for merchant
|
String
|
Y
|
Request Body
|
Request
|
Description
|
Type
|
Required
|
|
InvoiceID
|
InvoiceID of invoice for which the refund is being processed
|
String
|
Y
|
|
Invoice Amount
|
Amount to be refunded
|
Currency
|
Y
|
|
Currency Code
|
Currency of the amount to be refunded
|
Currency
|
Y
|
|
Transaction Id
|
Token issued by the Gateway for the original transaction for which the refund is being processed.
|
String
|
Y
|
Response Body
|
Response
|
Description
|
Type
|
Required
|
|
Status
|
Status of the Response for e.g. Successful, Bad Request etc. Either one from Status or Status Code is needed.
|
String
|
Y
|
|
Status Code
|
Status Code of the Response. for e.g. 200, 401 etc. Either one from Status or Status Code is needed.
|
String
|
Y
|
|
Status Message
|
Descriptive message about the response.
|
String
|
Y
|
|
Transaction Id
|
Refund token id for the transaction being refunded
|
String
|
Y
|
|
Created Date Time
|
Date and Time when refund was created
|
Date Time
|
Y
|
|
Modified Date Time
|
Date and Time when refund was updated
|
Date Time
|
Y
|
