AddCustomPayment
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 custom payment
Rules:N/A
Static Values:
  • event_type: add_custom_payment
  • event_name: platzi.sherlock.1.add_custom_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_custom_payment text and student_id value

value
string
required

Event value

payment
object
required

Contains the custom payment data

name
string
required

Student name

email
string
required

Student email

registerType
integer
required

Register type id

subscriptionType
integer
required

Subscription plan id

recurrenceType
integer
required

Recurrence type id

installments
integer
required

Installments number

currency
integer
required

Currency id

amount
integer
required

Amount to pay

currencyCode
string
required

Currency code

currentTrm
number
required

Current TRM based on currency

currentMax
integer
required

Mas currency amount

paymentMethods
array
required

List of payment methods

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_custom_payment",
6  "event_occurred_on": "2023-05-01T22:29:56Z",
7  "attributes": {
8    "username": "organizer",
9    "student_id": 1,
10    "value": "add_custom_payment-1",
11    "key": "true",
12    "payment":{
13      "name":"test test",
14      "email":"test@test.com",
15      "registerType":1,
16      "subscriptionType":1,
17      "recurrenceType":1,
18      "installments":1,
19      "currency":1,
20      "amount":299,
21      "currencyCode":"USD",
22      "currentTrm":1,
23      "currentMax":499,
24      "paymentMethods:[1]
25    }
26  },
27  "metadata": {
28    "event_type": "add_custom_payment"
29  }
30}'
31
Edit this pageLast updated on 2025/2/18