AddManualPayment
v1.0.0

Add a payment from sherlock.

Details

This event must be consumed using an authorization token. The token is utilized to verify that the user has permission to produce the event and set user_id and organization_id within the attributes. Additionally, the event_source and metadata.event_triggered_by are automatically populated by the CF-Worker-User-Event.

Triggered:
  • When the success team creates a new manual payment
Rules:N/A
Static Values:
  • event_type: add_manual_payment
  • event_name: platzi.sherlock.1.add_manual_payment
  • attributes.value: true/false
event_id
string<uuid>
required

Id for the event. This is a client auto-generated UUID_V4

event_name
string
required

Name of the event with format organization.domain.version.action

event_occurred_on
string<date-time>
required

DateTime when the event was raises. Format YYYY-MM-DDTHH:MM:SSz

attributes
object
required

Contains arbitrary properties with entity information

username
string
required

Platzian username

student_id
integer
required

Student identifier

key
string
required

Text combining add_manual_payment text and student_id value

value
string
required

Event value

payment
object
required

Contains the manual payment data

transaction_id
string
required

Transaction identification

token
string
required

Customer ID

amount
string
required

Amount of the payment

method
string
required

Payment method

plan
string
required

Plan name

currency
string
required

Currency code of the payment

country
integer
required

Country ID from geo_country table

register_type
string
required

Register type, can be normal or register type from promo

limit_date
string<date-time>
required

Student access limit date

log
string
required

Payment description log from success team

document
string
required

Student identification number

document_type
string
required

Student identification type

address
string
required

Student address

state
string
required

Student state

city
string
required

Student city

recurrence_current_installment
integer
required

Current installment number

recurrence_installments
integer
required

Total installments number

metadata
object
required

Contain fixed properties with event information

event_type
string
required

Type of the event, used to join common sub events

How to trigger this event

1curl --location 'https://api-c963080767f45828c31f83ca5cd25d36.staging.platzi.com/behavior/v1/' \
2--header 'Content-Type: application/json' \
3--data '{
4  "event_id": "2457207d-a9d8-4b46-aff3-2a8ca385f2f6",
5  "event_name": "platzi.sherlock.1.add-manual_payment",
6  "event_occurred_on": "2023-05-01T22:29:56Z",
7  "attributes": {
8    "username": "organizer",
9    "student_id": 1,
10    "value": "add_manual_payment-1",
11    "key": "true"
12    "payment":{
13      "transaction_id":"test_124563_4",
14      "country":1,
15      "recurrence_installments":1,
16      "amount":"990000",
17      "address":"Centro",
18      "method":"payu_manual",
19      "limit_date":"2028-09-26T05:00:00.000Z",
20      "log":"<p>Prueba</p>",
21      "city":"Chia",
22      "recurrence_current_installment":1,
23      "document":"124563",
24      "token":"d_test_124563",
25      "register_type":"normal",
26      "currency":"COP",
27      "state":"Cundinamarca",
28      "plan":"expert_annual",
29      "document_type":"CC"
30    },
31  },
32  "metadata": {
33    "event_type": "add_manual_payment"
34  }
35}'
36
Edit this pageLast updated on 2025/2/18