Overview
- Paymongo API allows businesses to accept digital payments from customers.
- The API gives businesses access to the GCash payment network.
- This enables them to process one of the most used digital wallet in the Philippines through a secure payment website.
Using the API
We built the API to be as self-documenting as possible, but if you find yourself overwhelmed, we organized this site into four major areas.
- Getting started introduces you to the operations offered by the API.
- API calls gives you a hands-on experience of those operations with an interactive console.
Getting Started
The current version of the API lives at https://gateway.qymera.tech/qymera/sb/patients/v1/.
- https://gateway.qymera.tech/qymera/sb/paymongo/v1/gcash/authorize
Endpoints
| Endpoint | What it does |
|---|---|
/gcash/authorize |
This endpoint will authorize GCash payments thru Paymongo. |
API Calls
Headers
| Key | Value Description |
|---|---|
accept |
application/json |
x-ibm-client-id |
Use the given application credential id |
x-ibm-client-secret |
Use the given application credential secret |
Authorization |
Use the generated bearer token |
/gcash/authorize
Implementation Notes
Authorize GCash Payment
Parameters:
| Parameter | Data Type | Necessity | Location | Description |
|---|---|---|---|---|
amount |
number | required | body | Amount |
redirect.success |
string | required | body | Redirect URL if successful transaction. |
redirect.failed |
string | required | body | Redirect URL if failed transaction. |
Sample Request:
curl --request POST \
--url 'https://gateway.qymera.tech/qymera/sb/paymongo/v1/gcash/authorize' \
--header 'accept: application/json' \
--header 'x-ibm-client-id: REPLACE_THIS_VALUE' \
--header 'x-ibm-client-secret: REPLACE_THIS_VALUE' \
--data-raw '{
"amount": REPLACE_THIS_VALUE,
"redirect": {
"success": REPLACE_THIS_VALUE,
"failed": REPLACE_THIS_VALUE
}
}'
Request:
POST
https://gateway.qymera.tech/qymera/sb/paymongo/v1/gcash/authorize
Response:
200
{
"redirect_url": "https://test-sources.paymongo.com/sources?id=src_KgeinxcbdEjcK6md3kmrSpG5",
"source_id": "src_KgeinxcbdEjcK6md3kmrSpG5"
}
404
{
"code": -14,
"message": "Something went wrong authorizing payment."
}