Get List of Payment Gateways

Learn how to get the list of payment gateways.

Payment Gateway - Data Model

fieldtypedescription
idstringID of the payment gateway.
Usually of the form: countryCode.type.shortname.currency
ng.bank.ecobank.ngn
countryCodestringTwo letter country shortcode, e.g. ng
currencystringThree letter currency code, e.g. NGN, KES
typeenumType of payment gateway. Valid values are:
bank , mobile-money, wallet
institutionIdstringShort local name of the institution
namestringLong offical name of the institution
feeStructurestringFee Structure for all withdrawal charges performed by the payment gateway
rsaPublicKeyBase64stringRSA public key of the payment gateway, base64 encoded
emailstringEmail of the payment gateway
websitestringWebsite of the payment gateway
accountVerificationEndpointstringAccount Verification Endpoint for the payment gateway
accountVerificationBearerTokenstringAccount Verification Bearer Token for the payment gateway
processingGatewaystringContains the id of the payment gateway which process all requests for this gateway.
null if this is a root PAPE gateway

API Calls

Endpoints

staging: https://apis-alpha.dev.projectwhite.io

Parameters

None

Responses
http codecontent-typeresponse
200application/jsonReturns list of payment gateways
4xxapplication/json{"error": "string","message": "string"

Try It Out

Get Token

export PAPE_TOKEN_ENDPOINT=https://id.dev.projectwhite.io/auth/realms/projectwhite/protocol/openid-connect/token;

export PAPE_API_ENDPOINT=https://apis-alpha.dev.projectwhite.io
export PAPE_USERNAME=cm.wallet.interstellar-demo.xaf;
export PAPE_PASSWORD=abc;
export PAPE_TOKEN=`curl -s --request POST \
--url "$PAPE_TOKEN_ENDPOINT" \
--data-urlencode grant_type=password \
--data-urlencode username=$PAPE_USERNAME \
--data-urlencode password=$PAPE_PASSWORD \
--data-urlencode 'client_id=projectwhite' \
| jq -r ".access_token"`

echo $PAPE_TOKEN

Get Payment Gateways

curl -s --request GET \
--url "$PAPE_API_ENDPOINT/payment-gateways" \
--header  "accept: application/json" \
--header 'accept: */*' \
--header "Authorization: Bearer $PAPE_TOKEN" | jq .