Skip to main content

Request Payment Session

This endpoint requests a payment session for VISA/Mastercard.

POST

https://payments.relworx.com/api/visa/request-session

Arguments

ParameterTypeRequiredDescription
account_nostringYesBusiness account number. This is generated for you when you create a business account.
referencestringYesA unique generated string to identify your request. A minimum of 8 and maximum of 36 characters is allowed.
currencystringYes3 letter ISO currency code for example UGX. No currency conversion is done. Currently we support UGX and USD.
amountdecimalYesAmount to be deducted from Visa/Mastercard card holder.
descriptionstringNoA description for the request.

Sample request to get a payment session

curl "https://payments.relworx.com/api/visa/request-session" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/vnd.relworx.v2" \
-H "Authorization: Bearer <--Your API Key-->" \
-d '{
"account_no": "RELJH012BV45P",
"reference": "52750b30ffbc7de3b36",
"currency": "UGX",
"amount": 10000.00,
"description": "Payment Request.",
}'

Sample response. Load returned payment_url to access visa payment form.

{
"success": true,
"message": "Visa/Mastercard payment url generated successfully.",
"payment_url": "https://payments.relworx.com/merchant-payment/1573621698448/visa-mastercard"
}