Récupérer la Liste des Passerelles Accordées avec l'API CashChap

Ce document explique comment utiliser l'API de CashChap pour récupérer la liste des passerelles accordées à un service spécifique. La requête est effectuée via la méthode GET.

URL de l'API

GET https://api.cashchap.com/v1/authorized-gateways

Paramètres de la Requête

En-têtes (Headers)

• X-Api-Public-Key: La clé publique API fournie par CashChap. Ce paramètre est requis pour authentifier votre requête.

Exemple de Requête

Voici un exemple de requête cURL pour récupérer la liste des passerelles :

curl -X GET https://api.cashchap.com/v1/authorized-gateways \
-H "X-Api-Public-Key: VOTRE_CLÉ_PUBLIQUE"

Réponses de l'API

Réponse en Cas de Succès

En cas de succès, l'API renverra une réponse au format JSON contenant les informations sur les passerelles accordées au service.

{
    "success": true,
    "service": {
    "name": "Default",
    "id": "ab83f23b-02e0-434d-8d5b-364578e0a19b",
    "mode": "LIVE"
    },
    "payment_methods": {
    "BANK CARD": {
        "logo": "https://api.cashchap.com/pictures/payment_methods_logos/credit-card.png",
        "code": "BankCard",
        "networks": {
        "VISA": {
            "logo": "https://api.cashchap.com/pictures/networks_logos/Old_Visa_Logo.svg.png",
            "data": [
            {
                "gateway_name": "VISA",
                "gateway_code": "visa",
                "currency": "USD",
                "min_amount_withdrawn": 0,
                "country": {
                "name": "Etats-Unis",
                "code": "1",
                "iso": "US"
                },
                "logo": "https://api.cashchap.com/pictures/gateways_logos/visa.png",
                "payment_methods": "BANK CARD",
                "network": "VISA",
                "assume_transaction_fees": 0,
                "supported_currencies": [
                {
                    "code": "XOF",
                    "name": "West African CFA franc",
                    "symbol": "CFA",
                    "exchange_rate": 1,
                    "logo": "https://api.cashchap.com/pictures/currencies_logos/cfa.jpg",
                    "country": "Multiple West African countries"
                }
                ],
                "fees": {
                "type": "percentage",
                "value": 0
                }
            }
            ]
        },
        }
    },
    "DEBIT DIRECT": {
        "logo": "https://api.cashchap.com/pictures/payment_methods_logos/piggy-bank.png",
        "code": "DebitDirect",
        "networks": {
        "BAXI": {
            "logo": "https://api.cashchap.com/pictures/networks_logos/baxi-logo.png",
            "data": [
            {
                "gateway_name": "BAXI",
                "gateway_code": "baxi-nigeria",
                "currency": "NGN",
                "min_amount_withdrawn": 0,
                "country": {
                "name": "Nigeria",
                "code": "234",
                "iso": "NG"
                },
                "logo": "https://api.cashchap.com/pictures/gateways_logos/nigeria.png",
                "payment_methods": "DEBIT DIRECT",
                "network": "BAXI",
                "assume_transaction_fees": 0,
                "supported_currencies": [
                {
                    "code": "NGN",
                    "name": "Nigerian Naira",
                    "symbol": "₦",
                    "exchange_rate": 1,
                    "logo": "https://api.cashchap.com/pictures/currencies_logos/naira.jpg",
                    "country": "Nigeria"
                }
                ],
                "fees": {
                "type": "percentage",
                "value": 0
                }
            }
            ]
        }
        }
    },
    "MOBILE MONEY": {
        "logo": "https://api.cashchap.com/pictures/payment_methods_logos/tablet-smartphone.png",
        "code": "MobileMoney",
        "networks": {
        "ORANGE": {
            "logo": "https://api.cashchap.com/pictures/networks_logos/orange-logo.png",
            "data": [
            {
                "gateway_name": "ORANGE MONEY",
                "gateway_code": "orange-rdc",
                "currency": "CDF",
                "min_amount_withdrawn": 0,
                "country": {
                "name": "RDC",
                "code": "243",
                "iso": "CD"
                },
                "logo": "https://api.cashchap.com/pictures/gateways_logos/orangerdc.jpg",
                "payment_methods": "MOBILE MONEY",
                "network": "ORANGE",
                "assume_transaction_fees": 0,
                "supported_currencies": [
                {
                    "code": "XOF",
                    "name": "West African CFA franc",
                    "symbol": "CFA",
                    "exchange_rate": 1,
                    "logo": "https://api.cashchap.com/pictures/currencies_logos/cfa.jpg",
                    "country": "Multiple West African countries"
                }
                ],
                "fees": {
                "type": "percentage",
                "value": 0
                }
            }
            ]
        }
        }
    }
    }
}

Réponse en Cas d'Erreur

En cas d'erreur, l'API renverra une réponse indiquant le problème rencontré.

{
"success": false,
"message": "No service exists with this public key."
}

Conclusion

Ce document vous guide sur la façon d'utiliser l'API CashChap pour obtenir la liste des passerelles autorisées pour un service donné. Assurez-vous d'inclure l'en-tête X-Api-Public-Key pour l'authentification et consultez les réponses pour vérifier le succès ou les erreurs possibles.

Effectuer une Collecte de Paiement avec l'API CashChap

Ce document explique comment utiliser l'API de CashChap pour effectuer une collecte de paiement en fonction de la méthode spécifiée. La requête est effectuée via la méthode POST.

URL de l'API

POST https://api.cashchap.com/v1/collection/{method}

Remplacez {method} par l'une des méthodes suivantes : MobileMoney, BankCard, ou DebitDirect.

Paramètres de la Requête

En-têtes (Headers)

• X-Api-Public-Key: La clé publique API fournie par CashChap. Ce paramètre est requis pour authentifier votre requête.
• X-Transaction-Id: Un identifiant unique pour la transaction.

Corps de la Requête (Body)

Pour MobileMoney

Lorsque vous utilisez MobileMoney, le corps de la requête doit être structuré comme suit :

{
"amount": "1",
"provider": "mtn-benin",
"currency": "XOF",
"customer": {
"email": "johndoe@gmail.com",
"fullname": "Jobs",
"phone": "90 00 00 00"
}
}

Pour BankCard

Lorsque vous utilisez BankCard, le corps de la requête doit inclure les informations suivantes :

{
    "amount": "1",
    "currency": "XOF",
    "customer": {
    "email": "johndoe@gmail.com",
    "fullname": "Jobs",
    "phone": "90 00 00 00",
    "card_details": {
        "card_number": "1234567890123456",
        "expiry_date": "12/25",
        "cvv": "123"
    }
    }
}

Note: Assurez-vous que les détails de la carte sont correctement formatés et sécurisés.

Pour DebitDirect

Lorsque vous utilisez DebitDirect, le corps de la requête doit inclure les informations suivantes :

{
    "amount": "1",
    "currency": "XOF",
    "customer": {
    "email": "johndoe@gmail.com",
    "fullname": "Jobs",
    "phone": "90 00 00 00",
    "account_details": {
        "account_number": "1234567890",
        "bank_code": "XYZ"
    }
    }
}

Note: Assurez-vous que les détails du compte sont correctement formatés.

Exemple de Requête

Voici un exemple de requête cURL pour effectuer une collecte avec MobileMoney :

curl -X POST https://api.cashchap.com/v1/collection/MobileMoney \
-H "X-Api-Public-Key: VOTRE_CLÉ_PUBLIQUE" \
-H "X-Transaction-Id: VOTRE_ID_TRANSACTION" \
-H "Content-Type: application/json" \
-d '{
    "amount": "1",
    "provider": "mtn-benin",
    "currency": "XOF",
    "customer": {
    "email": "johndoe@gmail.com",
    "fullname": "Jobs",
    "phone": "90 00 00 00"
    }
}'

Réponses de l'API

Réponse en Cas de Succès

En cas de succès, l'API renverra une réponse au format JSON confirmant la collecte de paiement.

{
"success": true,
"message": "Transaction successful."
"transaction_id": "1234567890"
}

Réponse en Cas d'Erreur

En cas d'erreur, l'API renverra une réponse indiquant le problème rencontré.

{
"success": false,
"message": "Transaction processing error."
}

Conclusion

Ce document vous guide sur la façon d'utiliser l'API CashChap pour effectuer une collecte de paiement selon la méthode spécifiée. Assurez-vous d'inclure les en-têtes requis et de structurer correctement le corps de la requête en fonction de la méthode de paiement choisie.

Vérification du Statut d'une Transaction avec l'API CashChap

Ce document décrit comment utiliser l'API de CashChap pour vérifier le statut d'une transaction. Vous devrez envoyer une requête POST à l'URL suivante avec des paramètres spécifiques pour obtenir les informations de statut.

URL de l'API

POST https://api.cashchap.com/v1/transaction-status

Paramètres de la Requête

En-têtes (Headers)

• X-Api-Public-Key: Clé publique API fournie par CashChap. Ce paramètre est obligatoire pour authentifier votre requête.

Corps de la Requête (Body)

Le corps de la requête doit contenir l'un des deux paramètres suivants, en format UUID :

• transactionId: Identifiant unique de la transaction que vous souhaitez vérifier. Ce paramètre est requis si vous ne fournissez pas externalId.
• externalId: Identifiant externe associé à la transaction. Ce paramètre est requis si vous ne fournissez pas transactionId.

Exemple de Corps de la Requête en JSON :

{
"transactionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"externalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Remarques

• Un seul des deux paramètres doit être fourni dans le corps de la requête. Vous ne devez pas inclure à la fois transactionId et externalId.
• Les valeurs des paramètres doivent être au format UUID.

Exemple de Requête en cURL

Voici un exemple de requête cURL pour vérifier le statut d'une transaction en utilisant l'API CashChap :

curl -X POST https://api.cashchap.com/v1/transaction-status \
-H "X-Api-Public-Key: VOTRE_CLÉ_PUBLIQUE" \
-H "Content-Type: application/json" \
-d '{
"transactionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}'

Réponse de l'API

En cas de succès, l'API renverra un objet JSON contenant le statut de la transaction et d'autres détails pertinents. Si la requête échoue, l'API renverra un message d'erreur expliquant le problème.

Exemple de Réponse en JSON

{
"success": true,
"status": "FAILED",
"transactionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"external_id": "ext123456789",
"payment": {
    "provider": "Provider WAX",
    "method": "MTN",
    "network": "Network A",
    "currency": "USD",
    "initial_amount": 5000,
    "debited_amount": 4750,
    "commission_fees": 250,
    "available_amount": 1000,
    "is_available": true
},
"currency": {
    "from": "XOF",
    "to": "USD",
    "rate": 1
},
"customer": {
    "name": "Jean Dupont",
    "email": "jean.dupont@example.com",
    "phone": "+33123456789"
},
"metadata": "{\"key1\": \"value1\", \"key2\": \"value2\"}",
"message": "Payment successful",
"transaction_created_at": "06-09-2024 20:31:22",
"completed_at": "06-09-2024 20:31:22"
}

Exemple de Réponse en cas d'Erreur

{
"success": false,
"message": "Transaction not found with the provided ID."
}

Statut des Transactions

Lors de l'utilisation de notre plateforme, vous pouvez rencontrer différents statuts de transaction. Ce tableau décrit les status auxquels vous pouvez vous attendre lors de vos intégrations.

Statut	Description
VALIDATED	La transaction a été validée avec succès.
FAILED	La transaction a échoué.
REFUNDED	La transaction a été remboursée.
CANCELLED	La transaction a été annulée.

Conclusion

En suivant ces instructions, vous pouvez facilement vérifier le statut de vos transactions en utilisant l'API CashChap. Assurez-vous de respecter les exigences de format et de fournir les informations nécessaires pour obtenir une réponse correcte de l'API.