FX
FX Module Endpoints
| API | Description |
|---|---|
| GET api/getfxquote?MerchantCurrency={MerchantCurrency}&ExchangeCurrency={ExchangeCurrency}&FxTransactionType={FxTransactionType} |
Generates a FXQuote for the requested currencies. The Auth-Token must be provided in the request header. |
| GET api/getFxMultiQuote?fxTransactionType={fxTransactionType} |
Generates a list of FXQuotes for the available currencies. The Auth-Token must be provided in the request header. |
Auth
Auth-Token provider endpoints
| API | Description |
|---|---|
| GET api/auth?MerchantID={MerchantID}&ApiKey={ApiKey} |
Provides AuthToken to be used in subsequent requests to the API. |
Payment
Payment Module Endpoints
| API | Description |
|---|---|
| GET api/pay?MerchantId={MerchantId}&PaymentType={PaymentType}&PayingCurrencyCode={PayingCurrencyCode}&SalePayingAmount={SalePayingAmount}&MerchantReferenceNumber={MerchantReferenceNumber}&UserInfoId={UserInfoId}&CardholderName={CardholderName}&CardholderEmail={CardholderEmail}&MerchantCurrency={MerchantCurrency}&MerchantAmount={MerchantAmount}&FxQuoteId={FxQuoteId}&Redirect={Redirect}&IpAddress={IpAddress}&Telephone={Telephone} |
Initiates a transaction payment by returning the URL to be used for payment. |
| GET api/void?transactionId={transactionId} |
Cancels the latest successful transaction operation. Use with caution. |
| GET api/refund?transactionId={transactionId}&refundAmount={refundAmount}&transactionType={transactionType}&fxQuoteId={fxQuoteId} |
Refund an already captured transaction. |
| GET api/capture?transactionId={transactionId}&captureAmount={captureAmount}&transactionType={transactionType} |
Single capture on an already authorized transaction |