Event types

Learn all about the webhooks event types.

dLocal supports event notifications for these types of events.

These transaction notifications are sent in near real time as transaction events occur; they contain detailed information about the events.

dLocal platform supports event notifications for these types of events:

List of available events

Transaction events

Webhook notification

{
   "uuid": "ISGW-4-86d652010e3c4a1db61ef6420ebf4197",
   "origin": "TRANSACTION_EVENT",
   "payload": {
      ...
   }
}
PropertyDescription
uuidWebhook unique identifier.
originWebhook event key.
payloadWebhook event body.

Card transaction events

The following applies to debit/credit transaction events

Webhook origin key = TRANSACTION_EVENT

Webhook payload = Transaction Object

Example Request

{
   "uuid": "ISGW-4-86d652010e3c4a1db61ef6420ebf4197",
   "origin": "TRANSACTION_EVENT",
   "payload": {
       "transaction_id": "ISGT-4-1JEqoK2eZvKYlo2CGGaCQ8Xn",
       "status": "COMPLETED",
       "status_code": 200,
       "status_detail": "The payment was completed."
       "description": "CREDIT payment created in Spotify",
       "type": "CREDIT",
       "created_date": "2021-03-10T10:02:21.898Z",
       "amount": 1976.00,
       "currency": "ARS",
       "card_id": "ISGC-4-1JEaoS3eZvKYlo2CGGaCQ8Xn",
       "card_acceptor": {
           "mid": "0000000001",
           "mcc": "4899",
           "name": "Spotify P0ED375917 St",
           "zip_code": "1001",
           "state": "",
           "street": "",
           "city": "",
           "country": "AR"
       }
   }
}

📘

You may specify “ALL” key to enable all events.

Authorization events

Authorization

A request will be sent to your server to approve or reject the transaction.

Webhook origin key = AUTHORIZATION

Webhook payload = Authorization Object

{
   "uuid": "ISGW-4-86d652010e3c4a1db61ef6420ebf4197",
   "origin": "AUTHORIZATION",
   "payload": {
      	"card_id" : "ISGC-1111-1111-1111",
	"account_id" : "ISGA-1111-1111-1111",  
	"transaction_id" : "123456",
	"entry_mode" : "05",
	"processing_code" : "00",
	"created_date" : "2020-06-22",
	"created_time" : "11:05",
	"amount_merchant" : 110,
	"currency_merchant" : "ARS",
	"amount_compensation" 1,
	"currency_compensation" : "USD",
	"amount_billing": 110,
	"currency_billing" : "ARS",
	"card_acceptor" : {
		"mid" : "1234",
		"mcc" : "12",
		"name" : "Walmart",
		"country" : "AR",
		"state" : "BA",
		"city" : "105",
		"street": "Calle Moreno Nro 134",
		"zip_code" : "1900"
	},
	"conversion":{
                   "amount": 1,
                   "currency": "USD",
                   "exchange_rate": 110
 	}
   }
}

Failed Authorization

A request will be sent to your server to notify that a transaction processing error has occurred.

Webhook origin key = FAILED_AUTHORIZATION

Webhook payload = Fail Authorization Object

{
   "uuid": "ISGW-4-86d652010e3c4a1db61ef6420ebf4197",
   "origin": "FAILED_AUTHORIZATION",
   "payload": {
      	"card_id" : "ISGC-1111-1111-1111",
	"account_id" : "ISGA-1111-1111-1111",  
	"transaction_id" : "123456",
	"fail_type" : "TIME_OUT"
	}
   }
}

Account Events

A request will be sent to your server to inform you updates on your account status.

Webhook notification

{
 "origin" : "ACCOUNT_EVENT",
 "uuid" : "ISGW-4-dasidnaio312kln12n4",
 "payload": {
     "account_id": "ISGA-4-1JEqoK2eZvKYlo2CGGaCQ8Xn",
     "account_reference" : "My account 1",
     "status": "ACTIVE",
     "status_code": "300",
     "status_detail": "The account is active.", 
     "previous_status" : "WAITING_FOR_OTP_PHONE",
     "created_date":"2021-03-10T10:02:21.898Z",
     "update_date": "2021-03-10T10:02:21.898Z",
 }
}
PropertyText
originWebhook event key.
uuidWebhook unique identifier.
payloadWebhook event body.
account_uidAccount identifier.
account_referenceMerchant reference to identify the account.
statusAccount status.
status_codeAccount status code.
status_detailAccount status description.
previous_statusAccount previous status.
update_dateTime in which the status has changed.

Card Events

A request will be sent to your server to inform you updates on your card status.

Webhook

{
  "origin": "CARD_EVENT",
  "uuid": "ISGW-4-dasidnaio312kln12n4",
  "payload": {
    "card_id": "ISGC-4-1JEqoK2eZvKYlo2CGGaCQ8Xn",
    "card_reference": "card test",
    "account_id": "ISGA-4-1JEqoK2eZvKYlo2CGGaCQ8Xn",
    "status": "ACTIVE",
    "status_code": "302",
    "status_detail": "The card is active.",
    "previous_status": null,
    "created_date": "2022-01-16T09:38:16.786Z",
    "update_date": "2022-01-16T09:38:16.786Z",    
  },  
}

Card Replacement Events

A request will be sent to your server to inform you if the user has cancelled the card via external channels (eg. via local call center).

{
    "origin": "CARD_REPLACEMENT_EVENT",
    "uuid": "ISGW-4-dasidnaio312kln12n4",
    "payload":
    {
        "account_id": "ISGA-4-1JEqoK2eZvKYlo2CGGaCQ8Xn",
        "old_card_id": "ISGC-4-1JEqoK2eZvKYlo2CGGaCQ8X1",
        "new_card_id": "ISGC-4-2JEqoK2eZvKYlo2CGGaCQ8X2",
        "card_reference": "REPLACE_{{old_card_reference}}",
        "reason": "LOST",
        "type": "VIRTUAL",
        "funding_type": "CREDIT",
        "status": "ACTIVE",
        "status_code": "302",
        "status_detail": "The card is active.",
        "created_date": "2021-03-10T10:02:21.898Z"
    }
}

Card Tracking Events

A request will be sent to your server to inform you updates on your card delivery status.

Webhook

{
    "origin": "TRACKING_EVENT",
    "uuid": "ISGW-4-dasidnaio312kln12n4",
    "payload":
        {
            "account_id": "ISGA-4-1JEqoK2eZvKYlo2CGGaCQ8Xn",
            "card_id": "ISGC-4-2JEqoK2eZvKYlo2CGGaCQ8X2",
            "status": "SHIPPED",
            "status_code": "701",
            "status_detail": "The card is shipped.",
            "created_date": "2021-03-10T10:02:21.898Z"
        }
}

Dispute Events

A request will be sent to your server to inform you updates on your disputes status.

Webhook

{
  "origin": "DISPUTE_EVENT",
  "uuid": "ISGW-4-dasidnaio312kln12n4",
  "payload": {
    "merchant_reference": "test 1",
    "dispute_id": "ISGD-4-c6b0ca07820041ffbbd8db010b1d01d9",
    "status": "IN_DISPUTE",
    "status_code": "201",
    "status_detail": "Waiting for the issuer to answer.",
    "previous_status": "DISPUTE_RECEIVED",
    "created_date": "2022-01-16T09:38:16.786Z",
    "update_date": "2022-02-01T08:47:18.685Z",
    "dispute_evidence": {
      "owner_has_card": false,
      "dispute_type": "FRAUD",
      "dispute_subtype": "STOLEN_CARD_TRANSACTIONS",
      "dispute_explanation": "someone stole my card and made a purchase"
    },
    
  },
  
}