Stripe

Entitas, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ini ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

• Entitas: Entitas dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, di konektor database, tabel adalah entitas, di konektor server file, folder adalah entitas, dan di konektor sistem pesan, antrean adalah entitas.

  Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity apa pun, sehingga daftar Entities akan kosong.

• Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:
  • Daftar
  • Dapatkan
  • Buat
  • Update
  • Hapus

  Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entitas tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak tercantum dalam daftar Operations.

• Tindakan: Tindakan adalah fungsi kelas pertama yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan berbeda-beda dari konektor ke konektor. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, ada kemungkinan konektor tidak mendukung tindakan apa pun, sehingga daftar Actions akan kosong.

Menggunakan koneksi Stripe dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Apigee Integration dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

• Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
• Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Tindakan

Bagian ini mencantumkan tindakan yang didukung oleh konektor. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Tindakan ConfirmPaymentIntent

Tindakan ini mengonfirmasi maksud pembayaran.

Parameter input tindakan ConfirmPaymentIntent

Untuk contoh cara mengonfigurasi tindakan ConfirmPaymentIntent, lihat Contoh tindakan.

Tindakan CapturePaymentIntent

Tindakan ini akan mengambil maksud pembayaran.

Parameter input tindakan CapturePaymentIntent

Untuk contoh cara mengonfigurasi tindakan ConfirmPaymentIntent, lihat Contoh tindakan.

Tindakan CancelPaymentIntent

Tindakan ini akan membatalkan maksud pembayaran.

Parameter input tindakan CancelPaymentIntent

Untuk contoh cara mengonfigurasi tindakan CancelPaymentIntent, lihat Contoh tindakan.

Tindakan AttachPaymentMethodToCustomer

Tindakan ini melampirkan objek PaymentMethod ke pelanggan.

Parameter input tindakan AttachPaymentMethodToCustomer

Untuk contoh cara mengonfigurasi tindakan AttachPaymentMethodToCustomer, lihat Contoh tindakan.

Tindakan DetachPaymentMethodFromCustomer

Tindakan ini melepaskan objek PaymentMethod dari pelanggan. Setelah PaymentMethod dilepas, Anda tidak dapat melampirkannya kembali ke pelanggan.

Parameter input tindakan DetachPaymentMethodFromCustomer

Untuk contoh cara mengonfigurasi tindakan DetachPaymentMethodFromCustomer, lihat Contoh tindakan.

Tindakan FinalizeInvoice

Tindakan ini menyelesaikan Invoice draf.

Parameter input tindakan Finalisasi Invoice

Untuk contoh cara mengonfigurasi tindakan FinalizeInvoice, lihat Contoh tindakan.

Tindakan FinalisasiKutipan

Tindakan ini akan menyelesaikan draf penawaran harga.

Parameter input tindakan FinalizeQuote

Untuk contoh cara mengonfigurasi tindakan FinalizeQuote, lihat Contoh tindakan.

Tindakan AcceptQuote

Tindakan ini menerima penawaran harga dan membuat invoice untuk penawaran harga yang diterima.

Parameter input tindakan AcceptQuote

Untuk contoh cara mengonfigurasi tindakan AcceptQuote, lihat Contoh tindakan.

Tindakan CancelQuote

Tindakan ini akan membatalkan draf penawaran.

Parameter input tindakan CancelQuote

Untuk contoh cara mengonfigurasi tindakan CancelQuote, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Mengonfirmasi maksud pembayaran

Contoh ini menunjukkan cara mengonfirmasi maksud pembayaran yang ditentukan.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan ConfirmPaymentIntent, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "ReturnUrl": "http://google.com/",
   "PaymentIntentId": "pi_3OggwFANHgX3SHp71AVrNtT3"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas ConfirmPaymentIntent akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true",
"id": "pi_3OggwFANHgX3SHp71AVrNtT3",
"object": "payment_intent",
"amount": "33000",
"amount_capturable": "0",
"amount_received": "33000",
"canceled_at": null,
"cancellation_reason": null,
"capture_method": "automatic",
"client_secret": "pi_3OggwFANHgX3SHp71AVrNtT3_secret_YEfjrYL5uHQZrGCx66cJbedlA",
"confirmation_method": "automatic",
"created": "1707196279",
"currency": "usd",
"invoice": null,
"last_payment_error": null,
"latest_charge": "ch_3OggwFANHgX3SHp71uYScRAw",
"level3": null,
"livemode": "false",
"next_action": null,
"on_behalf_of": null,
"payment_method": "pm_1Oggu6ANHgX3SHp7zaRNKNVL",
"payment_method_configuration_details": null,
"payment_method_options.card.installments": null,
"review": null,
"setup_future_usage": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
}]

Contoh - Ambil intent pembayaran

Contoh ini menunjukkan cara merekam maksud pembayaran yang ditentukan.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan CapturePaymentIntent, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "PaymentIntentId": "pi_3Ogh4sANHgX3SHp72YB0YotA"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CapturePaymentIntent akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true",
"id": "pi_3Ogh4sANHgX3SHp72YB0YotA",
"object": "payment_intent",
"amount": "33000",
"amount_capturable": "0",
"amount_received": "33000",
"canceled_at": null,
"cancellation_reason": null,
"capture_method": "manual",
"client_secret": "pi_3Ogh4sANHgX3SHp72YB0YotA_secret_jgqc0olEAOTcurQSDeQThJa3X",
"confirmation_method": "automatic",
"created": "1707196814",
"currency": "usd",
"customer": "cus_Okyi4e7t7BImUL",
"description": null,
"invoice": null,
"last_payment_error": null,
"latest_charge": "ch_3Ogh4sANHgX3SHp72uGBS7g4",
"level3": null,
"livemode": "false",
"next_action": null,
"on_behalf_of": null,
"payment_method": "pm_1Ogh4FANHgX3SHp7GBJJvfGR",
"payment_method_configuration_details": null,
"payment_method_options.card.installments": null,
"payment_method_types": null,
"processing": null,
"receipt_email": null,
"review": null,
"statement_descriptor_suffix": null,
"status": "succeeded",
"transfer_data": null,
"transfer_group": null
}]

Contoh - Membatalkan maksud pembayaran

Contoh ini menunjukkan cara membatalkan maksud pembayaran yang ditentukan.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan CancelPaymentIntent, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "PaymentIntentId": "pi_3Ogh7HANHgX3SHp738skMdSQ"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CancelPaymentIntent akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true",
"id": "pi_3Ogh7HANHgX3SHp738skMdSQ",
"object": "payment_intent",
"amount": "33000",
"amount_capturable": "0",
"amount_received": "0",
"canceled_at": "1707197160",
"cancellation_reason": null,
"capture_method": "manual",
"client_secret": "pi_3Ogh7HANHgX3SHp738skMdSQ_secret_NqQsBexbdyk19ETdMnpQXF19j",
"confirmation_method": "automatic",
"created": "1707196963",
"currency": "usd",
"customer": "cus_Okyi4e7t7BImUL",
"description": null,
"invoice": null,
"last_payment_error": null,
"latest_charge": "ch_3Ogh7HANHgX3SHp73LJMZiy5",
"level3": null,
"livemode": "false",
"next_action": null,
"on_behalf_of": null,
"payment_method": "pm_1Ogh75ANHgX3SHp79MNT6IHs",
"payment_method_configuration_details": null,
"receipt_email": null,
"review": null,
"setup_future_usage": null,
"shipping": null,
"status": "canceled",
"transfer_data": null,
"transfer_group": null
}]

Contoh - Menautkan metode pembayaran ke pelanggan

Contoh ini menunjukkan cara melampirkan metode pembayaran ke pelanggan yang ditentukan.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan AttachPaymentMethodToCustomer, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8",
   "CustomerId": "cus_PNX7n9xMDsMPH4"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas AttachPaymentMethodToCustomer akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true"
}]

Contoh - Lepaskan metode pembayaran dari pelanggan

Contoh ini menunjukkan cara memisahkan metode pembayaran dari pelanggan.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan DetachPaymentMethodFromCustomer, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "PaymentMethodId": "pm_1OYm2nANHgX3SHp7ihGfm5U8"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas DetachPaymentMethodFromCustomer akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true"
}]

Contoh - Menyelesaikan invoice

Contoh ini menunjukkan cara menyelesaikan invoice.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan FinalizeInvoice , lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "InvoiceId": "in_1OhnXRANHgX3SHp73ufStlXy"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas Finalize Invoice akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true",
"id": "in_1OhnXRANHgX3SHp73ufStlXy",
"object": "invoice",
"account_country": "US",
"account_name": "ZBTA_US_SAPDPA_TestAccount",
"billing_reason": "manual",
"charge": null,
"collection_method": "charge_automatically",
"created": "1707459976",
"currency": "usd",
"discounts": null,
"due_date": null,
"effective_at": "1707460034",
"ending_balance": "0",
"footer": null,
"lines.data": null,
"lines.has_more": "false",
"lines.total_count": "0",
"livemode": "false",
"next_payment_attempt": null,
"number": "F3C0E263-0004",
"on_behalf_of": null,
"paid": "true",
"paid_out_of_band": "false",
"payment_intent": null,
}]

Contoh - Menyelesaikan penawaran harga

Contoh ini menunjukkan cara menyelesaikan penawaran harga.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan FinalizeQuote, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "QuoteId": "qt_1ObiPfANHgX3SHp7KT7DXaJe"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas FinalizeQuote akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true"
}]

Contoh - Menerima penawaran harga

Contoh ini menunjukkan cara menyetujui penawaran harga.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan AcceptQuote, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "QuoteId": "qt_1ObmqKANHgX3SHp7ahHydwav"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas AcceptQuote akan memiliki nilai yang mirip dengan berikut ini:

[{
"InvoiceId": "in_1Obmr5ANHgX3SHp7HKi6bJDu",
"Success": "true"
}]

Contoh - Membatalkan penawaran harga

Contoh ini menunjukkan cara membatalkan penawaran harga.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan CancelQuote, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "QuoteId": "qt_1Obmu3ANHgX3SHp7as57wBLf"
   }

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas CancelQuote akan memiliki nilai yang mirip dengan berikut ini:

[{
"Success": "true"
}]

Contoh operasi entity

Bagian ini menunjukkan cara melakukan beberapa operasi entitas di konektor ini.

Contoh - Mencantumkan semua pelanggan

Contoh ini mencantumkan semua pelanggan dalam entitas Customer.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Customer dari Daftar Entity.
3. Pilih operasi List, lalu klik Selesai.
4. Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat memfilter kumpulan hasil dengan menentukan klausa filter. Selalu tentukan nilai klausa filter dalam tanda kutip tunggal (').

Contoh - Mendapatkan data pelanggan

Contoh ini mendapatkan catatan pelanggan yang ditentukan.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Customer dari daftar Entity.
3. Pilih operasi Get, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan cus_OxHsz0u5bCGWuy di kolom Default Value.

   Di sini, cus_OxHsz0u5bCGWuy adalah ID data unik dalam entitas Customer.

Contoh - Membuat maksud pembayaran

Contoh ini membuat maksud pembayaran di entitas PaymentIntent.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih PaymentIntent dari daftar Entity.
3. Pilih operasi Create, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "PaymentMethod": "pm_1OXN5YANHgX3SHp7Q5Y0rb39",
   "Currency": "usd",
   "Amount": 1500.0
   }

   Jika integrasi berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

   {
   "Id": "pi_3OXN69ANHgX3SHp70tgsxkuR"
   }

Contoh - Memperbarui catatan pelanggan

Contoh ini memperbarui detail pelanggan yang ditentukan.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Customer dari daftar Entity.
3. Pilih operasi Update, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "Name": "John"
   }

5. Klik entityId, lalu masukkan cus_OxHsz0u5bCGWuy di kolom Default Value.

   Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

   {
   "Id": "cus_OxHsz0u5bCGWuy"
   }

Contoh - Menghapus catatan pelanggan

Contoh ini menghapus pelanggan yang ditentukan dari entity Customer.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Customer dari daftar Entity.
3. Pilih operasi Delete, lalu klik Selesai.
4. Klik EntityId, lalu masukkan cus_OxIqiMh1W335rE di kolom Default Value.