🔎Retrouver un paiement

L'API de la plateforme Moneroo offre un endpoint qui vous permet de récupérer les informations détaillées d'une transaction de paiement spécifique sur la base de son transaction ID.

Ce guide vous guidera à travers le processus de récupération d'une transaction de paiement en utilisant l'API de Moneroo.

Demande

GET /v1/payments/{paymentId} HTTP/1.1
Host: https://api.moneroo.io
Authorization: Bearer YOUR_SECRET_KEY
Content-Type: application/json
Accept: application/json

ParamĂštres

  • Endpoint: /v1/payments/{paymentId}

  • Method: GET

NomTypeExigéeDescription

paymentId

String

Oui

L'id de l'opération de paiement à récupérer.

Structure de la RĂ©ponse

La réponse de cet endpoint de l'API sera dans le format standard de réponse de l'API Moneroo.

Vous obtiendrez une réponse qui ressemble à celle-ci :

{
  "success": true,
  "message": "Payment transaction fetched successfully",
  "data": {
    // Details of the payment transaction
  }
}

RĂ©ponse Positive:

En cas de récupération réussie, l'endpoint renvoie un code d'état HTTP de 200 et les détails de l'opération de paiement dans le corps de la réponse.

RĂ©ponses d'erreurs :

Si votre demande pose un problÚme, l'API renvoie une réponse d'erreur. Le type de réponse dépend de la nature du problÚme. Consultez notre page sur les formats de réponse pour plus d'informations.

Considérations de sécurité

Cet endpoint nĂ©cessite un jeton de support pour l'authentification. Ce jeton doit ĂȘtre inclus dans l'en-tĂȘte Authorization de la demande. Assurez-vous que le jeton est conservĂ© en toute sĂ©curitĂ© et qu'il n'est pas partagĂ© ou exposĂ© de maniĂšre inappropriĂ©e.

Exemples de demandes

Veuillez remplacer 'paymentId' par l'identifiant de la transaction de paiement et'your_token' par votre jeton d'autorisation valide dans les extraits de code ci-dessus.

curl --location --request GET 'https://api.moneroo.io/v1/payments/{paymentId}' \
--header 'Authorization: Bearer YOUR_TOKEN'

Exemple de réponse

Vous obtiendrez une réponse qui ressemble à celle-ci :

{
  "success": true,
  "message": "Payment transaction fetched successfully",
  "data": {
    "id": "abc123",
    "status": "success",
    "is_processed": true,
    "processed_at": "2023-05-21T12:00:00Z",
    "amount": 100.0,
    "currency": "USD",
    "amount_formatted": "$100.00",
    "description": "Purchase of goods",
    "return_url": "https://example.com/return",
    "environment": "production",
    "initiated_at": "2023-05-21T11:00:00Z",
    "checkout_url": "https://example.com/checkout",
    "payment_phone_number": "+1234567890",
    "app": {
      "id": "app1",
      "name": "Example App",
      "icon_url": "https://example.com/icon.png"
    },
    "customer": {
      "id": "cust1",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "address": "123 Main St",
      "city": "Springfield",
      "state": "IL",
      "country_code": "US",
      "country": "United States",
      "zip_code": "62701",
      "environment": "production",
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-05-21T00:00:00Z"
    },
    "method": {
      "name": "Credit Card",
      "code": "cc",
      "icon_url": "https://example.com/cc.png",
      "environment": "production"
    },
    "gateway": {
      "name": "Stripe",
      "account_name": "Acme Corp",
      "code": "stripe",
      "icon_url": "https://example.com/stripe.png",
      "environment": "production"
    },
    "metadata": {
      "custom_field1": "custom_value1",
      "custom_field2": "custom_value2"
    },
    "context": {
      "ip": "192.0.2.0",
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (HTML, like Gecko) Chrome/58.0.3029.110 Safari/537",
      "country": "US",
      "local": "en-US"
    }
  }
}

Le champ de data contient les détails de la transaction. La structure et le contenu de ce champ dépendent des détails de chaque transaction.

Last updated