Event types
Events
Events are the way OrkestaPay will notify you about what is happening with your merchant's payments.
These events are triggered when a payment changes status.
| Event | Description |
|---|---|
| payment.authorize | Occurs when a payment has been authorized only |
| payment.cancel | Occurs when an authorized payment has been canceled |
| payment.capture | Occurs when an authorized payment is captured |
| payment.purchase | Occurs when a payment is completed successfully |
| payment.refund | Occurs when a refund is issued for a payment |
payment.authorize example
{
"data": {
"payment": {
"amount": {
"authorized": 1250,
"currency": "MXN"
},
"created_at": "1780417354115",
"device_session_id": "",
"is_payment_link": false,
"merchant_id": "mch_591bbfb20c324605877afc9b01d715c3",
"merchant_order_id": "a79a5e9b-c439-4239-b367-ee82e0eb08d4",
"order_id": "ord_d721519fe9f3463495c610837aebb082",
"payment_id": "pay_393cf5b785a84cf18a90bcca6fe080ae",
"payment_source": {
"card": {
"bin": "518600",
"brand": "MASTERCARD",
"card_type": "CREDIT",
"expiration_month": "12",
"expiration_year": "2030",
"holder_last_name": "",
"holder_name": "Federico Balderas",
"issuer_bank_name": "MASTERCARD - TEST ICAS",
"last_four": "8785",
"one_time_use": true
},
"payment_method_id": "pym_41f4fdfed338491f8f3a3195967cf370",
"settings": {
"card": {
"capture": false
}
},
"type": "CARD"
},
"status": "AUTHORIZED",
"transactions": [
{
"amount": 1250,
"authorization_code": "ORK-PAY-J6S8QsoOlc",
"code": "APPROVED",
"created_at": "1780417358847",
"description": "ord_d721519fe9f3463495c610837aebb082",
"message": "Approved or completed successfully",
"provider": {
"code": "",
"merchant_provider_id": "mpv_4d72ee739290497197797b314ed2e98e",
"message": "completed",
"name": "OrkestaPay",
"provider_id": "prc_ork140lp9ght12uoq3266mza09hbgtw1",
"provider_transaction_id": "ORK-PQDFxUgq72dABQI"
},
"status": "SUCCESS",
"transaction_id": "ctx_fc712c3e194a4afaa57dab425b99927f",
"type": "AUTHORIZE"
}
],
"updated_at": "1780417354115"
}
},
"event_type": "payment.authorize",
"type": "payment",
"version": 1
}payment.cancel example
{
"data": {
"payment": {
"amount": {
"authorized": 1250,
"currency": "MXN",
"voided": 1250
},
"created_at": "1780420392077",
"device_session_id": "",
"is_payment_link": false,
"merchant_id": "mch_591bbfb20c324605877afc9b01d715c3",
"merchant_order_id": "e0d8efde-b591-4ffc-b788-814a589f2be9",
"order_id": "ord_ee9d757a655c464d8cb8eca112599530",
"payment_id": "pay_4445419b83854be5b2b6de225459b908",
"payment_source": {
"card": {
"bin": "518600",
"brand": "MASTERCARD",
"card_type": "CREDIT",
"id": "e3e8eddf238b3bbcc75123eeb5bb4599e1d339d03855d20294f8cb86395cc576fbd361103426e5f3fa4907a90fa620f891c6ff48b9b04c577acd13ed171fc2df",
"issuer_bank_name": "MASTERCARD - TEST ICAS",
"last_four": "8785",
"one_time_use": true
},
"payment_method_id": "pym_e1c510ab51864726861e32ada7aa5eea",
"settings": {
"card": {
"capture": false
}
},
"type": "CARD"
},
"status": "CANCELLED",
"transactions": [
{
"amount": 1250,
"authorization_code": "ORK-PAY-Yr0EZeeffq",
"code": "APPROVED",
"created_at": "1780420403854",
"description": "",
"message": "Approved or completed successfully",
"provider": {
"code": "COMPLETED",
"merchant_provider_id": "mpv_4d72ee739290497197797b314ed2e98e",
"message": "completed",
"name": "OrkestaPay",
"provider_id": "prc_ork140lp9ght12uoq3266mza09hbgtw1",
"provider_transaction_id": "ORK-FpJlJp8ckFimHfE"
},
"status": "SUCCESS",
"transaction_id": "ctx_d7f7e00562d54fe885b6d3ef3fbf3fdf",
"type": "VOID"
},
{
"amount": 1250,
"authorization_code": "ORK-PAY-Yr0EZeeffq",
"code": "APPROVED",
"created_at": "1780420394092",
"description": "ord_ee9d757a655c464d8cb8eca112599530",
"message": "Approved or completed successfully",
"provider": {
"code": "",
"merchant_provider_id": "mpv_4d72ee739290497197797b314ed2e98e",
"message": "completed",
"name": "OrkestaPay",
"provider_id": "prc_ork140lp9ght12uoq3266mza09hbgtw1",
"provider_transaction_id": "ORK-FpJlJp8ckFimHfE"
},
"status": "SUCCESS",
"transaction_id": "ctx_d7f7e00562d54fe885b6d3ef3fbf3fdf",
"type": "AUTHORIZE"
}
],
"updated_at": "1780420403854"
}
},
"event_type": "payment.cancel",
"type": "payment",
"version": 1
}payment.capture example
{
"data": {
"payment": {
"amount": {
"authorized": 1250,
"captured": 800,
"currency": "MXN"
},
"created_at": "1780417354115",
"device_session_id": "",
"is_payment_link": false,
"merchant_id": "mch_591bbfb20c324605877afc9b01d715c3",
"merchant_order_id": "a79a5e9b-c439-4239-b367-ee82e0eb08d4",
"order_id": "ord_d721519fe9f3463495c610837aebb082",
"payment_id": "pay_393cf5b785a84cf18a90bcca6fe080ae",
"payment_source": {
"card": {
"bin": "518600",
"brand": "MASTERCARD",
"card_type": "CREDIT",
"id": "43edc825166c6a17acb80e3a28c278920755adccb670a879d53716a581d28a42f13a6e344829e0024a7cf0793f4ed573d4584224d5ff362771a47de991830f12",
"issuer_bank_name": "MASTERCARD - TEST ICAS",
"last_four": "8785",
"one_time_use": true
},
"payment_method_id": "pym_41f4fdfed338491f8f3a3195967cf370",
"settings": {
"card": {
"capture": false
}
},
"type": "CARD"
},
"status": "COMPLETED",
"transactions": [
{
"amount": 800,
"authorization_code": "ORK-PAY-J6S8QsoOlc",
"code": "APPROVED",
"created_at": "1780417444767",
"description": "Ouguiya Incredible Granite success synthesizing",
"message": "Approved or completed successfully",
"provider": {
"code": "COMPLETED",
"merchant_provider_id": "mpv_4d72ee739290497197797b314ed2e98e",
"message": "completed",
"name": "OrkestaPay",
"provider_id": "prc_ork140lp9ght12uoq3266mza09hbgtw1",
"provider_transaction_id": "ORK-PQDFxUgq72dABQI"
},
"status": "SUCCESS",
"transaction_id": "ctx_fc712c3e194a4afaa57dab425b99927f",
"type": "CAPTURE"
},
{
"amount": 1250,
"authorization_code": "ORK-PAY-J6S8QsoOlc",
"code": "APPROVED",
"created_at": "1780417358847",
"description": "ord_d721519fe9f3463495c610837aebb082",
"message": "Approved or completed successfully",
"provider": {
"code": "",
"merchant_provider_id": "mpv_4d72ee739290497197797b314ed2e98e",
"message": "completed",
"name": "OrkestaPay",
"provider_id": "prc_ork140lp9ght12uoq3266mza09hbgtw1",
"provider_transaction_id": "ORK-PQDFxUgq72dABQI"
},
"status": "SUCCESS",
"transaction_id": "ctx_fc712c3e194a4afaa57dab425b99927f",
"type": "AUTHORIZE"
}
],
"updated_at": "1780417444767"
}
},
"event_type": "payment.capture",
"type": "payment",
"version": 1
}payment.purchase example
{
"data": {
"payment": {
"amount": {
"authorized": 1250,
"captured": 1250,
"currency": "MXN"
},
"created_at": "1780415979349",
"device_session_id": "6596f73f-af31-5059-8c65-dd848d7aa664",
"is_payment_link": true,
"merchant_id": "mch_591bbfb20c324605877afc9b01d715c3",
"merchant_order_id": "d61fe2734ca74bb99bf34158994e3059",
"order_id": "ord_6bc5aa956dbd48e1af6c678cb55bdc62",
"payment_id": "pay_a710d77a60864d15a8aaaf8945109503",
"payment_source": {
"payment_method_id": "pym_518ebc901c244afcb9d57ea5f8965890",
"type": "CLICK_TO_PAY"
},
"status": "COMPLETED",
"transactions": [
{
"amount": 1250,
"authorization_code": "ORK-PAY-g2bj3kaoGY",
"code": "APPROVED",
"created_at": "1780415981857",
"description": "ord_6bc5aa956dbd48e1af6c678cb55bdc62",
"message": "Approved or completed successfully",
"provider": {
"code": "",
"merchant_provider_id": "mpv_4d72ee739290497197797b314ed2e98e",
"message": "completed",
"name": "OrkestaPay",
"provider_transaction_id": "ORK-sKQKuWr75sKqQvw"
},
"status": "SUCCESS",
"transaction_id": "ctx_17d8e69fd49e45cc8c1fd6d3973bef61",
"type": "PURCHASE"
}
],
"updated_at": "1780415979349"
}
},
"event_type": "payment.purchase",
"type": "payment",
"version": 1
}payment.refund example
{
"data": {
"payment": {
"amount": {
"authorized": 1250,
"captured": 800,
"currency": "MXN",
"refunded": 800
},
"created_at": "1780417354115",
"device_session_id": "",
"is_payment_link": false,
"merchant_id": "mch_591bbfb20c324605877afc9b01d715c3",
"merchant_order_id": "a79a5e9b-c439-4239-b367-ee82e0eb08d4",
"order_id": "ord_d721519fe9f3463495c610837aebb082",
"payment_id": "pay_393cf5b785a84cf18a90bcca6fe080ae",
"payment_source": {
"card": {
"bin": "518600",
"brand": "MASTERCARD",
"card_type": "CREDIT",
"id": "43edc825166c6a17acb80e3a28c278920755adccb670a879d53716a581d28a42f13a6e344829e0024a7cf0793f4ed573d4584224d5ff362771a47de991830f12",
"issuer_bank_name": "MASTERCARD - TEST ICAS",
"last_four": "8785",
"one_time_use": true
},
"payment_method_id": "pym_41f4fdfed338491f8f3a3195967cf370",
"settings": {
"card": {
"capture": false
}
},
"type": "CARD"
},
"status": "REFUNDED",
"transactions": [
{
"amount": 800,
"authorization_code": "ORK-PAY-J6S8QsoOlc",
"code": "APPROVED",
"created_at": "1780417506876",
"description": "reinvent Small hacking",
"message": "Approved or completed successfully",
"provider": {
"code": "COMPLETED",
"merchant_provider_id": "mpv_4d72ee739290497197797b314ed2e98e",
"message": "completed",
"name": "OrkestaPay",
"provider_id": "prc_ork140lp9ght12uoq3266mza09hbgtw1",
"provider_transaction_id": "ORK-PQDFxUgq72dABQI"
},
"status": "SUCCESS",
"transaction_id": "ref_135b9d942cbd45529eafa6ee171248f6",
"type": "REFUND"
},
{
"amount": 800,
"authorization_code": "ORK-PAY-J6S8QsoOlc",
"code": "APPROVED",
"created_at": "1780417444767",
"description": "Ouguiya Incredible Granite success synthesizing",
"message": "Approved or completed successfully",
"provider": {
"code": "COMPLETED",
"merchant_provider_id": "mpv_4d72ee739290497197797b314ed2e98e",
"message": "completed",
"name": "OrkestaPay",
"provider_id": "prc_ork140lp9ght12uoq3266mza09hbgtw1",
"provider_transaction_id": "ORK-PQDFxUgq72dABQI"
},
"status": "SUCCESS",
"transaction_id": "ctx_fc712c3e194a4afaa57dab425b99927f",
"type": "CAPTURE"
},
{
"amount": 1250,
"authorization_code": "ORK-PAY-J6S8QsoOlc",
"code": "APPROVED",
"created_at": "1780417358847",
"description": "ord_d721519fe9f3463495c610837aebb082",
"message": "Approved or completed successfully",
"provider": {
"code": "",
"merchant_provider_id": "mpv_4d72ee739290497197797b314ed2e98e",
"message": "completed",
"name": "OrkestaPay",
"provider_id": "prc_ork140lp9ght12uoq3266mza09hbgtw1",
"provider_transaction_id": "ORK-PQDFxUgq72dABQI"
},
"status": "SUCCESS",
"transaction_id": "ctx_fc712c3e194a4afaa57dab425b99927f",
"type": "AUTHORIZE"
}
],
"updated_at": "1780417507135"
}
},
"event_type": "payment.refund",
"type": "payment",
"version": 1
}