Documentation

Overview

Sparkle  provides you access to your resources through RESTful endpoints. so you can test the API. You would also be able to access your test API credential and keys from here

HTTP Request Sample

We would provide cURL request sample, just so you can quickly test each endpoint on your terminal or command line. Need a quick how-to for making cURL requests? just use an HTTP client such as Postman, like the rest of us!

Requests and Responses

Both request body data and response data are formatted as JSON. Content type for responses are always of the type application/json. You can use the Tryba API in test mode, which does not affect your live data or interact with the banking networks. The API key you use to authenticate the request determines whether the request is live mode or test mode

Errors

Errors are returned when one or more validation rules fail or unauthorized access to API. Examples include not passing required parameters e.g. not passing the transaction/provider ref during a re-query call will result in a validation error. Here's a sample below:

                                    
                                    {
                                        "status": "failed",
                                        "message": "tx_ref is required",
                                        "data": "null"
                                    }
                                    
                                    

Initiate Transaction

                                    
                                    curl -X POST "https://whitelabel.justwallet.com/sparkleconnect/public/api/payment" 
                                    -H "Accept: application/json" 
                                    -H "Authorization: Bearer {secret_key}"
                                    -d "{
                                        "amount": "100",
                                        "currency": "NGN",
                                        "email": "[email protected]",
                                        "first_name":"John",
                                        "last_name":"Doe",
                                        "callback_url": "https://webhook.site/9d0b00ba-9a69-44fa-a43d-a82c33c36fdc",
                                        "return_url": "https://webhook.site",
                                        "tx_ref": "2346vrcd",
                                        "customization": {
                                            "title": "Test Payment",
                                            "description": "Payment Description",
                                            "logo": "https://assets.piedpiper.com/logo.png"
                                        },
                                        "meta": {
                                            "uuid": "uuid",
                                            "response": "Response"
                                        }
                                    }"
                                    
                                

Response

                                    
                                    {
                                        "message": "Payment link created",
                                        "status": "success",
                                        "data": {
                                            "checkout_url": "https://whitelabel.justwallet.com/sparkleconnect/public/payment/09229936784"
                                        }
                                    }
                                    
                                

Validate a Transaction

This shows you how to validate a transaction

                                    
                                    curl -X GET "https://whitelabel.justwallet.com/sparkleconnect/public/api/transaction/{tx_ref}"
                                    -H "Accept: application/json" 
                                    -H "Authorization: Bearer {secret_key}"
                                    
                                

Response

                                    
                                    {
                                        "message": "Payment details",
                                        "status": "success",
                                        "data": {
                                            "first_name": "John",
                                            "last_name": "Doe",
                                            "email": "[email protected]",
                                            "currency": "NGN",
                                            "amount": "10,000.00",
                                            "charge": "400.00",
                                            "mode": "test",
                                            "type": "API",
                                            "status": "success",
                                            "reference": "20193542126",
                                            "tx_ref": "2346vrcdssdadffx",
                                            "customization": {
                                                "title": "Test Payment",
                                                "description": "Payment Description",
                                                "logo": "https://logo.png"
                                            },
                                            "meta": {
                                                "uuid": "uuid",
                                                "response": "Response"
                                            },
                                            "created_at": "2022-01-12T10:43:09.000000Z",
                                            "updated_at": "2022-01-12T10:43:09.000000Z"
                                        }
                                    }