The CREDIT object

Estimated reading: 4 minutes

CREDIT_CREATED
When a credit is created

{
  "eventId": "b0ea7273-7421-4f3d-b9b6-27c1f521386b",
  "type": "CREDIT_CREATED",
  "creationDate": "2024-01-05T14:51:48.090154+01:00",
  "object": {
    "additionalData": {
      "key1": "value1"
    },
    "amount": 100,
    "card": {
      "additionalData": {},
      "cardId": "5ba4a451-e3ba-4555-b6f1-955b1531cbed",
      "cardTokenId": "39e38277-d68d-4970-b7ef-2f3e65e3ba1c",
      "cardType": "DEBIT",
      "check": false,
      "commercialBrand": "VISA",
      "country": "FRA",
      "creationDate": "2024-01-05T14:51:46.753895+01:00",
      "europeanEconomicArea": true,
      "expirationMonth": 12,
      "expirationYear": 2026,
      "fingerprint": "31e7053d8ee3f13b4f391c989d83aaaa7771450d",
      "first6": "400000",
      "last4": "0002",
      "productType": "UNKNOWN",
      "region": "EUROPE"
    },
    "cardPresent": {},
    "commission": 0,
    "contractId": "a674d481-4805-4a66-915a-67956efca36f",
    "creationDate": "2024-01-05T14:51:47.744817+01:00",
    "creditId": "a0184f13-cb58-4db2-9c02-f7ecdaf61909",
    "currency": "EUR",
    "fee": 0,
    "merchantCreditId": "MCID-01",
    "movementId": "304a16a4-f3f1-4e14-ab3b-2e9b4cee2f20",
    "order": {
      "addressLine1": "142 RUE DE LA REFAPI",
      "cardCountry": "FRA",
      "city": "BRIANNEBURY",
      "country": "FRA",
      "firstName": "MANDATORY",
      "lastName": "MANDATORY"
    },
    "payoutAmount": 100,
    "payoutCurrency": "EUR",
    "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
    "status": "UNCLEARED",
    "transactionTransfers": []
  },
  "requestId": "d4cf4f9b-83bc-4877-8d2a-c84a7183c666"
}

CREDIT_CANCELED
When a credit is cancelled

{
  "eventId": "df668650-b893-462e-aa1a-f232bed383da",
  "type": "CREDIT_CANCELED",
  "creationDate": "2024-01-05T14:53:29.028715+01:00",
  "object": {
    "additionalData": {
      "key1": "value1",
      "test": "test"
    },
    "amount": 100,
    "cancelMovementId": "1555e13a-0344-403a-a01c-6d435c598659",
    "cancellationDate": "2024-01-05T14:53:29.015180+01:00",
    "card": {
      "additionalData": {},
      "cardId": "5ba4a451-e3ba-4555-b6f1-955b1531cbed",
      "cardType": "DEBIT",
      "check": false,
      "commercialBrand": "VISA",
      "country": "FRA",
      "creationDate": "2024-01-05T14:51:46.753895+01:00",
      "europeanEconomicArea": true,
      "expirationMonth": 12,
      "expirationYear": 2026,
      "fingerprint": "31e7053d8ee3f13b4f391c989d83aaaa7771450d",
      "first6": "400000",
      "last4": "0002",
      "productType": "UNKNOWN",
      "region": "EUROPE"
    },
    "cardPresent": {},
    "commission": 0,
    "contractId": "a674d481-4805-4a66-915a-67956efca36f",
    "creationDate": "2024-01-05T14:51:47.744817+01:00",
    "creditId": "a0184f13-cb58-4db2-9c02-f7ecdaf61909",
    "currency": "EUR",
    "fee": 0,
    "merchantCreditId": "MCID-01",
    "movementId": "304a16a4-f3f1-4e14-ab3b-2e9b4cee2f20",
    "order": {
      "addressLine1": "142 RUE DE LA REFAPI",
      "cardCountry": "FRA",
      "city": "BRIANNEBURY",
      "country": "FRA",
      "firstName": "MANDATORY",
      "lastName": "MANDATORY"
    },
    "payoutAmount": 100,
    "payoutCurrency": "EUR",
    "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
    "status": "CANCELED",
    "transactionTransfers": []
  },
  "requestId": "dca78a74-22f1-4fd8-a6bb-fc4be4735838"
}

CREDIT_UPDATED
When a credit is updated

{
  "eventId": "b51f11be-c535-49a4-8a70-6241afd75654",
  "type": "CREDIT_UPDATED",
  "creationDate": "2024-01-05T14:52:49.329773+01:00",
  "object": {
    "additionalData": {
      "key1": "value1",
      "test": "test"
    },
    "amount": 100,
    "card": {
      "additionalData": {},
      "cardId": "5ba4a451-e3ba-4555-b6f1-955b1531cbed",
      "cardType": "DEBIT",
      "check": false,
      "commercialBrand": "VISA",
      "country": "FRA",
      "creationDate": "2024-01-05T14:51:46.753895+01:00",
      "europeanEconomicArea": true,
      "expirationMonth": 12,
      "expirationYear": 2026,
      "fingerprint": "31e7053d8ee3f13b4f391c989d83aaaa7771450d",
      "first6": "400000",
      "last4": "0002",
      "productType": "UNKNOWN",
      "region": "EUROPE"
    },
    "cardPresent": {},
    "commission": 0,
    "contractId": "a674d481-4805-4a66-915a-67956efca36f",
    "creationDate": "2024-01-05T14:51:47.744817+01:00",
    "creditId": "a0184f13-cb58-4db2-9c02-f7ecdaf61909",
    "currency": "EUR",
    "fee": 0,
    "merchantCreditId": "MCID-01",
    "movementId": "304a16a4-f3f1-4e14-ab3b-2e9b4cee2f20",
    "order": {
      "addressLine1": "142 RUE DE LA REFAPI",
      "cardCountry": "FRA",
      "city": "BRIANNEBURY",
      "country": "FRA",
      "firstName": "MANDATORY",
      "lastName": "MANDATORY"
    },
    "payoutAmount": 100,
    "payoutCurrency": "EUR",
    "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
    "status": "UNCLEARED",
    "transactionTransfers": []
  },
  "requestId": "300fdb28-2e74-4512-a7e9-f3fa843c8a7c",
  "objectBeforeUpdate": {
    "additionalData": {
      "key1": "value1"
    },
    "amount": 100,
    "card": {
      "additionalData": {},
      "cardId": "5ba4a451-e3ba-4555-b6f1-955b1531cbed",
      "cardType": "DEBIT",
      "check": false,
      "commercialBrand": "VISA",
      "country": "FRA",
      "creationDate": "2024-01-05T14:51:46.753895+01:00",
      "europeanEconomicArea": true,
      "expirationMonth": 12,
      "expirationYear": 2026,
      "fingerprint": "31e7053d8ee3f13b4f391c989d83aaaa7771450d",
      "first6": "400000",
      "last4": "0002",
      "productType": "UNKNOWN",
      "region": "EUROPE"
    },
    "cardPresent": {},
    "commission": 0,
    "contractId": "a674d481-4805-4a66-915a-67956efca36f",
    "creationDate": "2024-01-05T14:51:47.744817+01:00",
    "creditId": "a0184f13-cb58-4db2-9c02-f7ecdaf61909",
    "currency": "EUR",
    "fee": 0,
    "merchantCreditId": "MCID-01",
    "movementId": "304a16a4-f3f1-4e14-ab3b-2e9b4cee2f20",
    "order": {
      "addressLine1": "142 RUE DE LA REFAPI",
      "cardCountry": "FRA",
      "city": "BRIANNEBURY",
      "country": "FRA",
      "firstName": "MANDATORY",
      "lastName": "MANDATORY"
    },
    "payoutAmount": 100,
    "payoutCurrency": "EUR",
    "pointOfSaleId": "7d99a970-cc26-4de8-aa5d-d9ebf4088247",
    "status": "UNCLEARED",
    "transactionTransfers": []
  }
}