API Reference

Charge

Route: POST /charge

Description: When processing a charge, you can specify a webhook URL that will be used for transaction-related notifications.

Request Example:

{
  "wallet_uuid": "string",  
  "value": 0,  
  "due_date": "2024-08-21",
  "description": "string",
  "type_charge": "credit_card",
  "card_name": "string",
  "card_number": "string",
  "card_expiry_month": "string",
  "card_expiry_year": "string",
  "card_cvv": "string",
  "email": "string",
  "ip_address": "string",
  "device_id": "string",  
  "soft_descriptor": "string",
  "transaction_reference": "string",
  "webhook_url": "https://webhook-test.com/3389079f102da2fa60b128e6aea86447"
}

Field webhook_url:

  • Description: URL that will be called for notifications about the status of the charge..
  • Format: String (valid URL)
  • Required: Optional

Response Example:

{
  "charge_uuid": "string",
  "status": "string",
  "transaction_reference": "string"
}
  • charge_uuid: Unique identifier of the charge.
  • status: Current status of the charge.
    • paid
    • refunded
    • chargeback_requested
    • chargeback_refunded
  • transaction_reference: Reference of the transaction associated with the charge.