hash
stringlengths 40
40
| date
stringdate 2022-11-17 13:04:47
2025-03-21 17:04:41
| author
stringclasses 141
values | commit_message
stringlengths 22
166
| is_merge
bool 1
class | git_diff
stringlengths 238
9.63M
| type
stringclasses 17
values | masked_commit_message
stringlengths 6
143
|
|---|---|---|---|---|---|---|---|
e5330528faf68cba0cab112dc155f7eaef9f4ce9
|
2023-01-06 14:33:30
|
Sangamesh Kulkarni
|
feat: list of refunds (#284)
| false
|
diff --git a/crates/api_models/src/refunds.rs b/crates/api_models/src/refunds.rs
index 14abcc9f9d7..c3ca1e0fd97 100644
--- a/crates/api_models/src/refunds.rs
+++ b/crates/api_models/src/refunds.rs
@@ -1,4 +1,6 @@
+use common_utils::custom_serde;
use serde::{Deserialize, Serialize};
+use time::PrimitiveDateTime;
use crate::enums;
@@ -34,6 +36,35 @@ pub struct RefundResponse {
pub error_message: Option<String>,
}
+#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
+pub struct RefundListRequest {
+ pub payment_id: Option<String>,
+ pub limit: Option<i64>,
+ #[serde(default, with = "custom_serde::iso8601::option")]
+ pub created: Option<PrimitiveDateTime>,
+ #[serde(default, rename = "created.lt", with = "custom_serde::iso8601::option")]
+ pub created_lt: Option<PrimitiveDateTime>,
+ #[serde(default, rename = "created.gt", with = "custom_serde::iso8601::option")]
+ pub created_gt: Option<PrimitiveDateTime>,
+ #[serde(
+ default,
+ rename = "created.lte",
+ with = "custom_serde::iso8601::option"
+ )]
+ pub created_lte: Option<PrimitiveDateTime>,
+ #[serde(
+ default,
+ rename = "created.gte",
+ with = "custom_serde::iso8601::option"
+ )]
+ pub created_gte: Option<PrimitiveDateTime>,
+}
+
+#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
+pub struct RefundListResponse {
+ pub data: Vec<RefundResponse>,
+}
+
#[derive(Debug, Eq, Clone, PartialEq, Default, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum RefundStatus {
diff --git a/crates/router/src/core/refunds.rs b/crates/router/src/core/refunds.rs
index 32d0cd4fdca..af0e3bb013e 100644
--- a/crates/router/src/core/refunds.rs
+++ b/crates/router/src/core/refunds.rs
@@ -455,6 +455,40 @@ pub async fn validate_and_create_refund(
Ok(refund.foreign_into())
}
+// ********************************************** Refund list **********************************************
+
+/// If payment-id is provided, lists all the refunds associated with that particular payment-id
+/// If payment-id is not provided, lists the refunds associated with that particular merchant - to the limit specified,if no limits given, it is 10 by default
+
+#[instrument(skip_all)]
+pub async fn refund_list(
+ db: &dyn db::StorageInterface,
+ merchant_account: storage::merchant_account::MerchantAccount,
+ req: api_models::refunds::RefundListRequest,
+) -> RouterResponse<api_models::refunds::RefundListResponse> {
+ let limit = validator::validate_refund_list(req.limit)?;
+ let refund_list = db
+ .filter_refund_by_constraints(
+ &merchant_account.merchant_id,
+ &req,
+ merchant_account.storage_scheme,
+ limit,
+ )
+ .await
+ .change_context(errors::ApiErrorResponse::RefundNotFound)?;
+
+ let data: Vec<refunds::RefundResponse> = refund_list
+ .into_iter()
+ .map(ForeignInto::foreign_into)
+ .collect();
+ utils::when(data.is_empty(), || {
+ Err(errors::ApiErrorResponse::RefundNotFound)
+ })?;
+ Ok(services::BachResponse::Json(
+ api_models::refunds::RefundListResponse { data },
+ ))
+}
+
// ********************************************** UTILS **********************************************
// FIXME: function should not have more than 3 arguments.
diff --git a/crates/router/src/core/refunds/validator.rs b/crates/router/src/core/refunds/validator.rs
index 593269b60fb..ecd900b5827 100644
--- a/crates/router/src/core/refunds/validator.rs
+++ b/crates/router/src/core/refunds/validator.rs
@@ -122,3 +122,19 @@ pub async fn validate_uniqueness_of_refund_id_against_merchant_id(
}
}
}
+
+pub fn validate_refund_list(limit: Option<i64>) -> CustomResult<i64, errors::ApiErrorResponse> {
+ match limit {
+ Some(limit_val) => {
+ if !(1..=100).contains(&limit_val) {
+ Err(errors::ApiErrorResponse::InvalidRequestData {
+ message: "limit should be in between 1 and 100".to_string(),
+ }
+ .into())
+ } else {
+ Ok(limit_val)
+ }
+ }
+ None => Ok(10),
+ }
+}
diff --git a/crates/router/src/db/refund.rs b/crates/router/src/db/refund.rs
index 2cbb8cec7af..aec81c37069 100644
--- a/crates/router/src/db/refund.rs
+++ b/crates/router/src/db/refund.rs
@@ -55,6 +55,14 @@ pub trait RefundInterface {
new: storage_types::RefundNew,
storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<storage_types::Refund, errors::StorageError>;
+
+ async fn filter_refund_by_constraints(
+ &self,
+ merchant_id: &str,
+ refund_details: &api_models::refunds::RefundListRequest,
+ storage_scheme: enums::MerchantStorageScheme,
+ limit: i64,
+ ) -> CustomResult<Vec<storage_models::refund::Refund>, errors::StorageError>;
}
#[cfg(not(feature = "kv_store"))]
@@ -163,6 +171,25 @@ mod storage {
.map_err(Into::into)
.into_report()
}
+
+ async fn filter_refund_by_constraints(
+ &self,
+ merchant_id: &str,
+ refund_details: &api_models::refunds::RefundListRequest,
+ _storage_scheme: enums::MerchantStorageScheme,
+ limit: i64,
+ ) -> CustomResult<Vec<storage_models::refund::Refund>, errors::StorageError> {
+ let conn = pg_connection(&self.master_pool).await;
+ <storage_models::refund::Refund as storage_types::RefundDbExt>::filter_by_constraints(
+ &conn,
+ merchant_id,
+ refund_details,
+ limit,
+ )
+ .await
+ .map_err(Into::into)
+ .into_report()
+ }
}
}
@@ -546,6 +573,26 @@ mod storage {
}
}
}
+
+ async fn filter_refund_by_constraints(
+ &self,
+ merchant_id: &str,
+ refund_details: &api_models::refunds::RefundListRequest,
+ storage_scheme: enums::MerchantStorageScheme,
+ limit: i64,
+ ) -> CustomResult<Vec<storage_models::refund::Refund>, errors::StorageError> {
+ match storage_scheme {
+ enums::MerchantStorageScheme::PostgresOnly => {
+ let conn = pg_connection(&self.master_pool).await;
+ <storage_models::refund::Refund as storage_types::RefundDbExt>::filter_by_constraints(&conn, merchant_id, refund_details, limit)
+ .await
+ .map_err(Into::into)
+ .into_report()
+ }
+
+ enums::MerchantStorageScheme::RedisKv => Err(errors::StorageError::KVError.into()),
+ }
+ }
}
}
@@ -651,4 +698,15 @@ impl RefundInterface for MockDb {
// [#172]: Implement function for `MockDb`
Err(errors::StorageError::MockDbError)?
}
+
+ async fn filter_refund_by_constraints(
+ &self,
+ _merchant_id: &str,
+ _refund_details: &api_models::refunds::RefundListRequest,
+ _storage_scheme: enums::MerchantStorageScheme,
+ _limit: i64,
+ ) -> CustomResult<Vec<storage_models::refund::Refund>, errors::StorageError> {
+ // [#172]: Implement function for `MockDb`
+ Err(errors::StorageError::MockDbError)?
+ }
}
diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs
index efe16f05694..f7b7d868ffb 100644
--- a/crates/router/src/routes/app.rs
+++ b/crates/router/src/routes/app.rs
@@ -113,12 +113,12 @@ impl Refunds {
web::scope("/refunds")
.app_data(web::Data::new(state))
.service(web::resource("").route(web::post().to(refunds_create)))
+ .service(web::resource("/list").route(web::get().to(refunds_list)))
.service(
web::resource("/{id}")
.route(web::get().to(refunds_retrieve))
.route(web::post().to(refunds_update)),
)
- .service(web::resource("/list").route(web::get().to(refunds_list)))
}
}
diff --git a/crates/router/src/routes/refunds.rs b/crates/router/src/routes/refunds.rs
index 97ba2c8fcaa..c274ad6ccf6 100644
--- a/crates/router/src/routes/refunds.rs
+++ b/crates/router/src/routes/refunds.rs
@@ -68,6 +68,17 @@ pub async fn refunds_update(
#[instrument(skip_all, fields(flow = ?Flow::RefundsList))]
// #[get("/list")]
-pub async fn refunds_list() -> HttpResponse {
- api::http_response_json("list")
+pub async fn refunds_list(
+ state: web::Data<AppState>,
+ req: HttpRequest,
+ payload: web::Query<api_models::refunds::RefundListRequest>,
+) -> HttpResponse {
+ api::server_wrap(
+ &state,
+ &req,
+ payload.into_inner(),
+ |state, merchant_account, req| refund_list(&*state.store, merchant_account, req),
+ api::MerchantAuthentication::ApiKey,
+ )
+ .await
}
diff --git a/crates/router/src/types/storage/refund.rs b/crates/router/src/types/storage/refund.rs
index a278d2fe137..a0ffb33c98b 100644
--- a/crates/router/src/types/storage/refund.rs
+++ b/crates/router/src/types/storage/refund.rs
@@ -1,6 +1,72 @@
+use async_bb8_diesel::AsyncRunQueryDsl;
+use common_utils::errors::CustomResult;
+use diesel::{associations::HasTable, ExpressionMethods, QueryDsl};
+use error_stack::{IntoReport, ResultExt};
pub use storage_models::refund::{
Refund, RefundCoreWorkflow, RefundNew, RefundUpdate, RefundUpdateInternal,
};
+use storage_models::{errors, schema::refund::dsl};
+
+use crate::{connection::PgPooledConn, logger};
#[cfg(feature = "kv_store")]
impl crate::utils::storage_partitioning::KvStorePartition for Refund {}
+
+#[async_trait::async_trait]
+pub trait RefundDbExt: Sized {
+ async fn filter_by_constraints(
+ conn: &PgPooledConn,
+ merchant_id: &str,
+ refund_list_details: &api_models::refunds::RefundListRequest,
+ limit: i64,
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError>;
+}
+
+#[async_trait::async_trait]
+impl RefundDbExt for Refund {
+ async fn filter_by_constraints(
+ conn: &PgPooledConn,
+ merchant_id: &str,
+ refund_list_details: &api_models::refunds::RefundListRequest,
+ limit: i64,
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
+ let mut filter = <Self as HasTable>::table()
+ .filter(dsl::merchant_id.eq(merchant_id.to_owned()))
+ .order_by(dsl::id)
+ .into_boxed();
+
+ match &refund_list_details.payment_id {
+ Some(pid) => {
+ filter = filter.filter(dsl::payment_id.eq(pid.to_owned()));
+ }
+ None => {
+ filter = filter.limit(limit);
+ }
+ };
+
+ if let Some(created) = refund_list_details.created {
+ filter = filter.filter(dsl::created_at.eq(created));
+ }
+ if let Some(created_lt) = refund_list_details.created_lt {
+ filter = filter.filter(dsl::created_at.lt(created_lt));
+ }
+ if let Some(created_gt) = refund_list_details.created_gt {
+ filter = filter.filter(dsl::created_at.gt(created_gt));
+ }
+ if let Some(created_lte) = refund_list_details.created_lte {
+ filter = filter.filter(dsl::created_at.le(created_lte));
+ }
+ if let Some(created_gte) = refund_list_details.created_gte {
+ filter = filter.filter(dsl::created_at.gt(created_gte));
+ }
+
+ logger::debug!(query = %diesel::debug_query::<diesel::pg::Pg, _>(&filter).to_string());
+
+ filter
+ .get_results_async(conn)
+ .await
+ .into_report()
+ .change_context(errors::DatabaseError::NotFound)
+ .attach_printable_lazy(|| "Error filtering records by predicate")
+ }
+}
|
feat
|
list of refunds (#284)
|
45c19a1729af3f4b80bde2661868cb213138df86
|
2024-09-16 19:37:43
|
Swangi Kumari
|
refactor(core): update response for PaymentsDynamicTaxCalculationResponse (#5909)
| false
|
diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json
index 7f59ad24c0f..f7aa7923b0f 100644
--- a/api-reference-v2/openapi_spec.json
+++ b/api-reference-v2/openapi_spec.json
@@ -6224,6 +6224,28 @@
"BRW"
]
},
+ "DisplayAmountOnSdk": {
+ "type": "object",
+ "required": [
+ "net_amount",
+ "order_tax_amount",
+ "shipping_cost"
+ ],
+ "properties": {
+ "net_amount": {
+ "type": "string",
+ "description": "net amount = amount + order_tax_amount + shipping_cost"
+ },
+ "order_tax_amount": {
+ "type": "string",
+ "description": "order tax amount calculated by tax connectors"
+ },
+ "shipping_cost": {
+ "type": "string",
+ "description": "shipping cost for the order"
+ }
+ }
+ },
"DisputeResponse": {
"type": "object",
"required": [
@@ -13549,7 +13571,8 @@
"type": "object",
"required": [
"payment_id",
- "net_amount"
+ "net_amount",
+ "display_amount"
],
"properties": {
"payment_id": {
@@ -13574,6 +13597,9 @@
}
],
"nullable": true
+ },
+ "display_amount": {
+ "$ref": "#/components/schemas/DisplayAmountOnSdk"
}
}
},
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
index 58c8bb9afb4..cf02aefcf75 100644
--- a/api-reference/openapi_spec.json
+++ b/api-reference/openapi_spec.json
@@ -10015,6 +10015,28 @@
"BRW"
]
},
+ "DisplayAmountOnSdk": {
+ "type": "object",
+ "required": [
+ "net_amount",
+ "order_tax_amount",
+ "shipping_cost"
+ ],
+ "properties": {
+ "net_amount": {
+ "type": "string",
+ "description": "net amount = amount + order_tax_amount + shipping_cost"
+ },
+ "order_tax_amount": {
+ "type": "string",
+ "description": "order tax amount calculated by tax connectors"
+ },
+ "shipping_cost": {
+ "type": "string",
+ "description": "shipping cost for the order"
+ }
+ }
+ },
"DisputeResponse": {
"type": "object",
"required": [
@@ -17719,7 +17741,8 @@
"type": "object",
"required": [
"payment_id",
- "net_amount"
+ "net_amount",
+ "display_amount"
],
"properties": {
"payment_id": {
@@ -17744,6 +17767,9 @@
}
],
"nullable": true
+ },
+ "display_amount": {
+ "$ref": "#/components/schemas/DisplayAmountOnSdk"
}
}
},
diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs
index 01a786f523b..20f1205e14b 100644
--- a/crates/api_models/src/payments.rs
+++ b/crates/api_models/src/payments.rs
@@ -4627,6 +4627,21 @@ pub struct PaymentsDynamicTaxCalculationResponse {
pub order_tax_amount: Option<MinorUnit>,
/// shipping cost for the order
pub shipping_cost: Option<MinorUnit>,
+ /// amount in Base Unit display format
+ pub display_amount: DisplayAmountOnSdk,
+}
+
+#[derive(Debug, serde::Serialize, serde::Deserialize, Clone, ToSchema)]
+pub struct DisplayAmountOnSdk {
+ /// net amount = amount + order_tax_amount + shipping_cost
+ #[schema(value_type = String)]
+ pub net_amount: StringMajorUnit,
+ /// order tax amount calculated by tax connectors
+ #[schema(value_type = String)]
+ pub order_tax_amount: Option<StringMajorUnit>,
+ /// shipping cost for the order
+ #[schema(value_type = String)]
+ pub shipping_cost: Option<StringMajorUnit>,
}
#[derive(Debug, Clone, Eq, PartialEq, serde::Serialize, serde::Deserialize, ToSchema)]
diff --git a/crates/openapi/src/openapi.rs b/crates/openapi/src/openapi.rs
index 6219fd6de28..297228cc25e 100644
--- a/crates/openapi/src/openapi.rs
+++ b/crates/openapi/src/openapi.rs
@@ -615,6 +615,7 @@ Never share your secret api keys. Keep them guarded and secure.
api_models::payments::additional_info::UpiCollectAdditionalData,
api_models::payments::PaymentsDynamicTaxCalculationRequest,
api_models::payments::PaymentsDynamicTaxCalculationResponse,
+ api_models::payments::DisplayAmountOnSdk,
)),
modifiers(&SecurityAddon)
)]
diff --git a/crates/openapi/src/openapi_v2.rs b/crates/openapi/src/openapi_v2.rs
index 5393e8d6fae..31feb8e85b1 100644
--- a/crates/openapi/src/openapi_v2.rs
+++ b/crates/openapi/src/openapi_v2.rs
@@ -522,6 +522,7 @@ Never share your secret api keys. Keep them guarded and secure.
api_models::payments::additional_info::UpiCollectAdditionalData,
api_models::payments::PaymentsDynamicTaxCalculationRequest,
api_models::payments::PaymentsDynamicTaxCalculationResponse,
+ api_models::payments::DisplayAmountOnSdk,
)),
modifiers(&SecurityAddon)
)]
diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs
index a48aed1fb2b..93fa3ed44b8 100644
--- a/crates/router/src/core/payments/transformers.rs
+++ b/crates/router/src/core/payments/transformers.rs
@@ -4,8 +4,13 @@ use api_models::payments::{
Address, CustomerDetails, CustomerDetailsResponse, FrmMessage, PaymentChargeRequest,
PaymentChargeResponse, RequestSurchargeDetails,
};
-use common_enums::RequestIncrementalAuthorization;
-use common_utils::{consts::X_HS_LATENCY, fp_utils, pii::Email, types::MinorUnit};
+use common_enums::{Currency, RequestIncrementalAuthorization};
+use common_utils::{
+ consts::X_HS_LATENCY,
+ fp_utils,
+ pii::Email,
+ types::{AmountConvertor, MinorUnit, StringMajorUnitForConnector},
+};
use diesel_models::ephemeral_key;
use error_stack::{report, ResultExt};
use hyperswitch_domain_models::{payments::payment_intent::CustomerData, router_request_types};
@@ -503,18 +508,80 @@ where
amount = amount + tax_amount;
}
+ let currency = payment_data
+ .get_payment_attempt()
+ .currency
+ .get_required_value("currency")?;
+
Ok(services::ApplicationResponse::JsonWithHeaders((
Self {
net_amount: amount,
payment_id: payment_data.get_payment_attempt().payment_id.clone(),
order_tax_amount,
shipping_cost,
+ display_amount: api_models::payments::DisplayAmountOnSdk::foreign_try_from((
+ amount,
+ shipping_cost,
+ order_tax_amount,
+ currency,
+ ))?,
},
vec![],
)))
}
}
+impl ForeignTryFrom<(MinorUnit, Option<MinorUnit>, Option<MinorUnit>, Currency)>
+ for api_models::payments::DisplayAmountOnSdk
+{
+ type Error = error_stack::Report<errors::ApiErrorResponse>;
+
+ fn foreign_try_from(
+ (net_amount, shipping_cost, order_tax_amount, currency): (
+ MinorUnit,
+ Option<MinorUnit>,
+ Option<MinorUnit>,
+ Currency,
+ ),
+ ) -> Result<Self, Self::Error> {
+ let major_unit_convertor = StringMajorUnitForConnector;
+
+ let sdk_net_amount = major_unit_convertor
+ .convert(net_amount, currency)
+ .change_context(errors::ApiErrorResponse::PreconditionFailed {
+ message: "Failed to convert net_amount to base unit".to_string(),
+ })
+ .attach_printable("Failed to convert net_amount to string major unit")?;
+
+ let sdk_shipping_cost = shipping_cost
+ .map(|cost| {
+ major_unit_convertor
+ .convert(cost, currency)
+ .change_context(errors::ApiErrorResponse::PreconditionFailed {
+ message: "Failed to convert shipping_cost to base unit".to_string(),
+ })
+ .attach_printable("Failed to convert shipping_cost to string major unit")
+ })
+ .transpose()?;
+
+ let sdk_order_tax_amount = order_tax_amount
+ .map(|cost| {
+ major_unit_convertor
+ .convert(cost, currency)
+ .change_context(errors::ApiErrorResponse::PreconditionFailed {
+ message: "Failed to convert order_tax_amount to base unit".to_string(),
+ })
+ .attach_printable("Failed to convert order_tax_amount to string major unit")
+ })
+ .transpose()?;
+ Ok(Self {
+ net_amount: sdk_net_amount,
+ shipping_cost: sdk_shipping_cost,
+ order_tax_amount: sdk_order_tax_amount,
+ })
+ }
+}
+
impl<F, Op, D> ToResponse<F, D, Op> for api::VerifyResponse
where
F: Clone,
|
refactor
|
update response for PaymentsDynamicTaxCalculationResponse (#5909)
|
97a495cfa700835fd2dbf4f4be1b404a1e4a264a
|
2023-08-11 15:08:34
|
Kritik Modi
|
fix: add diesel migration to update local db (#1812)
| false
|
diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs
index c70ad59cfd7..76c0436a79c 100644
--- a/crates/diesel_models/src/schema.rs
+++ b/crates/diesel_models/src/schema.rs
@@ -183,7 +183,7 @@ diesel::table! {
currency -> Varchar,
dispute_stage -> DisputeStage,
dispute_status -> DisputeStatus,
- #[max_length = 255]
+ #[max_length = 64]
payment_id -> Varchar,
#[max_length = 64]
attempt_id -> Varchar,
@@ -588,6 +588,7 @@ diesel::table! {
created_at -> Timestamp,
last_modified -> Timestamp,
payment_method -> Varchar,
+ #[max_length = 64]
payment_method_type -> Nullable<Varchar>,
#[max_length = 128]
payment_method_issuer -> Nullable<Varchar>,
diff --git a/migrations/2023-07-28-111829_update_columns_to_fix_db_diff/down.sql b/migrations/2023-07-28-111829_update_columns_to_fix_db_diff/down.sql
new file mode 100644
index 00000000000..681a0f5f060
--- /dev/null
+++ b/migrations/2023-07-28-111829_update_columns_to_fix_db_diff/down.sql
@@ -0,0 +1,8 @@
+ALTER TABLE dispute
+ALTER COLUMN payment_id TYPE VARCHAR(255);
+
+ALTER TABLE payment_methods
+ALTER COLUMN payment_method_type TYPE VARCHAR;
+
+ALTER TABLE merchant_account
+ALTER COLUMN primary_business_details SET DEFAULT '[{"country": "US", "business": "default"}]';
\ No newline at end of file
diff --git a/migrations/2023-07-28-111829_update_columns_to_fix_db_diff/up.sql b/migrations/2023-07-28-111829_update_columns_to_fix_db_diff/up.sql
new file mode 100644
index 00000000000..7ae0a22a9f0
--- /dev/null
+++ b/migrations/2023-07-28-111829_update_columns_to_fix_db_diff/up.sql
@@ -0,0 +1,8 @@
+ALTER TABLE dispute
+ALTER COLUMN payment_id TYPE VARCHAR(64);
+
+ALTER TABLE payment_methods
+ALTER COLUMN payment_method_type TYPE VARCHAR(64);
+
+ALTER TABLE merchant_account
+ALTER COLUMN primary_business_details DROP DEFAULT;
\ No newline at end of file
|
fix
|
add diesel migration to update local db (#1812)
|
7b293ff785e2cdc323eae13c1342d9e65067402f
|
2024-06-11 19:31:46
|
Jeeva Ramachandran
|
chore(euclid_wasm): update apple pay metadata (#4930)
| false
|
diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml
index 246eb566a91..5d4aea5d5dd 100644
--- a/crates/connector_configs/toml/development.toml
+++ b/crates/connector_configs/toml/development.toml
@@ -244,6 +244,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[adyen.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -360,6 +361,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[authorizedotnet.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -463,6 +465,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[bankofamerica.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -540,6 +543,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[bluesnap.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -772,6 +776,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[checkout.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -854,6 +859,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[cybersource.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1331,6 +1337,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[nexinets.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1402,6 +1409,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[nmi.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1469,6 +1477,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[noon.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1548,6 +1557,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[nuvei.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1869,6 +1879,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[rapyd.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -2023,6 +2034,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[stripe.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -2180,6 +2192,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[trustpay.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -2347,6 +2360,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[worldpay.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml
index 30b63249881..eb35dbf3df2 100644
--- a/crates/connector_configs/toml/production.toml
+++ b/crates/connector_configs/toml/production.toml
@@ -139,6 +139,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[adyen.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -248,6 +249,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[authorizedotnet.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -322,6 +324,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[bluesnap.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -476,6 +479,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[bankofamerica.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -651,6 +655,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[checkout.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -721,6 +726,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[cybersource.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1126,6 +1132,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[nexinets.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1383,6 +1390,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[rapyd.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1521,6 +1529,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[stripe.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1593,6 +1602,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[trustpay.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1701,6 +1711,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[worldpay.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml
index dee4e5e4fb6..acc422f3bd9 100644
--- a/crates/connector_configs/toml/sandbox.toml
+++ b/crates/connector_configs/toml/sandbox.toml
@@ -244,6 +244,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[adyen.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -360,6 +361,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[authorizedotnet.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -463,6 +465,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[bankofamerica.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -540,6 +543,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[bluesnap.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -772,6 +776,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[checkout.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -854,6 +859,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[cybersource.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1331,6 +1337,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[nexinets.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1402,6 +1409,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[nmi.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1469,6 +1477,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[noon.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1548,6 +1557,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[nuvei.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -1869,6 +1879,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[rapyd.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -2023,6 +2034,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[stripe.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -2180,6 +2192,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[trustpay.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
@@ -2347,6 +2360,7 @@ merchant_identifier="Apple Merchant Identifier"
display_name="Display Name"
initiative="Domain"
initiative_context="Domain Name"
+payment_processing_details_at="Connector"
[worldpay.metadata.apple_pay.payment_request_data]
supported_networks=["visa","masterCard","amex","discover"]
merchant_capabilities=["supports3DS"]
|
chore
|
update apple pay metadata (#4930)
|
b5720f1e3801b0b9965de8d330284f5d2daec9e7
|
2023-01-27 12:29:57
|
Sanchith Hegde
|
chore: address Rust 1.67 clippy lints (#465)
| false
|
diff --git a/crates/common_utils/src/ext_traits.rs b/crates/common_utils/src/ext_traits.rs
index 474e4b026be..1d98f7d3452 100644
--- a/crates/common_utils/src/ext_traits.rs
+++ b/crates/common_utils/src/ext_traits.rs
@@ -87,7 +87,7 @@ where
serde_json::to_string(&P::try_from(self).change_context(errors::ParsingError)?)
.into_report()
.change_context(errors::ParsingError)
- .attach_printable_lazy(|| format!("Unable to convert {:?} to a request", self))
+ .attach_printable_lazy(|| format!("Unable to convert {self:?} to a request"))
}
fn convert_and_url_encode(&'e self) -> CustomResult<String, errors::ParsingError>
@@ -99,7 +99,7 @@ where
serde_urlencoded::to_string(&P::try_from(self).change_context(errors::ParsingError)?)
.into_report()
.change_context(errors::ParsingError)
- .attach_printable_lazy(|| format!("Unable to convert {:?} to a request", self))
+ .attach_printable_lazy(|| format!("Unable to convert {self:?} to a request"))
}
// Check without two functions can we combine this
@@ -110,7 +110,7 @@ where
serde_urlencoded::to_string(self)
.into_report()
.change_context(errors::ParsingError)
- .attach_printable_lazy(|| format!("Unable to convert {:?} to a request", self))
+ .attach_printable_lazy(|| format!("Unable to convert {self:?} to a request"))
}
fn encode_to_string_of_json(&'e self) -> CustomResult<String, errors::ParsingError>
@@ -120,7 +120,7 @@ where
serde_json::to_string(self)
.into_report()
.change_context(errors::ParsingError)
- .attach_printable_lazy(|| format!("Unable to convert {:?} to a request", self))
+ .attach_printable_lazy(|| format!("Unable to convert {self:?} to a request"))
}
fn encode_to_value(&'e self) -> CustomResult<serde_json::Value, errors::ParsingError>
@@ -130,7 +130,7 @@ where
serde_json::to_value(self)
.into_report()
.change_context(errors::ParsingError)
- .attach_printable_lazy(|| format!("Unable to convert {:?} to a value", self))
+ .attach_printable_lazy(|| format!("Unable to convert {self:?} to a value"))
}
fn encode_to_vec(&'e self) -> CustomResult<Vec<u8>, errors::ParsingError>
@@ -140,7 +140,7 @@ where
serde_json::to_vec(self)
.into_report()
.change_context(errors::ParsingError)
- .attach_printable_lazy(|| format!("Unable to convert {:?} to a value", self))
+ .attach_printable_lazy(|| format!("Unable to convert {self:?} to a value"))
}
}
diff --git a/crates/common_utils/src/pii.rs b/crates/common_utils/src/pii.rs
index bf7c70bbbb2..013e90431e9 100644
--- a/crates/common_utils/src/pii.rs
+++ b/crates/common_utils/src/pii.rs
@@ -143,13 +143,13 @@ mod pii_masking_strategy_tests {
#[test]
fn test_valid_card_number_masking() {
let secret: Secret<String, CardNumber> = Secret::new("1234567890987654".to_string());
- assert_eq!("123456**********", format!("{:?}", secret));
+ assert_eq!("123456**********", format!("{secret:?}"));
}
#[test]
fn test_invalid_card_number_masking() {
let secret: Secret<String, CardNumber> = Secret::new("1234567890".to_string());
- assert_eq!("123456****", format!("{:?}", secret));
+ assert_eq!("123456****", format!("{secret:?}"));
}
/*
@@ -172,34 +172,34 @@ mod pii_masking_strategy_tests {
#[test]
fn test_valid_email_masking() {
let secret: Secret<String, Email> = Secret::new("[email protected]".to_string());
- assert_eq!("*******@gmail.com", format!("{:?}", secret));
+ assert_eq!("*******@gmail.com", format!("{secret:?}"));
}
#[test]
fn test_invalid_email_masking() {
let secret: Secret<String, Email> = Secret::new("myemailgmail.com".to_string());
- assert_eq!("*** alloc::string::String ***", format!("{:?}", secret));
+ assert_eq!("*** alloc::string::String ***", format!("{secret:?}"));
let secret: Secret<String, Email> = Secret::new("myemail@gmail@com".to_string());
- assert_eq!("*** alloc::string::String ***", format!("{:?}", secret));
+ assert_eq!("*** alloc::string::String ***", format!("{secret:?}"));
}
#[test]
fn test_valid_ip_addr_masking() {
let secret: Secret<String, IpAddress> = Secret::new("123.23.1.78".to_string());
- assert_eq!("123.**.**.**", format!("{:?}", secret));
+ assert_eq!("123.**.**.**", format!("{secret:?}"));
}
#[test]
fn test_invalid_ip_addr_masking() {
let secret: Secret<String, IpAddress> = Secret::new("123.4.56".to_string());
- assert_eq!("*** alloc::string::String ***", format!("{:?}", secret));
+ assert_eq!("*** alloc::string::String ***", format!("{secret:?}"));
let secret: Secret<String, IpAddress> = Secret::new("123.4567.12.4".to_string());
- assert_eq!("*** alloc::string::String ***", format!("{:?}", secret));
+ assert_eq!("*** alloc::string::String ***", format!("{secret:?}"));
let secret: Secret<String, IpAddress> = Secret::new("123..4.56".to_string());
- assert_eq!("*** alloc::string::String ***", format!("{:?}", secret));
+ assert_eq!("*** alloc::string::String ***", format!("{secret:?}"));
}
#[test]
@@ -208,7 +208,7 @@ mod pii_masking_strategy_tests {
Secret::new("pay_uszFB2QGe9MmLY65ojhT_secret_tLjTz9tAQxUVEFqfmOIP".to_string());
assert_eq!(
"pay_uszFB2QGe9MmLY65ojhT_***************************",
- format!("{:?}", secret)
+ format!("{secret:?}")
);
}
@@ -216,6 +216,6 @@ mod pii_masking_strategy_tests {
fn test_invalid_client_secret_masking() {
let secret: Secret<String, IpAddress> =
Secret::new("pay_uszFB2QGe9MmLY65ojhT_secret".to_string());
- assert_eq!("*** alloc::string::String ***", format!("{:?}", secret));
+ assert_eq!("*** alloc::string::String ***", format!("{secret:?}"));
}
}
diff --git a/crates/drainer/src/utils.rs b/crates/drainer/src/utils.rs
index 506faa5467e..91c15275548 100644
--- a/crates/drainer/src/utils.rs
+++ b/crates/drainer/src/utils.rs
@@ -111,5 +111,5 @@ pub(crate) fn get_stream_key_flag(store: Arc<services::Store>, stream_index: u8)
}
pub(crate) fn get_drainer_stream_name(store: Arc<services::Store>, stream_index: u8) -> String {
- store.drainer_stream(format!("shard_{}", stream_index).as_str())
+ store.drainer_stream(format!("shard_{stream_index}").as_str())
}
diff --git a/crates/masking/tests/basic.rs b/crates/masking/tests/basic.rs
index 59bb2cefaa4..53cad9bd78d 100644
--- a/crates/masking/tests/basic.rs
+++ b/crates/masking/tests/basic.rs
@@ -40,7 +40,7 @@ fn basic() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
// format
- let got = format!("{:?}", composite);
+ let got = format!("{composite:?}");
let exp = "Composite { secret_number: *** basic::basic::AccountNumber ***, not_secret: \"not secret\" }";
assert_eq!(got, exp);
@@ -87,7 +87,7 @@ fn without_serialize() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
// format
- let got = format!("{:?}", composite);
+ let got = format!("{composite:?}");
let exp = "Composite { secret_number: *** basic::without_serialize::AccountNumber ***, not_secret: \"not secret\" }";
assert_eq!(got, exp);
@@ -129,7 +129,7 @@ fn for_string() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
// format
- let got = format!("{:?}", composite);
+ let got = format!("{composite:?}");
let exp =
"Composite { secret_number: *** alloc::string::String ***, not_secret: \"not secret\" }";
assert_eq!(got, exp);
diff --git a/crates/router/src/connector/cybersource.rs b/crates/router/src/connector/cybersource.rs
index bf553f3639d..3fd44571f63 100644
--- a/crates/router/src/connector/cybersource.rs
+++ b/crates/router/src/connector/cybersource.rs
@@ -153,7 +153,7 @@ where
("Signature".to_string(), signature),
];
if matches!(http_method, services::Method::Post | services::Method::Put) {
- headers.push(("Digest".to_string(), format!("SHA-256={}", sha256)));
+ headers.push(("Digest".to_string(), format!("SHA-256={sha256}")));
}
Ok(headers)
}
diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs
index 3ac21c714d1..c9ba3319fbf 100644
--- a/crates/router/src/core/admin.rs
+++ b/crates/router/src/core/admin.rs
@@ -416,10 +416,7 @@ pub async fn update_payment_connector(
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable_lazy(|| {
- format!(
- "Failed while updating MerchantConnectorAccount: id: {}",
- merchant_connector_id
- )
+ format!("Failed while updating MerchantConnectorAccount: id: {merchant_connector_id}")
})?;
let updated_pm_enabled = updated_mca.payment_methods_enabled.map(|pm| {
diff --git a/crates/router/src/core/customers.rs b/crates/router/src/core/customers.rs
index 308f6aead24..de1646ce89b 100644
--- a/crates/router/src/core/customers.rs
+++ b/crates/router/src/core/customers.rs
@@ -77,10 +77,7 @@ pub async fn create_customer(
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable_lazy(|| {
- format!(
- "Failed while fetching Customer, customer_id: {}",
- customer_id
- )
+ format!("Failed while fetching Customer, customer_id: {customer_id}")
})?
} else {
Err(error
diff --git a/crates/router/src/core/payment_methods/transformers.rs b/crates/router/src/core/payment_methods/transformers.rs
index d646666f1a3..cedf98e5dcc 100644
--- a/crates/router/src/core/payment_methods/transformers.rs
+++ b/crates/router/src/core/payment_methods/transformers.rs
@@ -72,7 +72,7 @@ pub fn mk_add_card_request(
merchant_id: &str,
) -> CustomResult<services::Request, errors::VaultError> {
let customer_id = if cfg!(feature = "sandbox") {
- format!("{}::{}", customer_id, merchant_id)
+ format!("{customer_id}::{merchant_id}")
} else {
customer_id.to_owned()
};
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index a0e616cf0c0..afb431fe6c9 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -239,7 +239,7 @@ where
}
fn is_start_pay<Op: Debug>(operation: &Op) -> bool {
- format!("{:?}", operation).eq("PaymentStart")
+ format!("{operation:?}").eq("PaymentStart")
}
#[allow(clippy::too_many_arguments)]
@@ -562,7 +562,7 @@ pub fn should_call_connector<Op: Debug, F: Clone>(
operation: &Op,
payment_data: &PaymentData<F>,
) -> bool {
- match format!("{:?}", operation).as_str() {
+ match format!("{operation:?}").as_str() {
"PaymentConfirm" => true,
"PaymentStart" => {
!matches!(
diff --git a/crates/router/src/core/payments/flows/session_flow.rs b/crates/router/src/core/payments/flows/session_flow.rs
index c6e09329482..158edcbc81f 100644
--- a/crates/router/src/core/payments/flows/session_flow.rs
+++ b/crates/router/src/core/payments/flows/session_flow.rs
@@ -74,8 +74,7 @@ fn create_gpay_session_token(
.parse_value::<payment_types::GpaySessionTokenData>("GpaySessionTokenData")
.change_context(errors::ConnectorError::NoConnectorMetaData)
.attach_printable(format!(
- "cannot parse gpay metadata from the given value {:?}",
- connector_metadata
+ "cannot parse gpay metadata from the given value {connector_metadata:?}"
))
.change_context(errors::ApiErrorResponse::InvalidDataFormat {
field_name: "connector_metadata".to_string(),
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index bdc4b6ce476..f8afbd3ae27 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -230,8 +230,7 @@ pub fn validate_request_amount_and_amount_to_capture(
utils::when(!amount_to_capture.le(&amount_inner.get()), || {
Err(report!(errors::ApiErrorResponse::PreconditionFailed {
message: format!(
- "amount_to_capture is greater than amount capture_amount: {:?} request_amount: {:?}",
- amount_to_capture, amount
+ "amount_to_capture is greater than amount capture_amount: {amount_to_capture:?} request_amount: {amount:?}"
)
}))
})
@@ -1054,9 +1053,9 @@ pub fn make_url_with_signature(
})
}
-pub fn hmac_sha256_sorted_query_params<'a>(
+pub fn hmac_sha256_sorted_query_params(
params: &mut [(Cow<'_, str>, Cow<'_, str>)],
- key: &'a str,
+ key: &str,
) -> RouterResult<String> {
params.sort();
let final_string = params
@@ -1077,7 +1076,7 @@ pub fn hmac_sha256_sorted_query_params<'a>(
}
pub fn check_if_operation_confirm<Op: std::fmt::Debug>(operations: Op) -> bool {
- format!("{:?}", operations) == "PaymentConfirm"
+ format!("{operations:?}") == "PaymentConfirm"
}
pub fn generate_mandate(
diff --git a/crates/router/src/core/payments/operations/payment_method_validate.rs b/crates/router/src/core/payments/operations/payment_method_validate.rs
index ce508471e25..acf8a8c07c5 100644
--- a/crates/router/src/core/payments/operations/payment_method_validate.rs
+++ b/crates/router/src/core/payments/operations/payment_method_validate.rs
@@ -298,7 +298,7 @@ impl PaymentMethodValidate {
let status = helpers::payment_intent_status_fsm(&request.payment_method_data, Some(true));
let client_secret =
- utils::generate_id(consts::ID_LENGTH, format!("{}_secret", payment_id).as_str());
+ utils::generate_id(consts::ID_LENGTH, format!("{payment_id}_secret").as_str());
storage::PaymentIntentNew {
payment_id: payment_id.to_string(),
merchant_id: merchant_id.to_string(),
diff --git a/crates/router/src/core/refunds.rs b/crates/router/src/core/refunds.rs
index f560fa7e001..c10d08597ed 100644
--- a/crates/router/src/core/refunds.rs
+++ b/crates/router/src/core/refunds.rs
@@ -384,9 +384,7 @@ pub async fn refund_update_core(
)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable_lazy(|| {
- format!("Unable to update refund with refund_id: {}", refund_id)
- })?;
+ .attach_printable_lazy(|| format!("Unable to update refund with refund_id: {refund_id}"))?;
Ok(services::ApplicationResponse::Json(response.foreign_into()))
}
@@ -693,7 +691,7 @@ pub async fn sync_refund_with_gateway_workflow(
let id = refund_tracker.id.clone();
refund_tracker
.clone()
- .finish_with_status(&*state.store, format!("COMPLETED_BY_PT_{}", id))
+ .finish_with_status(&*state.store, format!("COMPLETED_BY_PT_{id}"))
.await?
}
_ => {
@@ -806,7 +804,7 @@ pub async fn trigger_refund_execute_workflow(
let id = refund_tracker.id.clone();
refund_tracker
.clone()
- .finish_with_status(db, format!("COMPLETED_BY_PT_{}", id))
+ .finish_with_status(db, format!("COMPLETED_BY_PT_{id}"))
.await?;
}
};
@@ -916,7 +914,7 @@ pub async fn get_refund_sync_process_schedule_time(
let redis_mapping: errors::CustomResult<process_data::ConnectorPTMapping, errors::RedisError> =
db::get_and_deserialize_key(
db,
- &format!("pt_mapping_refund_sync_{}", connector),
+ &format!("pt_mapping_refund_sync_{connector}"),
"ConnectorPTMapping",
)
.await;
diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs
index 55d46393ba0..e43598414d9 100644
--- a/crates/router/src/core/webhooks/utils.rs
+++ b/crates/router/src/core/webhooks/utils.rs
@@ -13,7 +13,7 @@ pub async fn lookup_webhook_event(
merchant_id: &str,
event: &api::IncomingWebhookEvent,
) -> bool {
- let redis_key = format!("whconf_{}_{}", merchant_id, connector_id);
+ let redis_key = format!("whconf_{merchant_id}_{connector_id}");
let webhook_config: api::MerchantWebhookConfig =
get_and_deserialize_key(db, &redis_key, "MerchantWebhookConfig")
.await
diff --git a/crates/router/src/db/ephemeral_key.rs b/crates/router/src/db/ephemeral_key.rs
index 1768396afc8..15c9a6f673b 100644
--- a/crates/router/src/db/ephemeral_key.rs
+++ b/crates/router/src/db/ephemeral_key.rs
@@ -88,7 +88,7 @@ mod storage {
&self,
key: &str,
) -> CustomResult<EphemeralKey, errors::StorageError> {
- let key = format!("epkey_{}", key);
+ let key = format!("epkey_{key}");
self.redis_conn
.get_hash_field_and_deserialize(&key, "ephkey", "EphemeralKey")
.await
diff --git a/crates/router/src/db/payment_attempt.rs b/crates/router/src/db/payment_attempt.rs
index cac74b88180..28e89f8c488 100644
--- a/crates/router/src/db/payment_attempt.rs
+++ b/crates/router/src/db/payment_attempt.rs
@@ -392,7 +392,7 @@ mod storage {
.await
{
Ok(HsetnxReply::KeyNotSet) => Err(errors::StorageError::DuplicateValue(
- format!("Payment Attempt already exists for payment_id: {}", key),
+ format!("Payment Attempt already exists for payment_id: {key}"),
))
.into_report(),
Ok(HsetnxReply::KeySet) => {
@@ -544,7 +544,7 @@ mod storage {
}
enums::MerchantStorageScheme::RedisKv => {
- let key = format!("{}_{}", merchant_id, payment_id);
+ let key = format!("{merchant_id}_{payment_id}");
let lookup = self
.get_lookup_by_lookup_id(&key)
.await
@@ -619,8 +619,7 @@ mod storage {
.and_then(|attempt| match attempt.status {
enums::AttemptStatus::Charged => Ok(attempt),
_ => Err(errors::StorageError::ValueNotFound(format!(
- "Successful payment attempt does not exist for {}_{}",
- payment_id, merchant_id
+ "Successful payment attempt does not exist for {payment_id}_{merchant_id}"
)))
.into_report(),
})
diff --git a/crates/router/src/db/payment_intent.rs b/crates/router/src/db/payment_intent.rs
index 5d1ee1ce88e..bb4cc946e01 100644
--- a/crates/router/src/db/payment_intent.rs
+++ b/crates/router/src/db/payment_intent.rs
@@ -220,7 +220,7 @@ mod storage {
}
enums::MerchantStorageScheme::RedisKv => {
- let key = format!("{}_{}", merchant_id, payment_id);
+ let key = format!("{merchant_id}_{payment_id}");
self.redis_conn
.get_hash_field_and_deserialize::<PaymentIntent>(
&key,
@@ -230,7 +230,7 @@ mod storage {
.await
.map_err(|error| match error.current_context() {
errors::RedisError::NotFound => errors::StorageError::ValueNotFound(
- format!("Payment Intent does not exist for {}", key),
+ format!("Payment Intent does not exist for {key}"),
)
.into(),
_ => error.change_context(errors::StorageError::KVError),
diff --git a/crates/router/src/db/refund.rs b/crates/router/src/db/refund.rs
index 958adf728b7..821138431a0 100644
--- a/crates/router/src/db/refund.rs
+++ b/crates/router/src/db/refund.rs
@@ -235,7 +235,7 @@ mod storage {
.into_report()
}
enums::MerchantStorageScheme::RedisKv => {
- let lookup_id = format!("{}_{}", merchant_id, internal_reference_id);
+ let lookup_id = format!("{merchant_id}_{internal_reference_id}");
let lookup = self
.get_lookup_by_lookup_id(&lookup_id)
.await
@@ -560,7 +560,7 @@ mod storage {
.into_report()
}
enums::MerchantStorageScheme::RedisKv => {
- let key = format!("{}_{}", merchant_id, payment_id);
+ let key = format!("{merchant_id}_{payment_id}");
let lookup = self
.get_lookup_by_lookup_id(&key)
.await
diff --git a/crates/router/src/scheduler/types/batch.rs b/crates/router/src/scheduler/types/batch.rs
index bd81d093a95..df21d4de7b1 100644
--- a/crates/router/src/scheduler/types/batch.rs
+++ b/crates/router/src/scheduler/types/batch.rs
@@ -107,7 +107,7 @@ impl ProcessTrackerBatch {
.into_report()
.change_context(errors::ParsingError)
.attach_printable_lazy(|| {
- format!("Unable to parse trackers from JSON string: {:?}", trackers)
+ format!("Unable to parse trackers from JSON string: {trackers:?}")
})
.change_context(errors::ProcessTrackerError::DeserializationFailed)?;
diff --git a/crates/router/src/scheduler/workflows/payment_sync.rs b/crates/router/src/scheduler/workflows/payment_sync.rs
index c23b0ed7900..e1d12f71de3 100644
--- a/crates/router/src/scheduler/workflows/payment_sync.rs
+++ b/crates/router/src/scheduler/workflows/payment_sync.rs
@@ -58,7 +58,7 @@ impl ProcessTrackerWorkflow for PaymentsSyncWorkflow {
status if terminal_status.contains(status) => {
let id = process.id.clone();
process
- .finish_with_status(db, format!("COMPLETED_BY_PT_{}", id))
+ .finish_with_status(db, format!("COMPLETED_BY_PT_{id}"))
.await?
}
_ => {
@@ -96,12 +96,7 @@ pub async fn get_sync_process_schedule_time(
retry_count: i32,
) -> Result<Option<time::PrimitiveDateTime>, errors::ProcessTrackerError> {
let redis_mapping: errors::CustomResult<process_data::ConnectorPTMapping, errors::RedisError> =
- get_and_deserialize_key(
- db,
- &format!("pt_mapping_{}", connector),
- "ConnectorPTMapping",
- )
- .await;
+ get_and_deserialize_key(db, &format!("pt_mapping_{connector}"), "ConnectorPTMapping").await;
let mapping = match redis_mapping {
Ok(x) => x,
Err(err) => {
diff --git a/crates/router/src/types/storage/payment_attempt.rs b/crates/router/src/types/storage/payment_attempt.rs
index 62b35cefc58..e1fe0e867a4 100644
--- a/crates/router/src/types/storage/payment_attempt.rs
+++ b/crates/router/src/types/storage/payment_attempt.rs
@@ -41,7 +41,7 @@ mod tests {
.insert_payment_attempt(payment_attempt, enums::MerchantStorageScheme::PostgresOnly)
.await
.unwrap();
- eprintln!("{:?}", response);
+ eprintln!("{response:?}");
assert_eq!(response.payment_id, payment_id.clone());
}
@@ -82,7 +82,7 @@ mod tests {
.await
.unwrap();
- eprintln!("{:?}", response);
+ eprintln!("{response:?}");
assert_eq!(response.payment_id, payment_id);
}
diff --git a/crates/router/src/utils/ext_traits.rs b/crates/router/src/utils/ext_traits.rs
index 5e7d42107c8..b087882524b 100644
--- a/crates/router/src/utils/ext_traits.rs
+++ b/crates/router/src/utils/ext_traits.rs
@@ -93,7 +93,7 @@ pub(crate) fn merge_json_values(a: &mut serde_json::Value, b: &serde_json::Value
use serde_json::Value;
match (a, b) {
- (&mut Value::Object(ref mut a), &Value::Object(ref b)) => {
+ (&mut Value::Object(ref mut a), Value::Object(b)) => {
for (k, v) in b {
merge_json_values(a.entry(k.clone()).or_insert(Value::Null), v);
}
diff --git a/crates/router/tests/customers.rs b/crates/router/tests/customers.rs
index f765b9f4619..aa17635388f 100644
--- a/crates/router/tests/customers.rs
+++ b/crates/router/tests/customers.rs
@@ -38,40 +38,40 @@ async fn customer_success() {
.await
.unwrap();
response_body = response.body().await;
- println!("customer-create: {:?} : {:?}", response, response_body);
+ println!("customer-create: {response:?} : {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
// retrieve customer
response = client
- .get(format!("http://127.0.0.1:8080/customers/{}", customer_id))
+ .get(format!("http://127.0.0.1:8080/customers/{customer_id}"))
.insert_header(api_key)
.send()
.await
.unwrap();
response_body = response.body().await;
- println!("customer-retrieve: {:?} =:= {:?}", response, response_body);
+ println!("customer-retrieve: {response:?} =:= {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
// update customer
response = client
- .post(format!("http://127.0.0.1:8080/customers/{}", customer_id))
+ .post(format!("http://127.0.0.1:8080/customers/{customer_id}"))
.insert_header(api_key)
.send_json(&update_request)
.await
.unwrap();
response_body = response.body().await;
- println!("customer-update: {:?} =:= {:?}", response, response_body);
+ println!("customer-update: {response:?} =:= {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
// delete customer
response = client
- .delete(format!("http://127.0.0.1:8080/customers/{}", customer_id))
+ .delete(format!("http://127.0.0.1:8080/customers/{customer_id}"))
.insert_header(api_key)
.send()
.await
.unwrap();
response_body = response.body().await;
- println!("customer-delete : {:?} =:= {:?}", response, response_body);
+ println!("customer-delete : {response:?} =:= {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
}
@@ -100,7 +100,7 @@ async fn customer_failure() {
.await
.unwrap();
response_body = response.body().await;
- println!("{:?} : {:?}", response, response_body);
+ println!("{response:?} : {response_body:?}");
assert_eq!(
response.status(),
awc::http::StatusCode::UNPROCESSABLE_ENTITY
@@ -108,24 +108,24 @@ async fn customer_failure() {
// retrieve a customer with customer id which is not in DB
response = client
- .post(format!("http://127.0.0.1:8080/customers/{}", customer_id))
+ .post(format!("http://127.0.0.1:8080/customers/{customer_id}"))
.insert_header(api_key)
.send()
.await
.unwrap();
response_body = response.body().await;
- println!("{:?} : {:?}", response, response_body);
+ println!("{response:?} : {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::BAD_REQUEST);
// update customer id with customer id which is not in DB
response = client
- .post(format!("http://127.0.0.1:8080/customers/{}", customer_id))
+ .post(format!("http://127.0.0.1:8080/customers/{customer_id}"))
.insert_header(api_key)
.send_json(&request)
.await
.unwrap();
response_body = response.body().await;
- println!("{:?} : {:?}", response, response_body);
+ println!("{response:?} : {response_body:?}");
assert_eq!(
response.status(),
awc::http::StatusCode::UNPROCESSABLE_ENTITY
@@ -133,13 +133,13 @@ async fn customer_failure() {
// delete a customer with customer id which is not in DB
response = client
- .delete(format!("http://127.0.0.1:8080/customers/{}", customer_id))
+ .delete(format!("http://127.0.0.1:8080/customers/{customer_id}"))
.insert_header(api_key)
.send()
.await
.unwrap();
response_body = response.body().await;
- println!("{:?} : {:?}", response, response_body);
+ println!("{response:?} : {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::BAD_REQUEST);
// email validation for customer update
@@ -152,20 +152,20 @@ async fn customer_failure() {
.await
.unwrap();
response_body = response.body().await;
- println!("{:?} : {:?}", response, response_body);
+ println!("{response:?} : {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
request = serde_json::json!({
"email": "abch"
});
response = client
- .post(format!("http://127.0.0.1:8080/customers/{}", customer_id))
+ .post(format!("http://127.0.0.1:8080/customers/{customer_id}"))
.insert_header(api_key)
.send_json(&request)
.await
.unwrap();
response_body = response.body().await;
- println!("{:?} : {:?}", response, response_body);
+ println!("{response:?} : {response_body:?}");
assert_eq!(
response.status(),
awc::http::StatusCode::UNPROCESSABLE_ENTITY
@@ -176,13 +176,13 @@ async fn customer_failure() {
"email": "abch"
});
response = client
- .post(format!("http://127.0.0.1:8080/customers/{}", customer_id))
+ .post(format!("http://127.0.0.1:8080/customers/{customer_id}"))
.insert_header(api_key)
.send_json(&request)
.await
.unwrap();
response_body = response.body().await;
- println!("{:?} : {:?}", response, response_body);
+ println!("{response:?} : {response_body:?}");
assert_eq!(
response.status(),
awc::http::StatusCode::UNPROCESSABLE_ENTITY
diff --git a/crates/router/tests/payments.rs b/crates/router/tests/payments.rs
index 415b54d6b51..506db903626 100644
--- a/crates/router/tests/payments.rs
+++ b/crates/router/tests/payments.rs
@@ -63,7 +63,7 @@ async fn payments_create_stripe() {
.await
.unwrap();
let create_response_body = create_response.body().await;
- println!("{:?} : {:?}", create_response, create_response_body);
+ println!("{create_response:?} : {create_response_body:?}");
assert_eq!(create_response.status(), awc::http::StatusCode::OK);
let mut retrieve_response = client
@@ -73,7 +73,7 @@ async fn payments_create_stripe() {
.await
.unwrap();
let retrieve_response_body = retrieve_response.body().await;
- println!("{:?} =:= {:?}", retrieve_response, retrieve_response_body);
+ println!("{retrieve_response:?} =:= {retrieve_response_body:?}");
assert_eq!(retrieve_response.status(), awc::http::StatusCode::OK);
let mut refund_response = client
@@ -84,7 +84,7 @@ async fn payments_create_stripe() {
.unwrap();
let refund_response_body = refund_response.body().await;
- println!("{:?} =:= {:?}", refund_response, refund_response_body);
+ println!("{refund_response:?} =:= {refund_response_body:?}");
assert_eq!(refund_response.status(), awc::http::StatusCode::OK);
}
@@ -132,7 +132,7 @@ async fn payments_create_adyen() {
.await
.unwrap();
let create_response_body = create_response.body().await;
- println!("{:?} : {:?}", create_response, create_response_body);
+ println!("{create_response:?} : {create_response_body:?}");
assert_eq!(create_response.status(), awc::http::StatusCode::OK);
let mut retrieve_response = client
@@ -142,7 +142,7 @@ async fn payments_create_adyen() {
.await
.unwrap();
let retrieve_response_body = retrieve_response.body().await;
- println!("{:?} =:= {:?}", retrieve_response, retrieve_response_body);
+ println!("{retrieve_response:?} =:= {retrieve_response_body:?}");
assert_eq!(retrieve_response.status(), awc::http::StatusCode::OK);
let mut refund_response = client
@@ -153,7 +153,7 @@ async fn payments_create_adyen() {
.unwrap();
let refund_response_body = refund_response.body().await;
- println!("{:?} =:= {:?}", refund_response, refund_response_body);
+ println!("{refund_response:?} =:= {refund_response_body:?}");
assert_eq!(refund_response.status(), awc::http::StatusCode::OK);
}
@@ -197,7 +197,7 @@ async fn payments_create_fail() {
.await
.unwrap();
let invalid_response_body = invalid_response.body().await;
- println!("{:?} : {:?}", invalid_response, invalid_response_body);
+ println!("{invalid_response:?} : {invalid_response_body:?}");
assert_eq!(
invalid_response.status(),
awc::http::StatusCode::BAD_REQUEST
@@ -210,7 +210,7 @@ async fn payments_create_fail() {
.await
.unwrap();
let api_key_response_body = api_key_response.body().await;
- println!("{:?} =:= {:?}", api_key_response, api_key_response_body);
+ println!("{api_key_response:?} =:= {api_key_response_body:?}");
assert_eq!(
api_key_response.status(),
awc::http::StatusCode::UNAUTHORIZED
@@ -230,13 +230,13 @@ async fn payments_todo() {
for endpoint in get_endpoints {
response = client
- .get(format!("http://127.0.0.1:8080/payments/{}", endpoint))
+ .get(format!("http://127.0.0.1:8080/payments/{endpoint}"))
.insert_header(("API-KEY", "MySecretApiKey"))
.send()
.await
.unwrap();
response_body = response.body().await;
- println!("{} =:= {:?} : {:?}", endpoint, response, response_body);
+ println!("{endpoint} =:= {response:?} : {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
}
@@ -264,7 +264,7 @@ fn connector_list() {
let newlist: types::ConnectorsList = serde_json::from_str(&json).unwrap();
- println!("{:#?}", newlist);
+ println!("{newlist:#?}");
assert_eq!(true, true);
}
diff --git a/crates/router/tests/payments2.rs b/crates/router/tests/payments2.rs
index 5b1b065c272..fd7b5e27a5d 100644
--- a/crates/router/tests/payments2.rs
+++ b/crates/router/tests/payments2.rs
@@ -24,7 +24,7 @@ fn connector_list() {
let newlist: router::types::ConnectorsList = serde_json::from_str(&json).unwrap();
- println!("{:#?}", newlist);
+ println!("{newlist:#?}");
assert_eq!(true, true);
}
diff --git a/crates/router/tests/payouts.rs b/crates/router/tests/payouts.rs
index 0c208340ace..566930cd4e3 100644
--- a/crates/router/tests/payouts.rs
+++ b/crates/router/tests/payouts.rs
@@ -14,23 +14,23 @@ async fn payouts_todo() {
for endpoint in get_endpoints {
response = client
- .get(format!("http://127.0.0.1:8080/payouts/{}", endpoint))
+ .get(format!("http://127.0.0.1:8080/payouts/{endpoint}"))
.send()
.await
.unwrap();
response_body = response.body().await;
- println!("{} =:= {:?} : {:?}", endpoint, response, response_body);
+ println!("{endpoint} =:= {response:?} : {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
}
for endpoint in post_endpoints {
response = client
- .post(format!("http://127.0.0.1:8080/payouts/{}", endpoint))
+ .post(format!("http://127.0.0.1:8080/payouts/{endpoint}"))
.send()
.await
.unwrap();
response_body = response.body().await;
- println!("{} =:= {:?} : {:?}", endpoint, response, response_body);
+ println!("{endpoint} =:= {response:?} : {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
}
}
diff --git a/crates/router/tests/refunds.rs b/crates/router/tests/refunds.rs
index 608b16f5cad..c9e08d22350 100644
--- a/crates/router/tests/refunds.rs
+++ b/crates/router/tests/refunds.rs
@@ -49,23 +49,23 @@ async fn refunds_todo() {
for endpoint in get_endpoints {
response = client
- .get(format!("http://127.0.0.1:8080/refunds/{}", endpoint))
+ .get(format!("http://127.0.0.1:8080/refunds/{endpoint}"))
.send()
.await
.unwrap();
response_body = response.body().await;
- println!("{} =:= {:?} : {:?}", endpoint, response, response_body);
+ println!("{endpoint} =:= {response:?} : {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
}
for endpoint in post_endpoints {
response = client
- .post(format!("http://127.0.0.1:8080/refunds/{}", endpoint))
+ .post(format!("http://127.0.0.1:8080/refunds/{endpoint}"))
.send()
.await
.unwrap();
response_body = response.body().await;
- println!("{} =:= {:?} : {:?}", endpoint, response, response_body);
+ println!("{endpoint} =:= {response:?} : {response_body:?}");
assert_eq!(response.status(), awc::http::StatusCode::OK);
}
}
diff --git a/crates/router_derive/src/lib.rs b/crates/router_derive/src/lib.rs
index e1e04d0b818..da7c01202f4 100644
--- a/crates/router_derive/src/lib.rs
+++ b/crates/router_derive/src/lib.rs
@@ -160,7 +160,7 @@ pub fn setter(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
// pub fn set_n(&mut self,n: u32)
let build_methods = fields.iter().map(|f| {
let name = f.ident.as_ref().unwrap();
- let method_name = format!("set_{}", name);
+ let method_name = format!("set_{name}");
let method_ident = syn::Ident::new(&method_name, name.span());
let ty = &f.ty;
if check_if_auth_based_attr_is_present(f, "auth_based") {
diff --git a/crates/router_derive/src/macros/helpers.rs b/crates/router_derive/src/macros/helpers.rs
index ee1aae15846..8932edbe0cc 100644
--- a/crates/router_derive/src/macros/helpers.rs
+++ b/crates/router_derive/src/macros/helpers.rs
@@ -13,7 +13,7 @@ pub(super) fn occurrence_error<T: ToTokens>(
) -> syn::Error {
let mut error = syn::Error::new_spanned(
second_keyword,
- format!("Found multiple occurrences of error({})", attr),
+ format!("Found multiple occurrences of error({attr})"),
);
error.combine(syn::Error::new_spanned(first_keyword, "first one here"));
error
diff --git a/crates/router_env/src/logger/formatter.rs b/crates/router_env/src/logger/formatter.rs
index 13e12f628ef..b53f83795e3 100644
--- a/crates/router_env/src/logger/formatter.rs
+++ b/crates/router_env/src/logger/formatter.rs
@@ -106,7 +106,7 @@ impl fmt::Display for RecordType {
Self::ExitSpan => "END",
Self::Event => "EVENT",
};
- write!(f, "{}", repr)
+ write!(f, "{repr}")
}
}
diff --git a/crates/router_env/src/logger/setup.rs b/crates/router_env/src/logger/setup.rs
index 35c7a910345..d851414c99d 100644
--- a/crates/router_env/src/logger/setup.rs
+++ b/crates/router_env/src/logger/setup.rs
@@ -156,6 +156,6 @@ fn setup_metrics() -> Option<BasicController> {
.with_period(Duration::from_secs(3))
.with_timeout(Duration::from_secs(10))
.build()
- .map_err(|err| eprintln!("Failed to Setup Metrics with {:?}", err))
+ .map_err(|err| eprintln!("Failed to Setup Metrics with {err:?}"))
.ok()
}
diff --git a/crates/router_env/src/logger/storage.rs b/crates/router_env/src/logger/storage.rs
index 973ec8013b1..04f00f71cb3 100644
--- a/crates/router_env/src/logger/storage.rs
+++ b/crates/router_env/src/logger/storage.rs
@@ -78,11 +78,11 @@ impl Visit for Storage<'_> {
name if name.starts_with("log.") => (),
name if name.starts_with("r#") => {
self.values
- .insert(&name[2..], serde_json::Value::from(format!("{:?}", value)));
+ .insert(&name[2..], serde_json::Value::from(format!("{value:?}")));
}
name => {
self.values
- .insert(name, serde_json::Value::from(format!("{:?}", value)));
+ .insert(name, serde_json::Value::from(format!("{value:?}")));
}
};
}
diff --git a/crates/storage_models/src/query/generics.rs b/crates/storage_models/src/query/generics.rs
index bf09b2e594c..766d0bb21c0 100644
--- a/crates/storage_models/src/query/generics.rs
+++ b/crates/storage_models/src/query/generics.rs
@@ -34,7 +34,7 @@ where
AsQuery + LoadQuery<'static, PgConnection, R> + Send,
R: Send + 'static,
{
- let debug_values = format!("{:?}", values);
+ let debug_values = format!("{values:?}");
let query = diesel::insert_into(<T as HasTable>::table()).values(values);
logger::debug!(query = %debug_query::<Pg, _>(&query).to_string());
@@ -49,7 +49,7 @@ where
_ => Err(err).change_context(errors::DatabaseError::Others),
},
}
- .attach_printable_lazy(|| format!("Error while inserting {}", debug_values))
+ .attach_printable_lazy(|| format!("Error while inserting {debug_values}"))
}
#[instrument(level = "DEBUG", skip_all)]
@@ -68,7 +68,7 @@ where
<V as AsChangeset>::Changeset,
>: AsQuery + QueryFragment<Pg> + QueryId + Send + 'static,
{
- let debug_values = format!("{:?}", values);
+ let debug_values = format!("{values:?}");
let query = diesel::update(<T as HasTable>::table().filter(predicate)).set(values);
logger::debug!(query = %debug_query::<Pg, _>(&query).to_string());
@@ -78,7 +78,7 @@ where
.await
.into_report()
.change_context(errors::DatabaseError::Others)
- .attach_printable_lazy(|| format!("Error while updating {}", debug_values))
+ .attach_printable_lazy(|| format!("Error while updating {debug_values}"))
}
#[instrument(level = "DEBUG", skip_all)]
@@ -98,7 +98,7 @@ where
>: AsQuery + LoadQuery<'static, PgConnection, R> + QueryFragment<Pg> + Send,
R: Send + 'static,
{
- let debug_values = format!("{:?}", values);
+ let debug_values = format!("{values:?}");
let query = diesel::update(<T as HasTable>::table().filter(predicate)).set(values);
logger::debug!(query = %debug_query::<Pg, _>(&query).to_string());
@@ -108,7 +108,7 @@ where
.await
.into_report()
.change_context(errors::DatabaseError::Others)
- .attach_printable_lazy(|| format!("Error while updating {}", debug_values))
+ .attach_printable_lazy(|| format!("Error while updating {debug_values}"))
}
#[instrument(level = "DEBUG", skip_all)]
@@ -138,7 +138,7 @@ where
<V as AsChangeset>::Changeset: Clone,
<<<T as FindDsl<Pk>>::Output as HasTable>::Table as QuerySource>::FromClause: Clone,
{
- let debug_values = format!("{:?}", values);
+ let debug_values = format!("{values:?}");
let query = diesel::update(<T as HasTable>::table().find(id.to_owned())).set(values);
@@ -152,10 +152,10 @@ where
}
Err(ConnectionError::Query(DieselError::NotFound)) => {
Err(report!(errors::DatabaseError::NotFound))
- .attach_printable_lazy(|| format!("Error while updating by ID {}", debug_values))
+ .attach_printable_lazy(|| format!("Error while updating by ID {debug_values}"))
}
_ => Err(report!(errors::DatabaseError::Others))
- .attach_printable_lazy(|| format!("Error while updating by ID {}", debug_values)),
+ .attach_printable_lazy(|| format!("Error while updating by ID {debug_values}")),
}
}
@@ -243,7 +243,7 @@ where
_ => Err(err).change_context(errors::DatabaseError::Others),
},
}
- .attach_printable_lazy(|| format!("Error finding record by primary key: {:?}", id))
+ .attach_printable_lazy(|| format!("Error finding record by primary key: {id:?}"))
}
#[instrument(level = "DEBUG", skip_all)]
|
chore
|
address Rust 1.67 clippy lints (#465)
|
3a5b262870dbd959cb83773c7a08bb9bbbccc1bd
|
2023-09-21 16:33:25
|
github-actions
|
chore(version): v1.43.0
| false
|
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1e0b5a56593..d54dafce1c3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,31 @@ All notable changes to HyperSwitch will be documented here.
- - -
+## 1.43.0 (2023-09-21)
+
+### Features
+
+- **connector:** [Gocardless] add support for Ach, Sepa, Becs payment methods ([#2180](https://github.com/juspay/hyperswitch/pull/2180)) ([`3efce90`](https://github.com/juspay/hyperswitch/commit/3efce9013d0572be9162216f134830ccf7e04905))
+- **core:** Add support for webhook additional source verification call for paypal ([#2058](https://github.com/juspay/hyperswitch/pull/2058)) ([`2a9e09d`](https://github.com/juspay/hyperswitch/commit/2a9e09d812ca11960cabab289b32be162bc5cfc9))
+- **db:** Enable caching for merchant_account fetch using publishable key ([#2186](https://github.com/juspay/hyperswitch/pull/2186)) ([`eb10aca`](https://github.com/juspay/hyperswitch/commit/eb10aca6313b3b3cb1763ca20b54b11c31b93b26))
+- **router:** Add kv implementation for address for payment flows ([#2177](https://github.com/juspay/hyperswitch/pull/2177)) ([`afff3e1`](https://github.com/juspay/hyperswitch/commit/afff3e1789b99a586f0b7ff6c5880743a996f565))
+
+### Bug Fixes
+
+- **connector:**
+ - [trustpay] add missing error_codes ([#2204](https://github.com/juspay/hyperswitch/pull/2204)) ([`8098322`](https://github.com/juspay/hyperswitch/commit/809832213eb0f961853bf0db8b2830a606f9ed37))
+ - [Trustpay] Add missing error code ([#2212](https://github.com/juspay/hyperswitch/pull/2212)) ([`e4b3cc7`](https://github.com/juspay/hyperswitch/commit/e4b3cc790580f04012dba3d926e170dce4cec5d1))
+- **env:** Remove EUR currency from clearpay_afterpay in stripe connector ([#2213](https://github.com/juspay/hyperswitch/pull/2213)) ([`9009ab2`](https://github.com/juspay/hyperswitch/commit/9009ab2896ef9c8df9045c288af5ad601ec7fcd7))
+
+### Refactors
+
+- **router:** Refactor customer <> address in customers and payments flow ([#2158](https://github.com/juspay/hyperswitch/pull/2158)) ([`8ee2ce1`](https://github.com/juspay/hyperswitch/commit/8ee2ce1f4fc416ac33a5e4def22ce2debdc6a6f9))
+
+**Full Changelog:** [`v1.42.0...v1.43.0`](https://github.com/juspay/hyperswitch/compare/v1.42.0...v1.43.0)
+
+- - -
+
+
## 1.42.0 (2023-09-20)
### Features
|
chore
|
v1.43.0
|
064d915884b18fde187fc43f9b13797d9b3081dd
|
2023-08-22 18:18:24
|
github-actions
|
chore(version): v1.25.1
| false
|
diff --git a/CHANGELOG.md b/CHANGELOG.md
index aa613b6706f..21a29c9e43e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,17 @@ All notable changes to HyperSwitch will be documented here.
- - -
+## 1.25.1 (2023-08-22)
+
+### Bug Fixes
+
+- Storage of generic payment methods in permanent locker ([#1799](https://github.com/juspay/hyperswitch/pull/1799)) ([`19ee324`](https://github.com/juspay/hyperswitch/commit/19ee324d373262aea873bb7a120f0e80b918fd84))
+
+**Full Changelog:** [`v1.25.0...v1.25.1`](https://github.com/juspay/hyperswitch/compare/v1.25.0...v1.25.1)
+
+- - -
+
+
## 1.25.0 (2023-08-22)
### Features
|
chore
|
v1.25.1
|
4e433a49f26905e8d13b4a9d90c22ac2fcaeee0e
|
2022-12-16 15:52:20
|
ItsMeShashank
|
fix(router): pop bugs in the payments confirm flow (#157)
| false
|
diff --git a/crates/router/src/compatibility/stripe/errors.rs b/crates/router/src/compatibility/stripe/errors.rs
index 0ee8c8a3d2a..65b411be7a7 100644
--- a/crates/router/src/compatibility/stripe/errors.rs
+++ b/crates/router/src/compatibility/stripe/errors.rs
@@ -64,6 +64,9 @@ pub(crate) enum ErrorCode {
#[error(error_type = StripeErrorType::InvalidRequestError, code = "resource_missing", message = "No such refund")]
RefundNotFound,
+ #[error(error_type = StripeErrorType::InvalidRequestError, code = "client_secret_invalid", message = "Expected client secret to be included in the request")]
+ ClientSecretNotFound,
+
#[error(error_type = StripeErrorType::InvalidRequestError, code = "resource_missing", message = "No such customer")]
CustomerNotFound,
@@ -353,6 +356,7 @@ impl From<ApiErrorResponse> for ErrorCode {
ApiErrorResponse::CustomerNotFound => ErrorCode::CustomerNotFound,
ApiErrorResponse::PaymentNotFound => ErrorCode::PaymentNotFound,
ApiErrorResponse::PaymentMethodNotFound => ErrorCode::PaymentMethodNotFound,
+ ApiErrorResponse::ClientSecretNotGiven => ErrorCode::ClientSecretNotFound,
ApiErrorResponse::MerchantAccountNotFound => ErrorCode::MerchantAccountNotFound,
ApiErrorResponse::ResourceIdNotFound => ErrorCode::ResourceIdNotFound,
ApiErrorResponse::MerchantConnectorAccountNotFound => {
@@ -420,6 +424,7 @@ impl actix_web::ResponseError for ErrorCode {
| ErrorCode::DuplicateRefundRequest
| ErrorCode::RefundNotFound
| ErrorCode::CustomerNotFound
+ | ErrorCode::ClientSecretNotFound
| ErrorCode::PaymentNotFound
| ErrorCode::PaymentMethodNotFound
| ErrorCode::MerchantAccountNotFound
diff --git a/crates/router/src/core/errors/api_error_response.rs b/crates/router/src/core/errors/api_error_response.rs
index 12cc827e702..bfeabd7b1da 100644
--- a/crates/router/src/core/errors/api_error_response.rs
+++ b/crates/router/src/core/errors/api_error_response.rs
@@ -48,6 +48,8 @@ pub enum ApiErrorResponse {
/// a field fails.
#[error(error_type = ErrorType::InvalidRequestError, code = "IR_07", message = "Invalid value provided: {field_name}.")]
InvalidDataValue { field_name: &'static str },
+ #[error(error_type = ErrorType::InvalidRequestError, code = "IR_07", message = "Client secret was not provided")]
+ ClientSecretNotGiven,
#[error(error_type = ErrorType::InvalidRequestError, code = "IR_07", message = "The client_secret provided does not match the client_secret associated with the Payment.")]
ClientSecretInvalid,
#[error(error_type = ErrorType::InvalidRequestError, code = "IR_07", message = "Customer has existing mandate/subsciption.")]
@@ -178,6 +180,7 @@ impl actix_web::ResponseError for ApiErrorResponse {
| ApiErrorResponse::MerchantAccountNotFound
| ApiErrorResponse::MerchantConnectorAccountNotFound
| ApiErrorResponse::MandateNotFound
+ | ApiErrorResponse::ClientSecretNotGiven
| ApiErrorResponse::ClientSecretInvalid
| ApiErrorResponse::SuccessfulPaymentNotFound
| ApiErrorResponse::ResourceIdNotFound
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index 6f6ac66f193..c32acc0a61c 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -20,6 +20,7 @@ use crate::{
db::StorageInterface,
pii::Secret,
routes::AppState,
+ scheduler::{metrics, workflows::payment_sync},
services,
types::{
self,
@@ -423,6 +424,45 @@ pub fn payment_intent_status_fsm(
}
}
+pub async fn add_domain_task_to_pt<Op>(
+ operation: &Op,
+ state: &AppState,
+ payment_attempt: &storage::PaymentAttempt,
+) -> CustomResult<(), errors::ApiErrorResponse>
+where
+ Op: std::fmt::Debug,
+{
+ if check_if_operation_confirm(operation) {
+ let connector_name = payment_attempt
+ .connector
+ .clone()
+ .ok_or(errors::ApiErrorResponse::InternalServerError)?;
+
+ let schedule_time = payment_sync::get_sync_process_schedule_time(
+ &*state.store,
+ &connector_name,
+ &payment_attempt.merchant_id,
+ 0,
+ )
+ .await
+ .into_report()
+ .change_context(errors::ApiErrorResponse::InternalServerError)?;
+
+ match schedule_time {
+ Some(stime) => {
+ metrics::TASKS_ADDED_COUNT.add(&metrics::CONTEXT, 1, &[]); // Metrics
+ super::add_process_sync_task(&*state.store, payment_attempt, stime)
+ .await
+ .into_report()
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ }
+ None => Ok(()),
+ }
+ } else {
+ Ok(())
+ }
+}
+
pub fn response_operation<'a, F, R>() -> BoxedOperation<'a, F, R>
where
F: Send + Clone,
@@ -1202,6 +1242,18 @@ pub(crate) fn authenticate_client_secret(
}
}
+pub(crate) fn validate_pm_or_token_given(
+ token: &Option<String>,
+ pm_data: &Option<api::PaymentMethod>,
+) -> Result<(), errors::ApiErrorResponse> {
+ utils::when(
+ token.is_none() && pm_data.is_none(),
+ Err(errors::ApiErrorResponse::InvalidRequestData {
+ message: "A payment token or payment method data is required".to_string(),
+ }),
+ )
+}
+
// A function to perform database lookup and then verify the client secret
pub(crate) async fn verify_client_secret(
db: &dyn StorageInterface,
diff --git a/crates/router/src/core/payments/operations.rs b/crates/router/src/core/payments/operations.rs
index 91f8bc5d46a..602191a6a7b 100644
--- a/crates/router/src/core/payments/operations.rs
+++ b/crates/router/src/core/payments/operations.rs
@@ -9,7 +9,7 @@ mod payment_start;
mod payment_status;
mod payment_update;
use async_trait::async_trait;
-use error_stack::{report, IntoReport, ResultExt};
+use error_stack::{report, ResultExt};
pub use payment_cancel::PaymentCancel;
pub use payment_capture::PaymentCapture;
pub use payment_confirm::PaymentConfirm;
@@ -29,7 +29,6 @@ use crate::{
db::StorageInterface,
pii::Secret,
routes::AppState,
- scheduler::{metrics, workflows::payment_sync},
types::{
self, api,
storage::{self, enums},
@@ -170,110 +169,6 @@ pub trait PostUpdateTracker<F, D, R>: Send {
F: 'b + Send;
}
-#[async_trait]
-impl<F: Clone + Send, Op: Send + Sync + Operation<F, api::PaymentsRequest>>
- Domain<F, api::PaymentsRequest> for Op
-where
- for<'a> &'a Op: Operation<F, api::PaymentsRequest> + std::fmt::Debug,
-{
- #[instrument(skip_all)]
- async fn get_or_create_customer_details<'a>(
- &'a self,
- db: &dyn StorageInterface,
- payment_data: &mut PaymentData<F>,
- request: Option<CustomerDetails>,
- merchant_id: &str,
- ) -> CustomResult<
- (
- BoxedOperation<'a, F, api::PaymentsRequest>,
- Option<storage::Customer>,
- ),
- errors::StorageError,
- > {
- helpers::create_customer_if_not_exist(
- Box::new(self),
- db,
- payment_data,
- request,
- merchant_id,
- )
- .await
- }
-
- #[instrument(skip_all)]
- async fn make_pm_data<'a>(
- &'a self,
- state: &'a AppState,
- payment_method: Option<enums::PaymentMethodType>,
- txn_id: &str,
- payment_attempt: &storage::PaymentAttempt,
- request: &Option<api::PaymentMethod>,
- token: &Option<String>,
- card_cvc: Option<Secret<String>>,
- _storage_scheme: enums::MerchantStorageScheme,
- ) -> RouterResult<(
- BoxedOperation<'a, F, api::PaymentsRequest>,
- Option<api::PaymentMethod>,
- Option<String>,
- )> {
- helpers::make_pm_data(
- Box::new(self),
- state,
- payment_method,
- txn_id,
- payment_attempt,
- request,
- token,
- card_cvc,
- )
- .await
- }
-
- #[instrument(skip_all)]
- async fn add_task_to_process_tracker<'a>(
- &'a self,
- state: &'a AppState,
- payment_attempt: &storage::PaymentAttempt,
- ) -> CustomResult<(), errors::ApiErrorResponse> {
- if helpers::check_if_operation_confirm(self) {
- metrics::TASKS_ADDED_COUNT.add(&metrics::CONTEXT, 1, &[]); // Metrics
-
- let connector_name = payment_attempt
- .connector
- .clone()
- .ok_or(errors::ApiErrorResponse::InternalServerError)?;
-
- let schedule_time = payment_sync::get_sync_process_schedule_time(
- &*state.store,
- &connector_name,
- &payment_attempt.merchant_id,
- 0,
- )
- .await
- .into_report()
- .change_context(errors::ApiErrorResponse::InternalServerError)?;
-
- match schedule_time {
- Some(stime) => super::add_process_sync_task(&*state.store, payment_attempt, stime)
- .await
- .into_report()
- .change_context(errors::ApiErrorResponse::InternalServerError),
- None => Ok(()),
- }
- } else {
- Ok(())
- }
- }
-
- async fn get_connector<'a>(
- &'a self,
- merchant_account: &storage::MerchantAccount,
- state: &AppState,
- ) -> CustomResult<api::ConnectorCallType, errors::ApiErrorResponse> {
- helpers::get_connector_default(merchant_account, state).await
- }
-}
-
#[async_trait]
impl<F: Clone + Send, Op: Send + Sync + Operation<F, api::PaymentsRetrieveRequest>>
Domain<F, api::PaymentsRetrieveRequest> for Op
diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs
index ee3f8669d19..cc4ca66605c 100644
--- a/crates/router/src/core/payments/operations/payment_confirm.rs
+++ b/crates/router/src/core/payments/operations/payment_confirm.rs
@@ -2,13 +2,14 @@ use std::marker::PhantomData;
use async_trait::async_trait;
use error_stack::{report, ResultExt};
+use masking::Secret;
use router_derive::PaymentOperation;
use router_env::{instrument, tracing};
use super::{BoxedOperation, Domain, GetTracker, Operation, UpdateTracker, ValidateRequest};
use crate::{
core::{
- errors::{self, RouterResult, StorageErrorExt},
+ errors::{self, CustomResult, RouterResult, StorageErrorExt},
payments::{helpers, operations, CustomerDetails, PaymentAddress, PaymentData},
utils as core_utils,
},
@@ -167,6 +168,86 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
}
}
+#[async_trait]
+impl<F: Clone + Send> Domain<F, api::PaymentsRequest> for PaymentConfirm {
+ #[instrument(skip_all)]
+ async fn get_or_create_customer_details<'a>(
+ &'a self,
+ db: &dyn StorageInterface,
+ payment_data: &mut PaymentData<F>,
+ request: Option<CustomerDetails>,
+ merchant_id: &str,
+ ) -> CustomResult<
+ (
+ BoxedOperation<'a, F, api::PaymentsRequest>,
+ Option<storage::Customer>,
+ ),
+ errors::StorageError,
+ > {
+ helpers::create_customer_if_not_exist(
+ Box::new(self),
+ db,
+ payment_data,
+ request,
+ merchant_id,
+ )
+ .await
+ }
+
+ #[instrument(skip_all)]
+ async fn make_pm_data<'a>(
+ &'a self,
+ state: &'a AppState,
+ payment_method: Option<enums::PaymentMethodType>,
+ txn_id: &str,
+ payment_attempt: &storage::PaymentAttempt,
+ request: &Option<api::PaymentMethod>,
+ token: &Option<String>,
+ card_cvc: Option<Secret<String>>,
+ _storage_scheme: enums::MerchantStorageScheme,
+ ) -> RouterResult<(
+ BoxedOperation<'a, F, api::PaymentsRequest>,
+ Option<api::PaymentMethod>,
+ Option<String>,
+ )> {
+ let (op, payment_method, payment_token) = helpers::make_pm_data(
+ Box::new(self),
+ state,
+ payment_method,
+ txn_id,
+ payment_attempt,
+ request,
+ token,
+ card_cvc,
+ )
+ .await?;
+
+ utils::when(
+ payment_method.is_none(),
+ Err(errors::ApiErrorResponse::PaymentMethodNotFound),
+ )?;
+
+ Ok((op, payment_method, payment_token))
+ }
+
+ #[instrument(skip_all)]
+ async fn add_task_to_process_tracker<'a>(
+ &'a self,
+ state: &'a AppState,
+ payment_attempt: &storage::PaymentAttempt,
+ ) -> CustomResult<(), errors::ApiErrorResponse> {
+ helpers::add_domain_task_to_pt(self, state, payment_attempt).await
+ }
+
+ async fn get_connector<'a>(
+ &'a self,
+ merchant_account: &storage::MerchantAccount,
+ state: &AppState,
+ ) -> CustomResult<api::ConnectorCallType, errors::ApiErrorResponse> {
+ helpers::get_connector_default(merchant_account, state).await
+ }
+}
+
#[async_trait]
impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentConfirm {
#[instrument(skip_all)]
@@ -265,6 +346,9 @@ impl<F: Send + Clone> ValidateRequest<F, api::PaymentsRequest> for PaymentConfir
field_name: "merchant_id".to_string(),
expected_format: "merchant_id from merchant account".to_string(),
})?;
+
+ helpers::validate_pm_or_token_given(&request.payment_token, &request.payment_method_data)?;
+
let mandate_type = helpers::validate_mandate(request)?;
let payment_id = core_utils::get_or_generate_id("payment_id", &given_payment_id, "pay")?;
diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs
index 1f636cab59f..c8cd30ea227 100644
--- a/crates/router/src/core/payments/operations/payment_create.rs
+++ b/crates/router/src/core/payments/operations/payment_create.rs
@@ -2,6 +2,7 @@ use std::marker::PhantomData;
use async_trait::async_trait;
use error_stack::ResultExt;
+use masking::Secret;
use router_derive::PaymentOperation;
use router_env::{instrument, tracing};
use uuid::Uuid;
@@ -10,7 +11,7 @@ use super::{BoxedOperation, Domain, GetTracker, Operation, UpdateTracker, Valida
use crate::{
consts,
core::{
- errors::{self, RouterResult, StorageErrorExt},
+ errors::{self, CustomResult, RouterResult, StorageErrorExt},
payments::{self, helpers, operations, CustomerDetails, PaymentAddress, PaymentData},
utils as core_utils,
},
@@ -221,6 +222,79 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
}
}
+#[async_trait]
+impl<F: Clone + Send> Domain<F, api::PaymentsRequest> for PaymentCreate {
+ #[instrument(skip_all)]
+ async fn get_or_create_customer_details<'a>(
+ &'a self,
+ db: &dyn StorageInterface,
+ payment_data: &mut PaymentData<F>,
+ request: Option<CustomerDetails>,
+ merchant_id: &str,
+ ) -> CustomResult<
+ (
+ BoxedOperation<'a, F, api::PaymentsRequest>,
+ Option<storage::Customer>,
+ ),
+ errors::StorageError,
+ > {
+ helpers::create_customer_if_not_exist(
+ Box::new(self),
+ db,
+ payment_data,
+ request,
+ merchant_id,
+ )
+ .await
+ }
+
+ #[instrument(skip_all)]
+ async fn make_pm_data<'a>(
+ &'a self,
+ state: &'a AppState,
+ payment_method: Option<enums::PaymentMethodType>,
+ txn_id: &str,
+ payment_attempt: &storage::PaymentAttempt,
+ request: &Option<api::PaymentMethod>,
+ token: &Option<String>,
+ card_cvc: Option<Secret<String>>,
+ _storage_scheme: enums::MerchantStorageScheme,
+ ) -> RouterResult<(
+ BoxedOperation<'a, F, api::PaymentsRequest>,
+ Option<api::PaymentMethod>,
+ Option<String>,
+ )> {
+ helpers::make_pm_data(
+ Box::new(self),
+ state,
+ payment_method,
+ txn_id,
+ payment_attempt,
+ request,
+ token,
+ card_cvc,
+ )
+ .await
+ }
+
+ #[instrument(skip_all)]
+ async fn add_task_to_process_tracker<'a>(
+ &'a self,
+ state: &'a AppState,
+ payment_attempt: &storage::PaymentAttempt,
+ ) -> CustomResult<(), errors::ApiErrorResponse> {
+ helpers::add_domain_task_to_pt(self, state, payment_attempt).await
+ }
+
+ async fn get_connector<'a>(
+ &'a self,
+ merchant_account: &storage::MerchantAccount,
+ state: &AppState,
+ ) -> CustomResult<api::ConnectorCallType, errors::ApiErrorResponse> {
+ helpers::get_connector_default(merchant_account, state).await
+ }
+}
+
#[async_trait]
impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentCreate {
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_status.rs b/crates/router/src/core/payments/operations/payment_status.rs
index d6391e8f3ba..c3845182f3b 100644
--- a/crates/router/src/core/payments/operations/payment_status.rs
+++ b/crates/router/src/core/payments/operations/payment_status.rs
@@ -2,13 +2,14 @@ use std::marker::PhantomData;
use async_trait::async_trait;
use error_stack::ResultExt;
+use masking::Secret;
use router_derive::PaymentOperation;
use router_env::{instrument, tracing};
use super::{BoxedOperation, Domain, GetTracker, Operation, UpdateTracker, ValidateRequest};
use crate::{
core::{
- errors::{self, ApiErrorResponse, RouterResult, StorageErrorExt},
+ errors::{self, ApiErrorResponse, CustomResult, RouterResult, StorageErrorExt},
payments::{helpers, operations, CustomerDetails, PaymentAddress, PaymentData},
},
db::StorageInterface,
@@ -48,6 +49,79 @@ impl<F: Send + Clone> Operation<F, api::PaymentsRequest> for &PaymentStatus {
}
}
+#[async_trait]
+impl<F: Clone + Send> Domain<F, api::PaymentsRequest> for PaymentStatus {
+ #[instrument(skip_all)]
+ async fn get_or_create_customer_details<'a>(
+ &'a self,
+ db: &dyn StorageInterface,
+ payment_data: &mut PaymentData<F>,
+ request: Option<CustomerDetails>,
+ merchant_id: &str,
+ ) -> CustomResult<
+ (
+ BoxedOperation<'a, F, api::PaymentsRequest>,
+ Option<storage::Customer>,
+ ),
+ errors::StorageError,
+ > {
+ helpers::create_customer_if_not_exist(
+ Box::new(self),
+ db,
+ payment_data,
+ request,
+ merchant_id,
+ )
+ .await
+ }
+
+ #[instrument(skip_all)]
+ async fn make_pm_data<'a>(
+ &'a self,
+ state: &'a AppState,
+ payment_method: Option<enums::PaymentMethodType>,
+ txn_id: &str,
+ payment_attempt: &storage::PaymentAttempt,
+ request: &Option<api::PaymentMethod>,
+ token: &Option<String>,
+ card_cvc: Option<Secret<String>>,
+ _storage_scheme: enums::MerchantStorageScheme,
+ ) -> RouterResult<(
+ BoxedOperation<'a, F, api::PaymentsRequest>,
+ Option<api::PaymentMethod>,
+ Option<String>,
+ )> {
+ helpers::make_pm_data(
+ Box::new(self),
+ state,
+ payment_method,
+ txn_id,
+ payment_attempt,
+ request,
+ token,
+ card_cvc,
+ )
+ .await
+ }
+
+ #[instrument(skip_all)]
+ async fn add_task_to_process_tracker<'a>(
+ &'a self,
+ state: &'a AppState,
+ payment_attempt: &storage::PaymentAttempt,
+ ) -> CustomResult<(), errors::ApiErrorResponse> {
+ helpers::add_domain_task_to_pt(self, state, payment_attempt).await
+ }
+
+ async fn get_connector<'a>(
+ &'a self,
+ merchant_account: &storage::MerchantAccount,
+ state: &AppState,
+ ) -> CustomResult<api::ConnectorCallType, errors::ApiErrorResponse> {
+ helpers::get_connector_default(merchant_account, state).await
+ }
+}
+
#[async_trait]
impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentStatus {
async fn update_trackers<'b>(
diff --git a/crates/router/src/core/payments/operations/payment_update.rs b/crates/router/src/core/payments/operations/payment_update.rs
index c6b9547de39..2bbea287826 100644
--- a/crates/router/src/core/payments/operations/payment_update.rs
+++ b/crates/router/src/core/payments/operations/payment_update.rs
@@ -2,13 +2,14 @@ use std::marker::PhantomData;
use async_trait::async_trait;
use error_stack::{report, ResultExt};
+use masking::Secret;
use router_derive::PaymentOperation;
use router_env::{instrument, tracing};
use super::{BoxedOperation, Domain, GetTracker, Operation, UpdateTracker, ValidateRequest};
use crate::{
core::{
- errors::{self, RouterResult, StorageErrorExt},
+ errors::{self, CustomResult, RouterResult, StorageErrorExt},
payments::{self, helpers, operations, CustomerDetails, PaymentAddress, PaymentData},
utils as core_utils,
},
@@ -168,6 +169,79 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
}
}
+#[async_trait]
+impl<F: Clone + Send> Domain<F, api::PaymentsRequest> for PaymentUpdate {
+ #[instrument(skip_all)]
+ async fn get_or_create_customer_details<'a>(
+ &'a self,
+ db: &dyn StorageInterface,
+ payment_data: &mut PaymentData<F>,
+ request: Option<CustomerDetails>,
+ merchant_id: &str,
+ ) -> CustomResult<
+ (
+ BoxedOperation<'a, F, api::PaymentsRequest>,
+ Option<storage::Customer>,
+ ),
+ errors::StorageError,
+ > {
+ helpers::create_customer_if_not_exist(
+ Box::new(self),
+ db,
+ payment_data,
+ request,
+ merchant_id,
+ )
+ .await
+ }
+
+ #[instrument(skip_all)]
+ async fn make_pm_data<'a>(
+ &'a self,
+ state: &'a AppState,
+ payment_method: Option<enums::PaymentMethodType>,
+ txn_id: &str,
+ payment_attempt: &storage::PaymentAttempt,
+ request: &Option<api::PaymentMethod>,
+ token: &Option<String>,
+ card_cvc: Option<Secret<String>>,
+ _storage_scheme: enums::MerchantStorageScheme,
+ ) -> RouterResult<(
+ BoxedOperation<'a, F, api::PaymentsRequest>,
+ Option<api::PaymentMethod>,
+ Option<String>,
+ )> {
+ helpers::make_pm_data(
+ Box::new(self),
+ state,
+ payment_method,
+ txn_id,
+ payment_attempt,
+ request,
+ token,
+ card_cvc,
+ )
+ .await
+ }
+
+ #[instrument(skip_all)]
+ async fn add_task_to_process_tracker<'a>(
+ &'a self,
+ state: &'a AppState,
+ payment_attempt: &storage::PaymentAttempt,
+ ) -> CustomResult<(), errors::ApiErrorResponse> {
+ helpers::add_domain_task_to_pt(self, state, payment_attempt).await
+ }
+
+ async fn get_connector<'a>(
+ &'a self,
+ merchant_account: &storage::MerchantAccount,
+ state: &AppState,
+ ) -> CustomResult<api::ConnectorCallType, errors::ApiErrorResponse> {
+ helpers::get_connector_default(merchant_account, state).await
+ }
+}
+
#[async_trait]
impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentUpdate {
#[instrument(skip_all)]
|
fix
|
pop bugs in the payments confirm flow (#157)
|
2f3a463253c1704218a1bed06b1bec192a3e02b9
|
2024-08-06 16:20:58
|
DEEPANSHU BANSAL
|
fix: [CYBERSOURCE] Update status handling for AuthorizedPendingReview (#5534)
| false
|
diff --git a/crates/router/src/connector/cybersource/transformers.rs b/crates/router/src/connector/cybersource/transformers.rs
index 86960b43ca4..c68f0e6069f 100644
--- a/crates/router/src/connector/cybersource/transformers.rs
+++ b/crates/router/src/connector/cybersource/transformers.rs
@@ -1730,8 +1730,7 @@ pub enum CybersourceIncrementalAuthorizationStatus {
impl ForeignFrom<(CybersourcePaymentStatus, bool)> for enums::AttemptStatus {
fn foreign_from((status, capture): (CybersourcePaymentStatus, bool)) -> Self {
match status {
- CybersourcePaymentStatus::Authorized
- | CybersourcePaymentStatus::AuthorizedPendingReview => {
+ CybersourcePaymentStatus::Authorized => {
if capture {
// Because Cybersource will return Payment Status as Authorized even in AutoCapture Payment
Self::Charged
@@ -1739,13 +1738,6 @@ impl ForeignFrom<(CybersourcePaymentStatus, bool)> for enums::AttemptStatus {
Self::Authorized
}
}
- CybersourcePaymentStatus::Pending => {
- if capture {
- Self::Charged
- } else {
- Self::Pending
- }
- }
CybersourcePaymentStatus::Succeeded | CybersourcePaymentStatus::Transmitted => {
Self::Charged
}
@@ -1762,7 +1754,9 @@ impl ForeignFrom<(CybersourcePaymentStatus, bool)> for enums::AttemptStatus {
CybersourcePaymentStatus::PendingReview
| CybersourcePaymentStatus::StatusNotReceived
| CybersourcePaymentStatus::Challenge
- | CybersourcePaymentStatus::Accepted => Self::Pending,
+ | CybersourcePaymentStatus::Accepted
+ | CybersourcePaymentStatus::Pending
+ | CybersourcePaymentStatus::AuthorizedPendingReview => Self::Pending,
}
}
}
@@ -1770,8 +1764,8 @@ impl ForeignFrom<(CybersourcePaymentStatus, bool)> for enums::AttemptStatus {
impl From<CybersourceIncrementalAuthorizationStatus> for common_enums::AuthorizationStatus {
fn from(item: CybersourceIncrementalAuthorizationStatus) -> Self {
match item {
- CybersourceIncrementalAuthorizationStatus::Authorized
- | CybersourceIncrementalAuthorizationStatus::AuthorizedPendingReview => Self::Success,
+ CybersourceIncrementalAuthorizationStatus::Authorized => Self::Success,
+ CybersourceIncrementalAuthorizationStatus::AuthorizedPendingReview => Self::Processing,
CybersourceIncrementalAuthorizationStatus::Declined => Self::Failure,
}
}
|
fix
|
[CYBERSOURCE] Update status handling for AuthorizedPendingReview (#5534)
|
99702ed8f99cb03fc4452c067131aebf368de054
|
2024-05-14 12:37:40
|
AkshayaFoiger
|
refactor(connector): [BOA/CYBS] refund error handling (#4632)
| false
|
diff --git a/crates/router/src/connector/bankofamerica/transformers.rs b/crates/router/src/connector/bankofamerica/transformers.rs
index 08ed89c7fb6..1e8a167a179 100644
--- a/crates/router/src/connector/bankofamerica/transformers.rs
+++ b/crates/router/src/connector/bankofamerica/transformers.rs
@@ -1597,6 +1597,7 @@ fn get_error_response_if_failure(
Some(types::ErrorResponse::from((
&info_response.error_information,
&info_response.risk_information,
+ Some(status),
http_code,
info_response.id.clone(),
)))
@@ -1995,6 +1996,7 @@ impl<F>
let response = Err(types::ErrorResponse::from((
&info_response.error_information,
&risk_info,
+ Some(status),
item.http_code,
info_response.id.clone(),
)));
@@ -2420,6 +2422,7 @@ impl<F>
response: Err(types::ErrorResponse::from((
&app_response.error_information,
&risk_info,
+ Some(status),
item.http_code,
app_response.id.clone(),
))),
@@ -2611,6 +2614,7 @@ impl From<BankofamericaRefundStatus> for enums::RefundStatus {
pub struct BankOfAmericaRefundResponse {
id: String,
status: BankofamericaRefundStatus,
+ error_information: Option<BankOfAmericaErrorInformation>,
}
impl TryFrom<types::RefundsResponseRouterData<api::Execute, BankOfAmericaRefundResponse>>
@@ -2620,17 +2624,30 @@ impl TryFrom<types::RefundsResponseRouterData<api::Execute, BankOfAmericaRefundR
fn try_from(
item: types::RefundsResponseRouterData<api::Execute, BankOfAmericaRefundResponse>,
) -> Result<Self, Self::Error> {
- Ok(Self {
- response: Ok(types::RefundsResponseData {
+ let refund_status = enums::RefundStatus::from(item.response.status.clone());
+ let response = if utils::is_refund_failure(refund_status) {
+ Err(types::ErrorResponse::from((
+ &item.response.error_information,
+ &None,
+ None,
+ item.http_code,
+ item.response.id.clone(),
+ )))
+ } else {
+ Ok(types::RefundsResponseData {
connector_refund_id: item.response.id,
refund_status: enums::RefundStatus::from(item.response.status),
- }),
+ })
+ };
+
+ Ok(Self {
+ response,
..item.data
})
}
}
-#[derive(Debug, Deserialize, Serialize)]
+#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum BankofamericaRefundStatus {
Succeeded,
@@ -2644,21 +2661,15 @@ pub enum BankofamericaRefundStatus {
#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct RsyncApplicationInformation {
- status: BankofamericaRefundStatus,
-}
-
-#[derive(Debug, Deserialize, Serialize)]
-#[serde(untagged)]
-pub enum BankOfAmericaRsyncResponse {
- RsyncApplicationResponse(Box<BankOfAmericaRsyncApplicationResponse>),
- ErrorInformation(BankOfAmericaErrorInformationResponse),
+ status: Option<BankofamericaRefundStatus>,
}
#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
-pub struct BankOfAmericaRsyncApplicationResponse {
+pub struct BankOfAmericaRsyncResponse {
id: String,
- application_information: RsyncApplicationInformation,
+ application_information: Option<RsyncApplicationInformation>,
+ error_information: Option<BankOfAmericaErrorInformation>,
}
impl TryFrom<types::RefundsResponseRouterData<api::RSync, BankOfAmericaRsyncResponse>>
@@ -2668,25 +2679,56 @@ impl TryFrom<types::RefundsResponseRouterData<api::RSync, BankOfAmericaRsyncResp
fn try_from(
item: types::RefundsResponseRouterData<api::RSync, BankOfAmericaRsyncResponse>,
) -> Result<Self, Self::Error> {
- match item.response {
- BankOfAmericaRsyncResponse::RsyncApplicationResponse(rsync_response) => Ok(Self {
- response: Ok(types::RefundsResponseData {
- connector_refund_id: rsync_response.id,
- refund_status: enums::RefundStatus::from(
- rsync_response.application_information.status,
- ),
- }),
- ..item.data
- }),
- BankOfAmericaRsyncResponse::ErrorInformation(error_response) => Ok(Self {
- status: item.data.status,
- response: Ok(types::RefundsResponseData {
- refund_status: common_enums::RefundStatus::Pending,
- connector_refund_id: error_response.id.clone(),
- }),
- ..item.data
+ let response = match item
+ .response
+ .application_information
+ .and_then(|application_information| application_information.status)
+ {
+ Some(status) => {
+ let refund_status: common_enums::RefundStatus =
+ enums::RefundStatus::from(status.clone());
+ if utils::is_refund_failure(refund_status) {
+ if status == BankofamericaRefundStatus::Voided {
+ Err(types::ErrorResponse::from((
+ &Some(BankOfAmericaErrorInformation {
+ message: Some(consts::REFUND_VOIDED.to_string()),
+ reason: None,
+ }),
+ &None,
+ None,
+ item.http_code,
+ item.response.id.clone(),
+ )))
+ } else {
+ Err(types::ErrorResponse::from((
+ &item.response.error_information,
+ &None,
+ None,
+ item.http_code,
+ item.response.id.clone(),
+ )))
+ }
+ } else {
+ Ok(types::RefundsResponseData {
+ connector_refund_id: item.response.id,
+ refund_status,
+ })
+ }
+ }
+
+ None => Ok(types::RefundsResponseData {
+ connector_refund_id: item.response.id.clone(),
+ refund_status: match item.data.response {
+ Ok(response) => response.refund_status,
+ Err(_) => common_enums::RefundStatus::Pending,
+ },
}),
- }
+ };
+
+ Ok(Self {
+ response,
+ ..item.data
+ })
}
}
@@ -2750,14 +2792,16 @@ impl
From<(
&Option<BankOfAmericaErrorInformation>,
&Option<ClientRiskInformation>,
+ Option<enums::AttemptStatus>,
u16,
String,
)> for types::ErrorResponse
{
fn from(
- (error_data, risk_information, status_code, transaction_id): (
+ (error_data, risk_information, attempt_status, status_code, transaction_id): (
&Option<BankOfAmericaErrorInformation>,
&Option<ClientRiskInformation>,
+ Option<enums::AttemptStatus>,
u16,
String,
),
@@ -2794,7 +2838,7 @@ impl
.unwrap_or(consts::NO_ERROR_MESSAGE.to_string()),
reason: Some(error_reason.clone()),
status_code,
- attempt_status: Some(enums::AttemptStatus::Failure),
+ attempt_status,
connector_transaction_id: Some(transaction_id.clone()),
}
}
diff --git a/crates/router/src/connector/cybersource/transformers.rs b/crates/router/src/connector/cybersource/transformers.rs
index 2a444576b09..517d406a9d5 100644
--- a/crates/router/src/connector/cybersource/transformers.rs
+++ b/crates/router/src/connector/cybersource/transformers.rs
@@ -1729,6 +1729,7 @@ fn get_error_response_if_failure(
Some(types::ErrorResponse::from((
&info_response.error_information,
&info_response.risk_information,
+ Some(status),
http_code,
info_response.id.clone(),
)))
@@ -2191,6 +2192,7 @@ impl<F>
let response = Err(types::ErrorResponse::from((
&info_response.error_information,
&risk_info,
+ Some(status),
item.http_code,
info_response.id.clone(),
)));
@@ -2616,6 +2618,7 @@ impl<F>
response: Err(types::ErrorResponse::from((
&app_response.error_information,
&risk_info,
+ Some(status),
item.http_code,
app_response.id.clone(),
))),
@@ -2702,7 +2705,7 @@ impl From<CybersourceRefundStatus> for enums::RefundStatus {
}
}
-#[derive(Debug, Deserialize, Serialize)]
+#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum CybersourceRefundStatus {
Succeeded,
@@ -2718,6 +2721,7 @@ pub enum CybersourceRefundStatus {
pub struct CybersourceRefundResponse {
id: String,
status: CybersourceRefundStatus,
+ error_information: Option<CybersourceErrorInformation>,
}
impl TryFrom<types::RefundsResponseRouterData<api::Execute, CybersourceRefundResponse>>
@@ -2727,11 +2731,24 @@ impl TryFrom<types::RefundsResponseRouterData<api::Execute, CybersourceRefundRes
fn try_from(
item: types::RefundsResponseRouterData<api::Execute, CybersourceRefundResponse>,
) -> Result<Self, Self::Error> {
- Ok(Self {
- response: Ok(types::RefundsResponseData {
+ let refund_status = enums::RefundStatus::from(item.response.status.clone());
+ let response = if utils::is_refund_failure(refund_status) {
+ Err(types::ErrorResponse::from((
+ &item.response.error_information,
+ &None,
+ None,
+ item.http_code,
+ item.response.id.clone(),
+ )))
+ } else {
+ Ok(types::RefundsResponseData {
connector_refund_id: item.response.id,
refund_status: enums::RefundStatus::from(item.response.status),
- }),
+ })
+ };
+
+ Ok(Self {
+ response,
..item.data
})
}
@@ -2740,21 +2757,15 @@ impl TryFrom<types::RefundsResponseRouterData<api::Execute, CybersourceRefundRes
#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct RsyncApplicationInformation {
- status: CybersourceRefundStatus,
+ status: Option<CybersourceRefundStatus>,
}
#[derive(Debug, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
-pub struct CybersourceRsyncApplicationResponse {
+pub struct CybersourceRsyncResponse {
id: String,
- application_information: RsyncApplicationInformation,
-}
-
-#[derive(Debug, Deserialize, Serialize)]
-#[serde(untagged)]
-pub enum CybersourceRsyncResponse {
- RsyncApplicationResponse(Box<CybersourceRsyncApplicationResponse>),
- ErrorInformation(CybersourceErrorInformationResponse),
+ application_information: Option<RsyncApplicationInformation>,
+ error_information: Option<CybersourceErrorInformation>,
}
impl TryFrom<types::RefundsResponseRouterData<api::RSync, CybersourceRsyncResponse>>
@@ -2764,25 +2775,55 @@ impl TryFrom<types::RefundsResponseRouterData<api::RSync, CybersourceRsyncRespon
fn try_from(
item: types::RefundsResponseRouterData<api::RSync, CybersourceRsyncResponse>,
) -> Result<Self, Self::Error> {
- match item.response {
- CybersourceRsyncResponse::RsyncApplicationResponse(rsync_reponse) => Ok(Self {
- response: Ok(types::RefundsResponseData {
- connector_refund_id: rsync_reponse.id,
- refund_status: enums::RefundStatus::from(
- rsync_reponse.application_information.status,
- ),
- }),
- ..item.data
- }),
- CybersourceRsyncResponse::ErrorInformation(error_response) => Ok(Self {
- status: item.data.status,
- response: Ok(types::RefundsResponseData {
- refund_status: common_enums::RefundStatus::Pending,
- connector_refund_id: error_response.id.clone(),
- }),
- ..item.data
+ let response = match item
+ .response
+ .application_information
+ .and_then(|application_information| application_information.status)
+ {
+ Some(status) => {
+ let refund_status = enums::RefundStatus::from(status.clone());
+ if utils::is_refund_failure(refund_status) {
+ if status == CybersourceRefundStatus::Voided {
+ Err(types::ErrorResponse::from((
+ &Some(CybersourceErrorInformation {
+ message: Some(consts::REFUND_VOIDED.to_string()),
+ reason: None,
+ }),
+ &None,
+ None,
+ item.http_code,
+ item.response.id.clone(),
+ )))
+ } else {
+ Err(types::ErrorResponse::from((
+ &item.response.error_information,
+ &None,
+ None,
+ item.http_code,
+ item.response.id.clone(),
+ )))
+ }
+ } else {
+ Ok(types::RefundsResponseData {
+ connector_refund_id: item.response.id,
+ refund_status,
+ })
+ }
+ }
+
+ None => Ok(types::RefundsResponseData {
+ connector_refund_id: item.response.id.clone(),
+ refund_status: match item.data.response {
+ Ok(response) => response.refund_status,
+ Err(_) => common_enums::RefundStatus::Pending,
+ },
}),
- }
+ };
+
+ Ok(Self {
+ response,
+ ..item.data
+ })
}
}
@@ -3079,14 +3120,16 @@ impl
From<(
&Option<CybersourceErrorInformation>,
&Option<ClientRiskInformation>,
+ Option<enums::AttemptStatus>,
u16,
String,
)> for types::ErrorResponse
{
fn from(
- (error_data, risk_information, status_code, transaction_id): (
+ (error_data, risk_information, attempt_status, status_code, transaction_id): (
&Option<CybersourceErrorInformation>,
&Option<ClientRiskInformation>,
+ Option<enums::AttemptStatus>,
u16,
String,
),
@@ -3123,7 +3166,7 @@ impl
.unwrap_or(consts::NO_ERROR_MESSAGE.to_string()),
reason: Some(error_reason.clone()),
status_code,
- attempt_status: Some(enums::AttemptStatus::Failure),
+ attempt_status,
connector_transaction_id: Some(transaction_id.clone()),
}
}
diff --git a/crates/router/src/consts.rs b/crates/router/src/consts.rs
index 301cd64b011..3a94a4e7655 100644
--- a/crates/router/src/consts.rs
+++ b/crates/router/src/consts.rs
@@ -36,6 +36,8 @@ pub(crate) const NO_ERROR_CODE: &str = "No error code";
pub(crate) const UNSUPPORTED_ERROR_MESSAGE: &str = "Unsupported response type";
pub(crate) const LOW_BALANCE_ERROR_MESSAGE: &str = "Insufficient balance in the payment method";
pub(crate) const CONNECTOR_UNAUTHORIZED_ERROR: &str = "Authentication Error from the connector";
+pub(crate) const REFUND_VOIDED: &str = "Refund request has been voided.";
+
pub(crate) const CANNOT_CONTINUE_AUTH: &str =
"Cannot continue with Authorization due to failed Liability Shift.";
#[cfg(feature = "payouts")]
diff --git a/crates/router/src/core/refunds.rs b/crates/router/src/core/refunds.rs
index 2ddc5e1f6c2..fa6b06ba3a5 100644
--- a/crates/router/src/core/refunds.rs
+++ b/crates/router/src/core/refunds.rs
@@ -493,12 +493,19 @@ pub async fn sync_refund_with_gateway(
};
let refund_update = match router_data_res.response {
- Err(error_message) => storage::RefundUpdate::ErrorUpdate {
- refund_status: None,
- refund_error_message: error_message.reason.or(Some(error_message.message)),
- refund_error_code: Some(error_message.code),
- updated_by: storage_scheme.to_string(),
- },
+ Err(error_message) => {
+ let refund_status = match error_message.status_code {
+ // marking failure for 2xx because this is genuine refund failure
+ 200..=299 => Some(enums::RefundStatus::Failure),
+ _ => None,
+ };
+ storage::RefundUpdate::ErrorUpdate {
+ refund_status,
+ refund_error_message: error_message.reason.or(Some(error_message.message)),
+ refund_error_code: Some(error_message.code),
+ updated_by: storage_scheme.to_string(),
+ }
+ }
Ok(response) => storage::RefundUpdate::Update {
connector_refund_id: response.connector_refund_id,
refund_status: response.refund_status,
|
refactor
|
[BOA/CYBS] refund error handling (#4632)
|
7f0d04fe3782cf6777c67e40e708c7abb5c4f45e
|
2024-04-25 12:02:42
|
Sakil Mostak
|
feat(core): [Payouts] Add access_token flow for Payout Create and Fulfill flow (#4375)
| false
|
diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs
index 3aa2a676d43..6bdb51281fb 100644
--- a/crates/api_models/src/enums.rs
+++ b/crates/api_models/src/enums.rs
@@ -135,6 +135,25 @@ pub enum Connector {
}
impl Connector {
+ #[cfg(feature = "payouts")]
+ pub fn supports_instant_payout(&self, payout_method: PayoutType) -> bool {
+ matches!(
+ (self, payout_method),
+ (Self::Paypal, PayoutType::Wallet) | (_, PayoutType::Card)
+ )
+ }
+ #[cfg(feature = "payouts")]
+ pub fn supports_create_recipient(&self, payout_method: PayoutType) -> bool {
+ matches!((self, payout_method), (_, PayoutType::Bank))
+ }
+ #[cfg(feature = "payouts")]
+ pub fn supports_payout_eligibility(&self, payout_method: PayoutType) -> bool {
+ matches!((self, payout_method), (_, PayoutType::Card))
+ }
+ #[cfg(feature = "payouts")]
+ pub fn supports_access_token_for_payout(&self, payout_method: PayoutType) -> bool {
+ matches!((self, payout_method), (Self::Paypal, _))
+ }
pub fn supports_access_token(&self, payment_method: PaymentMethod) -> bool {
matches!(
(self, payment_method),
@@ -320,6 +339,7 @@ pub enum AuthenticationConnectors {
pub enum PayoutConnectors {
Adyen,
Wise,
+ Paypal,
}
#[cfg(feature = "payouts")]
@@ -328,6 +348,7 @@ impl From<PayoutConnectors> for RoutableConnectors {
match value {
PayoutConnectors::Adyen => Self::Adyen,
PayoutConnectors::Wise => Self::Wise,
+ PayoutConnectors::Paypal => Self::Paypal,
}
}
}
@@ -338,6 +359,7 @@ impl From<PayoutConnectors> for Connector {
match value {
PayoutConnectors::Adyen => Self::Adyen,
PayoutConnectors::Wise => Self::Wise,
+ PayoutConnectors::Paypal => Self::Paypal,
}
}
}
@@ -349,6 +371,7 @@ impl TryFrom<Connector> for PayoutConnectors {
match value {
Connector::Adyen => Ok(Self::Adyen),
Connector::Wise => Ok(Self::Wise),
+ Connector::Paypal => Ok(Self::Paypal),
_ => Err(format!("Invalid payout connector {}", value)),
}
}
diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs
index 47dad675a4e..d7ae7b8a01e 100644
--- a/crates/connector_configs/src/connector.rs
+++ b/crates/connector_configs/src/connector.rs
@@ -215,6 +215,7 @@ impl ConnectorConfig {
match connector {
PayoutConnectors::Adyen => Ok(connector_data.adyen_payout),
PayoutConnectors::Wise => Ok(connector_data.wise_payout),
+ PayoutConnectors::Paypal => Ok(connector_data.paypal),
}
}
diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs
index 47ea7ff3761..1d791e78677 100644
--- a/crates/router/src/core/payouts.rs
+++ b/crates/router/src/core/payouts.rs
@@ -1,3 +1,4 @@
+pub mod access_token;
pub mod helpers;
#[cfg(feature = "payout_retry")]
pub mod retry;
@@ -160,7 +161,7 @@ pub async fn make_connector_decision(
key_store,
req,
&connector_data,
- &mut payout_data,
+ payout_data,
)
.await?;
@@ -200,7 +201,7 @@ pub async fn make_connector_decision(
key_store,
req,
&connector_data,
- &mut payout_data,
+ payout_data,
)
.await?;
@@ -858,7 +859,7 @@ pub async fn call_connector_payout(
key_store: &domain::MerchantKeyStore,
req: &payouts::PayoutCreateRequest,
connector_data: &api::ConnectorData,
- payout_data: &mut PayoutData,
+ mut payout_data: PayoutData,
) -> RouterResult<PayoutData> {
let payout_attempt = &payout_data.payout_attempt.to_owned();
let payouts = &payout_data.payouts.to_owned();
@@ -896,7 +897,7 @@ pub async fn call_connector_payout(
&payout_attempt.merchant_id,
Some(&payouts.payout_type),
key_store,
- Some(payout_data),
+ Some(&mut payout_data),
merchant_account.storage_scheme,
)
.await?
@@ -906,96 +907,83 @@ pub async fn call_connector_payout(
if let Some(true) = req.confirm {
// Eligibility flow
- if payouts.payout_type == storage_enums::PayoutType::Card
- && payout_attempt.is_eligible.is_none()
- {
- *payout_data = check_payout_eligibility(
- state,
- merchant_account,
- key_store,
- req,
- connector_data,
- payout_data,
- )
- .await
- .attach_printable("Eligibility failed for given Payout request")?;
- }
-
- // Payout creation flow
- utils::when(
- !payout_attempt
- .is_eligible
- .unwrap_or(state.conf.payouts.payout_eligibility),
- || {
- Err(report!(errors::ApiErrorResponse::PayoutFailed {
- data: Some(serde_json::json!({
- "message": "Payout method data is invalid"
- }))
- })
- .attach_printable("Payout data provided is invalid"))
- },
- )?;
- if payout_data.payouts.payout_type == storage_enums::PayoutType::Bank
- && payout_data.payout_attempt.status == storage_enums::PayoutStatus::RequiresCreation
- {
- // Create customer flow
- *payout_data = create_recipient(
- state,
- merchant_account,
- key_store,
- req,
- connector_data,
- payout_data,
- )
- .await
- .attach_printable("Creation of customer failed")?;
+ payout_data = complete_payout_eligibility(
+ state,
+ merchant_account,
+ key_store,
+ req,
+ connector_data,
+ payout_data,
+ )
+ .await?;
- // Create payout flow
- *payout_data = create_payout(
- state,
- merchant_account,
- key_store,
- req,
- connector_data,
- payout_data,
- )
- .await
- .attach_printable("Payout creation failed for given Payout request")?;
- }
+ // Create customer flow
+ payout_data = complete_create_recipient(
+ state,
+ merchant_account,
+ key_store,
+ req,
+ connector_data,
+ payout_data,
+ )
+ .await?;
- if payout_data.payouts.payout_type == storage_enums::PayoutType::Wallet
- && payout_data.payout_attempt.status == storage_enums::PayoutStatus::RequiresCreation
- {
- // Create payout flow
- *payout_data = create_payout(
- state,
- merchant_account,
- key_store,
- req,
- connector_data,
- payout_data,
- )
- .await
- .attach_printable("Payout creation failed for given Payout request")?;
- }
+ // Payout creation flow
+ payout_data = complete_create_payout(
+ state,
+ merchant_account,
+ key_store,
+ req,
+ connector_data,
+ payout_data,
+ )
+ .await?;
};
// Auto fulfillment flow
let status = payout_data.payout_attempt.status;
if payouts.auto_fulfill && status == storage_enums::PayoutStatus::RequiresFulfillment {
- *payout_data = fulfill_payout(
+ payout_data = fulfill_payout(
state,
merchant_account,
key_store,
&payouts::PayoutRequest::PayoutCreateRequest(req.to_owned()),
connector_data,
- payout_data,
+ &mut payout_data,
)
.await
.attach_printable("Payout fulfillment failed for given Payout request")?;
}
- Ok(payout_data.to_owned())
+ Ok(payout_data)
+}
+
+pub async fn complete_create_recipient(
+ state: &AppState,
+ merchant_account: &domain::MerchantAccount,
+ key_store: &domain::MerchantKeyStore,
+ req: &payouts::PayoutCreateRequest,
+ connector_data: &api::ConnectorData,
+ mut payout_data: PayoutData,
+) -> RouterResult<PayoutData> {
+ if payout_data.payout_attempt.status == storage_enums::PayoutStatus::RequiresCreation
+ && connector_data
+ .connector_name
+ .supports_create_recipient(payout_data.payouts.payout_type)
+ {
+ payout_data = create_recipient(
+ state,
+ merchant_account,
+ key_store,
+ req,
+ connector_data,
+ &mut payout_data,
+ )
+ .await
+ .attach_printable("Creation of customer failed")?;
+ }
+
+ Ok(payout_data)
}
pub async fn create_recipient(
@@ -1084,6 +1072,50 @@ pub async fn create_recipient(
Ok(payout_data.clone())
}
+pub async fn complete_payout_eligibility(
+ state: &AppState,
+ merchant_account: &domain::MerchantAccount,
+ key_store: &domain::MerchantKeyStore,
+ req: &payouts::PayoutCreateRequest,
+ connector_data: &api::ConnectorData,
+ mut payout_data: PayoutData,
+) -> RouterResult<PayoutData> {
+ let payout_attempt = &payout_data.payout_attempt.to_owned();
+
+ if payout_attempt.is_eligible.is_none()
+ && connector_data
+ .connector_name
+ .supports_payout_eligibility(payout_data.payouts.payout_type)
+ {
+ payout_data = check_payout_eligibility(
+ state,
+ merchant_account,
+ key_store,
+ req,
+ connector_data,
+ &mut payout_data,
+ )
+ .await
+ .attach_printable("Eligibility failed for given Payout request")?;
+ }
+
+ utils::when(
+ !payout_attempt
+ .is_eligible
+ .unwrap_or(state.conf.payouts.payout_eligibility),
+ || {
+ Err(report!(errors::ApiErrorResponse::PayoutFailed {
+ data: Some(serde_json::json!({
+ "message": "Payout method data is invalid"
+ }))
+ })
+ .attach_printable("Payout data provided is invalid"))
+ },
+ )?;
+
+ Ok(payout_data)
+}
+
pub async fn check_payout_eligibility(
state: &AppState,
merchant_account: &domain::MerchantAccount,
@@ -1200,6 +1232,68 @@ pub async fn check_payout_eligibility(
Ok(payout_data.clone())
}
+pub async fn complete_create_payout(
+ state: &AppState,
+ merchant_account: &domain::MerchantAccount,
+ key_store: &domain::MerchantKeyStore,
+ req: &payouts::PayoutCreateRequest,
+ connector_data: &api::ConnectorData,
+ mut payout_data: PayoutData,
+) -> RouterResult<PayoutData> {
+ if payout_data.payout_attempt.status == storage_enums::PayoutStatus::RequiresCreation {
+ if connector_data
+ .connector_name
+ .supports_instant_payout(payout_data.payouts.payout_type)
+ {
+ // create payout_object only in router
+ let db = &*state.store;
+ let payout_attempt = &payout_data.payout_attempt;
+ let updated_payout_attempt = storage::PayoutAttemptUpdate::StatusUpdate {
+ connector_payout_id: "".to_string(),
+ status: storage::enums::PayoutStatus::RequiresFulfillment,
+ error_code: None,
+ error_message: None,
+ is_eligible: None,
+ };
+ payout_data.payout_attempt = db
+ .update_payout_attempt(
+ payout_attempt,
+ updated_payout_attempt,
+ &payout_data.payouts,
+ merchant_account.storage_scheme,
+ )
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Error updating payout_attempt in db")?;
+ payout_data.payouts = db
+ .update_payout(
+ &payout_data.payouts,
+ storage::PayoutsUpdate::StatusUpdate {
+ status: storage::enums::PayoutStatus::RequiresFulfillment,
+ },
+ &payout_data.payout_attempt,
+ merchant_account.storage_scheme,
+ )
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Error updating payouts in db")?;
+ } else {
+ // create payout_object in connector as well as router
+ payout_data = create_payout(
+ state,
+ merchant_account,
+ key_store,
+ req,
+ connector_data,
+ &mut payout_data,
+ )
+ .await
+ .attach_printable("Payout creation failed for given Payout request")?;
+ }
+ }
+ Ok(payout_data)
+}
+
pub async fn create_payout(
state: &AppState,
merchant_account: &domain::MerchantAccount,
@@ -1219,7 +1313,17 @@ pub async fn create_payout(
)
.await?;
- // 2. Fetch connector integration details
+ // 2. Get/Create access token
+ access_token::create_access_token(
+ state,
+ connector_data,
+ merchant_account,
+ &mut router_data,
+ payout_data.payouts.payout_type.to_owned(),
+ )
+ .await?;
+
+ // 3. Fetch connector integration details
let connector_integration: services::BoxedConnectorIntegration<
'_,
api::PoCreate,
@@ -1227,13 +1331,13 @@ pub async fn create_payout(
types::PayoutsResponseData,
> = connector_data.connector.get_connector_integration();
- // 3. Execute pretasks
+ // 4. Execute pretasks
connector_integration
.execute_pretasks(&mut router_data, state)
.await
.to_payout_failed_response()?;
- // 4. Call connector service
+ // 5. Call connector service
let router_data_resp = services::execute_connector_processing_step(
state,
connector_integration,
@@ -1244,7 +1348,7 @@ pub async fn create_payout(
.await
.to_payout_failed_response()?;
- // 5. Process data returned by the connector
+ // 6. Process data returned by the connector
let db = &*state.store;
match router_data_resp.response {
Ok(payout_response_data) => {
@@ -1439,7 +1543,7 @@ pub async fn fulfill_payout(
payout_data: &mut PayoutData,
) -> RouterResult<PayoutData> {
// 1. Form Router data
- let router_data = core_utils::construct_payout_router_data(
+ let mut router_data = core_utils::construct_payout_router_data(
state,
&connector_data.connector_name.to_string(),
merchant_account,
@@ -1449,7 +1553,17 @@ pub async fn fulfill_payout(
)
.await?;
- // 2. Fetch connector integration details
+ // 2. Get/Create access token
+ access_token::create_access_token(
+ state,
+ connector_data,
+ merchant_account,
+ &mut router_data,
+ payout_data.payouts.payout_type.to_owned(),
+ )
+ .await?;
+
+ // 3. Fetch connector integration details
let connector_integration: services::BoxedConnectorIntegration<
'_,
api::PoFulfill,
@@ -1457,7 +1571,7 @@ pub async fn fulfill_payout(
types::PayoutsResponseData,
> = connector_data.connector.get_connector_integration();
- // 3. Call connector service
+ // 4. Call connector service
let router_data_resp = services::execute_connector_processing_step(
state,
connector_integration,
@@ -1468,7 +1582,7 @@ pub async fn fulfill_payout(
.await
.to_payout_failed_response()?;
- // 4. Process data returned by the connector
+ // 5. Process data returned by the connector
let db = &*state.store;
match router_data_resp.response {
Ok(payout_response_data) => {
diff --git a/crates/router/src/core/payouts/access_token.rs b/crates/router/src/core/payouts/access_token.rs
new file mode 100644
index 00000000000..8dddc0c570c
--- /dev/null
+++ b/crates/router/src/core/payouts/access_token.rs
@@ -0,0 +1,194 @@
+use common_utils::ext_traits::AsyncExt;
+use error_stack::ResultExt;
+
+use crate::{
+ consts,
+ core::{
+ errors::{self, RouterResult},
+ payments,
+ },
+ routes::{metrics, AppState},
+ services,
+ types::{self, api as api_types, domain, storage::enums},
+};
+
+/// After we get the access token, check if there was an error and if the flow should proceed further
+/// Everything is well, continue with the flow
+/// There was an error, cannot proceed further
+#[cfg(feature = "payouts")]
+pub async fn create_access_token<F: Clone + 'static>(
+ state: &AppState,
+ connector_data: &api_types::ConnectorData,
+ merchant_account: &domain::MerchantAccount,
+ router_data: &mut types::PayoutsRouterData<F>,
+ payout_type: enums::PayoutType,
+) -> RouterResult<()> {
+ let connector_access_token = add_access_token_for_payout(
+ state,
+ connector_data,
+ merchant_account,
+ router_data,
+ payout_type,
+ )
+ .await?;
+
+ if connector_access_token.connector_supports_access_token {
+ match connector_access_token.access_token_result {
+ Ok(access_token) => {
+ router_data.access_token = access_token;
+ }
+ Err(connector_error) => {
+ router_data.response = Err(connector_error);
+ }
+ }
+ }
+
+ Ok(())
+}
+
+#[cfg(feature = "payouts")]
+pub async fn add_access_token_for_payout<F: Clone + 'static>(
+ state: &AppState,
+ connector: &api_types::ConnectorData,
+ merchant_account: &domain::MerchantAccount,
+ router_data: &types::PayoutsRouterData<F>,
+ payout_type: enums::PayoutType,
+) -> RouterResult<types::AddAccessTokenResult> {
+ if connector
+ .connector_name
+ .supports_access_token_for_payout(payout_type)
+ {
+ let merchant_id = &merchant_account.merchant_id;
+ let store = &*state.store;
+ let old_access_token = store
+ .get_access_token(merchant_id, connector.connector.id())
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("DB error when accessing the access token")?;
+
+ let res = match old_access_token {
+ Some(access_token) => Ok(Some(access_token)),
+ None => {
+ let cloned_router_data = router_data.clone();
+ let refresh_token_request_data = types::AccessTokenRequestData::try_from(
+ router_data.connector_auth_type.clone(),
+ )
+ .attach_printable(
+ "Could not create access token request, invalid connector account credentials",
+ )?;
+
+ let refresh_token_response_data: Result<types::AccessToken, types::ErrorResponse> =
+ Err(types::ErrorResponse::default());
+ let refresh_token_router_data = payments::helpers::router_data_type_conversion::<
+ _,
+ api_types::AccessTokenAuth,
+ _,
+ _,
+ _,
+ _,
+ >(
+ cloned_router_data,
+ refresh_token_request_data,
+ refresh_token_response_data,
+ );
+ refresh_connector_auth(
+ state,
+ connector,
+ merchant_account,
+ &refresh_token_router_data,
+ )
+ .await?
+ .async_map(|access_token| async {
+ //Store the access token in db
+ let store = &*state.store;
+ // This error should not be propagated, we don't want payments to fail once we have
+ // the access token, the next request will create new access token
+ let _ = store
+ .set_access_token(
+ merchant_id,
+ connector.connector.id(),
+ access_token.clone(),
+ )
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("DB error when setting the access token");
+ Some(access_token)
+ })
+ .await
+ }
+ };
+
+ Ok(types::AddAccessTokenResult {
+ access_token_result: res,
+ connector_supports_access_token: true,
+ })
+ } else {
+ Ok(types::AddAccessTokenResult {
+ access_token_result: Err(types::ErrorResponse::default()),
+ connector_supports_access_token: false,
+ })
+ }
+}
+
+#[cfg(feature = "payouts")]
+pub async fn refresh_connector_auth(
+ state: &AppState,
+ connector: &api_types::ConnectorData,
+ _merchant_account: &domain::MerchantAccount,
+ router_data: &types::RouterData<
+ api_types::AccessTokenAuth,
+ types::AccessTokenRequestData,
+ types::AccessToken,
+ >,
+) -> RouterResult<Result<types::AccessToken, types::ErrorResponse>> {
+ let connector_integration: services::BoxedConnectorIntegration<
+ '_,
+ api_types::AccessTokenAuth,
+ types::AccessTokenRequestData,
+ types::AccessToken,
+ > = connector.connector.get_connector_integration();
+
+ let access_token_router_data_result = services::execute_connector_processing_step(
+ state,
+ connector_integration,
+ router_data,
+ payments::CallConnectorAction::Trigger,
+ None,
+ )
+ .await;
+
+ let access_token_router_data = match access_token_router_data_result {
+ Ok(router_data) => Ok(router_data.response),
+ Err(connector_error) => {
+ // If we receive a timeout error from the connector, then
+ // the error has to be handled gracefully by updating the payment status to failed.
+ // further payment flow will not be continued
+ if connector_error.current_context().is_connector_timeout() {
+ let error_response = types::ErrorResponse {
+ code: consts::REQUEST_TIMEOUT_ERROR_CODE.to_string(),
+ message: consts::REQUEST_TIMEOUT_ERROR_MESSAGE.to_string(),
+ reason: Some(consts::REQUEST_TIMEOUT_ERROR_MESSAGE.to_string()),
+ status_code: 504,
+ attempt_status: None,
+ connector_transaction_id: None,
+ };
+
+ Ok(Err(error_response))
+ } else {
+ Err(connector_error
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Could not refresh access token"))
+ }
+ }
+ }?;
+
+ metrics::ACCESS_TOKEN_CREATION.add(
+ &metrics::CONTEXT,
+ 1,
+ &[metrics::request::add_attributes(
+ "connector",
+ connector.connector_name.to_string(),
+ )],
+ );
+ Ok(access_token_router_data)
+}
diff --git a/crates/router/src/core/payouts/retry.rs b/crates/router/src/core/payouts/retry.rs
index 7c0b8265603..af8b016d884 100644
--- a/crates/router/src/core/payouts/retry.rs
+++ b/crates/router/src/core/payouts/retry.rs
@@ -258,7 +258,7 @@ pub async fn do_retry(
key_store,
req,
&connector,
- &mut payout_data,
+ payout_data,
)
.await
}
diff --git a/openapi/openapi_spec.json b/openapi/openapi_spec.json
index 913782448fa..b64756fc434 100644
--- a/openapi/openapi_spec.json
+++ b/openapi/openapi_spec.json
@@ -15607,7 +15607,8 @@
"type": "string",
"enum": [
"adyen",
- "wise"
+ "wise",
+ "paypal"
]
},
"PayoutCreateRequest": {
|
feat
|
[Payouts] Add access_token flow for Payout Create and Fulfill flow (#4375)
|
e9be4e22411d218009e6cd6c1a5ef9dc8fc430b7
|
2024-06-04 05:45:00
|
github-actions
|
chore(version): 2024.06.04.0
| false
|
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0d88ba7053e..8d523897086 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,36 @@ All notable changes to HyperSwitch will be documented here.
- - -
+## 2024.06.04.0
+
+### Features
+
+- **connector:** [AUTHORIZEDOTNET] Support payment_method_id in recurring mandate payment ([#4841](https://github.com/juspay/hyperswitch/pull/4841)) ([`a1788b8`](https://github.com/juspay/hyperswitch/commit/a1788b8da942f0e32a80b37eac4eecece2bef77d))
+- **consolidated-kafka-events:** Add consolidated kafka payment events ([#4798](https://github.com/juspay/hyperswitch/pull/4798)) ([`ccee1a9`](https://github.com/juspay/hyperswitch/commit/ccee1a9ce9e860bfa04e74329fb47fd73f010b23))
+- **multitenancy:** Add support for multitenancy and handle the same in router, producer, consumer, drainer and analytics ([#4630](https://github.com/juspay/hyperswitch/pull/4630)) ([`15d6c3e`](https://github.com/juspay/hyperswitch/commit/15d6c3e846a77dec6b6a5165d86044a9b9fd52f1))
+- **router:** Send `three_ds_requestor_url` in authentication_response for external 3ds flow ([#4828](https://github.com/juspay/hyperswitch/pull/4828)) ([`67f017f`](https://github.com/juspay/hyperswitch/commit/67f017f6f035b102ce7a0102b157a884ce9d4109))
+- **users:** Create config for TOTP Issuer ([#4776](https://github.com/juspay/hyperswitch/pull/4776)) ([`0cbb292`](https://github.com/juspay/hyperswitch/commit/0cbb2928bd054cb8e98c3811f397a837a8887486))
+
+### Bug Fixes
+
+- **connector:** Make few fields optional in struct NetceteraErrorDetails ([#4827](https://github.com/juspay/hyperswitch/pull/4827)) ([`69b2f76`](https://github.com/juspay/hyperswitch/commit/69b2f76be7a2c0deba2c069a87c10a33253e2216))
+- Include client_version and client_source in retried payments ([#4826](https://github.com/juspay/hyperswitch/pull/4826)) ([`fa5f5a4`](https://github.com/juspay/hyperswitch/commit/fa5f5a4eddecd072f974738d2168cd0b7c277d2e))
+
+### Refactors
+
+- **connector:**
+ - [Klarna] Add shipping Address in Klarna Session and Payment Request ([#4836](https://github.com/juspay/hyperswitch/pull/4836)) ([`8650077`](https://github.com/juspay/hyperswitch/commit/865007717c5c7e617ca1b447ea5f9bb3d274cac3))
+ - Airwallex convert init payment to preprocessing ([#4842](https://github.com/juspay/hyperswitch/pull/4842)) ([`e5da133`](https://github.com/juspay/hyperswitch/commit/e5da133fe00b5736dc3c55bf4ee86fa77158dbe7))
+- **users:** Changes for Home and Signout APIs for TOTP Redis flows ([#4851](https://github.com/juspay/hyperswitch/pull/4851)) ([`d242850`](https://github.com/juspay/hyperswitch/commit/d242850b63173f314fb259451139464f09e0a9e9))
+
+### Miscellaneous Tasks
+
+- **cypress:** Remove logs that expose `globalState` ([#4844](https://github.com/juspay/hyperswitch/pull/4844)) ([`d84e624`](https://github.com/juspay/hyperswitch/commit/d84e62441f39c165af7dc1c8d893344ff85c1711))
+
+**Full Changelog:** [`2024.05.31.1...2024.06.04.0`](https://github.com/juspay/hyperswitch/compare/2024.05.31.1...2024.06.04.0)
+
+- - -
+
## 2024.05.31.1
### Features
|
chore
|
2024.06.04.0
|
655b388358ecb7d3c3e990d19989febea9f9d4c9
|
2023-08-31 13:24:58
|
Sahkal Poddar
|
refactor(router): fixed unprocessable entity error message to custom message (#1979)
| false
|
diff --git a/crates/router/src/compatibility/stripe/errors.rs b/crates/router/src/compatibility/stripe/errors.rs
index 9be092a6720..8c3c62b01fa 100644
--- a/crates/router/src/compatibility/stripe/errors.rs
+++ b/crates/router/src/compatibility/stripe/errors.rs
@@ -223,8 +223,8 @@ pub enum StripeErrorCode {
WebhookProcessingError,
#[error(error_type = StripeErrorType::InvalidRequestError, code = "payment_method_unactivated", message = "The operation cannot be performed as the payment method used has not been activated. Activate the payment method in the Dashboard, then try again.")]
PaymentMethodUnactivated,
- #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "{entity} expired or invalid")]
- HyperswitchUnprocessableEntity { entity: String },
+ #[error(error_type = StripeErrorType::HyperswitchError, code = "", message = "{message}")]
+ HyperswitchUnprocessableEntity { message: String },
#[error(error_type = StripeErrorType::InvalidRequestError, code = "", message = "{message}")]
CurrencyNotSupported { message: String },
// [#216]: https://github.com/juspay/hyperswitch/issues/216
@@ -403,8 +403,8 @@ impl From<errors::ApiErrorResponse> for StripeErrorCode {
param: field_name.to_string(),
}
}
- errors::ApiErrorResponse::UnprocessableEntity { entity } => {
- Self::HyperswitchUnprocessableEntity { entity }
+ errors::ApiErrorResponse::UnprocessableEntity { message } => {
+ Self::HyperswitchUnprocessableEntity { message }
}
errors::ApiErrorResponse::MissingRequiredFields { field_names } => {
// Instead of creating a new error variant in StripeErrorCode for MissingRequiredFields, converted vec<&str> to String
diff --git a/crates/router/src/core/errors/api_error_response.rs b/crates/router/src/core/errors/api_error_response.rs
index 6546c26e616..de07f061c8d 100644
--- a/crates/router/src/core/errors/api_error_response.rs
+++ b/crates/router/src/core/errors/api_error_response.rs
@@ -92,8 +92,8 @@ pub enum ApiErrorResponse {
AccessForbidden,
#[error(error_type = ErrorType::InvalidRequestError, code = "IR_23", message = "{message}")]
FileProviderNotSupported { message: String },
- #[error(error_type = ErrorType::InvalidRequestError, code = "IR_23", message = "{entity} expired or invalid")]
- UnprocessableEntity { entity: String },
+ #[error(error_type = ErrorType::InvalidRequestError, code = "IR_23", message = "{message}")]
+ UnprocessableEntity { message: String },
#[error(error_type = ErrorType::ConnectorError, code = "CE_00", message = "{code}: {message}", ignore = "status_code")]
ExternalConnectorError {
code: String,
diff --git a/crates/router/src/core/errors/transformers.rs b/crates/router/src/core/errors/transformers.rs
index a139261da97..208aad56ee1 100644
--- a/crates/router/src/core/errors/transformers.rs
+++ b/crates/router/src/core/errors/transformers.rs
@@ -93,7 +93,7 @@ impl ErrorSwitch<api_models::errors::types::ApiErrorResponse> for ApiErrorRespon
Self::FileProviderNotSupported { message } => {
AER::BadRequest(ApiError::new("IR", 23, message.to_string(), None))
},
- Self::UnprocessableEntity {entity} => AER::Unprocessable(ApiError::new("IR", 23, format!("{entity} expired or invalid"), None)),
+ Self::UnprocessableEntity {message} => AER::Unprocessable(ApiError::new("IR", 23, message.to_string(), None)),
Self::ExternalConnectorError {
code,
message,
diff --git a/crates/router/src/core/payment_methods/vault.rs b/crates/router/src/core/payment_methods/vault.rs
index 0a647d6a547..3f593fcea99 100644
--- a/crates/router/src/core/payment_methods/vault.rs
+++ b/crates/router/src/core/payment_methods/vault.rs
@@ -1085,7 +1085,7 @@ pub async fn get_tokenized_data(
metrics::TEMP_LOCKER_FAILURES.add(&metrics::CONTEXT, 1, &[]);
match err.status_code {
404 => Err(errors::ApiErrorResponse::UnprocessableEntity {
- entity: "Token".to_string(),
+ message: "Token is invalid or expired".into(),
}
.into()),
_ => Err(errors::ApiErrorResponse::InternalServerError)
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index d63551bdbf0..5fe34c33851 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -1202,7 +1202,9 @@ pub async fn make_pm_data<'a, F: Clone, R>(
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to fetch the token from redis")?
.ok_or(error_stack::Report::new(
- errors::ApiErrorResponse::UnprocessableEntity { entity: token },
+ errors::ApiErrorResponse::UnprocessableEntity {
+ message: token + " is invalid or expired",
+ },
))?;
Some(key)
@@ -2424,7 +2426,7 @@ pub async fn get_merchant_connector_account(
let decrypted_mca = services::decrypt_jwe(mca_config.config.as_str(), services::KeyIdCheck::SkipKeyIdCheck, private_key, jwe::RSA_OAEP_256)
.await
.change_context(errors::ApiErrorResponse::UnprocessableEntity{
- entity: "merchant_connector_details".to_string()})
+ message: "decoding merchant_connector_details failed due to invalid data format!".into()})
.attach_printable(
"Failed to decrypt merchant_connector_details sent in request and then put in cache",
)?;
|
refactor
|
fixed unprocessable entity error message to custom message (#1979)
|
540ef071cb238a56d52d06687226aab7fd0dfe68
|
2024-07-31 12:39:52
|
GORAKHNATH YADAV
|
docs: API-Ref changes for Payouts (#5236)
| false
|
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
index 7effe2dcc64..040df7d84f0 100644
--- a/api-reference/openapi_spec.json
+++ b/api-reference/openapi_spec.json
@@ -7817,7 +7817,7 @@
},
"ChargeRefunds": {
"type": "object",
- "description": "Charge object for refunds",
+ "description": "Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.",
"required": [
"charge_id"
],
@@ -16251,13 +16251,6 @@
"example": true,
"nullable": true
},
- "capture_on": {
- "type": "string",
- "format": "date-time",
- "description": "A timestamp (ISO 8601 code) that determines when the payment should be captured.\nProviding this field will automatically set `capture` to true",
- "example": "2022-09-10T10:11:12Z",
- "nullable": true
- },
"capture_method": {
"allOf": [
{
@@ -18313,7 +18306,8 @@
}
}
}
- ]
+ ],
+ "description": "Custom payout link config for the particular payout, if payout link is to be generated."
},
"PayoutCreateRequest": {
"type": "object",
@@ -18332,7 +18326,7 @@
"properties": {
"payout_id": {
"type": "string",
- "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.",
+ "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts that have been done by a single merchant. This field is auto generated and is returned in the API response, **not required to be included in the Payout Create/Update Request.**",
"example": "payout_mbabizu24mvu3mela5njyhpit4",
"nullable": true,
"maxLength": 30,
@@ -18340,7 +18334,7 @@
},
"merchant_id": {
"type": "string",
- "description": "This is an identifier for the merchant account. This is inferred from the API key\nprovided during the request",
+ "description": "This is an identifier for the merchant account. This is inferred from the API key provided during the request, **not required to be included in the Payout Create/Update Request.**",
"example": "merchant_1668273825",
"nullable": true,
"maxLength": 255
@@ -18367,7 +18361,7 @@
"items": {
"$ref": "#/components/schemas/PayoutConnectors"
},
- "description": "This allows the merchant to manually select a connector with which the payout can go through",
+ "description": "This field allows the merchant to manually select a connector with which the payout can go through.",
"example": [
"wise",
"adyen"
@@ -18376,7 +18370,7 @@
},
"confirm": {
"type": "boolean",
- "description": "The boolean value to create payout with connector",
+ "description": "This field is used when merchant wants to confirm the payout, thus useful for the payout _Confirm_ request. Ideally merchants should _Create_ a payout, _Update_ it (if required), then _Confirm_ it.",
"default": false,
"example": true
},
@@ -18477,13 +18471,13 @@
},
"payout_token": {
"type": "string",
- "description": "Provide a reference to a stored payout method",
+ "description": "Provide a reference to a stored payout method, used to process the payout.",
"example": "187282ab-40ef-47a9-9206-5099ba31e432",
"nullable": true
},
"profile_id": {
"type": "string",
- "description": "The business profile to use for this payout, if not passed the default business profile\nassociated with the merchant account will be used.",
+ "description": "The business profile to use for this payout, especially if there are multiple business profiles associated with the account, otherwise default business profile associated with the merchant account will be used.",
"nullable": true
},
"priority": {
@@ -18491,7 +18485,7 @@
},
"payout_link": {
"type": "boolean",
- "description": "Whether to get the payout link (if applicable)",
+ "description": "Whether to get the payout link (if applicable). Merchant need to specify this during the Payout _Create_, this field can not be updated during Payout _Update_.",
"default": false,
"example": true,
"nullable": true
@@ -18713,6 +18707,7 @@
},
"PayoutEntityType": {
"type": "string",
+ "description": "Type of entity to whom the payout is being carried out to, select from the given list of options",
"enum": [
"Individual",
"Company",
@@ -18953,7 +18948,8 @@
}
}
}
- ]
+ ],
+ "description": "The payout method information required for carrying out a payout"
},
"PayoutRequest": {
"oneOf": [
@@ -19034,6 +19030,7 @@
},
"PayoutSendPriority": {
"type": "string",
+ "description": "The send method which will be required for processing payouts, check options for better understanding.",
"enum": [
"instant",
"fast",
@@ -19063,6 +19060,7 @@
},
"PayoutType": {
"type": "string",
+ "description": "The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.",
"enum": [
"card",
"bank",
diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs
index a158d2de9bd..570b76f3b51 100644
--- a/crates/api_models/src/payments.rs
+++ b/crates/api_models/src/payments.rs
@@ -3674,6 +3674,7 @@ pub struct PaymentsResponse {
/// Providing this field will automatically set `capture` to true
#[schema(example = "2022-09-10T10:11:12Z")]
#[serde(with = "common_utils::custom_serde::iso8601::option")]
+ #[remove_in(PaymentsCreateResponseOpenApi)]
pub capture_on: Option<PrimitiveDateTime>,
/// This is the instruction for capture/ debit the money from the users' card. On the other hand authorization refers to blocking the amount on the users' payment method.
diff --git a/crates/api_models/src/payouts.rs b/crates/api_models/src/payouts.rs
index 9509df8c591..c3ae760215b 100644
--- a/crates/api_models/src/payouts.rs
+++ b/crates/api_models/src/payouts.rs
@@ -21,8 +21,7 @@ pub enum PayoutRequest {
#[derive(Default, Debug, Deserialize, Serialize, Clone, ToSchema)]
#[serde(deny_unknown_fields)]
pub struct PayoutCreateRequest {
- /// Unique identifier for the payout. This ensures idempotency for multiple payouts
- /// that have been done by a single merchant. This field is auto generated and is returned in the API response.
+ /// Unique identifier for the payout. This ensures idempotency for multiple payouts that have been done by a single merchant. This field is auto generated and is returned in the API response, **not required to be included in the Payout Create/Update Request.**
#[schema(
value_type = Option<String>,
min_length = 30,
@@ -31,8 +30,7 @@ pub struct PayoutCreateRequest {
)]
pub payout_id: Option<String>, // TODO: #1321 https://github.com/juspay/hyperswitch/issues/1321
- /// This is an identifier for the merchant account. This is inferred from the API key
- /// provided during the request
+ /// This is an identifier for the merchant account. This is inferred from the API key provided during the request, **not required to be included in the Payout Create/Update Request.**
#[schema(max_length = 255, value_type = Option<String>, example = "merchant_1668273825")]
pub merchant_id: Option<id_type::MerchantId>,
@@ -52,15 +50,15 @@ pub struct PayoutCreateRequest {
}))]
pub routing: Option<serde_json::Value>,
- /// This allows the merchant to manually select a connector with which the payout can go through
+ /// This field allows the merchant to manually select a connector with which the payout can go through.
#[schema(value_type = Option<Vec<PayoutConnectors>>, max_length = 255, example = json!(["wise", "adyen"]))]
pub connector: Option<Vec<api_enums::PayoutConnectors>>,
- /// The boolean value to create payout with connector
+ /// This field is used when merchant wants to confirm the payout, thus useful for the payout _Confirm_ request. Ideally merchants should _Create_ a payout, _Update_ it (if required), then _Confirm_ it.
#[schema(value_type = bool, example = true, default = false)]
pub confirm: Option<bool>,
- /// The payout_type of the payout request can be specified here
+ /// The payout_type of the payout request can be specified here, this is a mandatory field to _Confirm_ the payout, i.e., should be passed in _Create_ request, if not then should be updated in the payout _Update_ request, then only it can be confirmed.
#[schema(value_type = PayoutType, example = "card")]
pub payout_type: Option<api_enums::PayoutType>,
@@ -129,7 +127,7 @@ pub struct PayoutCreateRequest {
#[schema(example = "It's my first payout request", value_type = String)]
pub description: Option<String>,
- /// Type of entity to whom the payout is being carried out to
+ /// Type of entity to whom the payout is being carried out to, select from the given list of options
#[schema(value_type = PayoutEntityType, example = "Individual")]
pub entity_type: Option<api_enums::PayoutEntityType>,
@@ -141,23 +139,22 @@ pub struct PayoutCreateRequest {
#[schema(value_type = Option<Object>, example = r#"{ "udf1": "some-value", "udf2": "some-value" }"#)]
pub metadata: Option<pii::SecretSerdeValue>,
- /// Provide a reference to a stored payout method
+ /// Provide a reference to a stored payout method, used to process the payout.
#[schema(example = "187282ab-40ef-47a9-9206-5099ba31e432")]
pub payout_token: Option<String>,
- /// The business profile to use for this payout, if not passed the default business profile
- /// associated with the merchant account will be used.
+ /// The business profile to use for this payout, especially if there are multiple business profiles associated with the account, otherwise default business profile associated with the merchant account will be used.
pub profile_id: Option<String>,
- /// The send method for processing payouts
+ /// The send method which will be required for processing payouts, check options for better understanding.
#[schema(value_type = PayoutSendPriority, example = "instant")]
pub priority: Option<api_enums::PayoutSendPriority>,
- /// Whether to get the payout link (if applicable)
+ /// Whether to get the payout link (if applicable). Merchant need to specify this during the Payout _Create_, this field can not be updated during Payout _Update_.
#[schema(default = false, example = true)]
pub payout_link: Option<bool>,
- /// custom payout link config for the particular payout
+ /// Custom payout link config for the particular payout, if payout link is to be generated.
#[schema(value_type = Option<PayoutCreatePayoutLinkConfig>)]
pub payout_link_config: Option<PayoutCreatePayoutLinkConfig>,
@@ -167,6 +164,7 @@ pub struct PayoutCreateRequest {
pub session_expiry: Option<u32>,
}
+/// Custom payout link config for the particular payout, if payout link is to be generated.
#[derive(Default, Debug, Deserialize, Serialize, Clone, ToSchema)]
pub struct PayoutCreatePayoutLinkConfig {
/// The unique identifier for the collect link.
@@ -182,6 +180,7 @@ pub struct PayoutCreatePayoutLinkConfig {
pub enabled_payment_methods: Option<Vec<link_utils::EnabledPaymentMethod>>,
}
+/// The payout method information required for carrying out a payout
#[derive(Debug, Clone, Deserialize, Serialize, ToSchema)]
#[serde(rename_all = "snake_case")]
pub enum PayoutMethodData {
@@ -486,7 +485,7 @@ pub struct PayoutCreateResponse {
#[serde(skip_serializing_if = "Option::is_none")]
pub attempts: Option<Vec<PayoutAttemptResponse>>,
- // If payout link is request, this represents response on
+ /// If payout link was requested, this contains the link's ID and the URL to render the payout widget
#[schema(value_type = Option<PayoutLinkResponse>)]
pub payout_link: Option<PayoutLinkResponse>,
}
diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs
index 2bd2e8c03b9..5c8a860c168 100644
--- a/crates/common_enums/src/enums.rs
+++ b/crates/common_enums/src/enums.rs
@@ -2310,6 +2310,7 @@ pub enum PayoutStatus {
RequiresVendorAccountCreation,
}
+/// The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.
#[derive(
Clone,
Copy,
@@ -2336,6 +2337,7 @@ pub enum PayoutType {
Wallet,
}
+/// Type of entity to whom the payout is being carried out to, select from the given list of options
#[derive(
Clone,
Copy,
@@ -2369,6 +2371,7 @@ pub enum PayoutEntityType {
Personal,
}
+/// The send method which will be required for processing payouts, check options for better understanding.
#[derive(
Clone,
Copy,
diff --git a/crates/common_utils/src/types.rs b/crates/common_utils/src/types.rs
index 02b49f52730..83d005dd637 100644
--- a/crates/common_utils/src/types.rs
+++ b/crates/common_utils/src/types.rs
@@ -690,7 +690,7 @@ mod amount_conversion_tests {
Serialize, serde::Deserialize, Debug, Clone, PartialEq, Eq, FromSqlRow, AsExpression, ToSchema,
)]
#[diesel(sql_type = Jsonb)]
-/// Charge object for refunds
+/// Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.
pub struct ChargeRefunds {
/// Identifier for charge created for the payment
pub charge_id: String,
|
docs
|
API-Ref changes for Payouts (#5236)
|
bf47b560c2cb7126fbef4b0cc528a3ff2f27d54a
|
2024-09-29 17:06:57
|
Sai Harsha Vardhan
|
feat(router): add auto retries configs in profile CRUD apis (#6134)
| false
|
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
index 4d8d5239234..d91dbb9f825 100644
--- a/api-reference/openapi_spec.json
+++ b/api-reference/openapi_spec.json
@@ -21220,6 +21220,18 @@
"is_network_tokenization_enabled": {
"type": "boolean",
"description": "Indicates if is_network_tokenization_enabled is enabled or not.\nIf set to `true` is_network_tokenization_enabled will be checked."
+ },
+ "is_auto_retries_enabled": {
+ "type": "boolean",
+ "description": "Indicates if is_auto_retries_enabled is enabled or not.",
+ "nullable": true
+ },
+ "max_auto_retries_enabled": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Maximum number of auto retries allowed for a payment",
+ "nullable": true,
+ "minimum": 0
}
},
"additionalProperties": false
@@ -21251,7 +21263,8 @@
"enable_payment_response_hash",
"redirect_to_merchant_with_http_post",
"is_tax_connector_enabled",
- "is_network_tokenization_enabled"
+ "is_network_tokenization_enabled",
+ "is_auto_retries_enabled"
],
"properties": {
"merchant_id": {
@@ -21436,6 +21449,18 @@
"description": "Indicates if is_network_tokenization_enabled is enabled or not.\nIf set to `true` is_network_tokenization_enabled will be checked.",
"default": false,
"example": false
+ },
+ "is_auto_retries_enabled": {
+ "type": "boolean",
+ "description": "Indicates if is_auto_retries_enabled is enabled or not.",
+ "default": false,
+ "example": false
+ },
+ "max_auto_retries_enabled": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Maximum number of auto retries allowed for a payment",
+ "nullable": true
}
}
},
diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs
index 6f656339569..6e7f4f29d03 100644
--- a/crates/api_models/src/admin.rs
+++ b/crates/api_models/src/admin.rs
@@ -1971,6 +1971,12 @@ pub struct ProfileCreate {
/// If set to `true` is_network_tokenization_enabled will be checked.
#[serde(default)]
pub is_network_tokenization_enabled: bool,
+
+ /// Indicates if is_auto_retries_enabled is enabled or not.
+ pub is_auto_retries_enabled: Option<bool>,
+
+ /// Maximum number of auto retries allowed for a payment
+ pub max_auto_retries_enabled: Option<u8>,
}
#[nutype::nutype(
@@ -2202,6 +2208,13 @@ pub struct ProfileResponse {
/// If set to `true` is_network_tokenization_enabled will be checked.
#[schema(default = false, example = false)]
pub is_network_tokenization_enabled: bool,
+
+ /// Indicates if is_auto_retries_enabled is enabled or not.
+ #[schema(default = false, example = false)]
+ pub is_auto_retries_enabled: bool,
+
+ /// Maximum number of auto retries allowed for a payment
+ pub max_auto_retries_enabled: Option<i16>,
}
#[cfg(feature = "v2")]
@@ -2431,6 +2444,12 @@ pub struct ProfileUpdate {
/// Indicates if is_network_tokenization_enabled is enabled or not.
pub is_network_tokenization_enabled: Option<bool>,
+
+ /// Indicates if is_auto_retries_enabled is enabled or not.
+ pub is_auto_retries_enabled: Option<bool>,
+
+ /// Maximum number of auto retries allowed for a payment
+ pub max_auto_retries_enabled: Option<u8>,
}
#[cfg(feature = "v2")]
diff --git a/crates/diesel_models/src/business_profile.rs b/crates/diesel_models/src/business_profile.rs
index 4edc2ba2432..fd0abc16614 100644
--- a/crates/diesel_models/src/business_profile.rs
+++ b/crates/diesel_models/src/business_profile.rs
@@ -55,6 +55,8 @@ pub struct Profile {
pub version: common_enums::ApiVersion,
pub dynamic_routing_algorithm: Option<serde_json::Value>,
pub is_network_tokenization_enabled: bool,
+ pub is_auto_retries_enabled: Option<bool>,
+ pub max_auto_retries_enabled: Option<i16>,
}
#[cfg(feature = "v1")]
@@ -96,6 +98,8 @@ pub struct ProfileNew {
pub is_tax_connector_enabled: Option<bool>,
pub version: common_enums::ApiVersion,
pub is_network_tokenization_enabled: bool,
+ pub is_auto_retries_enabled: Option<bool>,
+ pub max_auto_retries_enabled: Option<i16>,
}
#[cfg(feature = "v1")]
@@ -134,6 +138,8 @@ pub struct ProfileUpdateInternal {
pub is_tax_connector_enabled: Option<bool>,
pub dynamic_routing_algorithm: Option<serde_json::Value>,
pub is_network_tokenization_enabled: Option<bool>,
+ pub is_auto_retries_enabled: Option<bool>,
+ pub max_auto_retries_enabled: Option<i16>,
}
#[cfg(feature = "v1")]
@@ -171,6 +177,8 @@ impl ProfileUpdateInternal {
is_tax_connector_enabled,
dynamic_routing_algorithm,
is_network_tokenization_enabled,
+ is_auto_retries_enabled,
+ max_auto_retries_enabled,
} = self;
Profile {
profile_id: source.profile_id,
@@ -228,6 +236,8 @@ impl ProfileUpdateInternal {
.or(source.dynamic_routing_algorithm),
is_network_tokenization_enabled: is_network_tokenization_enabled
.unwrap_or(source.is_network_tokenization_enabled),
+ is_auto_retries_enabled: is_auto_retries_enabled.or(source.is_auto_retries_enabled),
+ max_auto_retries_enabled: max_auto_retries_enabled.or(source.max_auto_retries_enabled),
}
}
}
@@ -279,6 +289,8 @@ pub struct Profile {
pub version: common_enums::ApiVersion,
pub dynamic_routing_algorithm: Option<serde_json::Value>,
pub is_network_tokenization_enabled: bool,
+ pub is_auto_retries_enabled: Option<bool>,
+ pub max_auto_retries_enabled: Option<i16>,
}
impl Profile {
@@ -334,6 +346,8 @@ pub struct ProfileNew {
pub id: common_utils::id_type::ProfileId,
pub version: common_enums::ApiVersion,
pub is_network_tokenization_enabled: bool,
+ pub is_auto_retries_enabled: Option<bool>,
+ pub max_auto_retries_enabled: Option<i16>,
}
#[cfg(feature = "v2")]
@@ -373,6 +387,8 @@ pub struct ProfileUpdateInternal {
pub payout_routing_algorithm_id: Option<common_utils::id_type::RoutingId>,
pub default_fallback_routing: Option<pii::SecretSerdeValue>,
pub is_network_tokenization_enabled: Option<bool>,
+ pub is_auto_retries_enabled: Option<bool>,
+ pub max_auto_retries_enabled: Option<i16>,
}
#[cfg(feature = "v2")]
@@ -411,6 +427,8 @@ impl ProfileUpdateInternal {
payout_routing_algorithm_id,
default_fallback_routing,
is_network_tokenization_enabled,
+ is_auto_retries_enabled,
+ max_auto_retries_enabled,
} = self;
Profile {
id: source.id,
@@ -471,6 +489,8 @@ impl ProfileUpdateInternal {
dynamic_routing_algorithm: None,
is_network_tokenization_enabled: is_network_tokenization_enabled
.unwrap_or(source.is_network_tokenization_enabled),
+ is_auto_retries_enabled: is_auto_retries_enabled.or(source.is_auto_retries_enabled),
+ max_auto_retries_enabled: max_auto_retries_enabled.or(source.max_auto_retries_enabled),
}
}
}
diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs
index 77140891ad9..a9e0b54260c 100644
--- a/crates/diesel_models/src/schema.rs
+++ b/crates/diesel_models/src/schema.rs
@@ -211,6 +211,8 @@ diesel::table! {
version -> ApiVersion,
dynamic_routing_algorithm -> Nullable<Json>,
is_network_tokenization_enabled -> Bool,
+ is_auto_retries_enabled -> Nullable<Bool>,
+ max_auto_retries_enabled -> Nullable<Int2>,
}
}
diff --git a/crates/diesel_models/src/schema_v2.rs b/crates/diesel_models/src/schema_v2.rs
index 1c81b402f77..53f568f18c4 100644
--- a/crates/diesel_models/src/schema_v2.rs
+++ b/crates/diesel_models/src/schema_v2.rs
@@ -218,6 +218,8 @@ diesel::table! {
version -> ApiVersion,
dynamic_routing_algorithm -> Nullable<Json>,
is_network_tokenization_enabled -> Bool,
+ is_auto_retries_enabled -> Nullable<Bool>,
+ max_auto_retries_enabled -> Nullable<Int2>,
}
}
diff --git a/crates/hyperswitch_domain_models/src/business_profile.rs b/crates/hyperswitch_domain_models/src/business_profile.rs
index 156ca4d2feb..75cdd40024f 100644
--- a/crates/hyperswitch_domain_models/src/business_profile.rs
+++ b/crates/hyperswitch_domain_models/src/business_profile.rs
@@ -56,6 +56,8 @@ pub struct Profile {
pub version: common_enums::ApiVersion,
pub dynamic_routing_algorithm: Option<serde_json::Value>,
pub is_network_tokenization_enabled: bool,
+ pub is_auto_retries_enabled: bool,
+ pub max_auto_retries_enabled: Option<i16>,
}
#[cfg(feature = "v1")]
@@ -94,6 +96,8 @@ pub struct ProfileSetter {
pub is_tax_connector_enabled: bool,
pub dynamic_routing_algorithm: Option<serde_json::Value>,
pub is_network_tokenization_enabled: bool,
+ pub is_auto_retries_enabled: bool,
+ pub max_auto_retries_enabled: Option<i16>,
}
#[cfg(feature = "v1")]
@@ -139,6 +143,8 @@ impl From<ProfileSetter> for Profile {
version: consts::API_VERSION,
dynamic_routing_algorithm: value.dynamic_routing_algorithm,
is_network_tokenization_enabled: value.is_network_tokenization_enabled,
+ is_auto_retries_enabled: value.is_auto_retries_enabled,
+ max_auto_retries_enabled: value.max_auto_retries_enabled,
}
}
}
@@ -186,6 +192,8 @@ pub struct ProfileGeneralUpdate {
pub is_tax_connector_enabled: Option<bool>,
pub dynamic_routing_algorithm: Option<serde_json::Value>,
pub is_network_tokenization_enabled: Option<bool>,
+ pub is_auto_retries_enabled: Option<bool>,
+ pub max_auto_retries_enabled: Option<i16>,
}
#[cfg(feature = "v1")]
@@ -246,6 +254,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
is_tax_connector_enabled,
dynamic_routing_algorithm,
is_network_tokenization_enabled,
+ is_auto_retries_enabled,
+ max_auto_retries_enabled,
} = *update;
Self {
@@ -281,6 +291,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
is_tax_connector_enabled,
dynamic_routing_algorithm,
is_network_tokenization_enabled,
+ is_auto_retries_enabled,
+ max_auto_retries_enabled,
}
}
ProfileUpdate::RoutingAlgorithmUpdate {
@@ -318,6 +330,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
is_tax_connector_enabled: None,
dynamic_routing_algorithm: None,
is_network_tokenization_enabled: None,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
ProfileUpdate::DynamicRoutingAlgorithmUpdate {
dynamic_routing_algorithm,
@@ -353,6 +367,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
is_tax_connector_enabled: None,
dynamic_routing_algorithm,
is_network_tokenization_enabled: None,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
ProfileUpdate::ExtendedCardInfoUpdate {
is_extended_card_info_enabled,
@@ -388,6 +404,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
is_tax_connector_enabled: None,
dynamic_routing_algorithm: None,
is_network_tokenization_enabled: None,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
ProfileUpdate::ConnectorAgnosticMitUpdate {
is_connector_agnostic_mit_enabled,
@@ -423,6 +441,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
is_tax_connector_enabled: None,
dynamic_routing_algorithm: None,
is_network_tokenization_enabled: None,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
ProfileUpdate::NetworkTokenizationUpdate {
is_network_tokenization_enabled,
@@ -458,6 +478,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
is_tax_connector_enabled: None,
dynamic_routing_algorithm: None,
is_network_tokenization_enabled,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
}
}
@@ -512,6 +534,8 @@ impl super::behaviour::Conversion for Profile {
version: self.version,
dynamic_routing_algorithm: self.dynamic_routing_algorithm,
is_network_tokenization_enabled: self.is_network_tokenization_enabled,
+ is_auto_retries_enabled: Some(self.is_auto_retries_enabled),
+ max_auto_retries_enabled: self.max_auto_retries_enabled,
})
}
@@ -578,6 +602,8 @@ impl super::behaviour::Conversion for Profile {
version: item.version,
dynamic_routing_algorithm: item.dynamic_routing_algorithm,
is_network_tokenization_enabled: item.is_network_tokenization_enabled,
+ is_auto_retries_enabled: item.is_auto_retries_enabled.unwrap_or(false),
+ max_auto_retries_enabled: item.max_auto_retries_enabled,
})
}
.await
@@ -628,6 +654,8 @@ impl super::behaviour::Conversion for Profile {
is_tax_connector_enabled: Some(self.is_tax_connector_enabled),
version: self.version,
is_network_tokenization_enabled: self.is_network_tokenization_enabled,
+ is_auto_retries_enabled: Some(self.is_auto_retries_enabled),
+ max_auto_retries_enabled: self.max_auto_retries_enabled,
})
}
}
@@ -896,6 +924,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
tax_connector_id: None,
is_tax_connector_enabled: None,
is_network_tokenization_enabled,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
}
}
ProfileUpdate::RoutingAlgorithmUpdate {
@@ -934,6 +964,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
tax_connector_id: None,
is_tax_connector_enabled: None,
is_network_tokenization_enabled: None,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
ProfileUpdate::ExtendedCardInfoUpdate {
is_extended_card_info_enabled,
@@ -970,6 +1002,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
tax_connector_id: None,
is_tax_connector_enabled: None,
is_network_tokenization_enabled: None,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
ProfileUpdate::ConnectorAgnosticMitUpdate {
is_connector_agnostic_mit_enabled,
@@ -1006,6 +1040,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
tax_connector_id: None,
is_tax_connector_enabled: None,
is_network_tokenization_enabled: None,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
ProfileUpdate::DefaultRoutingFallbackUpdate {
default_fallback_routing,
@@ -1042,6 +1078,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
tax_connector_id: None,
is_tax_connector_enabled: None,
is_network_tokenization_enabled: None,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
ProfileUpdate::NetworkTokenizationUpdate {
is_network_tokenization_enabled,
@@ -1078,6 +1116,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal {
tax_connector_id: None,
is_tax_connector_enabled: None,
is_network_tokenization_enabled,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
},
}
}
@@ -1134,6 +1174,8 @@ impl super::behaviour::Conversion for Profile {
version: self.version,
dynamic_routing_algorithm: None,
is_network_tokenization_enabled: self.is_network_tokenization_enabled,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
})
}
@@ -1253,6 +1295,8 @@ impl super::behaviour::Conversion for Profile {
is_tax_connector_enabled: Some(self.is_tax_connector_enabled),
version: self.version,
is_network_tokenization_enabled: self.is_network_tokenization_enabled,
+ is_auto_retries_enabled: None,
+ max_auto_retries_enabled: None,
})
}
}
diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs
index ad9925a241f..d27b6b82fd4 100644
--- a/crates/router/src/core/admin.rs
+++ b/crates/router/src/core/admin.rs
@@ -3537,6 +3537,8 @@ impl ProfileCreateBridge for api::ProfileCreate {
.always_collect_shipping_details_from_wallet_connector,
dynamic_routing_algorithm: None,
is_network_tokenization_enabled: self.is_network_tokenization_enabled,
+ is_auto_retries_enabled: self.is_auto_retries_enabled.unwrap_or_default(),
+ max_auto_retries_enabled: self.max_auto_retries_enabled.map(i16::from),
}))
}
@@ -3884,6 +3886,8 @@ impl ProfileUpdateBridge for api::ProfileUpdate {
is_tax_connector_enabled: self.is_tax_connector_enabled,
dynamic_routing_algorithm: self.dynamic_routing_algorithm,
is_network_tokenization_enabled: self.is_network_tokenization_enabled,
+ is_auto_retries_enabled: self.is_auto_retries_enabled,
+ max_auto_retries_enabled: self.max_auto_retries_enabled.map(i16::from),
},
)))
}
diff --git a/crates/router/src/types/api/admin.rs b/crates/router/src/types/api/admin.rs
index c7b76d1780a..8d52e5dc11a 100644
--- a/crates/router/src/types/api/admin.rs
+++ b/crates/router/src/types/api/admin.rs
@@ -168,6 +168,8 @@ impl ForeignTryFrom<domain::Profile> for ProfileResponse {
tax_connector_id: item.tax_connector_id,
is_tax_connector_enabled: item.is_tax_connector_enabled,
is_network_tokenization_enabled: item.is_network_tokenization_enabled,
+ is_auto_retries_enabled: item.is_auto_retries_enabled,
+ max_auto_retries_enabled: item.max_auto_retries_enabled,
})
}
}
@@ -353,5 +355,7 @@ pub async fn create_profile_from_merchant_account(
is_tax_connector_enabled: request.is_tax_connector_enabled,
dynamic_routing_algorithm: None,
is_network_tokenization_enabled: request.is_network_tokenization_enabled,
+ is_auto_retries_enabled: request.is_auto_retries_enabled.unwrap_or_default(),
+ max_auto_retries_enabled: request.max_auto_retries_enabled.map(i16::from),
}))
}
diff --git a/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/down.sql b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/down.sql
new file mode 100644
index 00000000000..3751f25da4b
--- /dev/null
+++ b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/down.sql
@@ -0,0 +1,6 @@
+-- This file should undo anything in `up.sql`
+-- Drop is_auto_retries_enabled column from business_profile table
+ALTER TABLE business_profile DROP COLUMN IF EXISTS is_auto_retries_enabled;
+
+-- Drop max_auto_retries_enabled column from business_profile table
+ALTER TABLE business_profile DROP COLUMN IF EXISTS max_auto_retries_enabled;
diff --git a/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/up.sql b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/up.sql
new file mode 100644
index 00000000000..05b6a114a31
--- /dev/null
+++ b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/up.sql
@@ -0,0 +1,6 @@
+-- Your SQL goes here
+-- Add is_auto_retries_enabled column in business_profile table
+ALTER TABLE business_profile ADD COLUMN IF NOT EXISTS is_auto_retries_enabled BOOLEAN;
+
+-- Add max_auto_retries_enabled column in business_profile table
+ALTER TABLE business_profile ADD COLUMN IF NOT EXISTS max_auto_retries_enabled SMALLINT;
|
feat
|
add auto retries configs in profile CRUD apis (#6134)
|
f822730979d9aabdf082b0dc1160c819ba1907a1
|
2024-09-03 05:53:10
|
github-actions
|
chore(version): 2024.09.03.0
| false
|
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 09ba040ff70..27ea6b3f137 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,35 @@ All notable changes to HyperSwitch will be documented here.
- - -
+## 2024.09.03.0
+
+### Features
+
+- **connector:** [Adyenplatform] add webhooks for payout ([#5749](https://github.com/juspay/hyperswitch/pull/5749)) ([`258212d`](https://github.com/juspay/hyperswitch/commit/258212d8b0a17ac0f2efefd1809dfd681bd991e8))
+- **roles:** Add list support for roles ([#5754](https://github.com/juspay/hyperswitch/pull/5754)) ([`e4f1fbc`](https://github.com/juspay/hyperswitch/commit/e4f1fbc5a5622a86c3e3c27ae20e4b7b05f0a7ef))
+- **user:** Implement invitations api ([#5769](https://github.com/juspay/hyperswitch/pull/5769)) ([`730c2ba`](https://github.com/juspay/hyperswitch/commit/730c2ba258ea6c1c03dfbde562b5a883e0ffc4e9))
+
+### Bug Fixes
+
+- **cypress:** Fix cypress throwing error when `connectorId` is not passed and miscellaneous fixes ([#5746](https://github.com/juspay/hyperswitch/pull/5746)) ([`4eec869`](https://github.com/juspay/hyperswitch/commit/4eec86949881db19a39aa8473065aedd642ef1a3))
+
+### Refactors
+
+- **business_profile:** Change id for business profile ([#5748](https://github.com/juspay/hyperswitch/pull/5748)) ([`8e5c33e`](https://github.com/juspay/hyperswitch/commit/8e5c33e2d892f1f6dc514cacb25fdbc62f145b7c))
+- **connector:** Move globepay, powertranz, tsys, worldline to hyperswitch_connectors ([#5758](https://github.com/juspay/hyperswitch/pull/5758)) ([`1d14971`](https://github.com/juspay/hyperswitch/commit/1d149716ba47d3e3f4c749687cff851e18ec77c0))
+- **payment_id:** Add payment id domain type ([#5738](https://github.com/juspay/hyperswitch/pull/5738)) ([`7296cce`](https://github.com/juspay/hyperswitch/commit/7296cceba351dccf13a71ef2479dba3f24e3c31f))
+- **v2_migrations:** Re-organize v2 migrations ([#5760](https://github.com/juspay/hyperswitch/pull/5760)) ([`f32a329`](https://github.com/juspay/hyperswitch/commit/f32a32945d09b72da6eeb0196e7308145bcc9592))
+
+### Miscellaneous Tasks
+
+- Enable partial auth as a feature flag ([#5711](https://github.com/juspay/hyperswitch/pull/5711)) ([`c03587f`](https://github.com/juspay/hyperswitch/commit/c03587f9c6e8ad444cebac92fd5134fe01c71728))
+- Fix typos ([#5766](https://github.com/juspay/hyperswitch/pull/5766)) ([`4fc4763`](https://github.com/juspay/hyperswitch/commit/4fc4763035ae25b54736ac28f4a1303918275ccd))
+- Add wasm support for connector additional details ([#5712](https://github.com/juspay/hyperswitch/pull/5712)) ([`45929f2`](https://github.com/juspay/hyperswitch/commit/45929f2b8d28ca580e5c2dac5a010909d4fbb05b))
+
+**Full Changelog:** [`2024.09.02.0...2024.09.03.0`](https://github.com/juspay/hyperswitch/compare/2024.09.02.0...2024.09.03.0)
+
+- - -
+
## 2024.09.02.0
### Features
|
chore
|
2024.09.03.0
|
a9b5dc9ab767eb54a95bcebc4fd5a7b00dbf65f6
|
2023-10-19 19:43:42
|
Rutam Prita Mishra
|
feat(connector): [Bambora] Use connector_response_reference_id as reference to the connector (#2635)
| false
|
diff --git a/crates/router/src/connector/bambora/transformers.rs b/crates/router/src/connector/bambora/transformers.rs
index bfcd9846292..e686186c901 100644
--- a/crates/router/src/connector/bambora/transformers.rs
+++ b/crates/router/src/connector/bambora/transformers.rs
@@ -214,7 +214,7 @@ impl<F, T>
mandate_reference: None,
connector_metadata: None,
network_txn_id: None,
- connector_response_reference_id: None,
+ connector_response_reference_id: Some(pg_response.order_number.to_string()),
}),
..item.data
}),
@@ -238,7 +238,9 @@ impl<F, T>
.change_context(errors::ConnectorError::ResponseHandlingFailed)?,
),
network_txn_id: None,
- connector_response_reference_id: None,
+ connector_response_reference_id: Some(
+ item.data.connector_request_reference_id.to_string(),
+ ),
}),
..item.data
})
|
feat
|
[Bambora] Use connector_response_reference_id as reference to the connector (#2635)
|
47fbe486cec252b8befca38f1b7ea77cc0823ee5
|
2024-01-25 12:43:48
|
DEEPANSHU BANSAL
|
feat(core): [CYBERSOURCE] Add original authorized amount in router data (#3417)
| false
|
diff --git a/crates/router/src/connector/bankofamerica/transformers.rs b/crates/router/src/connector/bankofamerica/transformers.rs
index 72e3de0bf77..db96ff62f6c 100644
--- a/crates/router/src/connector/bankofamerica/transformers.rs
+++ b/crates/router/src/connector/bankofamerica/transformers.rs
@@ -442,7 +442,7 @@ pub struct ClientRiskInformationRules {
#[serde(rename_all = "camelCase")]
pub struct Avs {
code: String,
- code_raw: String,
+ code_raw: Option<String>,
}
impl
diff --git a/crates/router/src/connector/cybersource/transformers.rs b/crates/router/src/connector/cybersource/transformers.rs
index 0abe1fff42c..659f0733fdc 100644
--- a/crates/router/src/connector/cybersource/transformers.rs
+++ b/crates/router/src/connector/cybersource/transformers.rs
@@ -10,7 +10,7 @@ use crate::{
connector::utils::{
self, AddressDetailsData, ApplePayDecrypt, CardData, PaymentsAuthorizeRequestData,
PaymentsCompleteAuthorizeRequestData, PaymentsPreProcessingData,
- PaymentsSetupMandateRequestData, PaymentsSyncRequestData, RouterData,
+ PaymentsSetupMandateRequestData, PaymentsSyncRequestData, RecurringMandateData, RouterData,
},
consts,
core::errors,
@@ -47,6 +47,7 @@ impl<T>
T,
),
) -> Result<Self, Self::Error> {
+ // This conversion function is used at different places in the file, if updating this, keep a check for those
let amount = utils::get_amount_as_string(currency_unit, amount, currency)?;
Ok(Self {
amount,
@@ -81,11 +82,11 @@ impl TryFrom<&types::SetupMandateRouterData> for CybersourceZeroMandateRequest {
Some(vec![CybersourceActionsList::TokenCreate]),
Some(vec![CybersourceActionsTokenType::PaymentInstrument]),
Some(CybersourceAuthorizationOptions {
- initiator: CybersourcePaymentInitiator {
+ initiator: Some(CybersourcePaymentInitiator {
initiator_type: Some(CybersourcePaymentInitiatorTypes::Customer),
credential_stored_on_file: Some(true),
stored_credential_used: None,
- },
+ }),
merchant_intitiated_transaction: None,
}),
);
@@ -272,14 +273,16 @@ pub enum CybersourceActionsTokenType {
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CybersourceAuthorizationOptions {
- initiator: CybersourcePaymentInitiator,
+ initiator: Option<CybersourcePaymentInitiator>,
merchant_intitiated_transaction: Option<MerchantInitiatedTransaction>,
}
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct MerchantInitiatedTransaction {
- reason: String,
+ reason: Option<String>,
+ //Required for recurring mandates payment
+ original_authorized_amount: Option<String>,
}
#[derive(Debug, Serialize)]
@@ -470,35 +473,60 @@ impl From<&CybersourceRouterData<&types::PaymentsCompleteAuthorizeRouterData>>
}
impl
- From<(
+ TryFrom<(
&CybersourceRouterData<&types::PaymentsAuthorizeRouterData>,
Option<PaymentSolution>,
)> for ProcessingInformation
{
- fn from(
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
(item, solution): (
&CybersourceRouterData<&types::PaymentsAuthorizeRouterData>,
Option<PaymentSolution>,
),
- ) -> Self {
+ ) -> Result<Self, Self::Error> {
let (action_list, action_token_types, authorization_options) =
if item.router_data.request.setup_mandate_details.is_some() {
(
Some(vec![CybersourceActionsList::TokenCreate]),
Some(vec![CybersourceActionsTokenType::PaymentInstrument]),
Some(CybersourceAuthorizationOptions {
- initiator: CybersourcePaymentInitiator {
+ initiator: Some(CybersourcePaymentInitiator {
initiator_type: Some(CybersourcePaymentInitiatorTypes::Customer),
credential_stored_on_file: Some(true),
stored_credential_used: None,
- },
+ }),
merchant_intitiated_transaction: None,
}),
)
+ } else if item.router_data.request.connector_mandate_id().is_some() {
+ let original_amount = item
+ .router_data
+ .get_recurring_mandate_payment_data()?
+ .get_original_payment_amount()?;
+ let original_currency = item
+ .router_data
+ .get_recurring_mandate_payment_data()?
+ .get_original_payment_currency()?;
+ (
+ None,
+ None,
+ Some(CybersourceAuthorizationOptions {
+ initiator: None,
+ merchant_intitiated_transaction: Some(MerchantInitiatedTransaction {
+ reason: None,
+ original_authorized_amount: Some(utils::get_amount_as_string(
+ &types::api::CurrencyUnit::Base,
+ original_amount,
+ original_currency,
+ )?),
+ }),
+ }),
+ )
} else {
(None, None, None)
};
- Self {
+ Ok(Self {
capture: Some(matches!(
item.router_data.request.capture_method,
Some(enums::CaptureMethod::Automatic) | None
@@ -509,7 +537,7 @@ impl
authorization_options,
capture_options: None,
commerce_indicator: String::from("internet"),
- }
+ })
}
}
@@ -533,11 +561,11 @@ impl
Some(vec![CybersourceActionsList::TokenCreate]),
Some(vec![CybersourceActionsTokenType::PaymentInstrument]),
Some(CybersourceAuthorizationOptions {
- initiator: CybersourcePaymentInitiator {
+ initiator: Some(CybersourcePaymentInitiator {
initiator_type: Some(CybersourcePaymentInitiatorTypes::Customer),
credential_stored_on_file: Some(true),
stored_credential_used: None,
- },
+ }),
merchant_intitiated_transaction: None,
}),
)
@@ -680,7 +708,7 @@ impl
},
});
- let processing_information = ProcessingInformation::from((item, None));
+ let processing_information = ProcessingInformation::try_from((item, None))?;
let client_reference_information = ClientReferenceInformation::from(item);
let merchant_defined_information =
item.router_data.request.metadata.clone().map(|metadata| {
@@ -792,7 +820,7 @@ impl
let bill_to = build_bill_to(item.router_data.get_billing()?, email)?;
let order_information = OrderInformationWithBill::from((item, bill_to));
let processing_information =
- ProcessingInformation::from((item, Some(PaymentSolution::ApplePay)));
+ ProcessingInformation::try_from((item, Some(PaymentSolution::ApplePay)))?;
let client_reference_information = ClientReferenceInformation::from(item);
let expiration_month = apple_pay_data.get_expiry_month()?;
let expiration_year = apple_pay_data.get_four_digit_expiry_year()?;
@@ -846,7 +874,7 @@ impl
},
});
let processing_information =
- ProcessingInformation::from((item, Some(PaymentSolution::GooglePay)));
+ ProcessingInformation::try_from((item, Some(PaymentSolution::GooglePay)))?;
let client_reference_information = ClientReferenceInformation::from(item);
let merchant_defined_information =
item.router_data.request.metadata.clone().map(|metadata| {
@@ -893,10 +921,9 @@ impl TryFrom<&CybersourceRouterData<&types::PaymentsAuthorizeRouterData>>
build_bill_to(item.router_data.get_billing()?, email)?;
let order_information =
OrderInformationWithBill::from((item, bill_to));
- let processing_information = ProcessingInformation::from((
- item,
- Some(PaymentSolution::ApplePay),
- ));
+ let processing_information = ProcessingInformation::try_from(
+ (item, Some(PaymentSolution::ApplePay)),
+ )?;
let client_reference_information =
ClientReferenceInformation::from(item);
let payment_information = PaymentInformation::ApplePayToken(
@@ -1008,7 +1035,7 @@ impl
String,
),
) -> Result<Self, Self::Error> {
- let processing_information = ProcessingInformation::from((item, None));
+ let processing_information = ProcessingInformation::try_from((item, None))?;
let payment_instrument = CybersoucrePaymentInstrument {
id: connector_mandate_id,
};
@@ -1159,13 +1186,14 @@ impl TryFrom<&CybersourceRouterData<&types::PaymentsIncrementalAuthorizationRout
action_list: None,
action_token_types: None,
authorization_options: Some(CybersourceAuthorizationOptions {
- initiator: CybersourcePaymentInitiator {
+ initiator: Some(CybersourcePaymentInitiator {
initiator_type: None,
credential_stored_on_file: None,
stored_credential_used: Some(true),
- },
+ }),
merchant_intitiated_transaction: Some(MerchantInitiatedTransaction {
- reason: "5".to_owned(),
+ reason: Some("5".to_owned()),
+ original_authorized_amount: None,
}),
}),
commerce_indicator: String::from("internet"),
@@ -1339,18 +1367,6 @@ impl From<CybersourceIncrementalAuthorizationStatus> for common_enums::Authoriza
}
}
-impl From<CybersourcePaymentStatus> for enums::RefundStatus {
- fn from(item: CybersourcePaymentStatus) -> Self {
- match item {
- CybersourcePaymentStatus::Succeeded | CybersourcePaymentStatus::Transmitted => {
- Self::Success
- }
- CybersourcePaymentStatus::Failed => Self::Failure,
- _ => Self::Pending,
- }
- }
-}
-
#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum CybersourcePaymentsResponse {
@@ -1430,7 +1446,7 @@ pub struct ClientProcessorInformation {
#[serde(rename_all = "camelCase")]
pub struct Avs {
code: String,
- code_raw: String,
+ code_raw: Option<String>,
}
#[derive(Debug, Clone, Deserialize)]
diff --git a/crates/router/src/connector/utils.rs b/crates/router/src/connector/utils.rs
index 7226cb77342..3b3c992f0e0 100644
--- a/crates/router/src/connector/utils.rs
+++ b/crates/router/src/connector/utils.rs
@@ -25,7 +25,7 @@ use crate::{
consts,
core::{
errors::{self, ApiErrorResponse, CustomResult},
- payments::PaymentData,
+ payments::{PaymentData, RecurringMandatePaymentData},
},
pii::PeekInterface,
types::{
@@ -81,6 +81,7 @@ pub trait RouterData {
fn get_customer_id(&self) -> Result<String, Error>;
fn get_connector_customer_id(&self) -> Result<String, Error>;
fn get_preprocessing_id(&self) -> Result<String, Error>;
+ fn get_recurring_mandate_payment_data(&self) -> Result<RecurringMandatePaymentData, Error>;
#[cfg(feature = "payouts")]
fn get_payout_method_data(&self) -> Result<api::PayoutMethodData, Error>;
#[cfg(feature = "payouts")]
@@ -250,6 +251,12 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
.to_owned()
.ok_or_else(missing_field_err("preprocessing_id"))
}
+ fn get_recurring_mandate_payment_data(&self) -> Result<RecurringMandatePaymentData, Error> {
+ self.recurring_mandate_payment_data
+ .to_owned()
+ .ok_or_else(missing_field_err("recurring_mandate_payment_data"))
+ }
+
#[cfg(feature = "payouts")]
fn get_payout_method_data(&self) -> Result<api::PayoutMethodData, Error> {
self.payout_method_data
@@ -1133,6 +1140,22 @@ impl MandateData for payments::MandateAmountData {
}
}
+pub trait RecurringMandateData {
+ fn get_original_payment_amount(&self) -> Result<i64, Error>;
+ fn get_original_payment_currency(&self) -> Result<diesel_models::enums::Currency, Error>;
+}
+
+impl RecurringMandateData for RecurringMandatePaymentData {
+ fn get_original_payment_amount(&self) -> Result<i64, Error> {
+ self.original_payment_authorized_amount
+ .ok_or_else(missing_field_err("original_payment_authorized_amount"))
+ }
+ fn get_original_payment_currency(&self) -> Result<diesel_models::enums::Currency, Error> {
+ self.original_payment_authorized_currency
+ .ok_or_else(missing_field_err("original_payment_authorized_currency"))
+ }
+}
+
pub trait MandateReferenceData {
fn get_connector_mandate_id(&self) -> Result<String, Error>;
}
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index 21b82f30772..186f760ace1 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -2039,6 +2039,8 @@ pub struct IncrementalAuthorizationDetails {
#[derive(Debug, Default, Clone)]
pub struct RecurringMandatePaymentData {
pub payment_method_type: Option<storage_enums::PaymentMethodType>, //required for making recurring payment using saved payment method through stripe
+ pub original_payment_authorized_amount: Option<i64>,
+ pub original_payment_authorized_currency: Option<storage_enums::Currency>,
}
#[derive(Debug, Default, Clone)]
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index 213adc79fb0..0cbed255348 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -479,6 +479,27 @@ pub async fn get_token_for_recurring_mandate(
.await
.to_not_found_response(errors::ApiErrorResponse::MandateNotFound)?;
+ let original_payment_intent = mandate
+ .original_payment_id
+ .as_ref()
+ .async_map(|payment_id| async {
+ db.find_payment_intent_by_payment_id_merchant_id(
+ payment_id,
+ &mandate.merchant_id,
+ merchant_account.storage_scheme,
+ )
+ .await
+ .to_not_found_response(errors::ApiErrorResponse::PaymentNotFound)
+ .map_err(|err| logger::error!(mandate_original_payment_not_found=?err))
+ .ok()
+ })
+ .await
+ .flatten();
+
+ let original_payment_authorized_amount = original_payment_intent.clone().map(|pi| pi.amount);
+ let original_payment_authorized_currency =
+ original_payment_intent.clone().and_then(|pi| pi.currency);
+
let customer = req.customer_id.clone().get_required_value("customer_id")?;
let payment_method_id = {
@@ -540,6 +561,8 @@ pub async fn get_token_for_recurring_mandate(
Some(payment_method.payment_method),
Some(payments::RecurringMandatePaymentData {
payment_method_type,
+ original_payment_authorized_amount,
+ original_payment_authorized_currency,
}),
payment_method.payment_method_type,
Some(mandate_connector_details),
@@ -550,6 +573,8 @@ pub async fn get_token_for_recurring_mandate(
Some(payment_method.payment_method),
Some(payments::RecurringMandatePaymentData {
payment_method_type,
+ original_payment_authorized_amount,
+ original_payment_authorized_currency,
}),
payment_method.payment_method_type,
Some(mandate_connector_details),
|
feat
|
[CYBERSOURCE] Add original authorized amount in router data (#3417)
|
62a7c3053c5e276091f5bd54a5679caef58a4ace
|
2023-12-12 16:43:53
|
SamraatBansal
|
fix(connector): [trustpay] make paymentId optional field (#3101)
| false
|
diff --git a/crates/router/src/connector/trustpay.rs b/crates/router/src/connector/trustpay.rs
index 286eaf9cb54..9d9d998aa18 100644
--- a/crates/router/src/connector/trustpay.rs
+++ b/crates/router/src/connector/trustpay.rs
@@ -955,11 +955,15 @@ impl api::IncomingWebhook for Trustpay {
.switch()?;
let payment_info = trustpay_response.payment_information;
let reason = payment_info.status_reason_information.unwrap_or_default();
+ let connector_dispute_id = payment_info
+ .references
+ .payment_id
+ .ok_or(errors::ConnectorError::WebhookReferenceIdNotFound)?;
Ok(api::disputes::DisputePayload {
amount: payment_info.amount.amount.to_string(),
currency: payment_info.amount.currency,
dispute_stage: api_models::enums::DisputeStage::Dispute,
- connector_dispute_id: payment_info.references.payment_id,
+ connector_dispute_id,
connector_reason: reason.reason.reject_reason,
connector_reason_code: Some(reason.reason.code),
challenge_required_by: None,
diff --git a/crates/router/src/connector/trustpay/transformers.rs b/crates/router/src/connector/trustpay/transformers.rs
index 270a702bd6e..c112b644017 100644
--- a/crates/router/src/connector/trustpay/transformers.rs
+++ b/crates/router/src/connector/trustpay/transformers.rs
@@ -1700,7 +1700,7 @@ impl TryFrom<WebhookStatus> for diesel_models::enums::RefundStatus {
#[serde(rename_all = "PascalCase")]
pub struct WebhookReferences {
pub merchant_reference: String,
- pub payment_id: String,
+ pub payment_id: Option<String>,
pub payment_request_id: Option<String>,
}
|
fix
|
[trustpay] make paymentId optional field (#3101)
|
cecea8718a48b4e896b2bafce0f909ef8d9a6e8a
|
2023-10-17 15:18:51
|
Prajjwal Kumar
|
refactor(router): throw bad request error on applepay verification failure (#2607)
| false
|
diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs
index b0a328accba..66453315d44 100644
--- a/crates/router/src/core/payments/transformers.rs
+++ b/crates/router/src/core/payments/transformers.rs
@@ -449,7 +449,7 @@ where
headers.extend(
external_latency
.map(|latency| vec![(X_HS_LATENCY.to_string(), latency.to_string())])
- .unwrap_or(vec![]),
+ .unwrap_or_default(),
);
}
let output = Ok(match payment_request {
diff --git a/crates/router/src/core/verification.rs b/crates/router/src/core/verification.rs
index c1dac8f838e..fa700b4cd66 100644
--- a/crates/router/src/core/verification.rs
+++ b/crates/router/src/core/verification.rs
@@ -85,7 +85,7 @@ pub async fn verify_merchant_creds_for_applepay(
response.change_context(api_error_response::ApiErrorResponse::InternalServerError)?;
// Error is already logged
- Ok(match applepay_response {
+ match applepay_response {
Ok(_) => {
utils::check_existence_and_add_domain_to_db(
&state,
@@ -95,17 +95,20 @@ pub async fn verify_merchant_creds_for_applepay(
)
.await
.change_context(api_error_response::ApiErrorResponse::InternalServerError)?;
- services::api::ApplicationResponse::Json(ApplepayMerchantResponse {
- status_message: "Applepay verification Completed".to_string(),
- })
+ Ok(services::api::ApplicationResponse::Json(
+ ApplepayMerchantResponse {
+ status_message: "Applepay verification Completed".to_string(),
+ },
+ ))
}
Err(error) => {
logger::error!(?error);
- services::api::ApplicationResponse::Json(ApplepayMerchantResponse {
- status_message: "Applepay verification Failed".to_string(),
- })
+ Err(api_error_response::ApiErrorResponse::InvalidRequestData {
+ message: "Applepay verification Failed".to_string(),
+ }
+ .into())
}
- })
+ }
}
pub async fn get_verified_apple_domains_with_mid_mca_id(
|
refactor
|
throw bad request error on applepay verification failure (#2607)
|
9fa631d2b9df9a2ba429e197b8785885edd97798
|
2024-08-09 12:28:47
|
Hrithikesh
|
feat(core): use profile_id passed from auth layer within core functions (#5553)
| false
|
diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs
index 736360edf06..821057764e7 100644
--- a/crates/router/src/core/admin.rs
+++ b/crates/router/src/core/admin.rs
@@ -2817,7 +2817,7 @@ async fn validate_pm_auth(
pub async fn retrieve_connector(
state: SessionState,
merchant_id: id_type::MerchantId,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
merchant_connector_id: String,
) -> RouterResponse<api_models::admin::MerchantConnectorResponse> {
let store = state.store.as_ref();
@@ -2847,6 +2847,7 @@ pub async fn retrieve_connector(
.to_not_found_response(errors::ApiErrorResponse::MerchantConnectorAccountNotFound {
id: merchant_connector_id.clone(),
})?;
+ core_utils::validate_profile_id_from_auth_layer(profile_id, &mca)?;
Ok(service_api::ApplicationResponse::Json(
mca.foreign_try_into()?,
@@ -2897,7 +2898,7 @@ pub async fn retrieve_connector(
pub async fn list_payment_connectors(
state: SessionState,
merchant_id: id_type::MerchantId,
- _profile_id_list: Option<Vec<String>>,
+ profile_id_list: Option<Vec<String>>,
) -> RouterResponse<Vec<api_models::admin::MerchantConnectorListResponse>> {
let store = state.store.as_ref();
let key_manager_state = &(&state).into();
@@ -2925,6 +2926,10 @@ pub async fn list_payment_connectors(
)
.await
.to_not_found_response(errors::ApiErrorResponse::InternalServerError)?;
+ let merchant_connector_accounts = core_utils::filter_objects_based_on_profile_id_list(
+ profile_id_list,
+ merchant_connector_accounts,
+ );
let mut response = vec![];
// The can be eliminated once [#79711](https://github.com/rust-lang/rust/issues/79711) is stabilized
@@ -2938,7 +2943,7 @@ pub async fn list_payment_connectors(
pub async fn update_connector(
state: SessionState,
merchant_id: &id_type::MerchantId,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
merchant_connector_id: &str,
req: api_models::admin::MerchantConnectorUpdate,
) -> RouterResponse<api_models::admin::MerchantConnectorResponse> {
@@ -2968,6 +2973,7 @@ pub async fn update_connector(
key_manager_state,
)
.await?;
+ core_utils::validate_profile_id_from_auth_layer(profile_id, &mca)?;
let payment_connector = req
.clone()
diff --git a/crates/router/src/core/disputes.rs b/crates/router/src/core/disputes.rs
index 37f6d111de4..73215959305 100644
--- a/crates/router/src/core/disputes.rs
+++ b/crates/router/src/core/disputes.rs
@@ -26,7 +26,7 @@ use crate::{
pub async fn retrieve_dispute(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
req: disputes::DisputeId,
) -> RouterResponse<api_models::disputes::DisputeResponse> {
let dispute = state
@@ -36,6 +36,7 @@ pub async fn retrieve_dispute(
.to_not_found_response(errors::ApiErrorResponse::DisputeNotFound {
dispute_id: req.dispute_id,
})?;
+ core_utils::validate_profile_id_from_auth_layer(profile_id, &dispute)?;
let dispute_response = api_models::disputes::DisputeResponse::foreign_from(dispute);
Ok(services::ApplicationResponse::Json(dispute_response))
}
@@ -64,7 +65,7 @@ pub async fn retrieve_disputes_list(
pub async fn accept_dispute(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
key_store: domain::MerchantKeyStore,
req: disputes::DisputeId,
) -> RouterResponse<dispute_models::DisputeResponse> {
@@ -76,6 +77,7 @@ pub async fn accept_dispute(
.to_not_found_response(errors::ApiErrorResponse::DisputeNotFound {
dispute_id: req.dispute_id,
})?;
+ core_utils::validate_profile_id_from_auth_layer(profile_id, &dispute)?;
let dispute_id = dispute.dispute_id.clone();
common_utils::fp_utils::when(
!(dispute.dispute_stage == storage_enums::DisputeStage::Dispute
@@ -167,7 +169,7 @@ pub async fn accept_dispute(
pub async fn submit_evidence(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
key_store: domain::MerchantKeyStore,
req: dispute_models::SubmitEvidenceRequest,
) -> RouterResponse<dispute_models::DisputeResponse> {
@@ -179,6 +181,7 @@ pub async fn submit_evidence(
.to_not_found_response(errors::ApiErrorResponse::DisputeNotFound {
dispute_id: req.dispute_id.clone(),
})?;
+ core_utils::validate_profile_id_from_auth_layer(profile_id, &dispute)?;
let dispute_id = dispute.dispute_id.clone();
common_utils::fp_utils::when(
!(dispute.dispute_stage == storage_enums::DisputeStage::Dispute
@@ -333,7 +336,7 @@ pub async fn submit_evidence(
pub async fn attach_evidence(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
key_store: domain::MerchantKeyStore,
attach_evidence_request: api::AttachEvidenceRequest,
) -> RouterResponse<files_api_models::CreateFileResponse> {
@@ -349,6 +352,7 @@ pub async fn attach_evidence(
.to_not_found_response(errors::ApiErrorResponse::DisputeNotFound {
dispute_id: dispute_id.clone(),
})?;
+ core_utils::validate_profile_id_from_auth_layer(profile_id, &dispute)?;
common_utils::fp_utils::when(
!(dispute.dispute_stage == storage_enums::DisputeStage::Dispute
&& dispute.dispute_status == storage_enums::DisputeStatus::DisputeOpened),
@@ -411,7 +415,7 @@ pub async fn attach_evidence(
pub async fn retrieve_dispute_evidence(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
req: disputes::DisputeId,
) -> RouterResponse<Vec<api_models::disputes::DisputeEvidenceBlock>> {
let dispute = state
@@ -421,6 +425,7 @@ pub async fn retrieve_dispute_evidence(
.to_not_found_response(errors::ApiErrorResponse::DisputeNotFound {
dispute_id: req.dispute_id,
})?;
+ core_utils::validate_profile_id_from_auth_layer(profile_id, &dispute)?;
let dispute_evidence: api::DisputeEvidence = dispute
.evidence
.clone()
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index b4f369f71b4..cc324fa5291 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -103,6 +103,7 @@ pub async fn payments_operation_core<F, Req, Op, FData>(
state: &SessionState,
req_state: ReqState,
merchant_account: domain::MerchantAccount,
+ profile_id_from_auth_layer: Option<String>,
key_store: domain::MerchantKeyStore,
operation: Op,
req: Req,
@@ -162,6 +163,11 @@ where
)
.await?;
+ utils::validate_profile_id_from_auth_layer(
+ profile_id_from_auth_layer,
+ &payment_data.payment_intent,
+ )?;
+
let (operation, customer) = operation
.to_domain()?
.get_or_create_customer_details(
@@ -788,7 +794,7 @@ pub async fn payments_core<F, Res, Req, Op, FData>(
state: SessionState,
req_state: ReqState,
merchant_account: domain::MerchantAccount,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
key_store: domain::MerchantKeyStore,
operation: Op,
req: Req,
@@ -825,6 +831,7 @@ where
&state,
req_state,
merchant_account,
+ profile_id,
key_store,
operation.clone(),
req,
@@ -2877,7 +2884,7 @@ pub fn is_operation_complete_authorize<Op: Debug>(operation: &Op) -> bool {
pub async fn list_payments(
state: SessionState,
merchant: domain::MerchantAccount,
- _profile_id_list: Option<Vec<String>>,
+ profile_id_list: Option<Vec<String>>,
key_store: domain::MerchantKeyStore,
constraints: api::PaymentListConstraints,
) -> RouterResponse<api::PaymentListResponse> {
@@ -2894,6 +2901,8 @@ pub async fn list_payments(
)
.await
.to_not_found_response(errors::ApiErrorResponse::PaymentNotFound)?;
+ let payment_intents =
+ utils::filter_objects_based_on_profile_id_list(profile_id_list, payment_intents);
let collected_futures = payment_intents.into_iter().map(|pi| {
async {
@@ -2950,7 +2959,7 @@ pub async fn list_payments(
pub async fn apply_filters_on_payments(
state: SessionState,
merchant: domain::MerchantAccount,
- _profile_id_list: Option<Vec<String>>,
+ profile_id_list: Option<Vec<String>>,
merchant_key_store: domain::MerchantKeyStore,
constraints: api::PaymentListFilterConstraints,
) -> RouterResponse<api::PaymentListResponseV2> {
@@ -2967,7 +2976,7 @@ pub async fn apply_filters_on_payments(
)
.await
.to_not_found_response(errors::ApiErrorResponse::PaymentNotFound)?;
-
+ let list = utils::filter_objects_based_on_profile_id_list(profile_id_list, list);
let data: Vec<api::PaymentsResponse> =
list.into_iter().map(ForeignFrom::foreign_from).collect();
@@ -3048,10 +3057,11 @@ pub async fn get_filters_for_payments(
pub async fn get_payment_filters(
state: SessionState,
merchant: domain::MerchantAccount,
- _profile_id_list: Option<Vec<String>>,
+ profile_id_list: Option<Vec<String>>,
) -> RouterResponse<api::PaymentListFiltersV2> {
let merchant_connector_accounts = if let services::ApplicationResponse::Json(data) =
- super::admin::list_payment_connectors(state, merchant.get_id().to_owned(), None).await?
+ super::admin::list_payment_connectors(state, merchant.get_id().to_owned(), profile_id_list)
+ .await?
{
data
} else {
diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs
index 92763e43d27..b0819f4a5f8 100644
--- a/crates/router/src/core/payouts.rs
+++ b/crates/router/src/core/payouts.rs
@@ -358,6 +358,7 @@ pub async fn payouts_confirm_core(
let mut payout_data = make_payout_data(
&state,
&merchant_account,
+ None,
&key_store,
&payouts::PayoutRequest::PayoutCreateRequest(req.to_owned()),
)
@@ -422,6 +423,7 @@ pub async fn payouts_update_core(
let mut payout_data = make_payout_data(
&state,
&merchant_account,
+ None,
&key_store,
&payouts::PayoutRequest::PayoutCreateRequest(req.to_owned()),
)
@@ -482,18 +484,18 @@ pub async fn payouts_update_core(
pub async fn payouts_retrieve_core(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
key_store: domain::MerchantKeyStore,
req: payouts::PayoutRetrieveRequest,
) -> RouterResponse<payouts::PayoutCreateResponse> {
let mut payout_data = make_payout_data(
&state,
&merchant_account,
+ profile_id,
&key_store,
&payouts::PayoutRequest::PayoutRetrieveRequest(req.to_owned()),
)
.await?;
-
let payout_attempt = payout_data.payout_attempt.to_owned();
let status = payout_attempt.status;
@@ -533,6 +535,7 @@ pub async fn payouts_cancel_core(
let mut payout_data = make_payout_data(
&state,
&merchant_account,
+ None,
&key_store,
&payouts::PayoutRequest::PayoutActionRequest(req.to_owned()),
)
@@ -628,6 +631,7 @@ pub async fn payouts_fulfill_core(
let mut payout_data = make_payout_data(
&state,
&merchant_account,
+ None,
&key_store,
&payouts::PayoutRequest::PayoutActionRequest(req.to_owned()),
)
@@ -708,7 +712,7 @@ pub async fn payouts_fulfill_core(
pub async fn payouts_list_core(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id_list: Option<Vec<String>>,
+ profile_id_list: Option<Vec<String>>,
key_store: domain::MerchantKeyStore,
constraints: payouts::PayoutListConstraints,
) -> RouterResponse<payouts::PayoutListResponse> {
@@ -723,6 +727,7 @@ pub async fn payouts_list_core(
)
.await
.to_not_found_response(errors::ApiErrorResponse::PayoutNotFound)?;
+ let payouts = core_utils::filter_objects_based_on_profile_id_list(profile_id_list, payouts);
let collected_futures = payouts.into_iter().map(|payouts| async {
match db
@@ -807,7 +812,7 @@ pub async fn payouts_list_core(
pub async fn payouts_filtered_list_core(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id_list: Option<Vec<String>>,
+ profile_id_list: Option<Vec<String>>,
key_store: domain::MerchantKeyStore,
filters: payouts::PayoutListFilterConstraints,
) -> RouterResponse<payouts::PayoutListResponse> {
@@ -826,7 +831,7 @@ pub async fn payouts_filtered_list_core(
)
.await
.to_not_found_response(errors::ApiErrorResponse::PayoutNotFound)?;
-
+ let list = core_utils::filter_objects_based_on_profile_id_list(profile_id_list, list);
let data: Vec<api::PayoutCreateResponse> = join_all(list.into_iter().map(|(p, pa, c)| async {
match domain::Customer::convert_back(
&(&state).into(),
@@ -2327,6 +2332,7 @@ pub async fn payout_create_db_entries(
pub async fn make_payout_data(
state: &SessionState,
merchant_account: &domain::MerchantAccount,
+ auth_profile_id: Option<String>,
key_store: &domain::MerchantKeyStore,
req: &payouts::PayoutRequest,
) -> RouterResult<PayoutData> {
@@ -2346,6 +2352,7 @@ pub async fn make_payout_data(
)
.await
.to_not_found_response(errors::ApiErrorResponse::PayoutNotFound)?;
+ core_utils::validate_profile_id_from_auth_layer(auth_profile_id, &payouts)?;
let payout_attempt_id = utils::get_payment_attempt_id(payout_id, payouts.attempt_count);
diff --git a/crates/router/src/core/refunds.rs b/crates/router/src/core/refunds.rs
index 9f8fc2e30a9..878ec241854 100644
--- a/crates/router/src/core/refunds.rs
+++ b/crates/router/src/core/refunds.rs
@@ -401,7 +401,7 @@ where
pub async fn refund_retrieve_core(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
key_store: domain::MerchantKeyStore,
request: refunds::RefundsRetrieveRequest,
) -> RouterResult<storage::Refund> {
@@ -419,7 +419,7 @@ pub async fn refund_retrieve_core(
)
.await
.to_not_found_response(errors::ApiErrorResponse::RefundNotFound)?;
-
+ core_utils::validate_profile_id_from_auth_layer(profile_id, &refund)?;
let payment_id = refund.payment_id.as_str();
payment_intent = db
.find_payment_intent_by_payment_id_merchant_id(
@@ -987,11 +987,15 @@ pub async fn refund_manual_update(
pub async fn get_filters_for_refunds(
state: SessionState,
merchant_account: domain::MerchantAccount,
- _profile_id_list: Option<Vec<String>>,
+ profile_id_list: Option<Vec<String>>,
) -> RouterResponse<api_models::refunds::RefundListFilters> {
let merchant_connector_accounts = if let services::ApplicationResponse::Json(data) =
- super::admin::list_payment_connectors(state, merchant_account.get_id().to_owned(), None)
- .await?
+ super::admin::list_payment_connectors(
+ state,
+ merchant_account.get_id().to_owned(),
+ profile_id_list,
+ )
+ .await?
{
data
} else {
diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs
index acedad05b67..7bc4505b973 100644
--- a/crates/router/src/core/utils.rs
+++ b/crates/router/src/core/utils.rs
@@ -1,4 +1,4 @@
-use std::{marker::PhantomData, str::FromStr};
+use std::{collections::HashSet, marker::PhantomData, str::FromStr};
use api_models::enums::{DisputeStage, DisputeStatus};
#[cfg(feature = "payouts")]
@@ -8,7 +8,10 @@ use common_enums::{IntentStatus, RequestIncrementalAuthorization};
use common_utils::{crypto::Encryptable, pii::Email};
use common_utils::{errors::CustomResult, ext_traits::AsyncExt, types::MinorUnit};
use error_stack::{report, ResultExt};
-use hyperswitch_domain_models::{payment_address::PaymentAddress, router_data::ErrorResponse};
+use hyperswitch_domain_models::{
+ merchant_connector_account::MerchantConnectorAccount, payment_address::PaymentAddress,
+ router_data::ErrorResponse,
+};
#[cfg(feature = "payouts")]
use masking::{ExposeInterface, PeekInterface};
use maud::{html, PreEscaped};
@@ -450,6 +453,64 @@ mod tests {
let generated_id = generate_id(consts::ID_LENGTH, "ref");
assert_eq!(generated_id.len(), consts::ID_LENGTH + 4)
}
+
+ #[test]
+ fn test_filter_objects_based_on_profile_id_list() {
+ #[derive(PartialEq, Debug, Clone)]
+ struct Object {
+ profile_id: Option<String>,
+ }
+
+ impl Object {
+ pub fn new(profile_id: &str) -> Self {
+ Self {
+ profile_id: Some(profile_id.to_string()),
+ }
+ }
+ }
+
+ impl GetProfileId for Object {
+ fn get_profile_id(&self) -> Option<&String> {
+ self.profile_id.as_ref()
+ }
+ }
+
+ // non empty object_list and profile_id_list
+ let object_list = vec![
+ Object::new("p1"),
+ Object::new("p2"),
+ Object::new("p2"),
+ Object::new("p4"),
+ Object::new("p5"),
+ ];
+ let profile_id_list = vec!["p1".to_string(), "p2".to_string(), "p3".to_string()];
+ let filtered_list =
+ filter_objects_based_on_profile_id_list(Some(profile_id_list), object_list.clone());
+ let expected_result = vec![Object::new("p1"), Object::new("p2"), Object::new("p2")];
+ assert_eq!(filtered_list, expected_result);
+
+ // non empty object_list and empty profile_id_list
+ let empty_profile_id_list = vec![];
+ let filtered_list = filter_objects_based_on_profile_id_list(
+ Some(empty_profile_id_list),
+ object_list.clone(),
+ );
+ let expected_result = vec![];
+ assert_eq!(filtered_list, expected_result);
+
+ // non empty object_list and None profile_id_list
+ let profile_id_list_as_none = None;
+ let filtered_list =
+ filter_objects_based_on_profile_id_list(profile_id_list_as_none, object_list);
+ let expected_result = vec![
+ Object::new("p1"),
+ Object::new("p2"),
+ Object::new("p2"),
+ Object::new("p4"),
+ Object::new("p5"),
+ ];
+ assert_eq!(filtered_list, expected_result);
+ }
}
// Dispute Stage can move linearly from PreDispute -> Dispute -> PreArbitration
@@ -1267,3 +1328,100 @@ pub fn get_incremental_authorization_allowed_value(
incremental_authorization_allowed
}
}
+
+pub(super) trait GetProfileId {
+ fn get_profile_id(&self) -> Option<&String>;
+}
+
+impl GetProfileId for MerchantConnectorAccount {
+ fn get_profile_id(&self) -> Option<&String> {
+ self.profile_id.as_ref()
+ }
+}
+
+impl GetProfileId for storage::PaymentIntent {
+ fn get_profile_id(&self) -> Option<&String> {
+ self.profile_id.as_ref()
+ }
+}
+
+impl<A> GetProfileId for (storage::PaymentIntent, A) {
+ fn get_profile_id(&self) -> Option<&String> {
+ self.0.get_profile_id()
+ }
+}
+
+impl GetProfileId for diesel_models::Dispute {
+ fn get_profile_id(&self) -> Option<&String> {
+ self.profile_id.as_ref()
+ }
+}
+
+impl GetProfileId for diesel_models::Refund {
+ fn get_profile_id(&self) -> Option<&String> {
+ self.profile_id.as_ref()
+ }
+}
+
+#[cfg(feature = "payouts")]
+impl GetProfileId for storage::Payouts {
+ fn get_profile_id(&self) -> Option<&String> {
+ Some(&self.profile_id)
+ }
+}
+#[cfg(feature = "payouts")]
+impl<T, F> GetProfileId for (storage::Payouts, T, F) {
+ fn get_profile_id(&self) -> Option<&String> {
+ self.0.get_profile_id()
+ }
+}
+
+/// Filter Objects based on profile ids
+pub(super) fn filter_objects_based_on_profile_id_list<T: GetProfileId>(
+ profile_id_list_auth_layer: Option<Vec<String>>,
+ object_list: Vec<T>,
+) -> Vec<T> {
+ if let Some(profile_id_list) = profile_id_list_auth_layer {
+ let profile_ids_to_filter: HashSet<_> = profile_id_list.iter().collect();
+ object_list
+ .into_iter()
+ .filter_map(|item| {
+ if item
+ .get_profile_id()
+ .is_some_and(|profile_id| profile_ids_to_filter.contains(profile_id))
+ {
+ Some(item)
+ } else {
+ None
+ }
+ })
+ .collect()
+ } else {
+ object_list
+ }
+}
+
+pub(super) fn validate_profile_id_from_auth_layer<T: GetProfileId + std::fmt::Debug>(
+ profile_id_auth_layer: Option<String>,
+ object: &T,
+) -> RouterResult<()> {
+ match (profile_id_auth_layer, object.get_profile_id()) {
+ (Some(auth_profile_id), Some(object_profile_id)) => {
+ auth_profile_id.eq(object_profile_id).then_some(()).ok_or(
+ errors::ApiErrorResponse::PreconditionFailed {
+ message: "Profile id authentication failed. Please use the correct JWT token"
+ .to_string(),
+ }
+ .into(),
+ )
+ }
+ (Some(_auth_profile_id), None) => RouterResult::Err(
+ errors::ApiErrorResponse::PreconditionFailed {
+ message: "Couldn't find profile_id in record for authentication".to_string(),
+ }
+ .into(),
+ )
+ .attach_printable(format!("Couldn't find profile_id in entity {:?}", object)),
+ (None, None) | (None, Some(_)) => Ok(()),
+ }
+}
diff --git a/crates/router/src/core/verification.rs b/crates/router/src/core/verification.rs
index 9294b8f83e9..795e188c8aa 100644
--- a/crates/router/src/core/verification.rs
+++ b/crates/router/src/core/verification.rs
@@ -12,7 +12,7 @@ pub async fn verify_merchant_creds_for_applepay(
state: SessionState,
body: verifications::ApplepayMerchantVerificationRequest,
merchant_id: common_utils::id_type::MerchantId,
- _profile_id: Option<String>,
+ profile_id: Option<String>,
) -> CustomResult<services::ApplicationResponse<ApplepayMerchantResponse>, errors::ApiErrorResponse>
{
let applepay_merchant_configs = state.conf.applepay_merchant_configs.get_inner();
@@ -62,6 +62,7 @@ pub async fn verify_merchant_creds_for_applepay(
utils::check_existence_and_add_domain_to_db(
&state,
merchant_id,
+ profile_id,
body.merchant_connector_account_id.clone(),
body.domain_names.clone(),
)
diff --git a/crates/router/src/core/verification/utils.rs b/crates/router/src/core/verification/utils.rs
index 43a4bfdc73b..dd0aa3edef4 100644
--- a/crates/router/src/core/verification/utils.rs
+++ b/crates/router/src/core/verification/utils.rs
@@ -2,7 +2,10 @@ use common_utils::errors::CustomResult;
use error_stack::{Report, ResultExt};
use crate::{
- core::errors::{self, utils::StorageErrorExt},
+ core::{
+ errors::{self, utils::StorageErrorExt},
+ utils,
+ },
logger,
routes::SessionState,
types,
@@ -12,6 +15,7 @@ use crate::{
pub async fn check_existence_and_add_domain_to_db(
state: &SessionState,
merchant_id: common_utils::id_type::MerchantId,
+ profile_id_from_auth_layer: Option<String>,
merchant_connector_id: String,
domain_from_req: Vec<String>,
) -> CustomResult<Vec<String>, errors::ApiErrorResponse> {
@@ -48,7 +52,10 @@ pub async fn check_existence_and_add_domain_to_db(
let _ = domain_from_req;
todo!()
};
-
+ utils::validate_profile_id_from_auth_layer(
+ profile_id_from_auth_layer,
+ &merchant_connector_account,
+ )?;
let mut already_verified_domains = merchant_connector_account
.applepay_verified_domains
.clone()
diff --git a/crates/router/src/core/webhooks/incoming.rs b/crates/router/src/core/webhooks/incoming.rs
index 223acf48b58..7c292d158ca 100644
--- a/crates/router/src/core/webhooks/incoming.rs
+++ b/crates/router/src/core/webhooks/incoming.rs
@@ -706,7 +706,8 @@ async fn payouts_incoming_webhook_flow(
});
let payout_data =
- payouts::make_payout_data(&state, &merchant_account, &key_store, &action_req).await?;
+ payouts::make_payout_data(&state, &merchant_account, None, &key_store, &action_req)
+ .await?;
let updated_payout_attempt = db
.update_payout_attempt(
diff --git a/crates/router/src/workflows/attach_payout_account_workflow.rs b/crates/router/src/workflows/attach_payout_account_workflow.rs
index 37de784d5e9..fa481fdb9d6 100644
--- a/crates/router/src/workflows/attach_payout_account_workflow.rs
+++ b/crates/router/src/workflows/attach_payout_account_workflow.rs
@@ -47,7 +47,7 @@ impl ProcessTrackerWorkflow<SessionState> for AttachPayoutAccountWorkflow {
let request = api::payouts::PayoutRequest::PayoutRetrieveRequest(tracking_data);
let mut payout_data =
- payouts::make_payout_data(state, &merchant_account, &key_store, &request).await?;
+ payouts::make_payout_data(state, &merchant_account, None, &key_store, &request).await?;
payouts::payouts_core(
state,
diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs
index c6cf82d784d..40dfcfd005e 100644
--- a/crates/router/src/workflows/outgoing_webhook_retry.rs
+++ b/crates/router/src/workflows/outgoing_webhook_retry.rs
@@ -505,7 +505,8 @@ async fn get_outgoing_webhook_content_and_event_type(
);
let payout_data =
- payouts::make_payout_data(&state, &merchant_account, &key_store, &request).await?;
+ payouts::make_payout_data(&state, &merchant_account, None, &key_store, &request)
+ .await?;
let router_response =
payouts::response_handler(&merchant_account, &payout_data).await?;
diff --git a/crates/router/src/workflows/payment_sync.rs b/crates/router/src/workflows/payment_sync.rs
index 5d93849b205..c536ec7e4e9 100644
--- a/crates/router/src/workflows/payment_sync.rs
+++ b/crates/router/src/workflows/payment_sync.rs
@@ -67,6 +67,7 @@ impl ProcessTrackerWorkflow<SessionState> for PaymentsSyncWorkflow {
state,
state.get_req_state(),
merchant_account.clone(),
+ None,
key_store.clone(),
operations::PaymentStatus,
tracking_data.clone(),
|
feat
|
use profile_id passed from auth layer within core functions (#5553)
|
1407049b56bd07237b2f9ad6c12a92837995abfa
|
2023-09-11 21:04:37
|
Sakil Mostak
|
fix(core): [Bluesnap] Add secondary_base_url for script (#2124)
| false
|
diff --git a/config/config.example.toml b/config/config.example.toml
index 97a50672cf6..2d84d4f3843 100644
--- a/config/config.example.toml
+++ b/config/config.example.toml
@@ -159,6 +159,7 @@ authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api"
bambora.base_url = "https://api.na.bambora.com"
bitpay.base_url = "https://test.bitpay.com"
bluesnap.base_url = "https://sandbox.bluesnap.com/"
+bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/"
boku.base_url = "https://$-api4-stage.boku.com"
braintree.base_url = "https://api.sandbox.braintreegateway.com/"
braintree.secondary_base_url = "https://payments.sandbox.braintree-api.com/graphql"
diff --git a/config/development.toml b/config/development.toml
index f1363d22358..44eba5f93d4 100644
--- a/config/development.toml
+++ b/config/development.toml
@@ -135,6 +135,7 @@ authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api"
bambora.base_url = "https://api.na.bambora.com"
bitpay.base_url = "https://test.bitpay.com"
bluesnap.base_url = "https://sandbox.bluesnap.com/"
+bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/"
boku.base_url = "https://$-api4-stage.boku.com"
braintree.base_url = "https://api.sandbox.braintreegateway.com/"
braintree.secondary_base_url = "https://payments.sandbox.braintree-api.com/graphql"
diff --git a/config/docker_compose.toml b/config/docker_compose.toml
index 66f7e7e8ac3..adc41e1bb37 100644
--- a/config/docker_compose.toml
+++ b/config/docker_compose.toml
@@ -80,6 +80,7 @@ authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api"
bambora.base_url = "https://api.na.bambora.com"
bitpay.base_url = "https://test.bitpay.com"
bluesnap.base_url = "https://sandbox.bluesnap.com/"
+bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/"
boku.base_url = "https://$-api4-stage.boku.com"
braintree.base_url = "https://api.sandbox.braintreegateway.com/"
braintree.secondary_base_url = "https://payments.sandbox.braintree-api.com/graphql"
diff --git a/crates/router/src/compatibility/wrap.rs b/crates/router/src/compatibility/wrap.rs
index 890c9435ede..d8e84de2d50 100644
--- a/crates/router/src/compatibility/wrap.rs
+++ b/crates/router/src/compatibility/wrap.rs
@@ -110,14 +110,18 @@ where
),
}
}
- Ok(api::ApplicationResponse::Form(redirection_data)) => api::build_redirection_form(
- &redirection_data.redirect_form,
- redirection_data.payment_method_data,
- redirection_data.amount,
- redirection_data.currency,
- )
- .respond_to(request)
- .map_into_boxed_body(),
+ Ok(api::ApplicationResponse::Form(redirection_data)) => {
+ let config = state.conf();
+ api::build_redirection_form(
+ &redirection_data.redirect_form,
+ redirection_data.payment_method_data,
+ redirection_data.amount,
+ redirection_data.currency,
+ config,
+ )
+ .respond_to(request)
+ .map_into_boxed_body()
+ }
Err(error) => api::log_and_return_error_response(error),
};
diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs
index 20e33783e43..3739afc7671 100644
--- a/crates/router/src/configs/settings.rs
+++ b/crates/router/src/configs/settings.rs
@@ -486,7 +486,7 @@ pub struct Connectors {
pub authorizedotnet: ConnectorParams,
pub bambora: ConnectorParams,
pub bitpay: ConnectorParams,
- pub bluesnap: ConnectorParams,
+ pub bluesnap: ConnectorParamsWithSecondaryBaseUrl,
pub boku: ConnectorParams,
pub braintree: ConnectorParams,
pub cashtocode: ConnectorParams,
@@ -551,7 +551,6 @@ pub struct ConnectorParamsWithFileUploadUrl {
pub base_url_file_upload: String,
}
-#[cfg(feature = "payouts")]
#[derive(Debug, Deserialize, Clone, Default, router_derive::ConfigValidate)]
#[serde(default)]
pub struct ConnectorParamsWithSecondaryBaseUrl {
diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs
index 2c844958fdf..2f1f4323d81 100644
--- a/crates/router/src/services/api.rs
+++ b/crates/router/src/services/api.rs
@@ -23,7 +23,7 @@ use serde_json::json;
use self::request::{ContentType, HeaderExt, RequestBuilderExt};
pub use self::request::{Method, Request, RequestBuilder};
use crate::{
- configs::settings::Connectors,
+ configs::settings::{Connectors, Settings},
consts,
core::{
errors::{self, CustomResult},
@@ -802,14 +802,18 @@ where
),
}
}
- Ok(ApplicationResponse::Form(redirection_data)) => build_redirection_form(
- &redirection_data.redirect_form,
- redirection_data.payment_method_data,
- redirection_data.amount,
- redirection_data.currency,
- )
- .respond_to(request)
- .map_into_boxed_body(),
+ Ok(ApplicationResponse::Form(redirection_data)) => {
+ let config = state.conf();
+ build_redirection_form(
+ &redirection_data.redirect_form,
+ redirection_data.payment_method_data,
+ redirection_data.amount,
+ redirection_data.currency,
+ config,
+ )
+ .respond_to(request)
+ .map_into_boxed_body()
+ }
Ok(ApplicationResponse::JsonWithHeaders((response, headers))) => {
match serde_json::to_string(&response) {
Ok(res) => http_response_json_with_headers(res, headers),
@@ -980,6 +984,7 @@ pub fn build_redirection_form(
payment_method_data: Option<api_models::payments::PaymentMethodData>,
amount: String,
currency: String,
+ config: Settings,
) -> maud::Markup {
use maud::PreEscaped;
@@ -1062,12 +1067,14 @@ pub fn build_redirection_form(
} else {
"".to_string()
};
+
+ let bluesnap_url = config.connectors.bluesnap.secondary_base_url;
maud::html! {
(maud::DOCTYPE)
html {
head {
meta name="viewport" content="width=device-width, initial-scale=1";
- (PreEscaped(r#"<script src="https://sandpay.bluesnap.com/web-sdk/5/bluesnap.js"></script>"#))
+ (PreEscaped(format!("<script src=\"{bluesnap_url}web-sdk/5/bluesnap.js\"></script>")))
}
body style="background-color: #ffffff; padding: 20px; font-family: Arial, Helvetica, Sans-Serif;" {
diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml
index 62a3781ba4b..32a602d4fff 100644
--- a/loadtest/config/development.toml
+++ b/loadtest/config/development.toml
@@ -66,6 +66,7 @@ authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api"
bambora.base_url = "https://api.na.bambora.com"
bitpay.base_url = "https://test.bitpay.com"
bluesnap.base_url = "https://sandbox.bluesnap.com/"
+bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/"
boku.base_url = "https://country-api4-stage.boku.com"
braintree.base_url = "https://api.sandbox.braintreegateway.com/"
braintree.secondary_base_url = "https://payments.sandbox.braintree-api.com/graphql"
|
fix
|
[Bluesnap] Add secondary_base_url for script (#2124)
|
b7bf457d0cdcc4d4947b5750a7982aca85d3a7e9
|
2024-06-24 19:36:13
|
Narayan Bhat
|
fix(access_token): use `merchant_connector_id` in access token (#5106)
| false
|
diff --git a/crates/router/src/core/refunds.rs b/crates/router/src/core/refunds.rs
index b88efe527bb..d78dfcc0927 100644
--- a/crates/router/src/core/refunds.rs
+++ b/crates/router/src/core/refunds.rs
@@ -447,7 +447,7 @@ pub async fn sync_refund_with_gateway(
&state.conf.connectors,
&connector_id,
api::GetToken::Connector,
- payment_attempt.connector.clone(),
+ payment_attempt.merchant_connector_id.clone(),
)
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to get the connector")?;
|
fix
|
use `merchant_connector_id` in access token (#5106)
|
5fe96d4d9683d8eae25f214f3823d3765dce326a
|
2023-08-09 12:33:54
|
Amisha Prabhat
|
refactor(connector): update the `connector_template` (#1895)
| false
|
diff --git a/connector-template/mod.rs b/connector-template/mod.rs
index 67745e8b4ce..af58abbf923 100644
--- a/connector-template/mod.rs
+++ b/connector-template/mod.rs
@@ -1,4 +1,4 @@
-mod transformers;
+pub mod transformers;
use std::fmt::Debug;
use error_stack::{ResultExt, IntoReport};
@@ -77,14 +77,6 @@ impl ConnectorCommon for {{project-name | downcase | pascal_case}} {
fn base_url<'a>(&self, connectors: &'a settings::Connectors) -> &'a str {
connectors.{{project-name}}.base_url.as_ref()
}
-
- fn validate_auth_type(
- &self,
- val: &types::ConnectorAuthType,
- ) -> Result<(), error_stack::Report<errors::ConnectorError>> {
- {{project-name | downcase}}::{{project-name | downcase | pascal_case}}AuthType::try_from(val)?;
- Ok(())
- }
fn get_auth_header(&self, auth_type:&types::ConnectorAuthType)-> CustomResult<Vec<(String,request::Maskable<String>)>,errors::ConnectorError> {
let auth = {{project-name | downcase}}::{{project-name | downcase | pascal_case}}AuthType::try_from(auth_type)
|
refactor
|
update the `connector_template` (#1895)
|
90fbb62ecd418b85804c6ae824843237ff740302
|
2025-02-18 05:56:58
|
github-actions
|
chore(version): 2025.02.18.0
| false
|
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d514121ec75..704fda9678b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,20 @@ All notable changes to HyperSwitch will be documented here.
- - -
+## 2025.02.18.0
+
+### Features
+
+- **coingate:** Add Crypto Pay Flow ([#7247](https://github.com/juspay/hyperswitch/pull/7247)) ([`c868ff3`](https://github.com/juspay/hyperswitch/commit/c868ff38e0234fa83f1615e751af12cb7d32a3d9))
+
+### Refactors
+
+- **utils:** Use to_state_code of hyperswitch_connectors in router ([#7278](https://github.com/juspay/hyperswitch/pull/7278)) ([`b97370d`](https://github.com/juspay/hyperswitch/commit/b97370d59fd167af9c24f4470f4668ce2ee76a89))
+
+**Full Changelog:** [`2025.02.15.0...2025.02.18.0`](https://github.com/juspay/hyperswitch/compare/2025.02.15.0...2025.02.18.0)
+
+- - -
+
## 2025.02.15.0
### Features
|
chore
|
2025.02.18.0
|
5952017260180f0b52f989b60ff678868267a634
|
2024-02-21 19:10:22
|
Hrithikesh
|
fix(core): validate capture method before update trackers (#3715)
| false
|
diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs
index 7842678a92a..d7d122c3252 100644
--- a/crates/router/src/core/payments/flows/authorize_flow.rs
+++ b/crates/router/src/core/payments/flows/authorize_flow.rs
@@ -72,13 +72,6 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu
types::PaymentsAuthorizeData,
types::PaymentsResponseData,
> = connector.connector.get_connector_integration();
- connector
- .connector
- .validate_capture_method(
- self.request.capture_method,
- self.request.payment_method_type,
- )
- .to_payment_failed_response()?;
if self.should_proceed_with_authorize() {
self.decide_authentication_type();
@@ -210,13 +203,19 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu
) -> RouterResult<(Option<services::Request>, bool)> {
match call_connector_action {
payments::CallConnectorAction::Trigger => {
+ connector
+ .connector
+ .validate_capture_method(
+ self.request.capture_method,
+ self.request.payment_method_type,
+ )
+ .to_payment_failed_response()?;
let connector_integration: services::BoxedConnectorIntegration<
'_,
api::Authorize,
types::PaymentsAuthorizeData,
types::PaymentsResponseData,
> = connector.connector.get_connector_integration();
-
connector_integration
.execute_pretasks(self, state)
.await
|
fix
|
validate capture method before update trackers (#3715)
|
1eaba9a10b11a4f1d540e0a848a798c81e3f6fd1
|
2024-06-04 20:29:11
|
DEEPANSHU BANSAL
|
feat(connector): [CRYPTOPAY] Make payment_method_data.crypto.network as enum (#4853)
| false
|
diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs
index 81e50b020e7..c2969a16612 100644
--- a/crates/api_models/src/enums.rs
+++ b/crates/api_models/src/enums.rs
@@ -430,6 +430,7 @@ pub enum FieldType {
UserCountryCode, //phone number's country code
UserCountry { options: Vec<String> }, //for country inside payment method data ex- bank redirect
UserCurrency { options: Vec<String> },
+ UserCryptoCurrencyNetwork, //for crypto network associated with the cryptopcurrency
UserBillingName,
UserAddressLine1,
UserAddressLine2,
@@ -504,6 +505,7 @@ impl PartialEq for FieldType {
options: options_other,
},
) => options_self.eq(options_other),
+ (Self::UserCryptoCurrencyNetwork, Self::UserCryptoCurrencyNetwork) => true,
(Self::UserBillingName, Self::UserBillingName) => true,
(Self::UserAddressLine1, Self::UserAddressLine1) => true,
(Self::UserAddressLine2, Self::UserAddressLine2) => true,
diff --git a/crates/router/src/configs/defaults.rs b/crates/router/src/configs/defaults.rs
index 7177488cb3c..2c02dddaab0 100644
--- a/crates/router/src/configs/defaults.rs
+++ b/crates/router/src/configs/defaults.rs
@@ -8303,7 +8303,7 @@ impl Default for super::settings::RequiredFields {
RequiredFieldInfo {
required_field: "payment_method_data.crypto.network".to_string(),
display_name: "network".to_string(),
- field_type: enums::FieldType::Text,
+ field_type: enums::FieldType::UserCryptoCurrencyNetwork,
value: None,
}
),
diff --git a/openapi/openapi_spec.json b/openapi/openapi_spec.json
index 560f61bc265..87f05f3b675 100644
--- a/openapi/openapi_spec.json
+++ b/openapi/openapi_spec.json
@@ -9296,6 +9296,12 @@
}
}
},
+ {
+ "type": "string",
+ "enum": [
+ "user_crypto_currency_network"
+ ]
+ },
{
"type": "string",
"enum": [
|
feat
|
[CRYPTOPAY] Make payment_method_data.crypto.network as enum (#4853)
|
d93f65fd95a73b75d93290ac23ea4f73f22e6a7e
|
2024-06-12 00:05:31
|
Kiran Kumar
|
feat(connector): implement auth and post auth flows for gpayments (#4746)
| false
|
diff --git a/crates/router/src/connector/gpayments.rs b/crates/router/src/connector/gpayments.rs
index 4d72788a2d2..e628779cd97 100644
--- a/crates/router/src/connector/gpayments.rs
+++ b/crates/router/src/connector/gpayments.rs
@@ -9,6 +9,7 @@ use transformers as gpayments;
use crate::{
configs::settings,
+ connector::{gpayments::gpayments_types::GpaymentsConnectorMetaData, utils::to_connector_meta},
core::errors::{self, CustomResult},
events::connector_api_logs::ConnectorEvent,
headers, services,
@@ -214,8 +215,103 @@ impl
types::authentication::AuthenticationResponseData,
> for Gpayments
{
-}
+ fn get_headers(
+ &self,
+ req: &types::authentication::ConnectorAuthenticationRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ req: &types::authentication::ConnectorAuthenticationRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ let connector_metadata: GpaymentsConnectorMetaData = to_connector_meta(
+ req.request
+ .pre_authentication_data
+ .connector_metadata
+ .clone(),
+ )?;
+ Ok(connector_metadata.authentication_url)
+ }
+
+ fn get_request_body(
+ &self,
+ req: &types::authentication::ConnectorAuthenticationRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<RequestContent, errors::ConnectorError> {
+ let connector_router_data = gpayments::GpaymentsRouterData::try_from((0, req))?;
+ let req_obj =
+ gpayments_types::GpaymentsAuthenticationRequest::try_from(&connector_router_data)?;
+ Ok(RequestContent::Json(Box::new(req_obj)))
+ }
+ fn build_request(
+ &self,
+ req: &types::authentication::ConnectorAuthenticationRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ let gpayments_auth_type = gpayments::GpaymentsAuthType::try_from(&req.connector_auth_type)?;
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Post)
+ .url(
+ &types::authentication::ConnectorAuthenticationType::get_url(
+ self, req, connectors,
+ )?,
+ )
+ .attach_default_headers()
+ .headers(
+ types::authentication::ConnectorAuthenticationType::get_headers(
+ self, req, connectors,
+ )?,
+ )
+ .set_body(
+ types::authentication::ConnectorAuthenticationType::get_request_body(
+ self, req, connectors,
+ )?,
+ )
+ .add_certificate(Some(gpayments_auth_type.certificate))
+ .add_certificate_key(Some(gpayments_auth_type.private_key))
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::authentication::ConnectorAuthenticationRouterData,
+ event_builder: Option<&mut ConnectorEvent>,
+ res: Response,
+ ) -> CustomResult<
+ types::authentication::ConnectorAuthenticationRouterData,
+ errors::ConnectorError,
+ > {
+ let response: gpayments_types::GpaymentsAuthenticationSuccessResponse = res
+ .response
+ .parse_struct("gpayments GpaymentsAuthenticationResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ }
+ fn get_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res, event_builder)
+ }
+}
impl
ConnectorIntegration<
api::PostAuthentication,
@@ -223,6 +319,92 @@ impl
types::authentication::AuthenticationResponseData,
> for Gpayments
{
+ fn get_headers(
+ &self,
+ req: &types::authentication::ConnectorPostAuthenticationRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ req: &types::authentication::ConnectorPostAuthenticationRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ let base_url = build_endpoint(self.base_url(connectors), &req.connector_meta_data)?;
+ Ok(format!(
+ "{}/api/v2/auth/brw/result?threeDSServerTransID={}",
+ base_url, req.request.threeds_server_transaction_id,
+ ))
+ }
+
+ fn build_request(
+ &self,
+ req: &types::authentication::ConnectorPostAuthenticationRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ let gpayments_auth_type = gpayments::GpaymentsAuthType::try_from(&req.connector_auth_type)?;
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Get)
+ .url(
+ &types::authentication::ConnectorPostAuthenticationType::get_url(
+ self, req, connectors,
+ )?,
+ )
+ .attach_default_headers()
+ .headers(
+ types::authentication::ConnectorPostAuthenticationType::get_headers(
+ self, req, connectors,
+ )?,
+ )
+ .add_certificate(Some(gpayments_auth_type.certificate))
+ .add_certificate_key(Some(gpayments_auth_type.private_key))
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::authentication::ConnectorPostAuthenticationRouterData,
+ event_builder: Option<&mut ConnectorEvent>,
+ res: Response,
+ ) -> CustomResult<
+ types::authentication::ConnectorPostAuthenticationRouterData,
+ errors::ConnectorError,
+ > {
+ let response: gpayments_types::GpaymentsPostAuthenticationResponse = res
+ .response
+ .parse_struct("gpayments PaymentsSyncResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+ Ok(
+ types::authentication::ConnectorPostAuthenticationRouterData {
+ response: Ok(
+ types::authentication::AuthenticationResponseData::PostAuthNResponse {
+ trans_status: response.trans_status.into(),
+ authentication_value: response.authentication_value,
+ eci: response.eci,
+ },
+ ),
+ ..data.clone()
+ },
+ )
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res, event_builder)
+ }
}
impl
diff --git a/crates/router/src/connector/gpayments/gpayments_types.rs b/crates/router/src/connector/gpayments/gpayments_types.rs
index c95e778bcbe..cb436fe8830 100644
--- a/crates/router/src/connector/gpayments/gpayments_types.rs
+++ b/crates/router/src/connector/gpayments/gpayments_types.rs
@@ -1,13 +1,13 @@
+use api_models::payments::ThreeDsCompletionIndicator;
use cards::CardNumber;
use common_utils::types;
-use masking::{Deserialize, Serialize};
+use masking::{Deserialize, Secret, Serialize};
#[derive(Debug, Serialize, Deserialize)]
pub struct GpaymentsConnectorMetaData {
pub authentication_url: String,
pub three_ds_requestor_trans_id: Option<String>,
}
-
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct GpaymentsPreAuthVersionCallRequest {
@@ -38,6 +38,9 @@ pub struct TDS2ApiError {
pub error_description: String,
pub error_detail: Option<String>,
pub error_message_type: Option<String>,
+ /// Always returns 'Error' to indicate that this message is an error.
+ ///
+ /// Example: "Error"
pub message_type: String,
pub message_version: Option<String>,
#[serde(rename = "sdkTransID")]
@@ -122,3 +125,112 @@ pub struct GpaymentsPreAuthenticationResponse {
#[serde(rename = "threeDSServerTransID")]
pub three_ds_server_trans_id: String,
}
+
+#[derive(Serialize, Deserialize, Debug, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct GpaymentsAuthenticationRequest {
+ pub acct_number: CardNumber,
+ pub authentication_ind: String,
+ pub browser_info_collected: BrowserInfoCollected,
+ pub card_expiry_date: String,
+ #[serde(rename = "notificationURL")]
+ pub notification_url: String,
+ pub merchant_id: String,
+ #[serde(rename = "threeDSCompInd")]
+ pub three_ds_comp_ind: ThreeDsCompletionIndicator,
+ pub message_category: String,
+ pub purchase_amount: String,
+ pub purchase_date: String,
+ #[serde(rename = "threeDSServerTransID")]
+ pub three_ds_server_trans_id: String,
+}
+#[derive(Serialize, Deserialize, Debug, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct BrowserInfoCollected {
+ pub browser_accept_header: Option<String>,
+ pub browser_color_depth: Option<String>,
+ #[serde(rename = "browserIP")]
+ pub browser_ip: Option<Secret<String, common_utils::pii::IpAddress>>,
+ pub browser_javascript_enabled: Option<bool>,
+ pub browser_java_enabled: Option<bool>,
+ pub browser_language: Option<String>,
+ pub browser_screen_height: Option<String>,
+ pub browser_screen_width: Option<String>,
+ #[serde(rename = "browserTZ")]
+ pub browser_tz: Option<String>,
+ pub browser_user_agent: Option<String>,
+}
+
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub enum AuthenticationInd {
+ #[serde(rename = "01")]
+ PaymentTransaction,
+ #[serde(rename = "02")]
+ RecurringTransaction,
+ #[serde(rename = "03")]
+ InstalmentTransaction,
+ #[serde(rename = "04")]
+ AddCard,
+ #[serde(rename = "05")]
+ MaintainCard,
+ #[serde(rename = "06")]
+ CardholderVerification,
+}
+
+#[derive(Serialize, Deserialize, Debug, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct GpaymentsAuthenticationSuccessResponse {
+ #[serde(rename = "dsReferenceNumber")]
+ pub ds_reference_number: String,
+ #[serde(rename = "dsTransID")]
+ pub ds_trans_id: String,
+ #[serde(rename = "threeDSServerTransID")]
+ pub three_ds_server_trans_id: String,
+ #[serde(rename = "messageVersion")]
+ pub message_version: String,
+ #[serde(rename = "transStatus")]
+ pub trans_status: AuthStatus,
+ #[serde(rename = "acsTransID")]
+ pub acs_trans_id: String,
+ #[serde(rename = "challengeUrl")]
+ pub acs_url: Option<url::Url>,
+ #[serde(rename = "acsReferenceNumber")]
+ pub acs_reference_number: String,
+ pub authentication_value: Option<String>,
+}
+
+#[derive(Deserialize, Debug, Clone, Serialize, PartialEq)]
+pub enum AuthStatus {
+ /// Authentication/ Account Verification Successful
+ Y,
+ /// Not Authenticated /Account Not Verified; Transaction denied
+ N,
+ /// Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq
+ U,
+ /// Attempts Processing Performed; Not Authenticated/Verified , but a proof of attempted authentication/verification is provided
+ A,
+ /// Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and request that authorisation not be attempted.
+ R,
+ /// Challenge required
+ C,
+}
+
+impl From<AuthStatus> for common_enums::TransactionStatus {
+ fn from(value: AuthStatus) -> Self {
+ match value {
+ AuthStatus::Y => Self::Success,
+ AuthStatus::N => Self::Failure,
+ AuthStatus::U => Self::VerificationNotPerformed,
+ AuthStatus::A => Self::NotVerified,
+ AuthStatus::R => Self::Rejected,
+ AuthStatus::C => Self::ChallengeRequired,
+ }
+ }
+}
+#[derive(Debug, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct GpaymentsPostAuthenticationResponse {
+ pub authentication_value: Option<String>,
+ pub trans_status: AuthStatus,
+ pub eci: Option<String>,
+}
diff --git a/crates/router/src/connector/gpayments/transformers.rs b/crates/router/src/connector/gpayments/transformers.rs
index ee98d26e388..c6bce775e8f 100644
--- a/crates/router/src/connector/gpayments/transformers.rs
+++ b/crates/router/src/connector/gpayments/transformers.rs
@@ -1,16 +1,25 @@
+use api_models::payments::DeviceChannel;
+use base64::Engine;
+use common_utils::date_time;
use error_stack::ResultExt;
-use masking::Secret;
-use serde::{Deserialize, Serialize};
+use masking::{ExposeInterface, Secret};
+use serde::Deserialize;
+use serde_json::to_string;
use super::gpayments_types;
use crate::{
- connector::utils,
- consts,
+ connector::{
+ gpayments::gpayments_types::{
+ AuthStatus, BrowserInfoCollected, GpaymentsAuthenticationSuccessResponse,
+ },
+ utils,
+ utils::{get_card_details, CardData},
+ },
+ consts::BASE64_ENGINE,
core::errors,
- types::{self, api},
+ types::{self, api, api::MessageCategory, authentication::ChallengeParams},
};
-//TODO: Fill the struct with respective fields
pub struct GpaymentsRouterData<T> {
pub amount: i64, // The type of amount that a connector accepts, for example, String, i64, f64, etc.
pub router_data: T,
@@ -26,7 +35,6 @@ impl<T> TryFrom<(i64, T)> for GpaymentsRouterData<T> {
}
}
-//TODO: Fill the struct with respective fields
// Auth Struct
pub struct GpaymentsAuthType {
/// base64 encoded certificate
@@ -68,15 +76,6 @@ impl TryFrom<&GpaymentsRouterData<&types::authentication::PreAuthNVersionCallRou
}
}
-//TODO: Fill the struct with respective fields
-#[derive(Default, Debug, Serialize, Deserialize, PartialEq)]
-pub struct GpaymentsErrorResponse {
- pub status_code: u16,
- pub code: String,
- pub message: String,
- pub reason: Option<String>,
-}
-
#[derive(Deserialize, PartialEq)]
pub struct GpaymentsMetaData {
pub endpoint_prefix: String,
@@ -146,11 +145,9 @@ impl TryFrom<&GpaymentsRouterData<&types::authentication::PreAuthNRouterData>>
acct_number: router_data.request.card_holder_account_number.clone(),
card_scheme: None,
challenge_window_size: Some(gpayments_types::ChallengeWindowSize::FullScreen),
- // This is a required field but we don't listen to event callbacks
event_callback_url: "https://webhook.site/55e3db24-7c4e-4432-9941-d806f68d210b"
.to_string(),
merchant_id: metadata.merchant_id,
- // Since this feature is not in our favour, hard coded it to true
skip_auto_browser_info_collect: Some(true),
// should auto generate this id.
three_ds_requestor_trans_id: uuid::Uuid::new_v4().hyphenated().to_string(),
@@ -158,6 +155,151 @@ impl TryFrom<&GpaymentsRouterData<&types::authentication::PreAuthNRouterData>>
}
}
+impl TryFrom<&GpaymentsRouterData<&types::authentication::ConnectorAuthenticationRouterData>>
+ for gpayments_types::GpaymentsAuthenticationRequest
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+
+ fn try_from(
+ item: &GpaymentsRouterData<&types::authentication::ConnectorAuthenticationRouterData>,
+ ) -> Result<Self, Self::Error> {
+ let request = &item.router_data.request;
+ let browser_details = match request.browser_details.clone() {
+ Some(details) => Ok::<Option<types::BrowserInformation>, Self::Error>(Some(details)),
+ None => {
+ if request.device_channel == DeviceChannel::Browser {
+ Err(errors::ConnectorError::MissingRequiredField {
+ field_name: "browser_info",
+ })?
+ } else {
+ Ok(None)
+ }
+ }
+ }?;
+ let card_details = get_card_details(request.payment_method_data.clone(), "gpayments")?;
+
+ let metadata = GpaymentsMetaData::try_from(&item.router_data.connector_meta_data)?;
+
+ Ok(Self {
+ acct_number: card_details.card_number.clone(),
+ authentication_ind: "01".into(),
+ card_expiry_date: card_details.get_expiry_date_as_yymm()?.expose(),
+ merchant_id: metadata.merchant_id,
+ message_category: match item.router_data.request.message_category.clone() {
+ MessageCategory::Payment => "01".into(),
+ MessageCategory::NonPayment => "02".into(),
+ },
+ notification_url: request
+ .return_url
+ .clone()
+ .ok_or(errors::ConnectorError::RequestEncodingFailed)
+ .attach_printable("missing return_url")?,
+ three_ds_comp_ind: request.threeds_method_comp_ind.clone(),
+ purchase_amount: item.amount.to_string(),
+ purchase_date: date_time::DateTime::<date_time::YYYYMMDDHHmmss>::from(date_time::now())
+ .to_string(),
+ three_ds_server_trans_id: request
+ .pre_authentication_data
+ .threeds_server_transaction_id
+ .clone(),
+ browser_info_collected: BrowserInfoCollected {
+ browser_javascript_enabled: browser_details
+ .as_ref()
+ .and_then(|details| details.java_script_enabled),
+ browser_accept_header: browser_details
+ .as_ref()
+ .and_then(|details| details.accept_header.clone()),
+ browser_ip: browser_details
+ .clone()
+ .and_then(|details| details.ip_address.map(|ip| Secret::new(ip.to_string()))),
+ browser_java_enabled: browser_details
+ .as_ref()
+ .and_then(|details| details.java_enabled),
+ browser_language: browser_details
+ .as_ref()
+ .and_then(|details| details.language.clone()),
+ browser_color_depth: browser_details
+ .as_ref()
+ .and_then(|details| details.color_depth.map(|a| a.to_string())),
+ browser_screen_height: browser_details
+ .as_ref()
+ .and_then(|details| details.screen_height.map(|a| a.to_string())),
+ browser_screen_width: browser_details
+ .as_ref()
+ .and_then(|details| details.screen_width.map(|a| a.to_string())),
+ browser_tz: browser_details
+ .as_ref()
+ .and_then(|details| details.time_zone.map(|a| a.to_string())),
+ browser_user_agent: browser_details
+ .as_ref()
+ .and_then(|details| details.user_agent.clone().map(|a| a.to_string())),
+ },
+ })
+ }
+}
+impl
+ TryFrom<
+ types::ResponseRouterData<
+ api::Authentication,
+ GpaymentsAuthenticationSuccessResponse,
+ types::authentication::ConnectorAuthenticationRequestData,
+ types::authentication::AuthenticationResponseData,
+ >,
+ > for types::authentication::ConnectorAuthenticationRouterData
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: types::ResponseRouterData<
+ api::Authentication,
+ GpaymentsAuthenticationSuccessResponse,
+ types::authentication::ConnectorAuthenticationRequestData,
+ types::authentication::AuthenticationResponseData,
+ >,
+ ) -> Result<Self, Self::Error> {
+ let response_auth = item.response;
+ let creq = serde_json::json!({
+ "threeDSServerTransID": response_auth.three_ds_server_trans_id,
+ "acsTransID": response_auth.acs_trans_id,
+ "messageVersion": response_auth.message_version,
+ "messageType": "CReq",
+ "challengeWindowSize": "01",
+ });
+ let creq_str = to_string(&creq)
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)
+ .attach_printable("error while constructing creq_str")?;
+ let creq_base64 = Engine::encode(&BASE64_ENGINE, creq_str)
+ .trim_end_matches('=')
+ .to_owned();
+ let response: Result<
+ types::authentication::AuthenticationResponseData,
+ types::ErrorResponse,
+ > = Ok(
+ types::authentication::AuthenticationResponseData::AuthNResponse {
+ trans_status: response_auth.trans_status.clone().into(),
+ authn_flow_type: if response_auth.trans_status == AuthStatus::C {
+ types::authentication::AuthNFlowType::Challenge(Box::new(ChallengeParams {
+ acs_url: response_auth.acs_url,
+ challenge_request: Some(creq_base64),
+ acs_reference_number: Some(response_auth.acs_reference_number.clone()),
+ acs_trans_id: Some(response_auth.acs_trans_id.clone()),
+ three_dsserver_trans_id: Some(response_auth.three_ds_server_trans_id),
+ acs_signed_content: None,
+ }))
+ } else {
+ types::authentication::AuthNFlowType::Frictionless
+ },
+ authentication_value: response_auth.authentication_value,
+ ds_trans_id: Some(response_auth.ds_trans_id),
+ connector_metadata: None,
+ },
+ );
+ Ok(Self {
+ response,
+ ..item.data.clone()
+ })
+ }
+}
+
impl
TryFrom<
types::ResponseRouterData<
@@ -186,11 +328,11 @@ impl
"threeDSServerTransID": threeds_method_response.three_ds_server_trans_id,
"threeDSMethodNotificationURL": "https://webhook.site/bd06863d-82c2-42ea-b35b-5ffd5ecece71"
});
- serde_json::to_string(&three_ds_method_data_json)
+ to_string(&three_ds_method_data_json)
.change_context(errors::ConnectorError::ResponseDeserializationFailed)
.attach_printable("error while constructing three_ds_method_data_str")
.map(|three_ds_method_data_string| {
- base64::Engine::encode(&consts::BASE64_ENGINE, three_ds_method_data_string)
+ Engine::encode(&BASE64_ENGINE, three_ds_method_data_string)
})
})
.transpose()?;
|
feat
|
implement auth and post auth flows for gpayments (#4746)
|
53697fb472d6e236d57aef6883a6b11a0e9232f1
|
2024-04-12 15:43:01
|
Amisha Prabhat
|
feat(core): create mandates with payment_token (#4342)
| false
|
diff --git a/crates/router/src/core/mandate/helpers.rs b/crates/router/src/core/mandate/helpers.rs
index 704b7ae99f5..c15969fd1c8 100644
--- a/crates/router/src/core/mandate/helpers.rs
+++ b/crates/router/src/core/mandate/helpers.rs
@@ -1,3 +1,4 @@
+use api_models::payments as api_payments;
use common_enums::enums;
use common_utils::errors::CustomResult;
use data_models::mandates::MandateData;
@@ -7,7 +8,7 @@ use error_stack::ResultExt;
use crate::{
core::{errors, payments},
routes::AppState,
- types::domain,
+ types::{api, domain},
};
pub async fn get_profile_id_for_mandate(
@@ -40,6 +41,40 @@ pub async fn get_profile_id_for_mandate(
Ok(profile_id)
}
+pub fn get_mandate_type(
+ mandate_data: Option<api_payments::MandateData>,
+ off_session: Option<bool>,
+ setup_future_usage: Option<enums::FutureUsage>,
+ customer_acceptance: Option<api_payments::CustomerAcceptance>,
+ token: Option<String>,
+) -> CustomResult<Option<api::MandateTransactionType>, errors::ValidationError> {
+ match (
+ mandate_data.clone(),
+ off_session,
+ setup_future_usage,
+ customer_acceptance.or(mandate_data.and_then(|m_data| m_data.customer_acceptance)),
+ token,
+ ) {
+ (Some(_), Some(_), Some(enums::FutureUsage::OffSession), Some(_), Some(_)) => {
+ Err(errors::ValidationError::InvalidValue {
+ message: "Expected one out of recurring_details and mandate_data but got both"
+ .to_string(),
+ }
+ .into())
+ }
+ (_, _, Some(enums::FutureUsage::OffSession), Some(_), Some(_))
+ | (_, _, Some(enums::FutureUsage::OffSession), Some(_), _)
+ | (Some(_), _, Some(enums::FutureUsage::OffSession), _, _) => {
+ Ok(Some(api::MandateTransactionType::NewMandateTransaction))
+ }
+
+ (_, _, Some(enums::FutureUsage::OffSession), _, Some(_)) | (_, Some(_), _, _, _) => Ok(
+ Some(api::MandateTransactionType::RecurringMandateTransaction),
+ ),
+
+ _ => Ok(None),
+ }
+}
#[derive(Clone)]
pub struct MandateGenericData {
pub token: Option<String>,
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index b9eed02f74c..17237c625e0 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -129,13 +129,13 @@ where
customer_details,
mut payment_data,
business_profile,
+ mandate_type,
} = operation
.to_get_tracker()?
.get_trackers(
state,
&validate_result.payment_id,
&req,
- validate_result.mandate_type.to_owned(),
&merchant_account,
&key_store,
auth_flow,
@@ -167,6 +167,7 @@ where
&key_store,
&mut payment_data,
eligible_connectors,
+ mandate_type,
)
.await?;
@@ -2656,6 +2657,7 @@ pub async fn get_connector_choice<F, Req, Ctx>(
key_store: &domain::MerchantKeyStore,
payment_data: &mut PaymentData<F>,
eligible_connectors: Option<Vec<api_models::enums::RoutableConnectors>>,
+ mandate_type: Option<api::MandateTransactionType>,
) -> RouterResult<Option<ConnectorCallType>>
where
F: Send + Clone,
@@ -2695,6 +2697,7 @@ where
payment_data,
Some(straight_through),
eligible_connectors,
+ mandate_type,
)
.await?
}
@@ -2708,6 +2711,7 @@ where
payment_data,
None,
eligible_connectors,
+ mandate_type,
)
.await?
}
@@ -2724,6 +2728,7 @@ where
Ok(connector)
}
+#[allow(clippy::too_many_arguments)]
pub async fn connector_selection<F>(
state: &AppState,
merchant_account: &domain::MerchantAccount,
@@ -2732,6 +2737,7 @@ pub async fn connector_selection<F>(
payment_data: &mut PaymentData<F>,
request_straight_through: Option<serde_json::Value>,
eligible_connectors: Option<Vec<api_models::enums::RoutableConnectors>>,
+ mandate_type: Option<api::MandateTransactionType>,
) -> RouterResult<ConnectorCallType>
where
F: Send + Clone,
@@ -2773,6 +2779,7 @@ where
request_straight_through,
&mut routing_data,
eligible_connectors,
+ mandate_type,
)
.await?;
@@ -2806,6 +2813,7 @@ pub async fn decide_connector<F>(
request_straight_through: Option<api::routing::StraightThroughAlgorithm>,
routing_data: &mut storage::RoutingData,
eligible_connectors: Option<Vec<api_models::enums::RoutableConnectors>>,
+ mandate_type: Option<api::MandateTransactionType>,
) -> RouterResult<ConnectorCallType>
where
F: Send + Clone,
@@ -2937,6 +2945,7 @@ where
payment_data,
routing_data,
connector_data,
+ mandate_type,
)
.await;
}
@@ -2993,6 +3002,7 @@ where
payment_data,
routing_data,
connector_data,
+ mandate_type,
)
.await;
}
@@ -3005,6 +3015,7 @@ where
TransactionData::Payment(payment_data),
routing_data,
eligible_connectors,
+ mandate_type,
)
.await
}
@@ -3014,16 +3025,30 @@ pub async fn decide_multiplex_connector_for_normal_or_recurring_payment<F: Clone
payment_data: &mut PaymentData<F>,
routing_data: &mut storage::RoutingData,
connectors: Vec<api::ConnectorData>,
+ mandate_type: Option<api::MandateTransactionType>,
) -> RouterResult<ConnectorCallType> {
match (
payment_data.payment_intent.setup_future_usage,
payment_data.token_data.as_ref(),
payment_data.recurring_details.as_ref(),
payment_data.payment_intent.off_session,
+ mandate_type,
) {
- (Some(storage_enums::FutureUsage::OffSession), Some(_), None, None)
- | (None, None, Some(RecurringDetails::PaymentMethodId(_)), Some(true))
- | (None, Some(_), None, Some(true)) => {
+ (
+ Some(storage_enums::FutureUsage::OffSession),
+ Some(_),
+ None,
+ None,
+ Some(api::MandateTransactionType::RecurringMandateTransaction),
+ )
+ | (
+ None,
+ None,
+ Some(RecurringDetails::PaymentMethodId(_)),
+ Some(true),
+ Some(api::MandateTransactionType::RecurringMandateTransaction),
+ )
+ | (None, Some(_), None, Some(true), _) => {
logger::debug!("performing routing for token-based MIT flow");
let payment_method_info = payment_data
@@ -3327,6 +3352,7 @@ where
Ok(final_list)
}
+#[allow(clippy::too_many_arguments)]
pub async fn route_connector_v1<F>(
state: &AppState,
merchant_account: &domain::MerchantAccount,
@@ -3335,6 +3361,7 @@ pub async fn route_connector_v1<F>(
transaction_data: TransactionData<'_, F>,
routing_data: &mut storage::RoutingData,
eligible_connectors: Option<Vec<api_models::enums::RoutableConnectors>>,
+ mandate_type: Option<api::MandateTransactionType>,
) -> RouterResult<ConnectorCallType>
where
F: Send + Clone,
@@ -3425,6 +3452,7 @@ where
payment_data,
routing_data,
connector_data,
+ mandate_type,
)
.await
}
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index bde7e489836..9851ec1edc2 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -432,7 +432,7 @@ pub async fn get_token_pm_type_mandate_details(
request.payment_token.to_owned(),
request.payment_method,
request.payment_method_type,
- Some(mandate_data.clone().get_required_value("mandate_data")?),
+ mandate_data.clone(),
None,
None,
None,
@@ -495,29 +495,37 @@ pub async fn get_token_pm_type_mandate_details(
}
},
None => {
- let mandate_id = request
- .mandate_id
- .clone()
- .get_required_value("mandate_id")?;
- let mandate_generic_data = get_token_for_recurring_mandate(
- state,
- request,
- merchant_account,
- merchant_key_store,
- mandate_id,
- )
- .await?;
- (
- mandate_generic_data.token,
- mandate_generic_data.payment_method,
- mandate_generic_data
- .payment_method_type
- .or(request.payment_method_type),
- None,
- mandate_generic_data.recurring_mandate_payment_data,
- mandate_generic_data.mandate_connector,
- None,
- )
+ if let Some(mandate_id) = request.mandate_id.clone() {
+ let mandate_generic_data = get_token_for_recurring_mandate(
+ state,
+ request,
+ merchant_account,
+ merchant_key_store,
+ mandate_id,
+ )
+ .await?;
+ (
+ mandate_generic_data.token,
+ mandate_generic_data.payment_method,
+ mandate_generic_data
+ .payment_method_type
+ .or(request.payment_method_type),
+ None,
+ mandate_generic_data.recurring_mandate_payment_data,
+ mandate_generic_data.mandate_connector,
+ None,
+ )
+ } else {
+ (
+ request.payment_token.to_owned(),
+ request.payment_method,
+ request.payment_method_type,
+ None,
+ None,
+ None,
+ None,
+ )
+ }
}
}
}
diff --git a/crates/router/src/core/payments/operations.rs b/crates/router/src/core/payments/operations.rs
index 261cbf06271..3c5757ec249 100644
--- a/crates/router/src/core/payments/operations.rs
+++ b/crates/router/src/core/payments/operations.rs
@@ -79,7 +79,6 @@ pub trait Operation<F: Clone, T, Ctx: PaymentMethodRetrieve>: Send + std::fmt::D
pub struct ValidateResult<'a> {
pub merchant_id: &'a str,
pub payment_id: api::PaymentIdType,
- pub mandate_type: Option<api::MandateTransactionType>,
pub storage_scheme: enums::MerchantStorageScheme,
pub requeue: bool,
}
@@ -98,6 +97,7 @@ pub struct GetTrackerResponse<'a, F: Clone, R, Ctx> {
pub customer_details: Option<CustomerDetails>,
pub payment_data: PaymentData<F>,
pub business_profile: storage::business_profile::BusinessProfile,
+ pub mandate_type: Option<api::MandateTransactionType>,
}
#[async_trait]
@@ -108,7 +108,6 @@ pub trait GetTracker<F: Clone, D, R, Ctx: PaymentMethodRetrieve>: Send {
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &R,
- mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
mechant_key_store: &domain::MerchantKeyStore,
auth_flow: services::AuthFlow,
diff --git a/crates/router/src/core/payments/operations/payment_approve.rs b/crates/router/src/core/payments/operations/payment_approve.rs
index e25ef7ed4a4..b47608eba98 100644
--- a/crates/router/src/core/payments/operations/payment_approve.rs
+++ b/crates/router/src/core/payments/operations/payment_approve.rs
@@ -38,7 +38,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
_request: &api::PaymentsCaptureRequest,
- _mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -186,6 +185,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: None,
payment_data,
business_profile,
+ mandate_type: None,
};
Ok(get_trackers_response)
@@ -259,7 +259,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
request.payment_id.clone(),
"payment_id",
)?),
- mandate_type: None,
storage_scheme: merchant_account.storage_scheme,
requeue: false,
},
diff --git a/crates/router/src/core/payments/operations/payment_cancel.rs b/crates/router/src/core/payments/operations/payment_cancel.rs
index ab5feb5d9b5..9cd9ba9f6d4 100644
--- a/crates/router/src/core/payments/operations/payment_cancel.rs
+++ b/crates/router/src/core/payments/operations/payment_cancel.rs
@@ -39,7 +39,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &api::PaymentsCancelRequest,
- _mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -195,6 +194,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: None,
payment_data,
business_profile,
+ mandate_type: None,
};
Ok(get_trackers_response)
@@ -281,7 +281,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: api::PaymentIdType::PaymentIntentId(request.payment_id.to_owned()),
- mandate_type: None,
storage_scheme: merchant_account.storage_scheme,
requeue: false,
},
diff --git a/crates/router/src/core/payments/operations/payment_capture.rs b/crates/router/src/core/payments/operations/payment_capture.rs
index 4445589f42f..c6dfe6bd3cb 100644
--- a/crates/router/src/core/payments/operations/payment_capture.rs
+++ b/crates/router/src/core/payments/operations/payment_capture.rs
@@ -38,7 +38,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &api::PaymentsCaptureRequest,
- _mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -239,6 +238,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: None,
payment_data,
business_profile,
+ mandate_type: None,
};
Ok(get_trackers_response)
@@ -313,7 +313,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: api::PaymentIdType::PaymentIntentId(request.payment_id.to_owned()),
- mandate_type: None,
storage_scheme: merchant_account.storage_scheme,
requeue: false,
},
diff --git a/crates/router/src/core/payments/operations/payment_complete_authorize.rs b/crates/router/src/core/payments/operations/payment_complete_authorize.rs
index 03aa3685a42..c4da9ca687b 100644
--- a/crates/router/src/core/payments/operations/payment_complete_authorize.rs
+++ b/crates/router/src/core/payments/operations/payment_complete_authorize.rs
@@ -10,7 +10,7 @@ use super::{BoxedOperation, Domain, GetTracker, Operation, UpdateTracker, Valida
use crate::{
core::{
errors::{self, CustomResult, RouterResult, StorageErrorExt},
- mandate::helpers::MandateGenericData,
+ mandate::helpers as m_helpers,
payment_methods::PaymentMethodRetrieve,
payments::{self, helpers, operations, CustomerDetails, PaymentAddress, PaymentData},
utils as core_utils,
@@ -40,7 +40,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &api::PaymentsRequest,
- mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -72,23 +71,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
"confirm",
)?;
- let MandateGenericData {
- token,
- payment_method,
- payment_method_type,
- mandate_data,
- recurring_mandate_payment_data,
- mandate_connector,
- payment_method_info,
- } = helpers::get_token_pm_type_mandate_details(
- state,
- request,
- mandate_type.to_owned(),
- merchant_account,
- key_store,
- )
- .await?;
-
let browser_info = request
.browser_info
.clone()
@@ -99,6 +81,9 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
field_name: "browser_info",
})?;
+ let recurring_details = request.recurring_details.clone();
+ let customer_acceptance = request.customer_acceptance.clone().map(From::from);
+
payment_attempt = db
.find_payment_attempt_by_payment_id_merchant_id_attempt_id(
&payment_intent.payment_id,
@@ -109,6 +94,33 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
.await
.to_not_found_response(errors::ApiErrorResponse::PaymentNotFound)?;
+ let mandate_type = m_helpers::get_mandate_type(
+ request.mandate_data.clone(),
+ request.off_session,
+ payment_intent.setup_future_usage,
+ request.customer_acceptance.clone(),
+ request.payment_token.clone(),
+ )
+ .change_context(errors::ApiErrorResponse::MandateValidationFailed {
+ reason: "Expected one out of recurring_details and mandate_data but got both".into(),
+ })?;
+
+ let m_helpers::MandateGenericData {
+ token,
+ payment_method,
+ payment_method_type,
+ mandate_data,
+ recurring_mandate_payment_data,
+ mandate_connector,
+ payment_method_info,
+ } = helpers::get_token_pm_type_mandate_details(
+ state,
+ request,
+ mandate_type.to_owned(),
+ merchant_account,
+ key_store,
+ )
+ .await?;
let token = token.or_else(|| payment_attempt.payment_token.clone());
if let Some(payment_method) = payment_method {
@@ -259,7 +271,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
mandate_id: None,
mandate_connector,
setup_mandate,
- customer_acceptance: None,
+ customer_acceptance,
token,
token_data,
address: PaymentAddress::new(
@@ -293,7 +305,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
authorizations: vec![],
authentication: None,
frm_metadata: None,
- recurring_details: request.recurring_details.clone(),
+ recurring_details,
};
let customer_details = Some(CustomerDetails {
@@ -309,6 +321,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details,
payment_data,
business_profile,
+ mandate_type,
};
Ok(get_trackers_response)
@@ -458,7 +471,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve> ValidateRequest<F, api::Paymen
helpers::validate_payment_method_fields_present(request)?;
- let mandate_type =
+ let _mandate_type =
helpers::validate_mandate(request, payments::is_operation_confirm(self))?;
helpers::validate_recurring_details_and_token(
@@ -472,7 +485,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve> ValidateRequest<F, api::Paymen
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: payment_id.and_then(|id| core_utils::validate_id(id, "payment_id"))?,
- mandate_type,
storage_scheme: merchant_account.storage_scheme,
requeue: matches!(
request.retry_action,
diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs
index 21513930066..bdc724a1d21 100644
--- a/crates/router/src/core/payments/operations/payment_confirm.rs
+++ b/crates/router/src/core/payments/operations/payment_confirm.rs
@@ -15,7 +15,7 @@ use crate::{
authentication,
blocklist::utils as blocklist_utils,
errors::{self, CustomResult, RouterResult, StorageErrorExt},
- mandate::helpers::MandateGenericData,
+ mandate::helpers as m_helpers,
payment_methods::PaymentMethodRetrieve,
payments::{
self, helpers, operations, populate_surcharge_details, CustomerDetails, PaymentAddress,
@@ -47,7 +47,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &api::PaymentsRequest,
- mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
auth_flow: services::AuthFlow,
@@ -62,47 +61,18 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
.change_context(errors::ApiErrorResponse::PaymentNotFound)?;
// Stage 1
- let store = state.clone().store;
+ let store = &*state.store;
let m_merchant_id = merchant_id.clone();
- let payment_intent_fut = tokio::spawn(
- async move {
- store
- .find_payment_intent_by_payment_id_merchant_id(
- &payment_id,
- m_merchant_id.as_str(),
- storage_scheme,
- )
- .map(|x| x.change_context(errors::ApiErrorResponse::PaymentNotFound))
- .await
- }
- .in_current_span(),
- );
-
- let m_state = state.clone();
- let m_mandate_type = mandate_type.clone();
- let m_merchant_account = merchant_account.clone();
- let m_request = request.clone();
- let m_key_store = key_store.clone();
-
- let mandate_details_fut = tokio::spawn(
- async move {
- helpers::get_token_pm_type_mandate_details(
- &m_state,
- &m_request,
- m_mandate_type,
- &m_merchant_account,
- &m_key_store,
- )
- .await
- }
- .in_current_span(),
- );
// Parallel calls - level 0
- let (mut payment_intent, mandate_details) = tokio::try_join!(
- utils::flatten_join_error(payment_intent_fut),
- utils::flatten_join_error(mandate_details_fut)
- )?;
+ let mut payment_intent = store
+ .find_payment_intent_by_payment_id_merchant_id(
+ &payment_id,
+ m_merchant_id.as_str(),
+ storage_scheme,
+ )
+ .await
+ .to_not_found_response(errors::ApiErrorResponse::PaymentNotFound)?;
if let Some(order_details) = &request.order_details {
helpers::validate_order_details_amount(
@@ -352,16 +322,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
.setup_future_usage
.or(payment_intent.setup_future_usage);
- let MandateGenericData {
- token,
- payment_method,
- payment_method_type,
- mandate_data,
- recurring_mandate_payment_data,
- mandate_connector,
- payment_method_info,
- } = mandate_details;
-
let browser_info = request
.browser_info
.clone()
@@ -374,6 +334,8 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
})?;
let customer_acceptance = request.customer_acceptance.clone().map(From::from);
+ let recurring_details = request.recurring_details.clone();
+
helpers::validate_card_data(
request
.payment_method_data
@@ -381,46 +343,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
.map(|pmd| pmd.payment_method_data.clone()),
)?;
- let token = token.or_else(|| payment_attempt.payment_token.clone());
-
- helpers::validate_pm_or_token_given(
- &request.payment_method,
- &request
- .payment_method_data
- .as_ref()
- .map(|pmd| pmd.payment_method_data.clone()),
- &request.payment_method_type,
- &mandate_type,
- &token,
- )?;
-
- let (token_data, payment_method_info) = if let Some(token) = token.clone() {
- let token_data = helpers::retrieve_payment_token_data(
- state,
- token,
- payment_method.or(payment_attempt.payment_method),
- )
- .await?;
-
- let payment_method_info = helpers::retrieve_payment_method_from_db_with_token_data(
- state,
- &token_data,
- storage_scheme,
- )
- .await?;
-
- (Some(token_data), payment_method_info)
- } else {
- (None, payment_method_info)
- };
-
- payment_attempt.payment_method = payment_method.or(payment_attempt.payment_method);
payment_attempt.browser_info = browser_info;
- payment_attempt.payment_method_type = payment_method_type
- .or(payment_attempt.payment_method_type)
- .or(payment_method_info
- .as_ref()
- .and_then(|pm_info| pm_info.payment_method_type));
payment_attempt.payment_experience = request
.payment_experience
@@ -485,23 +408,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
.clone()
.or(payment_attempt.business_sub_label);
- // The operation merges mandate data from both request and payment_attempt
- let setup_mandate = mandate_data.map(|mut sm| {
- sm.mandate_type = payment_attempt.mandate_details.clone().or(sm.mandate_type);
- sm.update_mandate_id = payment_attempt
- .mandate_data
- .clone()
- .and_then(|mandate| mandate.update_mandate_id)
- .or(sm.update_mandate_id);
- sm
- });
-
- let mandate_details_present =
- payment_attempt.mandate_details.is_some() || request.mandate_data.is_some();
- helpers::validate_mandate_data_and_future_usage(
- payment_intent.setup_future_usage,
- mandate_details_present,
- )?;
let n_request_payment_method_data = request
.payment_method_data
.as_ref()
@@ -553,13 +459,112 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
}
.in_current_span(),
);
+ let mandate_type = m_helpers::get_mandate_type(
+ request.mandate_data.clone(),
+ request.off_session,
+ payment_intent.setup_future_usage,
+ request.customer_acceptance.clone(),
+ request.payment_token.clone(),
+ )
+ .change_context(errors::ApiErrorResponse::MandateValidationFailed {
+ reason: "Expected one out of recurring_details and mandate_data but got both".into(),
+ })?;
+
+ let m_state = state.clone();
+ let m_mandate_type = mandate_type.clone();
+ let m_merchant_account = merchant_account.clone();
+ let m_request = request.clone();
+ let m_key_store = key_store.clone();
+
+ let mandate_details_fut = tokio::spawn(
+ async move {
+ helpers::get_token_pm_type_mandate_details(
+ &m_state,
+ &m_request,
+ m_mandate_type,
+ &m_merchant_account,
+ &m_key_store,
+ )
+ .await
+ }
+ .in_current_span(),
+ );
// Parallel calls - level 2
- let (additional_pm_data, payment_method_billing) = tokio::try_join!(
+ let (mandate_details, additional_pm_data, payment_method_billing) = tokio::try_join!(
+ utils::flatten_join_error(mandate_details_fut),
utils::flatten_join_error(additional_pm_data_fut),
utils::flatten_join_error(payment_method_billing_future),
)?;
+ let m_helpers::MandateGenericData {
+ token,
+ payment_method,
+ payment_method_type,
+ mandate_data,
+ recurring_mandate_payment_data,
+ mandate_connector,
+ payment_method_info,
+ } = mandate_details;
+
+ payment_attempt.payment_method = payment_method.or(payment_attempt.payment_method);
+
+ payment_attempt.payment_method_type = payment_method_type
+ .or(payment_attempt.payment_method_type)
+ .or(payment_method_info
+ .as_ref()
+ .and_then(|pm_info| pm_info.payment_method_type));
+
+ let token = token.or_else(|| payment_attempt.payment_token.clone());
+
+ helpers::validate_pm_or_token_given(
+ &request.payment_method,
+ &request
+ .payment_method_data
+ .as_ref()
+ .map(|pmd| pmd.payment_method_data.clone()),
+ &request.payment_method_type,
+ &mandate_type,
+ &token,
+ )?;
+
+ let (token_data, payment_method_info) = if let Some(token) = token.clone() {
+ let token_data = helpers::retrieve_payment_token_data(
+ state,
+ token,
+ payment_method.or(payment_attempt.payment_method),
+ )
+ .await?;
+
+ let payment_method_info = helpers::retrieve_payment_method_from_db_with_token_data(
+ state,
+ &token_data,
+ storage_scheme,
+ )
+ .await?;
+
+ (Some(token_data), payment_method_info)
+ } else {
+ (None, payment_method_info)
+ };
+ // The operation merges mandate data from both request and payment_attempt
+ let setup_mandate = mandate_data.map(|mut sm| {
+ sm.mandate_type = payment_attempt.mandate_details.clone().or(sm.mandate_type);
+ sm.update_mandate_id = payment_attempt
+ .mandate_data
+ .clone()
+ .and_then(|mandate| mandate.update_mandate_id)
+ .or(sm.update_mandate_id);
+ sm
+ });
+
+ let mandate_details_present =
+ payment_attempt.mandate_details.is_some() || request.mandate_data.is_some();
+ helpers::validate_mandate_data_and_future_usage(
+ payment_intent.setup_future_usage,
+ mandate_details_present,
+ )?;
+
let payment_method_data_after_card_bin_call = request
.payment_method_data
.as_ref()
@@ -627,7 +632,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
authorizations: vec![],
frm_metadata: request.frm_metadata.clone(),
authentication,
- recurring_details: request.recurring_details.clone(),
+ recurring_details,
};
let get_trackers_response = operations::GetTrackerResponse {
@@ -635,6 +640,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: Some(customer_details),
payment_data,
business_profile,
+ mandate_type,
};
Ok(get_trackers_response)
@@ -1216,7 +1222,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve> ValidateRequest<F, api::Paymen
helpers::validate_payment_method_fields_present(request)?;
- let mandate_type =
+ let _mandate_type =
helpers::validate_mandate(request, payments::is_operation_confirm(self))?;
helpers::validate_recurring_details_and_token(
@@ -1235,7 +1241,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve> ValidateRequest<F, api::Paymen
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: payment_id.and_then(|id| core_utils::validate_id(id, "payment_id"))?,
- mandate_type,
storage_scheme: merchant_account.storage_scheme,
requeue: matches!(
request.retry_action,
diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs
index 2e8b7eb9df1..37f2e67a777 100644
--- a/crates/router/src/core/payments/operations/payment_create.rs
+++ b/crates/router/src/core/payments/operations/payment_create.rs
@@ -21,7 +21,7 @@ use crate::{
consts,
core::{
errors::{self, CustomResult, RouterResult, StorageErrorExt},
- mandate::helpers::MandateGenericData,
+ mandate::helpers as m_helpers,
payment_link,
payment_methods::PaymentMethodRetrieve,
payments::{self, helpers, operations, CustomerDetails, PaymentAddress, PaymentData},
@@ -58,7 +58,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &api::PaymentsRequest,
- mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
merchant_key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -106,8 +105,22 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
id: profile_id.to_string(),
})?
};
+ let customer_acceptance = request.customer_acceptance.clone().map(From::from);
+
+ let recurring_details = request.recurring_details.clone();
+
+ let mandate_type = m_helpers::get_mandate_type(
+ request.mandate_data.clone(),
+ request.off_session,
+ request.setup_future_usage,
+ request.customer_acceptance.clone(),
+ request.payment_token.clone(),
+ )
+ .change_context(errors::ApiErrorResponse::MandateValidationFailed {
+ reason: "Expected one out of recurring_details and mandate_data but got both".into(),
+ })?;
- let MandateGenericData {
+ let m_helpers::MandateGenericData {
token,
payment_method,
payment_method_type,
@@ -118,7 +131,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
} = helpers::get_token_pm_type_mandate_details(
state,
request,
- mandate_type,
+ mandate_type.clone(),
merchant_account,
merchant_key_store,
)
@@ -375,8 +388,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
// The operation merges mandate data from both request and payment_attempt
let setup_mandate = mandate_data.map(MandateData::from);
- let customer_acceptance = request.customer_acceptance.clone().map(From::from);
-
let surcharge_details = request.surcharge_details.map(|request_surcharge_details| {
payments::types::SurchargeDetails::from((&request_surcharge_details, &payment_attempt))
});
@@ -434,7 +445,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
authorizations: vec![],
authentication: None,
frm_metadata: request.frm_metadata.clone(),
- recurring_details: request.recurring_details.clone(),
+ recurring_details,
};
let get_trackers_response = operations::GetTrackerResponse {
@@ -442,6 +453,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: Some(customer_details),
payment_data,
business_profile,
+ mandate_type,
};
Ok(get_trackers_response)
@@ -728,7 +740,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve> ValidateRequest<F, api::Paymen
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id,
- mandate_type,
storage_scheme: merchant_account.storage_scheme,
requeue: matches!(
request.retry_action,
diff --git a/crates/router/src/core/payments/operations/payment_reject.rs b/crates/router/src/core/payments/operations/payment_reject.rs
index e1d58b032aa..506f372e947 100644
--- a/crates/router/src/core/payments/operations/payment_reject.rs
+++ b/crates/router/src/core/payments/operations/payment_reject.rs
@@ -37,7 +37,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
_request: &PaymentsCancelRequest,
- _mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -182,6 +181,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: None,
payment_data,
business_profile,
+ mandate_type: None,
};
Ok(get_trackers_response)
@@ -273,7 +273,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve> ValidateRequest<F, PaymentsCan
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: api::PaymentIdType::PaymentIntentId(request.payment_id.to_owned()),
- mandate_type: None,
storage_scheme: merchant_account.storage_scheme,
requeue: false,
},
diff --git a/crates/router/src/core/payments/operations/payment_session.rs b/crates/router/src/core/payments/operations/payment_session.rs
index e15c413de2c..bdae419d21c 100644
--- a/crates/router/src/core/payments/operations/payment_session.rs
+++ b/crates/router/src/core/payments/operations/payment_session.rs
@@ -39,7 +39,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &api::PaymentsSessionRequest,
- _mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -207,6 +206,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: Some(customer_details),
payment_data,
business_profile,
+ mandate_type: None,
};
Ok(get_trackers_response)
@@ -276,7 +276,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: api::PaymentIdType::PaymentIntentId(given_payment_id),
- mandate_type: None,
storage_scheme: merchant_account.storage_scheme,
requeue: false,
},
diff --git a/crates/router/src/core/payments/operations/payment_start.rs b/crates/router/src/core/payments/operations/payment_start.rs
index cfa245ccc3a..29573bc0a30 100644
--- a/crates/router/src/core/payments/operations/payment_start.rs
+++ b/crates/router/src/core/payments/operations/payment_start.rs
@@ -38,7 +38,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
_request: &api::PaymentsStartRequest,
- _mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -194,6 +193,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: Some(customer_details),
payment_data,
business_profile,
+ mandate_type: None,
};
Ok(get_trackers_response)
@@ -252,7 +252,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve> ValidateRequest<F, api::Paymen
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: api::PaymentIdType::PaymentIntentId(payment_id),
- mandate_type: None,
storage_scheme: merchant_account.storage_scheme,
requeue: false,
},
diff --git a/crates/router/src/core/payments/operations/payment_status.rs b/crates/router/src/core/payments/operations/payment_status.rs
index 39cd8328715..b48fc20d909 100644
--- a/crates/router/src/core/payments/operations/payment_status.rs
+++ b/crates/router/src/core/payments/operations/payment_status.rs
@@ -208,7 +208,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &api::PaymentsRetrieveRequest,
- _mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -496,6 +495,7 @@ async fn get_tracker_for_sync<
customer_details: None,
payment_data,
business_profile,
+ mandate_type: None,
};
Ok(get_trackers_response)
@@ -524,7 +524,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: request.resource_id.clone(),
- mandate_type: None,
storage_scheme: merchant_account.storage_scheme,
requeue: false,
},
diff --git a/crates/router/src/core/payments/operations/payment_update.rs b/crates/router/src/core/payments/operations/payment_update.rs
index fcf70212f30..efe4501e949 100644
--- a/crates/router/src/core/payments/operations/payment_update.rs
+++ b/crates/router/src/core/payments/operations/payment_update.rs
@@ -13,7 +13,7 @@ use super::{BoxedOperation, Domain, GetTracker, Operation, UpdateTracker, Valida
use crate::{
core::{
errors::{self, CustomResult, RouterResult, StorageErrorExt},
- mandate::helpers::MandateGenericData,
+ mandate::helpers as m_helpers,
payment_methods::PaymentMethodRetrieve,
payments::{self, helpers, operations, CustomerDetails, PaymentAddress, PaymentData},
utils as core_utils,
@@ -43,7 +43,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &api::PaymentsRequest,
- mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
key_store: &domain::MerchantKeyStore,
auth_flow: services::AuthFlow,
@@ -98,23 +97,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
helpers::authenticate_client_secret(request.client_secret.as_ref(), &payment_intent)?;
- let MandateGenericData {
- token,
- payment_method,
- payment_method_type,
- mandate_data,
- recurring_mandate_payment_data,
- mandate_connector,
- payment_method_info,
- } = helpers::get_token_pm_type_mandate_details(
- state,
- request,
- mandate_type.to_owned(),
- merchant_account,
- key_store,
- )
- .await?;
-
payment_intent = db
.find_payment_intent_by_payment_id_merchant_id(&payment_id, merchant_id, storage_scheme)
.await
@@ -136,6 +118,36 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
.await
.to_not_found_response(errors::ApiErrorResponse::PaymentNotFound)?;
+ let customer_acceptance = request.customer_acceptance.clone().map(From::from);
+ let recurring_details = request.recurring_details.clone();
+
+ let mandate_type = m_helpers::get_mandate_type(
+ request.mandate_data.clone(),
+ request.off_session,
+ payment_intent.setup_future_usage,
+ request.customer_acceptance.clone(),
+ request.payment_token.clone(),
+ )
+ .change_context(errors::ApiErrorResponse::MandateValidationFailed {
+ reason: "Expected one out of recurring_details and mandate_data but got both".into(),
+ })?;
+
+ let m_helpers::MandateGenericData {
+ token,
+ payment_method,
+ payment_method_type,
+ mandate_data,
+ recurring_mandate_payment_data,
+ mandate_connector,
+ payment_method_info,
+ } = helpers::get_token_pm_type_mandate_details(
+ state,
+ request,
+ mandate_type.to_owned(),
+ merchant_account,
+ key_store,
+ )
+ .await?;
helpers::validate_amount_to_capture_and_capture_method(Some(&payment_attempt), request)?;
helpers::validate_request_amount_and_amount_to_capture(
@@ -390,7 +402,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
.to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound {
id: profile_id.to_string(),
})?;
- let customer_acceptance = request.customer_acceptance.clone().map(From::from);
+
let surcharge_details = request.surcharge_details.map(|request_surcharge_details| {
payments::types::SurchargeDetails::from((&request_surcharge_details, &payment_attempt))
});
@@ -439,7 +451,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
authorizations: vec![],
authentication: None,
frm_metadata: request.frm_metadata.clone(),
- recurring_details: request.recurring_details.clone(),
+ recurring_details,
};
let get_trackers_response = operations::GetTrackerResponse {
@@ -447,6 +459,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: Some(customer_details),
payment_data,
business_profile,
+ mandate_type,
};
Ok(get_trackers_response)
@@ -752,7 +765,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve> ValidateRequest<F, api::Paymen
helpers::validate_payment_method_fields_present(request)?;
- let mandate_type = helpers::validate_mandate(request, false)?;
+ let _mandate_type = helpers::validate_mandate(request, false)?;
helpers::validate_recurring_details_and_token(
&request.recurring_details,
@@ -765,7 +778,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve> ValidateRequest<F, api::Paymen
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: payment_id.and_then(|id| core_utils::validate_id(id, "payment_id"))?,
- mandate_type,
storage_scheme: merchant_account.storage_scheme,
requeue: matches!(
request.retry_action,
diff --git a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs
index e73a829d04d..4ce65c991bf 100644
--- a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs
+++ b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs
@@ -42,7 +42,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
state: &'a AppState,
payment_id: &api::PaymentIdType,
request: &PaymentsIncrementalAuthorizationRequest,
- _mandate_type: Option<api::MandateTransactionType>,
merchant_account: &domain::MerchantAccount,
_key_store: &domain::MerchantKeyStore,
_auth_flow: services::AuthFlow,
@@ -160,6 +159,7 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
customer_details: None,
payment_data,
business_profile,
+ mandate_type: None,
};
Ok(get_trackers_response)
@@ -275,7 +275,6 @@ impl<F: Send + Clone, Ctx: PaymentMethodRetrieve>
operations::ValidateResult {
merchant_id: &merchant_account.merchant_id,
payment_id: api::PaymentIdType::PaymentIntentId(request.payment_id.to_owned()),
- mandate_type: None,
storage_scheme: merchant_account.storage_scheme,
requeue: false,
},
diff --git a/crates/router/src/core/payouts/helpers.rs b/crates/router/src/core/payouts/helpers.rs
index e5ab5c41062..df6e24122a2 100644
--- a/crates/router/src/core/payouts/helpers.rs
+++ b/crates/router/src/core/payouts/helpers.rs
@@ -785,6 +785,7 @@ pub async fn decide_payout_connector(
TransactionData::<()>::Payout(payout_data),
routing_data,
eligible_connectors,
+ None,
)
.await
}
|
feat
|
create mandates with payment_token (#4342)
|
50784ad1c13f0aa66a1da566ddd25e2621021538
|
2025-02-07 12:49:46
|
AkshayaFoiger
|
refactor(router): add display_name field to connector feature api (#7121)
| false
|
diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json
index ebfbfc3bf06..329bab6f3dd 100644
--- a/api-reference-v2/openapi_spec.json
+++ b/api-reference-v2/openapi_spec.json
@@ -6471,14 +6471,14 @@
"type": "object",
"required": [
"three_ds",
- "non_three_ds",
+ "no_three_ds",
"supported_card_networks"
],
"properties": {
"three_ds": {
"$ref": "#/components/schemas/FeatureStatus"
},
- "non_three_ds": {
+ "no_three_ds": {
"$ref": "#/components/schemas/FeatureStatus"
},
"supported_card_networks": {
@@ -6776,6 +6776,10 @@
"name": {
"type": "string"
},
+ "display_name": {
+ "type": "string",
+ "nullable": true
+ },
"description": {
"type": "string",
"nullable": true
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
index 7132fe905c7..d1bfc5dfdba 100644
--- a/api-reference/openapi_spec.json
+++ b/api-reference/openapi_spec.json
@@ -9228,14 +9228,14 @@
"type": "object",
"required": [
"three_ds",
- "non_three_ds",
+ "no_three_ds",
"supported_card_networks"
],
"properties": {
"three_ds": {
"$ref": "#/components/schemas/FeatureStatus"
},
- "non_three_ds": {
+ "no_three_ds": {
"$ref": "#/components/schemas/FeatureStatus"
},
"supported_card_networks": {
@@ -9526,6 +9526,10 @@
"name": {
"type": "string"
},
+ "display_name": {
+ "type": "string",
+ "nullable": true
+ },
"description": {
"type": "string",
"nullable": true
diff --git a/crates/api_models/src/feature_matrix.rs b/crates/api_models/src/feature_matrix.rs
index c1eb699705f..caa5aed1114 100644
--- a/crates/api_models/src/feature_matrix.rs
+++ b/crates/api_models/src/feature_matrix.rs
@@ -19,7 +19,7 @@ pub struct CardSpecificFeatures {
/// Indicates whether three_ds card payments are supported.
pub three_ds: FeatureStatus,
/// Indicates whether non three_ds card payments are supported.
- pub non_three_ds: FeatureStatus,
+ pub no_three_ds: FeatureStatus,
/// List of supported card networks
pub supported_card_networks: Vec<CardNetwork>,
}
@@ -47,6 +47,7 @@ pub struct SupportedPaymentMethod {
#[derive(Debug, ToSchema, Serialize)]
pub struct ConnectorFeatureMatrixResponse {
pub name: String,
+ pub display_name: Option<String>,
pub description: Option<String>,
pub category: Option<PaymentConnectorCategory>,
pub supported_payment_methods: Vec<SupportedPaymentMethod>,
diff --git a/crates/hyperswitch_connectors/src/connectors/bambora.rs b/crates/hyperswitch_connectors/src/connectors/bambora.rs
index d972e004f2d..c4a9edea65c 100644
--- a/crates/hyperswitch_connectors/src/connectors/bambora.rs
+++ b/crates/hyperswitch_connectors/src/connectors/bambora.rs
@@ -847,7 +847,7 @@ lazy_static! {
api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({
api_models::feature_matrix::CardSpecificFeatures {
three_ds: common_enums::FeatureStatus::Supported,
- non_three_ds: common_enums::FeatureStatus::Supported,
+ no_three_ds: common_enums::FeatureStatus::Supported,
supported_card_networks: supported_card_network.clone(),
}
}),
@@ -858,8 +858,8 @@ lazy_static! {
bambora_supported_payment_methods
};
static ref BAMBORA_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo {
- description: "Bambora is a leading online payment provider in Canada and United States."
- .to_string(),
+ display_name: "Bambora",
+ description: "Bambora is a leading online payment provider in Canada and United States.",
connector_type: enums::PaymentConnectorCategory::PaymentGateway,
};
static ref BAMBORA_SUPPORTED_WEBHOOK_FLOWS: Vec<enums::EventClass> = Vec::new();
diff --git a/crates/hyperswitch_connectors/src/connectors/deutschebank.rs b/crates/hyperswitch_connectors/src/connectors/deutschebank.rs
index 0b6b2f132e7..0b92cb2538c 100644
--- a/crates/hyperswitch_connectors/src/connectors/deutschebank.rs
+++ b/crates/hyperswitch_connectors/src/connectors/deutschebank.rs
@@ -1031,7 +1031,7 @@ lazy_static! {
api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({
api_models::feature_matrix::CardSpecificFeatures {
three_ds: common_enums::FeatureStatus::Supported,
- non_three_ds: common_enums::FeatureStatus::NotSupported,
+ no_three_ds: common_enums::FeatureStatus::NotSupported,
supported_card_networks: supported_card_network.clone(),
}
}),
@@ -1050,7 +1050,7 @@ lazy_static! {
api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({
api_models::feature_matrix::CardSpecificFeatures {
three_ds: common_enums::FeatureStatus::Supported,
- non_three_ds: common_enums::FeatureStatus::NotSupported,
+ no_three_ds: common_enums::FeatureStatus::NotSupported,
supported_card_networks: supported_card_network.clone(),
}
}),
@@ -1062,9 +1062,9 @@ lazy_static! {
};
static ref DEUTSCHEBANK_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo {
+ display_name: "Deutsche Bank",
description:
- "Deutsche Bank is a German multinational investment bank and financial services company "
- .to_string(),
+ "Deutsche Bank is a German multinational investment bank and financial services company ",
connector_type: enums::PaymentConnectorCategory::BankAcquirer,
};
diff --git a/crates/hyperswitch_connectors/src/connectors/zsl.rs b/crates/hyperswitch_connectors/src/connectors/zsl.rs
index cf01c31b747..d7c0152b7a6 100644
--- a/crates/hyperswitch_connectors/src/connectors/zsl.rs
+++ b/crates/hyperswitch_connectors/src/connectors/zsl.rs
@@ -466,9 +466,9 @@ lazy_static! {
};
static ref ZSL_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo {
+ display_name: "ZSL",
description:
- "Zsl is a payment gateway operating in China, specializing in facilitating local bank transfers"
- .to_string(),
+ "Zsl is a payment gateway operating in China, specializing in facilitating local bank transfers",
connector_type: enums::PaymentConnectorCategory::PaymentGateway,
};
diff --git a/crates/hyperswitch_domain_models/src/router_response_types.rs b/crates/hyperswitch_domain_models/src/router_response_types.rs
index 4d15d715ff7..5578647025b 100644
--- a/crates/hyperswitch_domain_models/src/router_response_types.rs
+++ b/crates/hyperswitch_domain_models/src/router_response_types.rs
@@ -569,9 +569,10 @@ pub type SupportedPaymentMethods = HashMap<common_enums::PaymentMethod, PaymentM
#[derive(Debug, Clone)]
pub struct ConnectorInfo {
+ /// Display name of the Connector
+ pub display_name: &'static str,
/// Description of the connector.
- pub description: String,
-
+ pub description: &'static str,
/// Connector Type
pub connector_type: common_enums::PaymentConnectorCategory,
}
diff --git a/crates/router/src/routes/feature_matrix.rs b/crates/router/src/routes/feature_matrix.rs
index 66a99680213..67e447ad476 100644
--- a/crates/router/src/routes/feature_matrix.rs
+++ b/crates/router/src/routes/feature_matrix.rs
@@ -99,7 +99,8 @@ fn build_connector_feature_details(
.map(|webhook_flows| webhook_flows.to_vec());
feature_matrix::ConnectorFeatureMatrixResponse {
name: connector_name.to_uppercase(),
- description: connector_about.map(|about| about.description.clone()),
+ display_name: connector_about.map(|about| about.display_name.to_string()),
+ description: connector_about.map(|about| about.description.to_string()),
category: connector_about.map(|about| about.connector_type),
supported_webhook_flows,
supported_payment_methods,
|
refactor
|
add display_name field to connector feature api (#7121)
|
98816c05bd1d870592de18057a63b098e1e3a97b
|
2023-01-09 17:57:39
|
Narayan Bhat
|
fix(core): save return url in update and confirm (#325)
| false
|
diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs
index a69fb8a0804..93033649b61 100644
--- a/crates/router/src/core/payments/operations/payment_confirm.rs
+++ b/crates/router/src/core/payments/operations/payment_confirm.rs
@@ -149,6 +149,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
payment_intent.shipping_address_id = shipping_address.clone().map(|i| i.address_id);
payment_intent.billing_address_id = billing_address.clone().map(|i| i.address_id);
+ payment_intent.return_url = request.return_url.clone();
match payment_intent.status {
enums::IntentStatus::Succeeded | enums::IntentStatus::Failed => {
@@ -317,6 +318,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
);
let customer_id = customer.map(|c| c.customer_id);
+ let return_url = payment_data.payment_intent.return_url.clone();
payment_data.payment_intent = db
.update_payment_intent(
@@ -328,6 +330,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
customer_id,
shipping_address_id: shipping_address,
billing_address_id: billing_address,
+ return_url,
},
storage_scheme,
)
diff --git a/crates/router/src/core/payments/operations/payment_update.rs b/crates/router/src/core/payments/operations/payment_update.rs
index c9e22337a10..1d496b53b41 100644
--- a/crates/router/src/core/payments/operations/payment_update.rs
+++ b/crates/router/src/core/payments/operations/payment_update.rs
@@ -112,6 +112,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
payment_intent.shipping_address_id = shipping_address.clone().map(|x| x.address_id);
payment_intent.billing_address_id = billing_address.clone().map(|x| x.address_id);
+ payment_intent.return_url = request.return_url.clone();
if request.confirm.unwrap_or(false) {
helpers::validate_customer_id_mandatory_cases_storage(
@@ -323,12 +324,11 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
let customer_id = customer.map(|c| c.customer_id);
- let get_status = || {
+ let intent_status = {
let current_intent_status = payment_data.payment_intent.status;
if is_payment_method_unavailable {
- return enums::IntentStatus::RequiresPaymentMethod;
- }
- if !payment_data.confirm.unwrap_or(true)
+ enums::IntentStatus::RequiresPaymentMethod
+ } else if !payment_data.confirm.unwrap_or(true)
|| current_intent_status == enums::IntentStatus::RequiresCustomerAction
{
enums::IntentStatus::RequiresConfirmation
@@ -342,16 +342,19 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
payment_data.payment_intent.billing_address_id.clone(),
);
+ let return_url = payment_data.payment_intent.return_url.clone();
+
payment_data.payment_intent = db
.update_payment_intent(
- payment_data.payment_intent.clone(),
+ payment_data.payment_intent,
storage::PaymentIntentUpdate::Update {
amount: payment_data.amount.into(),
currency: payment_data.currency,
- status: get_status(),
+ status: intent_status,
customer_id,
shipping_address_id: shipping_address,
billing_address_id: billing_address,
+ return_url,
},
storage_scheme,
)
diff --git a/crates/storage_models/src/payment_intent.rs b/crates/storage_models/src/payment_intent.rs
index 7906cbc6ce4..b5345114650 100644
--- a/crates/storage_models/src/payment_intent.rs
+++ b/crates/storage_models/src/payment_intent.rs
@@ -99,6 +99,7 @@ pub enum PaymentIntentUpdate {
customer_id: Option<String>,
shipping_address_id: Option<String>,
billing_address_id: Option<String>,
+ return_url: Option<String>,
},
}
@@ -161,6 +162,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
customer_id,
shipping_address_id,
billing_address_id,
+ return_url,
} => Self {
amount: Some(amount),
currency: Some(currency),
@@ -170,6 +172,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
shipping_address_id,
billing_address_id,
modified_at: Some(common_utils::date_time::now()),
+ return_url,
..Default::default()
},
PaymentIntentUpdate::MetadataUpdate { metadata } => Self {
|
fix
|
save return url in update and confirm (#325)
|
cc5add625da44aeb9d30f02d21d415be12ce0c48
|
2023-09-08 19:51:28
|
Shankar Singh C
|
fix(connector): revert checkout apple pay to tokenization flow (#2110)
| false
|
diff --git a/crates/router/src/connector/checkout/transformers.rs b/crates/router/src/connector/checkout/transformers.rs
index 688ef9226fb..f61ed158eef 100644
--- a/crates/router/src/connector/checkout/transformers.rs
+++ b/crates/router/src/connector/checkout/transformers.rs
@@ -1,6 +1,6 @@
use common_utils::{errors::CustomResult, ext_traits::ByteSliceExt};
use error_stack::{IntoReport, ResultExt};
-use masking::{ExposeInterface, PeekInterface, Secret};
+use masking::{ExposeInterface, Secret};
use serde::{Deserialize, Serialize};
use time::PrimitiveDateTime;
use url::Url;
@@ -11,7 +11,6 @@ use crate::{
core::errors,
services,
types::{self, api, storage::enums, transformers::ForeignFrom},
- utils::OptionExt,
};
#[derive(Debug, Serialize)]
@@ -251,7 +250,8 @@ impl TryFrom<&types::PaymentsAuthorizeRouterData> for PaymentsRequest {
Ok(a)
}
api::PaymentMethodData::Wallet(wallet_data) => match wallet_data {
- api_models::payments::WalletData::GooglePay(_) => {
+ api_models::payments::WalletData::GooglePay(_)
+ | api_models::payments::WalletData::ApplePay(_) => {
Ok(PaymentSource::Wallets(WalletSource {
source_type: CheckoutSourceTypes::Token,
token: match item.get_payment_method_token()? {
@@ -262,46 +262,6 @@ impl TryFrom<&types::PaymentsAuthorizeRouterData> for PaymentsRequest {
},
}))
}
- api_models::payments::WalletData::ApplePay(_) => {
- let payment_method_token = item
- .payment_method_token
- .to_owned()
- .get_required_value("payment_token")
- .change_context(errors::ConnectorError::RequestEncodingFailed)?;
- let decrypt_data = match payment_method_token {
- types::PaymentMethodToken::Token(_) => {
- Err(errors::ConnectorError::InvalidWalletToken)?
- }
- types::PaymentMethodToken::ApplePayDecrypt(data) => data,
- };
- let expiry_year_4_digit = Secret::new(format!(
- "20{:?}",
- decrypt_data
- .application_expiration_date
- .peek()
- .get(0..2)
- .ok_or(errors::ConnectorError::RequestEncodingFailed)?
- ));
- let expiry_month = Secret::new(
- decrypt_data
- .application_expiration_date
- .peek()
- .get(2..4)
- .ok_or(errors::ConnectorError::RequestEncodingFailed)?
- .to_owned(),
- );
- Ok(PaymentSource::ApplePayPredecrypt(Box::new(
- ApplePayPredecrypt {
- token: decrypt_data.application_primary_account_number,
- decrypt_type: "network_token".to_string(),
- token_type: "applepay".to_string(),
- expiry_month,
- expiry_year: expiry_year_4_digit,
- eci: decrypt_data.payment_data.eci_indicator,
- cryptogram: decrypt_data.payment_data.online_payment_cryptogram,
- },
- )))
- }
api_models::payments::WalletData::AliPayQr(_)
| api_models::payments::WalletData::AliPayRedirect(_)
| api_models::payments::WalletData::AliPayHkRedirect(_)
diff --git a/crates/router/src/connector/stripe/transformers.rs b/crates/router/src/connector/stripe/transformers.rs
index 9dc6689f466..3865e198583 100644
--- a/crates/router/src/connector/stripe/transformers.rs
+++ b/crates/router/src/connector/stripe/transformers.rs
@@ -1306,7 +1306,7 @@ fn create_stripe_payment_method(
payment_method_token
{
let expiry_year_4_digit = Secret::new(format!(
- "20{:?}",
+ "20{}",
decrypt_data
.clone()
.application_expiration_date
|
fix
|
revert checkout apple pay to tokenization flow (#2110)
|
8e58b56b43ad2f823c51943c34aa8837297c70d6
|
2024-10-24 20:57:46
|
Sakil Mostak
|
fix(core): populate billing_address for payment with pm_id (#6411)
| false
|
diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs
index 005b5aeba6c..87078dfa5af 100644
--- a/crates/router/src/core/payment_methods.rs
+++ b/crates/router/src/core/payment_methods.rs
@@ -753,6 +753,7 @@ pub(crate) async fn get_payment_method_create_request(
payment_method_type: Option<storage_enums::PaymentMethodType>,
customer_id: &Option<id_type::CustomerId>,
billing_name: Option<Secret<String>>,
+ payment_method_billing_address: Option<&api_models::payments::Address>,
) -> RouterResult<payment_methods::PaymentMethodCreate> {
match payment_method_data {
Some(pm_data) => match payment_method {
@@ -787,7 +788,7 @@ pub(crate) async fn get_payment_method_create_request(
.map(|card_network| card_network.to_string()),
client_secret: None,
payment_method_data: None,
- billing: None,
+ billing: payment_method_billing_address.cloned(),
connector_mandate_details: None,
network_transaction_id: None,
};
diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs
index ae64fe41b1f..6b243ba72aa 100644
--- a/crates/router/src/core/payments/operations/payment_response.rs
+++ b/crates/router/src/core/payments/operations/payment_response.rs
@@ -1047,6 +1047,7 @@ impl<F: Clone> PostUpdateTracker<F, PaymentData<F>, types::SetupMandateRequestDa
where
F: 'b + Clone + Send + Sync,
{
+ let payment_method_billing_address = payment_data.address.get_payment_method_billing();
let billing_name = resp
.address
.get_payment_method_billing()
@@ -1079,7 +1080,7 @@ impl<F: Clone> PostUpdateTracker<F, PaymentData<F>, types::SetupMandateRequestDa
resp.request.payment_method_type,
key_store,
billing_name,
- None,
+ payment_method_billing_address,
business_profile,
))
.await?;
diff --git a/crates/router/src/core/payments/tokenization.rs b/crates/router/src/core/payments/tokenization.rs
index b4e5ade5698..43353227c88 100644
--- a/crates/router/src/core/payments/tokenization.rs
+++ b/crates/router/src/core/payments/tokenization.rs
@@ -180,6 +180,7 @@ where
payment_method_type,
&customer_id.clone(),
billing_name,
+ payment_method_billing_address,
)
.await?;
let customer_id = customer_id.to_owned().get_required_value("customer_id")?;
|
fix
|
populate billing_address for payment with pm_id (#6411)
|
ce725ef8c680eea3fe03671c989fd4572cfc0640
|
2023-11-21 20:29:18
|
github-actions
|
test(postman): update postman collection files
| false
|
diff --git a/postman/collection-json/adyen_uk.postman_collection.json b/postman/collection-json/adyen_uk.postman_collection.json
index 716b6d9d069..ad916657948 100644
--- a/postman/collection-json/adyen_uk.postman_collection.json
+++ b/postman/collection-json/adyen_uk.postman_collection.json
@@ -4,6 +4,41 @@
"listen": "prerequest",
"script": {
"exec": [
+ "// Add appropriate profile_id for relevant requests",
+ "const path = pm.request.url.toString();",
+ "const isPostRequest = pm.request.method.toString() === \"POST\";",
+ "const isPaymentCreation = path.match(/\\/payments$/) && isPostRequest;",
+ "const isPayoutCreation = path.match(/\\/payouts\\/create$/) && isPostRequest;",
+ "",
+ "if (isPaymentCreation || isPayoutCreation) {",
+ " try {",
+ " const request = JSON.parse(pm.request.body.toJSON().raw);",
+ "",
+ " // Attach profile_id",
+ " const profile_id = isPaymentCreation",
+ " ? pm.collectionVariables.get(\"payment_profile_id\")",
+ " : pm.collectionVariables.get(\"payout_profile_id\");",
+ " request[\"profile_id\"] = profile_id;",
+ "",
+ " // Attach routing",
+ " const routing = { type: \"single\", data: \"adyen\" };",
+ " request[\"routing\"] = routing;",
+ "",
+ " let updatedRequest = {",
+ " mode: \"raw\",",
+ " raw: JSON.stringify(request),",
+ " options: {",
+ " raw: {",
+ " language: \"json\",",
+ " },",
+ " },",
+ " };",
+ " pm.request.body.update(updatedRequest);",
+ " } catch (error) {",
+ " console.error(\"Failed to inject profile_id in the request\");",
+ " console.error(error);",
+ " }",
+ "}",
""
],
"type": "text/javascript"
@@ -200,7 +235,7 @@
"language": "json"
}
},
- "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}],\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"},{\"country\":\"GB\",\"business\":\"payouts\"}],\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
},
"url": {
"raw": "{{baseUrl}}/accounts",
@@ -370,6 +405,19 @@
" \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
" );",
"}",
+ "",
+ "// pm.collectionVariables - Set profile_id as variable for jsonData.payment_profile_id",
+ "if (jsonData?.profile_id) {",
+ " pm.collectionVariables.set(\"payment_profile_id\", jsonData.profile_id);",
+ " console.log(",
+ " \"- use {{payment_profile_id}} as collection variable for value\",",
+ " jsonData.profile_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_profile_id}}, as jsonData.profile_id is undefined.\",",
+ " );",
+ "}",
""
],
"type": "text/javascript"
@@ -448,6 +496,143 @@
},
"response": []
},
+ {
+ "name": "Payout Connector - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set profile_id as variable for jsonData.payout_profile_id",
+ "if (jsonData?.profile_id) {",
+ " pm.collectionVariables.set(\"payout_profile_id\", jsonData.profile_id);",
+ " console.log(",
+ " \"- use {{payout_profile_id}} as collection variable for value\",",
+ " jsonData.profile_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_profile_id}}, as jsonData.profile_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"payout_processor\",\"connector_name\":\"adyen\",\"connector_account_details\":{\"auth_type\":\"SignatureKey\",\"api_key\":\"{{connector_api_key}}\",\"key1\":\"{{connector_key1}}\",\"api_secret\":\"{{connector_api_secret}}\"},\"test_mode\":false,\"disabled\":false,\"business_country\":\"GB\",\"business_label\":\"payouts\",\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"pay_bright\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"walley\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"paypal\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mobile_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"ali_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"we_chat_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mb_way\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"giropay\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"blik\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"trustly\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_czech_republic\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_finland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_poland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_slovakia\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bancontact_card\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}]}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
{
"name": "Payments - Create",
"event": [
@@ -816,180 +1001,243 @@
"description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- }
- ]
- },
- {
- "name": "Happy Cases",
- "item": [
+ },
{
- "name": "Scenario10-Create a mandate and recurring payment",
- "item": [
+ "name": "Payouts - Create",
+ "event": [
{
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payouts/create - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Validate if status is successful",
+ "// if (jsonData?.status) {",
+ "// pm.test(\"[POST]::/payouts/create - Content check if value for 'status' matches 'success'\",",
+ "// function () {",
+ "// pm.expect(jsonData.status).to.eql(\"success\");",
+ "// },",
+ "// );",
+ "// }",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
}
+ },
+ "raw": "{\"amount\":1,\"currency\":\"EUR\",\"customer_id\":\"payout_customer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payout request\",\"connector\":[\"adyen\"],\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"iban\":\"NL46TEST0136169112\",\"bic\":\"ABNANL2A\",\"bank_name\":\"Deutsche Bank\",\"bank_country_code\":\"NL\",\"bank_city\":\"Amsterdam\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"entity_type\":\"Individual\",\"recurring\":true,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payouts - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payouts/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payouts/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payouts/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payouts/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payout_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
},
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Happy Cases",
+ "item": [
+ {
+ "name": "Scenario1-Create payment with confirm true",
+ "item": [
{
- "name": "Payments - Retrieve",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -1038,31 +1286,15 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
" pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
""
],
"type": "text/javascript"
@@ -1070,61 +1302,60 @@
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
},
{
- "name": "Recurring Payments - Create",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -1173,39 +1404,15 @@
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"Succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
" pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"payment_method_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
- " },",
- ");",
""
],
"type": "text/javascript"
@@ -1213,60 +1420,66 @@
}
],
"request": {
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
- },
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario2-Create payment with confirm false",
+ "item": [
{
- "name": "Payments - Retrieve-copy",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -1315,31 +1528,15 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
" },",
" );",
"}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
""
],
"type": "text/javascript"
@@ -1347,66 +1544,63 @@
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario11-Partial refund",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Payments - Confirm",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -1458,7 +1652,7 @@
"// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
" pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
@@ -1471,6 +1665,26 @@
}
],
"request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
"method": "POST",
"header": [
{
@@ -1489,18 +1703,27 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\"}"
},
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/payments/:id/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
},
"response": []
},
@@ -1573,10 +1796,10 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
" pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
@@ -1622,61 +1845,87 @@
"description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario3-Create payment without PMD",
+ "item": [
{
- "name": "Refunds - Create",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
"// Set response object as internal variable",
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
" console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"540\" for \"amount\"",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
" function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
" },",
" );",
"}",
@@ -1705,38 +1954,46 @@
"language": "json"
}
},
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"RETURN\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
- "raw": "{{baseUrl}}/refunds",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "refunds"
+ "payments"
]
},
- "description": "To create a refund against an already processed payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
},
{
- "name": "Refunds - Retrieve",
+ "name": "Payments - Confirm",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
@@ -1745,35 +2002,51 @@
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
" console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"6540\" for \"amount\"",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
@@ -1784,88 +2057,143 @@
}
],
"request": {
- "method": "GET",
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}}}"
+ },
"url": {
- "raw": "{{baseUrl}}/refunds/:id",
+ "raw": "{{baseUrl}}/payments/:id/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
- "refunds",
- ":id"
+ "payments",
+ ":id",
+ "confirm"
],
"variable": [
{
"key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
}
]
},
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
},
"response": []
},
{
- "name": "Refunds - Create-copy",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
"// Set response object as internal variable",
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
" console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"1000\" for \"amount\"",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.amount).to.eql(1000);",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
@@ -1876,93 +2204,120 @@
}
],
"request": {
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":1000,\"reason\":\"FRAUD\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
- },
"url": {
- "raw": "{{baseUrl}}/refunds",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
- "refunds"
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To create a refund against an already processed payment"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
- {
- "name": "Refunds - Retrieve-copy",
+ }
+ ]
+ },
+ {
+ "name": "Scenario4-Create payment with Manual capture",
+ "item": [
+ {
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
"// Set response object as internal variable",
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
" console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"6540\" for \"amount\"",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
" function () {",
- " pm.expect(jsonData.amount).to.eql(1000);",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
" },",
" );",
"}",
@@ -1973,55 +2328,63 @@
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
"url": {
- "raw": "{{baseUrl}}/refunds/:id",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
+ "payments"
]
},
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
},
{
- "name": "Payments - Retrieve-copy",
+ "name": "Payments - Capture",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -2070,20 +2433,35 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'processing'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
" },",
" );",
"}",
"",
- "// Response body should have \"refunds\"",
- "pm.test(\"[POST]::/payments - Content check if 'refunds' exists\", function () {",
- " pm.expect(typeof jsonData.refunds !== \"undefined\").to.be.true;",
- "});",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6000);",
+ " },",
+ " );",
+ "}",
""
],
"type": "text/javascript"
@@ -2091,27 +2469,35 @@
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/payments/:id/capture",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
+ ":id",
+ "capture"
],
"variable": [
{
@@ -2121,36 +2507,31 @@
}
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To capture the funds for an uncaptured payment"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario12-Bank Redirect-sofort",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -2199,12 +2580,12 @@
" );",
"}",
"",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'processing'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
" },",
" );",
"}",
@@ -2215,63 +2596,60 @@
}
],
"request": {
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
- },
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/payments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario5-Void the payment",
+ "item": [
{
- "name": "Payments - Confirm",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -2320,41 +2698,120 @@
" );",
"}",
"",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "// Response body should have value \"requires_capture\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
" },",
" );",
"}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Cancel",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
" function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
" },",
");",
"",
- "// Response body should have value \"sofort\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'sofort'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"sofort\");",
- " },",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"cancelled\" for \"status\"",
+ "if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " \"[POST]::/payments/:id/cancel - Content check if value for 'status' matches 'cancelled'\",",
" function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " pm.expect(jsonData.status).to.eql(\"cancelled\");",
" },",
" );",
"}",
@@ -2365,26 +2822,6 @@
}
],
"request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
"method": "POST",
"header": [
{
@@ -2403,17 +2840,17 @@
"language": "json"
}
},
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"sofort\",\"payment_method_data\":{\"bank_redirect\":{\"sofort\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
+ "raw": "{\"cancellation_reason\":\"requested_by_customer\"}"
},
"url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
+ "raw": "{{baseUrl}}/payments/:id/cancel",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
":id",
- "confirm"
+ "cancel"
],
"variable": [
{
@@ -2423,7 +2860,7 @@
}
]
},
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
},
"response": []
},
@@ -2496,12 +2933,12 @@
" );",
"}",
"",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "// Response body should have value \"cancelled\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'cancelled'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " pm.expect(jsonData.status).to.eql(\"cancelled\");",
" },",
" );",
"}",
@@ -2549,7 +2986,7 @@
]
},
{
- "name": "Scenario13-Bank Redirect-eps",
+ "name": "Scenario6-Create 3DS payment",
"item": [
{
"name": "Payments - Create",
@@ -2620,15 +3057,24 @@
" );",
"}",
"",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
" },",
" );",
"}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
""
],
"type": "text/javascript"
@@ -2654,7 +3100,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4917610000000000\",\"card_exp_month\":\"03\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -2670,29 +3116,26 @@
"response": []
},
{
- "name": "Payments - Confirm",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -2744,41 +3187,12 @@
"// Response body should have value \"requires_customer_action\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
" function () {",
" pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
" },",
" );",
"}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"eps\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'eps'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"eps\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
""
],
"type": "text/javascript"
@@ -2786,89 +3200,66 @@
}
],
"request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"eps\",\"payment_method_data\":{\"bank_redirect\":{\"eps\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"AT\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
- },
"url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
- ":id",
- "confirm"
+ ":id"
],
- "variable": [
+ "query": [
{
- "key": "id",
- "value": "{{payment_id}}",
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
"description": "(Required) unique payment id"
}
]
},
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario7-Create 3DS payment with confrm false",
+ "item": [
{
- "name": "Payments - Retrieve",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -2917,12 +3308,12 @@
" );",
"}",
"",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
" },",
" );",
"}",
@@ -2933,66 +3324,63 @@
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4917610000000000\",\"card_exp_month\":\"03\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario14-Refund recurring payment",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Payments - Confirm",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -3041,39 +3429,22 @@
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
" },",
" );",
"}",
"",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
+ "// Response body should have \"next_action.redirect_to_url\"",
"pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " \"[POST]::/payments/:id/confirm - Content check if 'next_action.redirect_to_url' exists\",",
" function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
" },",
");",
""
@@ -3083,6 +3454,26 @@
}
],
"request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
"method": "POST",
"header": [
{
@@ -3101,18 +3492,27 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}"
},
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/payments/:id/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
},
"response": []
},
@@ -3185,31 +3585,15 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
" },",
" );",
"}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
""
],
"type": "text/javascript"
@@ -3250,9 +3634,14 @@
"description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario9-Refund full payment",
+ "item": [
{
- "name": "Recurring Payments - Create",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
@@ -3329,40 +3718,6 @@
" },",
" );",
"}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"payment_method_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
- " },",
- ");",
""
],
"type": "text/javascript"
@@ -3388,7 +3743,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":6570,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -3404,7 +3759,7 @@
"response": []
},
{
- "name": "Payments - Retrieve-copy",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
@@ -3481,22 +3836,6 @@
" },",
" );",
"}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
""
],
"type": "text/javascript"
@@ -3539,7 +3878,7 @@
"response": []
},
{
- "name": "Refunds - Create Copy",
+ "name": "Refunds - Create",
"event": [
{
"listen": "test",
@@ -3636,7 +3975,7 @@
"response": []
},
{
- "name": "Refunds - Retrieve Copy",
+ "name": "Refunds - Retrieve",
"event": [
{
"listen": "test",
@@ -3730,7 +4069,7 @@
]
},
{
- "name": "Scenario15-Bank Redirect-giropay",
+ "name": "Scenario10-Create a mandate and recurring payment",
"item": [
{
"name": "Payments - Create",
@@ -3801,15 +4140,41 @@
" );",
"}",
"",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
""
],
"type": "text/javascript"
@@ -3835,7 +4200,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -3851,29 +4216,26 @@
"response": []
},
{
- "name": "Payments - Confirm",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -3922,44 +4284,31 @@
" );",
"}",
"",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "// Response body should have value \"Succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
"",
- "// Response body should have \"next_action.redirect_to_url\"",
+ "// Response body should have \"mandate_id\"",
"pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
" function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
" },",
");",
"",
- "// Response body should have value \"giropay\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'giropay'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"giropay\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
""
],
"type": "text/javascript"
@@ -3967,55 +4316,27 @@
}
],
"request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"giropay\",\"payment_method_data\":{\"bank_redirect\":{\"giropay\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
- },
"url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
- ":id",
- "confirm"
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
],
"variable": [
{
@@ -4025,31 +4346,31 @@
}
]
},
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
},
{
- "name": "Payments - Retrieve",
+ "name": "Recurring Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -4098,15 +4419,39 @@
" );",
"}",
"",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"payment_method_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
""
],
"type": "text/javascript"
@@ -4114,66 +4459,60 @@
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario16-Bank debit-ach",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Payments - Retrieve-copy",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -4222,15 +4561,31 @@
" );",
"}",
"",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "// Response body should have value \"Succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
""
],
"type": "text/javascript"
@@ -4238,63 +4593,66 @@
}
],
"request": {
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"amount\":10000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"off_session\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
- },
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario11-Partial refund",
+ "item": [
{
- "name": "Payments - Confirm",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -4343,35 +4701,15 @@
" );",
"}",
"",
- "// Response body should have value \"ach\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ach'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"ach\");",
- " },",
- " );",
- "}",
- "",
"// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
" pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
""
],
"type": "text/javascript"
@@ -4379,26 +4717,6 @@
}
],
"request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
"method": "POST",
"header": [
{
@@ -4417,27 +4735,18 @@
"language": "json"
}
},
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_debit\",\"payment_method_type\":\"ach\",\"payment_method_data\":{\"bank_debit\":{\"ach_bank_debit\":{\"account_number\":\"40308669\",\"routing_number\":\"121000358\",\"sort_code\":\"560036\",\"shopper_email\":\"[email protected]\",\"card_holder_name\":\"joseph Doe\",\"bank_account_holder_name\":\"David Archer\",\"billing_details\":{\"houseNumberOrName\":\"50\",\"street\":\"Test Street\",\"city\":\"Amsterdam\",\"stateOrProvince\":\"NY\",\"postalCode\":\"12010\",\"country\":\"US\",\"name\":\"A. Klaassen\",\"email\":\"[email protected]\"},\"reference\":\"daslvcgbaieh\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
},
@@ -4510,10 +4819,10 @@
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"Succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
" pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
@@ -4559,87 +4868,61 @@
"description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario17-Bank debit-Bacs",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Refunds - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
"// Set response object as internal variable",
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
" console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
" );",
"}",
"",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
" );",
"}",
"",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "// Response body should have value \"540\" for \"amount\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " pm.expect(jsonData.amount).to.eql(540);",
" },",
" );",
"}",
@@ -4668,46 +4951,38 @@
"language": "json"
}
},
- "raw": "{\"amount\":100,\"currency\":\"GBP\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"off_session\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"GB\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"RETURN\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/refunds",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "refunds"
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "To create a refund against an already processed payment"
},
"response": []
},
{
- "name": "Payments - Confirm",
+ "name": "Refunds - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
"});",
"",
"// Set response object as internal variable",
@@ -4716,71 +4991,127 @@
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
" console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
" );",
"}",
"",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
" );",
"}",
"",
- "// Response body should have value \"processing\" for \"status\"",
+ "// Response body should have value \"6540\" for \"amount\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'processing'\",",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " pm.expect(jsonData.amount).to.eql(540);",
" },",
" );",
"}",
- "",
- "// Response body should have value \"bacs\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'bacs'\",",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
" function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"bacs\");",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
" },",
" );",
"}",
"",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
+ "// Response body should have value \"1000\" for \"amount\"",
+ "if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
" function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " pm.expect(jsonData.amount).to.eql(1000);",
" },",
" );",
"}",
@@ -4791,26 +5122,6 @@
}
],
"request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
"method": "POST",
"header": [
{
@@ -4829,32 +5140,115 @@
"language": "json"
}
},
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_debit\",\"payment_method_type\":\"bacs\",\"payment_method_data\":{\"bank_debit\":{\"bacs_bank_debit\":{\"account_number\":\"40308669\",\"routing_number\":\"121000358\",\"sort_code\":\"560036\",\"shopper_email\":\"[email protected]\",\"card_holder_name\":\"joseph Doe\",\"bank_account_holder_name\":\"David Archer\",\"billing_details\":{\"houseNumberOrName\":\"50\",\"street\":\"Test Street\",\"city\":\"Amsterdam\",\"stateOrProvince\":\"NY\",\"postalCode\":\"12010\",\"country\":\"GB\",\"name\":\"A. Klaassen\",\"email\":\"[email protected]\"},\"reference\":\"daslvcgbaieh\"}}}}"
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":1000,\"reason\":\"FRAUD\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
+ "raw": "{{baseUrl}}/refunds",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id",
- "confirm"
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(1000);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
],
"variable": [
{
"key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
}
]
},
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
},
{
- "name": "Payments - Retrieve",
+ "name": "Payments - Retrieve-copy",
"event": [
{
"listen": "test",
@@ -4922,15 +5316,20 @@
" );",
"}",
"",
- "// Response body should have value \"processing\" for \"status\"",
+ "// Response body should have value \"Succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'processing'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
+ "",
+ "// Response body should have \"refunds\"",
+ "pm.test(\"[POST]::/payments - Content check if 'refunds' exists\", function () {",
+ " pm.expect(typeof jsonData.refunds !== \"undefined\").to.be.true;",
+ "});",
""
],
"type": "text/javascript"
@@ -4975,7 +5374,7 @@
]
},
{
- "name": "Scenario18-Bank Redirect-Trustly",
+ "name": "Scenario12-Bank Redirect-sofort",
"item": [
{
"name": "Payments - Create",
@@ -5080,7 +5479,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"FI\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -5186,12 +5585,12 @@
" },",
");",
"",
- "// Response body should have value \"giropay\" for \"payment_method_type\"",
+ "// Response body should have value \"sofort\" for \"payment_method_type\"",
"if (jsonData?.payment_method_type) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'trustly'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'sofort'\",",
" function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"trustly\");",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"sofort\");",
" },",
" );",
"}",
@@ -5250,7 +5649,7 @@
"language": "json"
}
},
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"trustly\",\"payment_method_data\":{\"bank_redirect\":{\"trustly\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"FI\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"sofort\",\"payment_method_data\":{\"bank_redirect\":{\"sofort\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments/:id/confirm",
@@ -5396,7 +5795,7 @@
]
},
{
- "name": "Scenario19-Add card flow",
+ "name": "Scenario13-Bank Redirect-eps",
"item": [
{
"name": "Payments - Create",
@@ -5405,256 +5804,78 @@
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx ",
+ "// Validate status 2xx",
"pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
"pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
"});",
"",
- "// Validate if response has JSON Body ",
+ "// Validate if response has JSON Body",
"pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for a Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
- " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":customer_id",
- "payment_methods"
- ],
- "query": [
- {
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
- {
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
- },
- "response": []
- },
- {
- "name": "Save card payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
"",
"// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
"if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
"",
"// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
"if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
"",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
],
"type": "text/javascript"
}
@@ -5679,7 +5900,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -5695,7 +5916,7 @@
"response": []
},
{
- "name": "Save card payments - Confirm",
+ "name": "Payments - Confirm",
"event": [
{
"listen": "test",
@@ -5766,16 +5987,34 @@
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
" },",
" );",
"}",
"",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"eps\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'eps'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"eps\");",
+ " },",
+ " );",
+ "}",
"",
"// Response body should have value \"adyen\" for \"connector\"",
"if (jsonData?.connector) {",
@@ -5831,7 +6070,7 @@
"language": "json"
}
},
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"7373\"}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"eps\",\"payment_method_data\":{\"bank_redirect\":{\"eps\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"AT\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments/:id/confirm",
@@ -5856,7 +6095,7 @@
"response": []
},
{
- "name": "Payments - Retrieve Copy",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
@@ -5924,47 +6163,12 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- "});",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
" function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
" },",
" );",
"}",
@@ -6008,69 +6212,116 @@
"description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario14-Refund recurring payment",
+ "item": [
{
- "name": "Refunds - Create",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
"// Set response object as internal variable",
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
" console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
" );",
"}",
"",
"// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
"",
- "// Response body should have value \"540\" for \"amount\"",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
"",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- "});",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
""
],
"type": "text/javascript"
@@ -6096,78 +6347,115 @@
"language": "json"
}
},
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"FRAUD\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
- "raw": "{{baseUrl}}/refunds",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "refunds"
+ "payments"
]
},
- "description": "To create a refund against an already processed payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
},
{
- "name": "Refunds - Retrieve",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
"// Set response object as internal variable",
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
" console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"6540\" for \"amount\"",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
""
],
"type": "text/javascript"
@@ -6183,88 +6471,145 @@
}
],
"url": {
- "raw": "{{baseUrl}}/refunds/:id",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
- "refunds",
+ "payments",
":id"
],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
"variable": [
{
"key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
}
]
},
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario20-Pass Invalid CVV for save card flow and verify failed payment",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Recurring Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx ",
+ "// Validate status 2xx",
"pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
"pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
"});",
"",
- "// Validate if response has JSON Body ",
+ "// Validate if response has JSON Body",
"pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
"",
"// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
"if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
"",
"// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
"if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
"",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"payment_method_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
],
"type": "text/javascript"
}
@@ -6289,7 +6634,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":6570,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -6305,32 +6650,100 @@
"response": []
},
{
- "name": "List payment methods for a Customer",
+ "name": "Payments - Retrieve-copy",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
"",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
- " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
- "}"
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
],
"type": "text/javascript"
}
@@ -6345,126 +6758,90 @@
}
],
"url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
- "customers",
- ":customer_id",
- "payment_methods"
+ "payments",
+ ":id"
],
"query": [
{
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
- {
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
+ "key": "force_sync",
+ "value": "true"
}
],
"variable": [
{
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
- }
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
},
{
- "name": "Save card payments - Create",
+ "name": "Refunds - Create Copy",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
"",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
"",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
"",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
],
"type": "text/javascript"
}
@@ -6489,46 +6866,38 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"DUPLICATE\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/refunds",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "refunds"
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "To create a refund against an already processed payment"
},
"response": []
},
{
- "name": "Save card payments - Confirm",
+ "name": "Refunds - Retrieve Copy",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
"});",
"",
"// Set response object as internal variable",
@@ -6537,172 +6906,99 @@
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
" console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"failed\" for \"status\"",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
" function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
" },",
" );",
"}",
"",
- "// Response body should have value \"24\" for \"error_code\"",
- "if (jsonData?.error_code) {",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches '24'\",",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
" function () {",
- " pm.expect(jsonData.error_code).to.eql(\"24\");",
+ " pm.expect(jsonData.amount).to.eql(6540);",
" },",
" );",
"}",
- "",
- "// Response body should have value \"24\" for \"error_message\"",
- "if (jsonData?.error_message) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'CVC Declined'\",",
- " function () {",
- " pm.expect(jsonData.error_message).to.eql(\"CVC Declined\");",
- " },",
- " );",
- "}"
+ ""
],
"type": "text/javascript"
}
}
],
"request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"737\"}"
- },
"url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
+ "raw": "{{baseUrl}}/refunds/:id",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id",
- "confirm"
+ "refunds",
+ ":id"
],
"variable": [
{
"key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
}
]
},
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario15-Bank Redirect-giropay",
+ "item": [
{
- "name": "Payments - Retrieve",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -6751,47 +7047,12 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- "});",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
- " function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
" },",
" );",
"}",
@@ -6802,108 +7063,176 @@
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Payments - Confirm",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
"",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
"",
"// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
"if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
"",
"// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
"if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
"",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"giropay\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'giropay'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"giropay\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ ""
],
"type": "text/javascript"
}
}
],
"request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
"method": "POST",
"header": [
{
@@ -6922,48 +7251,109 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"giropay\",\"payment_method_data\":{\"bank_redirect\":{\"giropay\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
},
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/payments/:id/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
},
"response": []
},
{
- "name": "List payment methods for a Customer",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
"",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
- " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
- "}"
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
],
"type": "text/javascript"
}
@@ -6975,129 +7365,119 @@
{
"key": "Accept",
"value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":customer_id",
- "payment_methods"
- ],
- "query": [
- {
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
{
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
+ "key": "force_sync",
+ "value": "true"
}
],
"variable": [
{
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
}
]
},
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario16-Bank debit-ach",
+ "item": [
{
- "name": "Save card payments - Create",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx ",
+ "// Validate status 2xx",
"pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
"pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
"});",
"",
- "// Validate if response has JSON Body ",
+ "// Validate if response has JSON Body",
"pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
"",
"// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
"if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
"",
"// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
"if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
"} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
"",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
],
"type": "text/javascript"
}
@@ -7122,7 +7502,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":10000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"off_session\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -7138,7 +7518,7 @@
"response": []
},
{
- "name": "Save card payments - Confirm",
+ "name": "Payments - Confirm",
"event": [
{
"listen": "test",
@@ -7209,44 +7589,36 @@
" );",
"}",
"",
- "// Response body should have value \"failed\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
+ "// Response body should have value \"ach\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ach'\",",
" function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"ach\");",
" },",
" );",
"}",
"",
- "// Response body should have value \"24\" for \"error_code\"",
- "if (jsonData?.error_code) {",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches '24'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.error_code).to.eql(\"24\");",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
"",
- "// Response body should have value \"24\" for \"error_message\"",
- "if (jsonData?.error_message) {",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'CVC Declined'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
" function () {",
- " pm.expect(jsonData.error_message).to.eql(\"CVC Declined\");",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
" },",
" );",
- "}"
+ "}",
+ ""
],
"type": "text/javascript"
}
@@ -7291,17 +7663,136 @@
"language": "json"
}
},
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\"}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_debit\",\"payment_method_type\":\"ach\",\"payment_method_data\":{\"bank_debit\":{\"ach_bank_debit\":{\"account_number\":\"40308669\",\"routing_number\":\"121000358\",\"sort_code\":\"560036\",\"shopper_email\":\"[email protected]\",\"card_holder_name\":\"joseph Doe\",\"bank_account_holder_name\":\"David Archer\",\"billing_details\":{\"houseNumberOrName\":\"50\",\"street\":\"Test Street\",\"city\":\"Amsterdam\",\"stateOrProvince\":\"NY\",\"postalCode\":\"12010\",\"country\":\"US\",\"name\":\"A. Klaassen\",\"email\":\"[email protected]\"},\"reference\":\"daslvcgbaieh\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
},
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
"url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
- ":id",
- "confirm"
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
],
"variable": [
{
@@ -7311,31 +7802,36 @@
}
]
},
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario17-Bank debit-Bacs",
+ "item": [
{
- "name": "Payments - Retrieve",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -7384,47 +7880,12 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- "});",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
" function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
" },",
" );",
"}",
@@ -7435,66 +7896,63 @@
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":100,\"currency\":\"GBP\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"off_session\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"GB\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario1-Create payment with confirm true",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Payments - Confirm",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -7543,12 +8001,32 @@
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"processing\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'processing'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"bacs\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'bacs'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"bacs\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
" },",
" );",
"}",
@@ -7559,6 +8037,26 @@
}
],
"request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
"method": "POST",
"header": [
{
@@ -7577,18 +8075,27 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_debit\",\"payment_method_type\":\"bacs\",\"payment_method_data\":{\"bank_debit\":{\"bacs_bank_debit\":{\"account_number\":\"40308669\",\"routing_number\":\"121000358\",\"sort_code\":\"560036\",\"shopper_email\":\"[email protected]\",\"card_holder_name\":\"joseph Doe\",\"bank_account_holder_name\":\"David Archer\",\"billing_details\":{\"houseNumberOrName\":\"50\",\"street\":\"Test Street\",\"city\":\"Amsterdam\",\"stateOrProvince\":\"NY\",\"postalCode\":\"12010\",\"country\":\"GB\",\"name\":\"A. Klaassen\",\"email\":\"[email protected]\"},\"reference\":\"daslvcgbaieh\"}}}}"
},
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/payments/:id/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
},
"response": []
},
@@ -7661,12 +8168,12 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"processing\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'processing'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
" },",
" );",
"}",
@@ -7714,7 +8221,7 @@
]
},
{
- "name": "Scenario2-Create payment with confirm false",
+ "name": "Scenario18-Bank Redirect-Trustly",
"item": [
{
"name": "Payments - Create",
@@ -7785,12 +8292,12 @@
" );",
"}",
"",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
" },",
" );",
"}",
@@ -7819,7 +8326,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"FI\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -7906,12 +8413,41 @@
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"giropay\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'trustly'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"trustly\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
" },",
" );",
"}",
@@ -7960,7 +8496,7 @@
"language": "json"
}
},
- "raw": "{\"client_secret\":\"{{client_secret}}\"}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"trustly\",\"payment_method_data\":{\"bank_redirect\":{\"trustly\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"FI\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments/:id/confirm",
@@ -8053,12 +8589,12 @@
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
" },",
" );",
"}",
@@ -8106,7 +8642,7 @@
]
},
{
- "name": "Scenario3-Create payment without PMD",
+ "name": "Scenario19-Add card flow",
"item": [
{
"name": "Payments - Create",
@@ -8115,78 +8651,56 @@
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx",
+ "// Validate status 2xx ",
"pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
"pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
"});",
"",
- "// Validate if response has JSON Body",
+ "// Validate if response has JSON Body ",
"pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
+ "try {jsonData = pm.response.json();}catch(e){}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
"",
"// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
"if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
"",
"// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
"if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
"",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
],
"type": "text/javascript"
}
@@ -8211,7 +8725,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -8227,300 +8741,229 @@
"response": []
},
{
- "name": "Payments - Confirm",
+ "name": "List payment methods for a Customer",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
+ "try {jsonData = pm.response.json();}catch(e){}",
"",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
+ " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
+ " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
+ "}"
],
"type": "text/javascript"
}
}
],
"request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}}}"
- },
"url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id",
- "confirm"
+ "customers",
+ ":customer_id",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
+ }
],
"variable": [
{
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
}
]
},
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
},
"response": []
},
{
- "name": "Payments - Retrieve",
+ "name": "Save card payments - Create",
"event": [
{
"listen": "test",
"script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
"});",
"",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
+ "try {jsonData = pm.response.json();}catch(e){}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
"",
"// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
"if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
"",
"// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
"if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
],
"type": "text/javascript"
}
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario4-Create payment with Manual capture",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Save card payments - Confirm",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -8569,12 +9012,23 @@
" );",
"}",
"",
- "// Response body should have value \"requires_capture\" for \"status\"",
+ "// Response body should have value \"succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "",
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
" },",
" );",
"}",
@@ -8585,6 +9039,26 @@
}
],
"request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
"method": "POST",
"header": [
{
@@ -8603,45 +9077,51 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"7373\"}"
},
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/payments/:id/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
},
"response": []
},
{
- "name": "Payments - Capture",
+ "name": "Payments - Retrieve Copy",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -8690,16 +9170,21 @@
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"Succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'processing'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
" },",
" );",
"}",
"",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ "});",
+ "",
"// Response body should have value \"6540\" for \"amount\"",
"if (jsonData?.amount) {",
" pm.test(",
@@ -8715,7 +9200,17 @@
" pm.test(",
" \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
" function () {",
- " pm.expect(jsonData.amount_received).to.eql(6000);",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
" },",
" );",
"}",
@@ -8726,35 +9221,27 @@
}
],
"request": {
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
- },
"url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
- ":id",
- "capture"
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
],
"variable": [
{
@@ -8764,88 +9251,72 @@
}
]
},
- "description": "To capture the funds for an uncaptured payment"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
},
{
- "name": "Payments - Retrieve",
+ "name": "Refunds - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
"// Set response object as internal variable",
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
" console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
" );",
"}",
"",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"540\" for \"amount\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'processing'\",",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " pm.expect(jsonData.amount).to.eql(540);",
" },",
" );",
"}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ "});",
""
],
"type": "text/javascript"
@@ -8853,114 +9324,93 @@
}
],
"request": {
- "method": "GET",
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"FRAUD\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id",
+ "raw": "{{baseUrl}}/refunds",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "refunds"
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To create a refund against an already processed payment"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario5-Void the payment",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Refunds - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
"// Set response object as internal variable",
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
" console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
" );",
"}",
"",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
" );",
"}",
"",
- "// Response body should have value \"requires_capture\" for \"status\"",
+ "// Response body should have value \"6540\" for \"amount\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " pm.expect(jsonData.amount).to.eql(540);",
" },",
" );",
"}",
@@ -8971,108 +9421,96 @@
}
],
"request": {
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
- },
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/refunds/:id",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario20-Pass Invalid CVV for save card flow and verify failed payment",
+ "item": [
{
- "name": "Payments - Cancel",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
"",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
+ "try {jsonData = pm.response.json();}catch(e){}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
"",
"// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
"if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
"",
- "// Response body should have value \"cancelled\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/cancel - Content check if value for 'status' matches 'cancelled'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"cancelled\");",
- " },",
- " );",
- "}",
- ""
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
],
"type": "text/javascript"
}
@@ -9097,109 +9535,48 @@
"language": "json"
}
},
- "raw": "{\"cancellation_reason\":\"requested_by_customer\"}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
- "raw": "{{baseUrl}}/payments/:id/cancel",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id",
- "cancel"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
},
{
- "name": "Payments - Retrieve",
+ "name": "List payment methods for a Customer",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
+ "try {jsonData = pm.response.json();}catch(e){}",
"",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
+ " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"cancelled\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'cancelled'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"cancelled\");",
- " },",
- " );",
- "}",
- ""
+ " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
+ "}"
],
"type": "text/javascript"
}
@@ -9214,125 +9591,126 @@
}
],
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
+ "customers",
+ ":customer_id",
+ "payment_methods"
],
"query": [
{
- "key": "force_sync",
- "value": "true"
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
}
],
"variable": [
{
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
}
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario6-Create 3DS payment",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Save card payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx",
+ "// Validate status 2xx ",
"pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
"pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
"});",
"",
- "// Validate if response has JSON Body",
+ "// Validate if response has JSON Body ",
"pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
+ "try {jsonData = pm.response.json();}catch(e){}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
"",
"// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
"if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
"",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
],
"type": "text/javascript"
}
@@ -9357,7 +9735,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4917610000000000\",\"card_exp_month\":\"03\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -9373,26 +9751,29 @@
"response": []
},
{
- "name": "Payments - Retrieve",
+ "name": "Save card payments - Confirm",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -9441,43 +9822,99 @@
" );",
"}",
"",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "// Response body should have value \"failed\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'failed'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
" },",
" );",
"}",
- ""
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"24\" for \"error_code\"",
+ "if (jsonData?.error_code) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches '24'\",",
+ " function () {",
+ " pm.expect(jsonData.error_code).to.eql(\"24\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"24\" for \"error_message\"",
+ "if (jsonData?.error_message) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'CVC Declined'\",",
+ " function () {",
+ " pm.expect(jsonData.error_message).to.eql(\"CVC Declined\");",
+ " },",
+ " );",
+ "}"
],
"type": "text/javascript"
}
}
],
"request": {
- "method": "GET",
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
"header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
{
"key": "Accept",
"value": "application/json"
}
],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"737\"}"
+ },
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/payments/:id/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
"payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
+ ":id",
+ "confirm"
],
"variable": [
{
@@ -9487,36 +9924,31 @@
}
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario7-Create 3DS payment with confrm false",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -9565,12 +9997,47 @@
" );",
"}",
"",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "// Response body should have value \"Succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ "});",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
" },",
" );",
"}",
@@ -9581,156 +10048,108 @@
}
],
"request": {
- "method": "POST",
+ "method": "GET",
"header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
{
"key": "Accept",
"value": "application/json"
}
],
- "body": {
- "mode": "raw",
- "options": {
- "raw": {
- "language": "json"
- }
- },
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4917610000000000\",\"card_exp_month\":\"03\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
- },
"url": {
- "raw": "{{baseUrl}}/payments",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments"
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
- },
+ }
+ ]
+ },
+ {
+ "name": "Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy",
+ "item": [
{
- "name": "Payments - Confirm",
+ "name": "Payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
"",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
+ "try {jsonData = pm.response.json();}catch(e){}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
"",
"// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
"if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
"",
"// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
"if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
"",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
],
"type": "text/javascript"
}
}
],
"request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
"method": "POST",
"header": [
{
@@ -9749,109 +10168,48 @@
"language": "json"
}
},
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
+ "raw": "{{baseUrl}}/payments",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
+ "payments"
]
},
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
},
"response": []
},
{
- "name": "Payments - Retrieve",
+ "name": "List payment methods for a Customer",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
+ "try {jsonData = pm.response.json();}catch(e){}",
"",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
+ " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
+ " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
+ "}"
],
"type": "text/javascript"
}
@@ -9866,116 +10224,126 @@
}
],
"url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
"host": [
"{{baseUrl}}"
],
"path": [
- "payments",
- ":id"
+ "customers",
+ ":customer_id",
+ "payment_methods"
],
"query": [
{
- "key": "force_sync",
- "value": "true"
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
}
],
"variable": [
{
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
}
]
},
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
},
"response": []
- }
- ]
- },
- {
- "name": "Scenario9-Refund full payment",
- "item": [
+ },
{
- "name": "Payments - Create",
+ "name": "Save card payments - Create",
"event": [
{
"listen": "test",
"script": {
"exec": [
- "// Validate status 2xx",
+ "// Validate status 2xx ",
"pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
+ " pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
"pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
"});",
"",
- "// Validate if response has JSON Body",
+ "// Validate if response has JSON Body ",
"pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
+ " pm.response.to.have.jsonBody();",
"});",
"",
"// Set response object as internal variable",
"let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
+ "try {jsonData = pm.response.json();}catch(e){}",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
"",
"// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
"if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
"",
"// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
"if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
"} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
],
"type": "text/javascript"
}
@@ -10000,7 +10368,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
@@ -10016,26 +10384,29 @@
"response": []
},
{
- "name": "Payments - Retrieve",
+ "name": "Save card payments - Confirm",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
"",
"// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
" pm.response.to.have.jsonBody();",
"});",
"",
@@ -10084,120 +10455,70 @@
" );",
"}",
"",
- "// Response body should have value \"Succeeded\" for \"status\"",
+ "// Response body should have value \"failed\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'failed'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
" },",
" );",
"}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
+ "// Response body should have value \"24\" for \"error_code\"",
+ "if (jsonData?.error_code) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches '24'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " pm.expect(jsonData.error_code).to.eql(\"24\");",
" },",
" );",
"}",
"",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
+ "// Response body should have value \"24\" for \"error_message\"",
+ "if (jsonData?.error_message) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'CVC Declined'\",",
" function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
+ " pm.expect(jsonData.error_message).to.eql(\"CVC Declined\");",
" },",
" );",
- "}",
- ""
+ "}"
],
"type": "text/javascript"
}
}
],
"request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
"method": "POST",
"header": [
{
@@ -10216,78 +10537,143 @@
"language": "json"
}
},
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"DUPLICATE\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\"}"
},
"url": {
- "raw": "{{baseUrl}}/refunds",
+ "raw": "{{baseUrl}}/payments/:id/confirm",
"host": [
"{{baseUrl}}"
],
"path": [
- "refunds"
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
]
},
- "description": "To create a refund against an already processed payment"
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
},
"response": []
},
{
- "name": "Refunds - Retrieve",
+ "name": "Payments - Retrieve",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
" pm.response.to.be.success;",
"});",
"",
"// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
" pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
" \"application/json\",",
" );",
"});",
"",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
"// Set response object as internal variable",
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
"} catch (e) {}",
"",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
" console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
" );",
"} else {",
" console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
" );",
"}",
"",
- "// Response body should have value \"succeeded\" for \"status\"",
+ "// Response body should have value \"Succeeded\" for \"status\"",
"if (jsonData?.status) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
" function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
" },",
" );",
"}",
"",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ "});",
+ "",
"// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
+ "if (jsonData?.amount) {",
" pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
" function () {",
" pm.expect(jsonData.amount).to.eql(6540);",
" },",
" );",
"}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " },",
+ " );",
+ "}",
""
],
"type": "text/javascript"
@@ -10303,23 +10689,29 @@
}
],
"url": {
- "raw": "{{baseUrl}}/refunds/:id",
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
"host": [
"{{baseUrl}}"
],
"path": [
- "refunds",
+ "payments",
":id"
],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
"variable": [
{
"key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
}
]
},
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
},
"response": []
}
@@ -13542,6 +13934,221 @@
"response": []
}
]
+ },
+ {
+ "name": "Scenario10-Create payouts using unsupported methods",
+ "item": [
+ {
+ "name": "ACH Payouts - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 4xx\", function () {",
+ " pm.response.to.be.clientError;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":10000,\"currency\":\"USD\",\"customer_id\":\"payout_customer\",\"email\":\"[email protected]\",\"name\":\"Doest John\",\"phone\":\"6168205366\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payout request\",\"connector\":[\"adyen\"],\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"bank_routing_number\":\"110000000\",\"bank_account_number\":\"000123456789\",\"bank_name\":\"Stripe Test Bank\",\"bank_country_code\":\"US\",\"bank_city\":\"California\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"Doest\",\"last_name\":\"John\"},\"phone\":{\"number\":\"6168205366\",\"country_code\":\"1\"}},\"entity_type\":\"Individual\",\"recurring\":false,\"metadata\":{\"ref\":\"123\",\"vendor_details\":{\"account_type\":\"custom\",\"business_type\":\"individual\",\"business_profile_mcc\":5045,\"business_profile_url\":\"https://www.pastebin.com\",\"business_profile_name\":\"pT\",\"company_address_line1\":\"address_full_match\",\"company_address_line2\":\"Kimberly Way\",\"company_address_postal_code\":\"31062\",\"company_address_city\":\"Milledgeville\",\"company_address_state\":\"GA\",\"company_phone\":\"+16168205366\",\"company_tax_id\":\"000000000\",\"company_owners_provided\":false,\"capabilities_card_payments\":true,\"capabilities_transfers\":true},\"individual_details\":{\"tos_acceptance_date\":1680581051,\"tos_acceptance_ip\":\"103.159.11.202\",\"individual_dob_day\":\"01\",\"individual_dob_month\":\"01\",\"individual_dob_year\":\"1901\",\"individual_id_number\":\"000000000\",\"individual_ssn_last_4\":\"0000\",\"external_account_account_holder_type\":\"individual\"}},\"confirm\":true,\"auto_fulfill\":true}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Bacs Payouts - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 4xx\", function () {",
+ " pm.response.to.be.clientError;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1,\"currency\":\"GBP\",\"customer_id\":\"payout_customer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payout request\",\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"bank_sort_code\":\"231470\",\"bank_account_number\":\"28821822\",\"bank_name\":\"Deutsche Bank\",\"bank_country_code\":\"NL\",\"bank_city\":\"Amsterdam\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"entity_type\":\"Individual\",\"recurring\":true,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true,\"connector\":[\"adyen\"],\"business_label\":\"abcd\",\"business_country\":\"US\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
}
]
}
@@ -13614,6 +14221,11 @@
"key": "refund_id",
"value": ""
},
+ {
+ "key": "payout_id",
+ "value": "",
+ "type": "string"
+ },
{
"key": "merchant_connector_id",
"value": ""
@@ -13665,6 +14277,16 @@
"key": "connector_api_secret",
"value": "",
"type": "string"
+ },
+ {
+ "key": "payment_profile_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "payout_profile_id",
+ "value": "",
+ "type": "string"
}
]
}
diff --git a/postman/collection-json/wise.postman_collection.json b/postman/collection-json/wise.postman_collection.json
new file mode 100644
index 00000000000..dc4d9395d3a
--- /dev/null
+++ b/postman/collection-json/wise.postman_collection.json
@@ -0,0 +1,1025 @@
+{
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);",
+ "}",
+ "",
+ "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "item": [
+ {
+ "name": "Health check",
+ "item": [
+ {
+ "name": "Health",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "x-feature",
+ "value": "router-custom",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/health",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "health"
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Flow Testcases",
+ "item": [
+ {
+ "name": "QuickStart",
+ "item": [
+ {
+ "name": "Merchant Account - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
+ " console.log(",
+ " \"- use {{merchant_id}} as collection variable for value\",",
+ " jsonData.merchant_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}],\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts"
+ ]
+ },
+ "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
+ },
+ "response": []
+ },
+ {
+ "name": "API Key - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Payout Connector - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"payout_processor\",\"connector_name\":\"wise\",\"connector_account_details\":{\"auth_type\":\"BodyKey\",\"api_key\":\"{{connector_api_key}}\",\"key1\":\"{{connector_key1}}\"},\"test_mode\":false,\"disabled\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"pay_bright\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"walley\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"paypal\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mobile_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"ali_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"we_chat_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mb_way\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"giropay\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"blik\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"trustly\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_czech_republic\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_finland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_poland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_slovakia\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bancontact_card\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"google_pay\":{\"allowed_payment_methods\":[{\"type\":\"CARD\",\"parameters\":{\"allowed_auth_methods\":[\"PAN_ONLY\",\"CRYPTOGRAM_3DS\"],\"allowed_card_networks\":[\"AMEX\",\"DISCOVER\",\"INTERAC\",\"JCB\",\"MASTERCARD\",\"VISA\"]},\"tokenization_specification\":{\"type\":\"PAYMENT_GATEWAY\"}}],\"merchant_info\":{\"merchant_name\":\"Narayan Bhat\"}},\"apple_pay\":{\"session_token_data\":{\"initiative\":\"web\",\"certificate\":\"{{certificate}}\",\"display_name\":\"applepay\",\"certificate_keys\":\"{{certificate_keys}}\",\"initiative_context\":\"hyperswitch-sdk-test.netlify.app\",\"merchant_identifier\":\"merchant.com.stripe.sang\"},\"payment_request_data\":{\"label\":\"applepay pvt.ltd\",\"supported_networks\":[\"visa\",\"masterCard\",\"amex\",\"discover\"],\"merchant_capabilities\":[\"supports3DS\"]}}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
+ {
+ "name": "Payouts - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1,\"currency\":\"EUR\",\"customer_id\":\"wise_customer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payout request\",\"connector\":[\"wise\"],\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"iban\":\"NL46TEST0136169112\",\"bic\":\"ABNANL2A\",\"bank_name\":\"Deutsche Bank\",\"bank_country_code\":\"NL\",\"bank_city\":\"Amsterdam\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"entity_type\":\"Individual\",\"recurring\":true,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Happy Cases",
+ "item": [
+ {
+ "name": "Scenario1 - Process Bacs Payout",
+ "item": [
+ {
+ "name": "Payouts - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1,\"currency\":\"GBP\",\"customer_id\":\"wise_customer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payout request\",\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"bank_sort_code\":\"231470\",\"bank_account_number\":\"28821822\",\"bank_name\":\"Deutsche Bank\",\"bank_country_code\":\"NL\",\"bank_city\":\"Amsterdam\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"entity_type\":\"Individual\",\"recurring\":true,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true,\"connector\":[\"wise\"]}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2 - Process SEPA Payout",
+ "item": [
+ {
+ "name": "Payouts - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1,\"currency\":\"EUR\",\"customer_id\":\"wise_customer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payout request\",\"connector\":[\"wise\"],\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"iban\":\"NL46TEST0136169112\",\"bic\":\"ABNANL2A\",\"bank_name\":\"Deutsche Bank\",\"bank_country_code\":\"NL\",\"bank_city\":\"Amsterdam\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"entity_type\":\"Individual\",\"recurring\":true,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "name": "Variation Cases",
+ "item": [
+ {
+ "name": "Scenario1 - Create ACH payout with invalid data",
+ "item": [
+ {
+ "name": "Payouts - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 4xx\", function () {",
+ " pm.response.to.be.clientError;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":10000,\"currency\":\"USD\",\"customer_id\":\"wise_customer\",\"email\":\"[email protected]\",\"name\":\"Doest John\",\"phone\":\"6168205366\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payout request\",\"connector\":[\"wise\"],\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"bank_routing_number\":\"110000000\",\"bank_account_number\":\"000123456789\",\"bank_name\":\"Stripe Test Bank\",\"bank_country_code\":\"US\",\"bank_city\":\"California\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"Doest\",\"last_name\":\"John\"},\"phone\":{\"number\":\"6168205366\",\"country_code\":\"1\"}},\"entity_type\":\"Individual\",\"recurring\":false,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "info": {
+ "_postman_id": "b5107328-6e3c-4ef0-b575-4072bc64462a",
+ "name": "wise",
+ "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [[email protected]](mailto:[email protected])",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+ },
+ "variable": [
+ {
+ "key": "baseUrl",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "admin_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "merchant_id",
+ "value": ""
+ },
+ {
+ "key": "payment_id",
+ "value": ""
+ },
+ {
+ "key": "customer_id",
+ "value": ""
+ },
+ {
+ "key": "mandate_id",
+ "value": ""
+ },
+ {
+ "key": "payment_method_id",
+ "value": ""
+ },
+ {
+ "key": "refund_id",
+ "value": ""
+ },
+ {
+ "key": "payout_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "merchant_connector_id",
+ "value": ""
+ },
+ {
+ "key": "client_secret",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_key1",
+ "value": ""
+ },
+ {
+ "key": "publishable_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "payment_token",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "gateway_merchant_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate_keys",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key_id",
+ "value": ""
+ },
+ {
+ "key": "connector_api_secret",
+ "value": "",
+ "type": "string"
+ }
+ ]
+}
|
test
|
update postman collection files
|
4051cbb4e7f708267b26439061e001bb00342cad
|
2024-04-03 15:16:18
|
Narayan Bhat
|
feat(api): add browser information in payments response (#3963)
| false
|
diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs
index 2748ccbff40..de8142ddde2 100644
--- a/crates/api_models/src/payments.rs
+++ b/crates/api_models/src/payments.rs
@@ -3186,6 +3186,10 @@ pub struct PaymentsResponse {
/// Payment Fingerprint
pub fingerprint: Option<String>,
+ #[schema(value_type = Option<BrowserInformation>)]
+ /// The browser information used for this payment
+ pub browser_info: Option<serde_json::Value>,
+
/// Payment Method Id
pub payment_method_id: Option<String>,
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index 96f5a2833d0..72dace68f07 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -475,14 +475,12 @@ where
let cloned_payment_data = payment_data.clone();
let cloned_customer = customer.clone();
- let cloned_request = req.clone();
crate::utils::trigger_payments_webhook(
merchant_account,
business_profile,
&key_store,
cloned_payment_data,
- Some(cloned_request),
cloned_customer,
state,
operation,
@@ -687,7 +685,7 @@ where
FData: Send + Sync,
Op: Operation<F, Req, Ctx> + Send + Sync + Clone,
Req: Debug + Authenticate + Clone,
- Res: transformers::ToResponse<Req, PaymentData<F>, Op>,
+ Res: transformers::ToResponse<PaymentData<F>, Op>,
// To create connector flow specific interface data
PaymentData<F>: ConstructFlowSpecificData<F, FData, router_types::PaymentsResponseData>,
router_types::RouterData<F, FData, router_types::PaymentsResponseData>: Feature<F, FData>,
@@ -706,7 +704,7 @@ where
.flat_map(|c| c.foreign_try_into())
.collect()
});
- let (payment_data, req, customer, connector_http_status_code, external_latency) =
+ let (payment_data, _req, customer, connector_http_status_code, external_latency) =
payments_operation_core::<_, _, _, _, Ctx>(
&state,
merchant_account,
@@ -721,7 +719,6 @@ where
.await?;
Res::generate_response(
- Some(req),
payment_data,
customer,
auth_flow,
diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs
index 3e06bb0a34d..0c7869fa3cb 100644
--- a/crates/router/src/core/payments/transformers.rs
+++ b/crates/router/src/core/payments/transformers.rs
@@ -185,14 +185,13 @@ where
Ok(router_data)
}
-pub trait ToResponse<Req, D, Op>
+pub trait ToResponse<D, Op>
where
Self: Sized,
Op: Debug,
{
#[allow(clippy::too_many_arguments)]
fn generate_response(
- req: Option<Req>,
data: D,
customer: Option<domain::Customer>,
auth_flow: services::AuthFlow,
@@ -205,14 +204,13 @@ where
) -> RouterResponse<Self>;
}
-impl<F, Req, Op> ToResponse<Req, PaymentData<F>, Op> for api::PaymentsResponse
+impl<F, Op> ToResponse<PaymentData<F>, Op> for api::PaymentsResponse
where
F: Clone,
Op: Debug,
{
#[allow(clippy::too_many_arguments)]
fn generate_response(
- req: Option<Req>,
payment_data: PaymentData<F>,
customer: Option<domain::Customer>,
auth_flow: services::AuthFlow,
@@ -242,7 +240,6 @@ where
});
payments_to_payments_response(
- req,
payment_data,
captures,
customer,
@@ -257,15 +254,13 @@ where
}
}
-impl<F, Req, Op> ToResponse<Req, PaymentData<F>, Op> for api::PaymentsSessionResponse
+impl<F, Op> ToResponse<PaymentData<F>, Op> for api::PaymentsSessionResponse
where
- Self: From<Req>,
F: Clone,
Op: Debug,
{
#[allow(clippy::too_many_arguments)]
fn generate_response(
- _req: Option<Req>,
payment_data: PaymentData<F>,
_customer: Option<domain::Customer>,
_auth_flow: services::AuthFlow,
@@ -291,15 +286,13 @@ where
}
}
-impl<F, Req, Op> ToResponse<Req, PaymentData<F>, Op> for api::VerifyResponse
+impl<F, Op> ToResponse<PaymentData<F>, Op> for api::VerifyResponse
where
- Self: From<Req>,
F: Clone,
Op: Debug,
{
#[allow(clippy::too_many_arguments)]
fn generate_response(
- _req: Option<Req>,
data: PaymentData<F>,
customer: Option<domain::Customer>,
_auth_flow: services::AuthFlow,
@@ -354,8 +347,7 @@ where
// try to use router data here so that already validated things , we don't want to repeat the validations.
// Add internal value not found and external value not found so that we can give 500 / Internal server error for internal value not found
#[allow(clippy::too_many_arguments)]
-pub fn payments_to_payments_response<R, Op, F: Clone>(
- payment_request: Option<R>,
+pub fn payments_to_payments_response<Op, F: Clone>(
payment_data: PaymentData<F>,
captures: Option<Vec<storage::Capture>>,
customer: Option<domain::Customer>,
@@ -510,44 +502,42 @@ where
.unwrap_or_default(),
);
- let output = Ok(match payment_request {
- Some(_request) => {
- if payments::is_start_pay(&operation) && payment_attempt.authentication_data.is_some() {
- let redirection_data = payment_attempt
- .authentication_data
- .get_required_value("redirection_data")?;
-
- let form: RedirectForm = serde_json::from_value(redirection_data)
- .map_err(|_| errors::ApiErrorResponse::InternalServerError)?;
-
- services::ApplicationResponse::Form(Box::new(services::RedirectionFormData {
- redirect_form: form,
- payment_method_data: payment_data.payment_method_data,
- amount,
- currency: currency.to_string(),
- }))
- } else {
- let mut next_action_response = None;
+ let output = if payments::is_start_pay(&operation)
+ && payment_attempt.authentication_data.is_some()
+ {
+ let redirection_data = payment_attempt
+ .authentication_data
+ .get_required_value("redirection_data")?;
+
+ let form: RedirectForm = serde_json::from_value(redirection_data)
+ .map_err(|_| errors::ApiErrorResponse::InternalServerError)?;
+
+ services::ApplicationResponse::Form(Box::new(services::RedirectionFormData {
+ redirect_form: form,
+ payment_method_data: payment_data.payment_method_data,
+ amount,
+ currency: currency.to_string(),
+ }))
+ } else {
+ let mut next_action_response = None;
- let bank_transfer_next_steps =
- bank_transfer_next_steps_check(payment_attempt.clone())?;
+ let bank_transfer_next_steps = bank_transfer_next_steps_check(payment_attempt.clone())?;
- let next_action_voucher = voucher_next_steps_check(payment_attempt.clone())?;
+ let next_action_voucher = voucher_next_steps_check(payment_attempt.clone())?;
- let next_action_containing_qr_code_url =
- qr_code_next_steps_check(payment_attempt.clone())?;
+ let next_action_containing_qr_code_url = qr_code_next_steps_check(payment_attempt.clone())?;
- let next_action_containing_wait_screen =
- wait_screen_next_steps_check(payment_attempt.clone())?;
+ let next_action_containing_wait_screen =
+ wait_screen_next_steps_check(payment_attempt.clone())?;
- if payment_intent.status == enums::IntentStatus::RequiresCustomerAction
- || bank_transfer_next_steps.is_some()
- || next_action_voucher.is_some()
- || next_action_containing_qr_code_url.is_some()
- || next_action_containing_wait_screen.is_some()
- || payment_data.authentication.is_some()
- {
- next_action_response = bank_transfer_next_steps
+ if payment_intent.status == enums::IntentStatus::RequiresCustomerAction
+ || bank_transfer_next_steps.is_some()
+ || next_action_voucher.is_some()
+ || next_action_containing_qr_code_url.is_some()
+ || next_action_containing_wait_screen.is_some()
+ || payment_data.authentication.is_some()
+ {
+ next_action_response = bank_transfer_next_steps
.map(|bank_transfer| {
api_models::payments::NextActionData::DisplayBankTransferInformation {
bank_transfer_steps_and_charges_details: bank_transfer,
@@ -610,261 +600,183 @@ where
},
None => None
});
- };
+ };
- // next action check for third party sdk session (for ex: Apple pay through trustpay has third party sdk session response)
- if third_party_sdk_session_next_action(&payment_attempt, operation) {
- next_action_response = Some(
- api_models::payments::NextActionData::ThirdPartySdkSessionToken {
- session_token: payment_data.sessions_token.first().cloned(),
- },
- )
- }
+ // next action check for third party sdk session (for ex: Apple pay through trustpay has third party sdk session response)
+ if third_party_sdk_session_next_action(&payment_attempt, operation) {
+ next_action_response = Some(
+ api_models::payments::NextActionData::ThirdPartySdkSessionToken {
+ session_token: payment_data.sessions_token.first().cloned(),
+ },
+ )
+ }
- let mut response: api::PaymentsResponse = Default::default();
- let routed_through = payment_attempt.connector.clone();
+ let mut response: api::PaymentsResponse = Default::default();
+ let routed_through = payment_attempt.connector.clone();
- let connector_label = routed_through.as_ref().and_then(|connector_name| {
- core_utils::get_connector_label(
- payment_intent.business_country,
- payment_intent.business_label.as_ref(),
- payment_attempt.business_sub_label.as_ref(),
- connector_name,
- )
- });
- services::ApplicationResponse::JsonWithHeaders((
- response
- .set_net_amount(payment_attempt.net_amount)
- .set_payment_id(Some(payment_attempt.payment_id))
- .set_merchant_id(Some(payment_attempt.merchant_id))
- .set_status(payment_intent.status)
- .set_amount(payment_attempt.amount)
- .set_amount_capturable(Some(payment_attempt.amount_capturable))
- .set_amount_received(payment_intent.amount_captured)
- .set_surcharge_details(surcharge_details)
- .set_connector(routed_through)
- .set_client_secret(payment_intent.client_secret.map(masking::Secret::new))
- .set_created(Some(payment_intent.created_at))
- .set_currency(currency.to_string())
- .set_customer_id(customer.as_ref().map(|cus| cus.clone().customer_id))
- .set_email(
- customer
- .as_ref()
- .and_then(|cus| cus.email.as_ref().map(|s| s.to_owned())),
- )
- .set_name(
- customer
- .as_ref()
- .and_then(|cus| cus.name.as_ref().map(|s| s.to_owned())),
- )
- .set_phone(
- customer
- .as_ref()
- .and_then(|cus| cus.phone.as_ref().map(|s| s.to_owned())),
- )
- .set_mandate_id(mandate_id)
- .set_mandate_data(
- payment_data.setup_mandate.map(|d| api::MandateData {
- customer_acceptance: d.customer_acceptance.map(|d| {
- api::CustomerAcceptance {
- acceptance_type: match d.acceptance_type {
- data_models::mandates::AcceptanceType::Online => {
- api::AcceptanceType::Online
- }
- data_models::mandates::AcceptanceType::Offline => {
- api::AcceptanceType::Offline
- }
- },
- accepted_at: d.accepted_at,
- online: d.online.map(|d| api::OnlineMandate {
- ip_address: d.ip_address,
- user_agent: d.user_agent,
- }),
- }
- }),
- mandate_type: d.mandate_type.map(|d| match d {
- data_models::mandates::MandateDataType::MultiUse(Some(i)) => {
- api::MandateType::MultiUse(Some(api::MandateAmountData {
- amount: i.amount,
- currency: i.currency,
- start_date: i.start_date,
- end_date: i.end_date,
- metadata: i.metadata,
- }))
- }
- data_models::mandates::MandateDataType::SingleUse(i) => {
- api::MandateType::SingleUse(
- api::payments::MandateAmountData {
- amount: i.amount,
- currency: i.currency,
- start_date: i.start_date,
- end_date: i.end_date,
- metadata: i.metadata,
- },
- )
+ let connector_label = routed_through.as_ref().and_then(|connector_name| {
+ core_utils::get_connector_label(
+ payment_intent.business_country,
+ payment_intent.business_label.as_ref(),
+ payment_attempt.business_sub_label.as_ref(),
+ connector_name,
+ )
+ });
+
+ services::ApplicationResponse::JsonWithHeaders((
+ response
+ .set_net_amount(payment_attempt.net_amount)
+ .set_payment_id(Some(payment_attempt.payment_id))
+ .set_merchant_id(Some(payment_attempt.merchant_id))
+ .set_status(payment_intent.status)
+ .set_amount(payment_attempt.amount)
+ .set_amount_capturable(Some(payment_attempt.amount_capturable))
+ .set_amount_received(payment_intent.amount_captured)
+ .set_surcharge_details(surcharge_details)
+ .set_connector(routed_through)
+ .set_client_secret(payment_intent.client_secret.map(masking::Secret::new))
+ .set_created(Some(payment_intent.created_at))
+ .set_currency(currency.to_string())
+ .set_customer_id(customer.as_ref().map(|cus| cus.clone().customer_id))
+ .set_email(
+ customer
+ .as_ref()
+ .and_then(|cus| cus.email.as_ref().map(|s| s.to_owned())),
+ )
+ .set_name(
+ customer
+ .as_ref()
+ .and_then(|cus| cus.name.as_ref().map(|s| s.to_owned())),
+ )
+ .set_phone(
+ customer
+ .as_ref()
+ .and_then(|cus| cus.phone.as_ref().map(|s| s.to_owned())),
+ )
+ .set_mandate_id(mandate_id)
+ .set_mandate_data(
+ payment_data.setup_mandate.map(|d| api::MandateData {
+ customer_acceptance: d.customer_acceptance.map(|d| {
+ api::CustomerAcceptance {
+ acceptance_type: match d.acceptance_type {
+ data_models::mandates::AcceptanceType::Online => {
+ api::AcceptanceType::Online
}
- data_models::mandates::MandateDataType::MultiUse(None) => {
- api::MandateType::MultiUse(None)
+ data_models::mandates::AcceptanceType::Offline => {
+ api::AcceptanceType::Offline
}
+ },
+ accepted_at: d.accepted_at,
+ online: d.online.map(|d| api::OnlineMandate {
+ ip_address: d.ip_address,
+ user_agent: d.user_agent,
}),
- update_mandate_id: d.update_mandate_id,
- }),
- auth_flow == services::AuthFlow::Merchant,
- )
- .set_description(payment_intent.description)
- .set_refunds(refunds_response) // refunds.iter().map(refund_to_refund_response),
- .set_disputes(disputes_response)
- .set_attempts(attempts_response)
- .set_captures(captures_response)
- .set_payment_method(
- payment_attempt.payment_method,
- auth_flow == services::AuthFlow::Merchant,
- )
- .set_payment_method_data(
- payment_method_data_response,
- auth_flow == services::AuthFlow::Merchant,
- )
- .set_payment_token(payment_attempt.payment_token)
- .set_error_message(
- payment_attempt
- .error_reason
- .or(payment_attempt.error_message),
- )
- .set_error_code(payment_attempt.error_code)
- .set_shipping(payment_data.address.get_shipping().cloned())
- .set_billing(payment_data.address.get_payment_billing().cloned())
- .set_next_action(next_action_response)
- .set_return_url(payment_intent.return_url)
- .set_cancellation_reason(payment_attempt.cancellation_reason)
- .set_authentication_type(payment_attempt.authentication_type)
- .set_statement_descriptor_name(payment_intent.statement_descriptor_name)
- .set_statement_descriptor_suffix(payment_intent.statement_descriptor_suffix)
- .set_setup_future_usage(payment_intent.setup_future_usage)
- .set_capture_method(payment_attempt.capture_method)
- .set_payment_experience(payment_attempt.payment_experience)
- .set_payment_method_type(payment_attempt.payment_method_type)
- .set_metadata(payment_intent.metadata)
- .set_order_details(payment_intent.order_details)
- .set_connector_label(connector_label)
- .set_business_country(payment_intent.business_country)
- .set_business_label(payment_intent.business_label)
- .set_business_sub_label(payment_attempt.business_sub_label)
- .set_allowed_payment_method_types(
- payment_intent.allowed_payment_method_types,
- )
- .set_ephemeral_key(
- payment_data.ephemeral_key.map(ForeignFrom::foreign_from),
- )
- .set_frm_message(frm_message)
- .set_merchant_decision(merchant_decision)
- .set_manual_retry_allowed(helpers::is_manual_retry_allowed(
- &payment_intent.status,
- &payment_attempt.status,
- connector_request_reference_id_config,
- &merchant_id,
- ))
- .set_connector_transaction_id(payment_attempt.connector_transaction_id)
- .set_feature_metadata(payment_intent.feature_metadata)
- .set_connector_metadata(payment_intent.connector_metadata)
- .set_reference_id(payment_attempt.connector_response_reference_id)
- .set_payment_link(payment_link_data)
- .set_profile_id(payment_intent.profile_id)
- .set_attempt_count(payment_intent.attempt_count)
- .set_merchant_connector_id(payment_attempt.merchant_connector_id)
- .set_unified_code(payment_attempt.unified_code)
- .set_unified_message(payment_attempt.unified_message)
- .set_incremental_authorization_allowed(
- payment_intent.incremental_authorization_allowed,
- )
- .set_external_authentication_details(external_authentication_details)
- .set_fingerprint(payment_intent.fingerprint_id)
- .set_authorization_count(payment_intent.authorization_count)
- .set_incremental_authorizations(incremental_authorizations_response)
- .set_expires_on(payment_intent.session_expiry)
- .set_external_3ds_authentication_attempted(
- payment_attempt.external_three_ds_authentication_attempted,
- )
- .set_payment_method_id(payment_attempt.payment_method_id)
- .set_payment_method_status(
- payment_data.payment_method_info.map(|info| info.status),
- )
- .set_customer(customer_details_response.clone())
- .to_owned(),
- headers,
- ))
- }
- }
- None => services::ApplicationResponse::JsonWithHeaders((
- api::PaymentsResponse {
- net_amount: payment_attempt.net_amount,
- payment_id: Some(payment_attempt.payment_id),
- merchant_id: Some(payment_attempt.merchant_id),
- status: payment_intent.status,
- amount: payment_attempt.amount,
- amount_capturable: None,
- amount_received: payment_intent.amount_captured,
- client_secret: payment_intent.client_secret.map(masking::Secret::new),
- created: Some(payment_intent.created_at),
- currency: currency.to_string(),
- customer_id: payment_intent.customer_id,
- description: payment_intent.description,
- refunds: refunds_response,
- disputes: disputes_response,
- attempts: attempts_response,
- captures: captures_response,
- payment_method: payment_attempt.payment_method,
- capture_method: payment_attempt.capture_method,
- error_message: payment_attempt
- .error_reason
- .or(payment_attempt.error_message),
- error_code: payment_attempt.error_code,
- payment_method_data: payment_method_data_response,
- email: customer
- .as_ref()
- .and_then(|cus| cus.email.as_ref().map(|s| s.to_owned())),
- name: customer
- .as_ref()
- .and_then(|cus| cus.name.as_ref().map(|s| s.to_owned())),
- phone: customer
- .as_ref()
- .and_then(|cus| cus.phone.as_ref().map(|s| s.to_owned())),
- mandate_id,
- shipping: payment_data.address.get_shipping().cloned(),
- billing: payment_data.address.get_payment_billing().cloned(),
- cancellation_reason: payment_attempt.cancellation_reason,
- payment_token: payment_attempt.payment_token,
- metadata: payment_intent.metadata,
- manual_retry_allowed: helpers::is_manual_retry_allowed(
+ }
+ }),
+ mandate_type: d.mandate_type.map(|d| match d {
+ data_models::mandates::MandateDataType::MultiUse(Some(i)) => {
+ api::MandateType::MultiUse(Some(api::MandateAmountData {
+ amount: i.amount,
+ currency: i.currency,
+ start_date: i.start_date,
+ end_date: i.end_date,
+ metadata: i.metadata,
+ }))
+ }
+ data_models::mandates::MandateDataType::SingleUse(i) => {
+ api::MandateType::SingleUse(api::payments::MandateAmountData {
+ amount: i.amount,
+ currency: i.currency,
+ start_date: i.start_date,
+ end_date: i.end_date,
+ metadata: i.metadata,
+ })
+ }
+ data_models::mandates::MandateDataType::MultiUse(None) => {
+ api::MandateType::MultiUse(None)
+ }
+ }),
+ update_mandate_id: d.update_mandate_id,
+ }),
+ auth_flow == services::AuthFlow::Merchant,
+ )
+ .set_description(payment_intent.description)
+ .set_refunds(refunds_response) // refunds.iter().map(refund_to_refund_response),
+ .set_disputes(disputes_response)
+ .set_attempts(attempts_response)
+ .set_captures(captures_response)
+ .set_payment_method(
+ payment_attempt.payment_method,
+ auth_flow == services::AuthFlow::Merchant,
+ )
+ .set_payment_method_data(
+ payment_method_data_response,
+ auth_flow == services::AuthFlow::Merchant,
+ )
+ .set_payment_token(payment_attempt.payment_token)
+ .set_error_message(
+ payment_attempt
+ .error_reason
+ .or(payment_attempt.error_message),
+ )
+ .set_error_code(payment_attempt.error_code)
+ .set_shipping(payment_data.address.get_shipping().cloned())
+ .set_billing(payment_data.address.get_payment_billing().cloned())
+ .set_next_action(next_action_response)
+ .set_return_url(payment_intent.return_url)
+ .set_cancellation_reason(payment_attempt.cancellation_reason)
+ .set_authentication_type(payment_attempt.authentication_type)
+ .set_statement_descriptor_name(payment_intent.statement_descriptor_name)
+ .set_statement_descriptor_suffix(payment_intent.statement_descriptor_suffix)
+ .set_setup_future_usage(payment_intent.setup_future_usage)
+ .set_capture_method(payment_attempt.capture_method)
+ .set_payment_experience(payment_attempt.payment_experience)
+ .set_payment_method_type(payment_attempt.payment_method_type)
+ .set_metadata(payment_intent.metadata)
+ .set_order_details(payment_intent.order_details)
+ .set_connector_label(connector_label)
+ .set_business_country(payment_intent.business_country)
+ .set_business_label(payment_intent.business_label)
+ .set_business_sub_label(payment_attempt.business_sub_label)
+ .set_allowed_payment_method_types(payment_intent.allowed_payment_method_types)
+ .set_ephemeral_key(payment_data.ephemeral_key.map(ForeignFrom::foreign_from))
+ .set_frm_message(frm_message)
+ .set_merchant_decision(merchant_decision)
+ .set_manual_retry_allowed(helpers::is_manual_retry_allowed(
&payment_intent.status,
&payment_attempt.status,
connector_request_reference_id_config,
&merchant_id,
- ),
- order_details: payment_intent.order_details,
- frm_message,
- connector_transaction_id: payment_attempt.connector_transaction_id,
- feature_metadata: payment_intent.feature_metadata,
- connector_metadata: payment_intent.connector_metadata,
- allowed_payment_method_types: payment_intent.allowed_payment_method_types,
- reference_id: payment_attempt.connector_response_reference_id,
- attempt_count: payment_intent.attempt_count,
- payment_link: payment_link_data,
- surcharge_details,
- unified_code: payment_attempt.unified_code,
- unified_message: payment_attempt.unified_message,
- incremental_authorization_allowed: payment_intent.incremental_authorization_allowed,
- authorization_count: payment_intent.authorization_count,
- incremental_authorizations: incremental_authorizations_response,
- external_authentication_details,
- expires_on: payment_intent.session_expiry,
- external_3ds_authentication_attempted: payment_attempt
- .external_three_ds_authentication_attempted,
- customer: customer_details_response,
- ..Default::default()
- },
+ ))
+ .set_connector_transaction_id(payment_attempt.connector_transaction_id)
+ .set_feature_metadata(payment_intent.feature_metadata)
+ .set_connector_metadata(payment_intent.connector_metadata)
+ .set_reference_id(payment_attempt.connector_response_reference_id)
+ .set_payment_link(payment_link_data)
+ .set_profile_id(payment_intent.profile_id)
+ .set_attempt_count(payment_intent.attempt_count)
+ .set_merchant_connector_id(payment_attempt.merchant_connector_id)
+ .set_unified_code(payment_attempt.unified_code)
+ .set_unified_message(payment_attempt.unified_message)
+ .set_incremental_authorization_allowed(
+ payment_intent.incremental_authorization_allowed,
+ )
+ .set_external_authentication_details(external_authentication_details)
+ .set_fingerprint(payment_intent.fingerprint_id)
+ .set_authorization_count(payment_intent.authorization_count)
+ .set_incremental_authorizations(incremental_authorizations_response)
+ .set_expires_on(payment_intent.session_expiry)
+ .set_external_3ds_authentication_attempted(
+ payment_attempt.external_three_ds_authentication_attempted,
+ )
+ .set_payment_method_id(payment_attempt.payment_method_id)
+ .set_payment_method_status(payment_data.payment_method_info.map(|info| info.status))
+ .set_customer(customer_details_response.clone())
+ .set_browser_info(payment_attempt.browser_info)
+ .to_owned(),
headers,
- )),
- });
+ ))
+ };
metrics::PAYMENT_OPS_COUNT.add(
&metrics::CONTEXT,
@@ -877,7 +789,7 @@ where
],
);
- output
+ Ok(output)
}
pub fn third_party_sdk_session_next_action<Op>(
diff --git a/crates/router/src/utils.rs b/crates/router/src/utils.rs
index 1a3eb92d240..398ff7f30d9 100644
--- a/crates/router/src/utils.rs
+++ b/crates/router/src/utils.rs
@@ -736,12 +736,11 @@ pub fn add_apple_pay_payment_status_metrics(
}
#[allow(clippy::too_many_arguments)]
-pub async fn trigger_payments_webhook<F, Req, Op>(
+pub async fn trigger_payments_webhook<F, Op>(
merchant_account: domain::MerchantAccount,
business_profile: diesel_models::business_profile::BusinessProfile,
key_store: &domain::MerchantKeyStore,
payment_data: crate::core::payments::PaymentData<F>,
- req: Option<Req>,
customer: Option<domain::Customer>,
state: &crate::routes::AppState,
operation: Op,
@@ -770,7 +769,6 @@ where
| enums::IntentStatus::PartiallyCaptured
) {
let payments_response = crate::core::payments::transformers::payments_to_payments_response(
- req,
payment_data,
captures,
customer,
diff --git a/crates/router/src/workflows/payment_sync.rs b/crates/router/src/workflows/payment_sync.rs
index 051157f504b..5b290786ef0 100644
--- a/crates/router/src/workflows/payment_sync.rs
+++ b/crates/router/src/workflows/payment_sync.rs
@@ -176,16 +176,11 @@ impl ProcessTrackerWorkflow<AppState> for PaymentsSyncWorkflow {
// Trigger the outgoing webhook to notify the merchant about failed payment
let operation = operations::PaymentStatus;
- Box::pin(utils::trigger_payments_webhook::<
- _,
- api_models::payments::PaymentsRequest,
- _,
- >(
+ Box::pin(utils::trigger_payments_webhook(
merchant_account,
business_profile,
&key_store,
payment_data,
- None,
customer,
state,
operation,
diff --git a/openapi/openapi_spec.json b/openapi/openapi_spec.json
index 63b5128984e..0ae5b25fc95 100644
--- a/openapi/openapi_spec.json
+++ b/openapi/openapi_spec.json
@@ -14761,6 +14761,14 @@
"description": "Payment Fingerprint",
"nullable": true
},
+ "browser_info": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BrowserInformation"
+ }
+ ],
+ "nullable": true
+ },
"payment_method_id": {
"type": "string",
"description": "Payment Method Id",
diff --git a/postman/collection-dir/stripe/Flow Testcases/Happy Cases/Scenario1-Create payment with confirm true/Payments - Create/event.test.js b/postman/collection-dir/stripe/Flow Testcases/Happy Cases/Scenario1-Create payment with confirm true/Payments - Create/event.test.js
index ffcdd527d07..cd38d5ab9d5 100644
--- a/postman/collection-dir/stripe/Flow Testcases/Happy Cases/Scenario1-Create payment with confirm true/Payments - Create/event.test.js
+++ b/postman/collection-dir/stripe/Flow Testcases/Happy Cases/Scenario1-Create payment with confirm true/Payments - Create/event.test.js
@@ -19,7 +19,7 @@ pm.test("[POST]::/payments - Response has JSON Body", function () {
let jsonData = {};
try {
jsonData = pm.response.json();
-} catch (e) {}
+} catch (e) { }
// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id
if (jsonData?.payment_id) {
@@ -78,3 +78,12 @@ pm.test(
.true;
},
);
+
+// Response body should have "browser_info"
+pm.test(
+ "[POST]::/payments - Content check if 'browser_info' exists",
+ function () {
+ pm.expect(typeof jsonData.browser_info !== "undefined").to.be
+ .true;
+ },
+);
diff --git a/postman/collection-dir/stripe/Flow Testcases/Happy Cases/Scenario1-Create payment with confirm true/Payments - Create/request.json b/postman/collection-dir/stripe/Flow Testcases/Happy Cases/Scenario1-Create payment with confirm true/Payments - Create/request.json
index 9d0fac32c1f..950ec531ae7 100644
--- a/postman/collection-dir/stripe/Flow Testcases/Happy Cases/Scenario1-Create payment with confirm true/Payments - Create/request.json
+++ b/postman/collection-dir/stripe/Flow Testcases/Happy Cases/Scenario1-Create payment with confirm true/Payments - Create/request.json
@@ -54,6 +54,18 @@
"card_cvc": "123"
}
},
+ "browser_info": {
+ "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
+ "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
+ "language": "nl-NL",
+ "color_depth": 24,
+ "screen_height": 723,
+ "screen_width": 1536,
+ "time_zone": 0,
+ "java_enabled": true,
+ "java_script_enabled": true,
+ "ip_address": "127.0.0.1"
+ },
"billing": {
"address": {
"line1": "1467",
diff --git a/postman/collection-json/stripe.postman_collection.json b/postman/collection-json/stripe.postman_collection.json
index 078b0a7b281..2a18984e3f1 100644
--- a/postman/collection-json/stripe.postman_collection.json
+++ b/postman/collection-json/stripe.postman_collection.json
@@ -7085,7 +7085,7 @@
"let jsonData = {};",
"try {",
" jsonData = pm.response.json();",
- "} catch (e) {}",
+ "} catch (e) { }",
"",
"// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
"if (jsonData?.payment_id) {",
@@ -7144,6 +7144,15 @@
" .true;",
" },",
");",
+ "",
+ "// Response body should have \"browser_info\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'browser_info' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.browser_info !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
""
],
"type": "text/javascript"
@@ -7169,7 +7178,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"customer_acceptance\":{\"acceptance_type\":\"online\",\"accepted_at\":\"2022-09-10T10:11:12Z\",\"online\":{\"ip_address\":\"123.32.25.123\",\"user_agent\":\"Mozilla/5.0 (Linux; Android 12; SM-S906N Build/QP1A.190711.020; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.119 Mobile Safari/537.36\"}},\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"26\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"customer_acceptance\":{\"acceptance_type\":\"online\",\"accepted_at\":\"2022-09-10T10:11:12Z\",\"online\":{\"ip_address\":\"123.32.25.123\",\"user_agent\":\"Mozilla/5.0 (Linux; Android 12; SM-S906N Build/QP1A.190711.020; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.119 Mobile Safari/537.36\"}},\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"26\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
|
feat
|
add browser information in payments response (#3963)
|
4c8cdf1475ac74fb2df5bea419dfa7657f26f298
|
2024-03-22 17:02:05
|
Sanchith Hegde
|
feat(events): allow listing webhook events and webhook delivery attempts by business profile (#4159)
| false
|
diff --git a/crates/api_models/src/webhook_events.rs b/crates/api_models/src/webhook_events.rs
index 8eed5cb03fb..ef7db3231af 100644
--- a/crates/api_models/src/webhook_events.rs
+++ b/crates/api_models/src/webhook_events.rs
@@ -132,14 +132,28 @@ pub struct OutgoingWebhookResponseContent {
#[derive(Debug, serde::Serialize)]
pub struct EventListRequestInternal {
- pub merchant_id: String,
+ pub merchant_id_or_profile_id: String,
pub constraints: EventListConstraints,
}
impl common_utils::events::ApiEventMetric for EventListRequestInternal {
fn get_api_event_type(&self) -> Option<common_utils::events::ApiEventsType> {
Some(common_utils::events::ApiEventsType::Events {
- merchant_id: self.merchant_id.clone(),
+ merchant_id_or_profile_id: self.merchant_id_or_profile_id.clone(),
+ })
+ }
+}
+
+#[derive(Debug, serde::Serialize)]
+pub struct WebhookDeliveryAttemptListRequestInternal {
+ pub merchant_id_or_profile_id: String,
+ pub initial_attempt_id: String,
+}
+
+impl common_utils::events::ApiEventMetric for WebhookDeliveryAttemptListRequestInternal {
+ fn get_api_event_type(&self) -> Option<common_utils::events::ApiEventsType> {
+ Some(common_utils::events::ApiEventsType::Events {
+ merchant_id_or_profile_id: self.merchant_id_or_profile_id.clone(),
})
}
}
diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs
index a6d065d3e67..4e4a09d9387 100644
--- a/crates/common_utils/src/events.rs
+++ b/crates/common_utils/src/events.rs
@@ -54,7 +54,7 @@ pub enum ApiEventsType {
dispute_id: String,
},
Events {
- merchant_id: String,
+ merchant_id_or_profile_id: String,
},
}
diff --git a/crates/openapi/src/routes/webhook_events.rs b/crates/openapi/src/routes/webhook_events.rs
index 129cfa5650e..4238b6e99cd 100644
--- a/crates/openapi/src/routes/webhook_events.rs
+++ b/crates/openapi/src/routes/webhook_events.rs
@@ -1,14 +1,14 @@
/// Events - List
///
-/// List all Events associated with a Merchant Account.
+/// List all Events associated with a Merchant Account or Business Profile.
#[utoipa::path(
get,
- path = "/events/{merchant_id}",
+ path = "/events/{merchant_id_or_profile_id}",
params(
(
- "merchant_id" = String,
+ "merchant_id_or_profile_id" = String,
Path,
- description = "The unique identifier for the Merchant Account"
+ description = "The unique identifier for the Merchant Account or Business Profile"
),
(
"created_after" = Option<PrimitiveDateTime>,
@@ -45,7 +45,7 @@
(status = 200, description = "List of Events retrieved successfully", body = Vec<EventListItemResponse>),
),
tag = "Event",
- operation_id = "List all Events associated with a Merchant Account",
+ operation_id = "List all Events associated with a Merchant Account or Business Profile",
security(("admin_api_key" = []))
)]
pub fn list_initial_webhook_delivery_attempts() {}
@@ -55,9 +55,9 @@ pub fn list_initial_webhook_delivery_attempts() {}
/// List all delivery attempts for the specified Event.
#[utoipa::path(
get,
- path = "/events/{merchant_id}/{event_id}/attempts",
+ path = "/events/{merchant_id_or_profile_id}/{event_id}/attempts",
params(
- ("merchant_id" = String, Path, description = "The unique identifier for the Merchant Account"),
+ ("merchant_id_or_profile_id" = String, Path, description = "The unique identifier for the Merchant Account or Business Profile"),
("event_id" = String, Path, description = "The unique identifier for the Event"),
),
responses(
diff --git a/crates/router/src/core/webhooks/webhook_events.rs b/crates/router/src/core/webhooks/webhook_events.rs
index ebb73b387d1..c719200384f 100644
--- a/crates/router/src/core/webhooks/webhook_events.rs
+++ b/crates/router/src/core/webhooks/webhook_events.rs
@@ -5,15 +5,21 @@ use crate::{
core::errors::{self, RouterResponse, StorageErrorExt},
routes::AppState,
services::ApplicationResponse,
- types::{api, transformers::ForeignTryFrom},
+ types::{api, domain, transformers::ForeignTryFrom},
};
const INITIAL_DELIVERY_ATTEMPTS_LIST_MAX_LIMIT: i64 = 100;
+#[derive(Debug)]
+enum MerchantIdOrProfileId {
+ MerchantId(String),
+ ProfileId(String),
+}
+
#[instrument(skip(state))]
pub async fn list_initial_delivery_attempts(
state: AppState,
- merchant_id: String,
+ merchant_id_or_profile_id: String,
constraints: api::webhook_events::EventListConstraints,
) -> RouterResponse<Vec<api::webhook_events::EventListItemResponse>> {
let constraints =
@@ -21,24 +27,27 @@ pub async fn list_initial_delivery_attempts(
let store = state.store.as_ref();
- // This would handle verifying that the merchant ID actually exists
- let key_store = store
- .get_merchant_key_store_by_merchant_id(
- &merchant_id,
- &store.get_master_key().to_vec().into(),
- )
- .await
- .to_not_found_response(errors::ApiErrorResponse::MerchantAccountNotFound)?;
+ let (identifier, key_store) =
+ determine_identifier_and_get_key_store(state.clone(), merchant_id_or_profile_id).await?;
let events = match constraints {
api_models::webhook_events::EventListConstraintsInternal::ObjectIdFilter { object_id } => {
- store
+ match identifier {
+ MerchantIdOrProfileId::MerchantId(merchant_id) => store
.list_initial_events_by_merchant_id_primary_object_id(
&merchant_id,
&object_id,
&key_store,
)
- .await
+ .await,
+ MerchantIdOrProfileId::ProfileId(profile_id) => store
+ .list_initial_events_by_profile_id_primary_object_id(
+ &profile_id,
+ &object_id,
+ &key_store,
+ )
+ .await,
+ }
}
api_models::webhook_events::EventListConstraintsInternal::GenericFilter {
created_after,
@@ -60,7 +69,8 @@ pub async fn list_initial_delivery_attempts(
_ => None,
};
- store
+ match identifier {
+ MerchantIdOrProfileId::MerchantId(merchant_id) => store
.list_initial_events_by_merchant_id_constraints(
&merchant_id,
created_after,
@@ -69,7 +79,18 @@ pub async fn list_initial_delivery_attempts(
offset,
&key_store,
)
- .await
+ .await,
+ MerchantIdOrProfileId::ProfileId(profile_id) => store
+ .list_initial_events_by_profile_id_constraints(
+ &profile_id,
+ created_after,
+ created_before,
+ limit,
+ offset,
+ &key_store,
+ )
+ .await,
+ }
}
}
.change_context(errors::ApiErrorResponse::InternalServerError)
@@ -86,22 +107,36 @@ pub async fn list_initial_delivery_attempts(
#[instrument(skip(state))]
pub async fn list_delivery_attempts(
state: AppState,
- merchant_id: &str,
- initial_attempt_id: &str,
+ merchant_id_or_profile_id: String,
+ initial_attempt_id: String,
) -> RouterResponse<Vec<api::webhook_events::EventRetrieveResponse>> {
let store = state.store.as_ref();
- // This would handle verifying that the merchant ID actually exists
- let key_store = store
- .get_merchant_key_store_by_merchant_id(merchant_id, &store.get_master_key().to_vec().into())
- .await
- .to_not_found_response(errors::ApiErrorResponse::MerchantAccountNotFound)?;
+ let (identifier, key_store) =
+ determine_identifier_and_get_key_store(state.clone(), merchant_id_or_profile_id).await?;
- let events = store
- .list_events_by_merchant_id_initial_attempt_id(merchant_id, initial_attempt_id, &key_store)
- .await
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Failed to list delivery attempts for initial event")?;
+ let events = match identifier {
+ MerchantIdOrProfileId::MerchantId(merchant_id) => {
+ store
+ .list_events_by_merchant_id_initial_attempt_id(
+ &merchant_id,
+ &initial_attempt_id,
+ &key_store,
+ )
+ .await
+ }
+ MerchantIdOrProfileId::ProfileId(profile_id) => {
+ store
+ .list_events_by_profile_id_initial_attempt_id(
+ &profile_id,
+ &initial_attempt_id,
+ &key_store,
+ )
+ .await
+ }
+ }
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed to list delivery attempts for initial event")?;
if events.is_empty() {
Err(error_stack::report!(
@@ -117,3 +152,56 @@ pub async fn list_delivery_attempts(
))
}
}
+
+async fn determine_identifier_and_get_key_store(
+ state: AppState,
+ merchant_id_or_profile_id: String,
+) -> errors::RouterResult<(MerchantIdOrProfileId, domain::MerchantKeyStore)> {
+ let store = state.store.as_ref();
+ match store
+ .get_merchant_key_store_by_merchant_id(
+ &merchant_id_or_profile_id,
+ &store.get_master_key().to_vec().into(),
+ )
+ .await
+ {
+ // Valid merchant ID
+ Ok(key_store) => Ok((
+ MerchantIdOrProfileId::MerchantId(merchant_id_or_profile_id),
+ key_store,
+ )),
+
+ // Invalid merchant ID, check if we can find a business profile with the identifier
+ Err(error) if error.current_context().is_db_not_found() => {
+ router_env::logger::debug!(
+ ?error,
+ %merchant_id_or_profile_id,
+ "Failed to find merchant key store for the specified merchant ID or business profile ID"
+ );
+
+ let business_profile = store
+ .find_business_profile_by_profile_id(&merchant_id_or_profile_id)
+ .await
+ .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound {
+ id: merchant_id_or_profile_id,
+ })?;
+
+ let key_store = store
+ .get_merchant_key_store_by_merchant_id(
+ &business_profile.merchant_id,
+ &store.get_master_key().to_vec().into(),
+ )
+ .await
+ .to_not_found_response(errors::ApiErrorResponse::MerchantAccountNotFound)?;
+
+ Ok((
+ MerchantIdOrProfileId::ProfileId(business_profile.profile_id),
+ key_store,
+ ))
+ }
+
+ Err(error) => Err(error)
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed to find merchant key store by merchant ID"),
+ }
+}
diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs
index 7c513881eda..a889a9c5744 100644
--- a/crates/router/src/routes/app.rs
+++ b/crates/router/src/routes/app.rs
@@ -1224,7 +1224,7 @@ pub struct WebhookEvents;
#[cfg(feature = "olap")]
impl WebhookEvents {
pub fn server(config: AppState) -> Scope {
- web::scope("/events/{merchant_id}")
+ web::scope("/events/{merchant_id_or_profile_id}")
.app_data(web::Data::new(config))
.service(web::resource("").route(web::get().to(list_initial_webhook_delivery_attempts)))
.service(
diff --git a/crates/router/src/routes/webhook_events.rs b/crates/router/src/routes/webhook_events.rs
index de4892a1f95..2761ebbd1dc 100644
--- a/crates/router/src/routes/webhook_events.rs
+++ b/crates/router/src/routes/webhook_events.rs
@@ -5,7 +5,9 @@ use crate::{
core::{api_locking, webhooks::webhook_events},
routes::AppState,
services::{api, authentication as auth, authorization::permissions::Permission},
- types::api::webhook_events::{EventListConstraints, EventListRequestInternal},
+ types::api::webhook_events::{
+ EventListConstraints, EventListRequestInternal, WebhookDeliveryAttemptListRequestInternal,
+ },
};
#[instrument(skip_all, fields(flow = ?Flow::WebhookEventInitialDeliveryAttemptList))]
@@ -16,11 +18,11 @@ pub async fn list_initial_webhook_delivery_attempts(
query: web::Query<EventListConstraints>,
) -> impl Responder {
let flow = Flow::WebhookEventInitialDeliveryAttemptList;
- let merchant_id = path.into_inner();
+ let merchant_id_or_profile_id = path.into_inner();
let constraints = query.into_inner();
let request_internal = EventListRequestInternal {
- merchant_id: merchant_id.clone(),
+ merchant_id_or_profile_id: merchant_id_or_profile_id.clone(),
constraints,
};
@@ -32,14 +34,14 @@ pub async fn list_initial_webhook_delivery_attempts(
|state, _, request_internal| {
webhook_events::list_initial_delivery_attempts(
state,
- request_internal.merchant_id,
+ request_internal.merchant_id_or_profile_id,
request_internal.constraints,
)
},
auth::auth_type(
&auth::AdminApiAuth,
- &auth::JWTAuthMerchantFromRoute {
- merchant_id,
+ &auth::JWTAuthMerchantOrProfileFromRoute {
+ merchant_id_or_profile_id,
required_permission: Permission::WebhookEventRead,
},
req.headers(),
@@ -56,20 +58,29 @@ pub async fn list_webhook_delivery_attempts(
path: web::Path<(String, String)>,
) -> impl Responder {
let flow = Flow::WebhookEventDeliveryAttemptList;
- let (merchant_id, initial_event_id) = path.into_inner();
+ let (merchant_id_or_profile_id, initial_attempt_id) = path.into_inner();
+
+ let request_internal = WebhookDeliveryAttemptListRequestInternal {
+ merchant_id_or_profile_id: merchant_id_or_profile_id.clone(),
+ initial_attempt_id,
+ };
api::server_wrap(
flow,
state,
&req,
- (&merchant_id, &initial_event_id),
- |state, _, (merchant_id, initial_event_id)| {
- webhook_events::list_delivery_attempts(state, merchant_id, initial_event_id)
+ request_internal,
+ |state, _, request_internal| {
+ webhook_events::list_delivery_attempts(
+ state,
+ request_internal.merchant_id_or_profile_id,
+ request_internal.initial_attempt_id,
+ )
},
auth::auth_type(
&auth::AdminApiAuth,
- &auth::JWTAuthMerchantFromRoute {
- merchant_id: merchant_id.clone(),
+ &auth::JWTAuthMerchantOrProfileFromRoute {
+ merchant_id_or_profile_id,
required_permission: Permission::WebhookEventRead,
},
req.headers(),
diff --git a/crates/router/src/services/authentication.rs b/crates/router/src/services/authentication.rs
index eb115f5701c..ca8378080cf 100644
--- a/crates/router/src/services/authentication.rs
+++ b/crates/router/src/services/authentication.rs
@@ -531,6 +531,68 @@ where
}
}
+pub struct JWTAuthMerchantOrProfileFromRoute {
+ pub merchant_id_or_profile_id: String,
+ pub required_permission: Permission,
+}
+
+#[async_trait]
+impl<A> AuthenticateAndFetch<(), A> for JWTAuthMerchantOrProfileFromRoute
+where
+ A: AppStateInfo + Sync,
+{
+ async fn authenticate_and_fetch(
+ &self,
+ request_headers: &HeaderMap,
+ state: &A,
+ ) -> RouterResult<((), AuthenticationType)> {
+ let payload = parse_jwt_payload::<A, AuthToken>(request_headers, state).await?;
+ if payload.check_in_blacklist(state).await? {
+ return Err(errors::ApiErrorResponse::InvalidJwtToken.into());
+ }
+
+ let permissions = authorization::get_permissions(state, &payload).await?;
+ authorization::check_authorization(&self.required_permission, &permissions)?;
+
+ // Check if token has access to MerchantId that has been requested through path or query param
+ if payload.merchant_id == self.merchant_id_or_profile_id {
+ return Ok((
+ (),
+ AuthenticationType::MerchantJwt {
+ merchant_id: payload.merchant_id,
+ user_id: Some(payload.user_id),
+ },
+ ));
+ }
+
+ // Route did not contain the merchant ID in present JWT, check if it corresponds to a
+ // business profile
+ let business_profile = state
+ .store()
+ .find_business_profile_by_profile_id(&self.merchant_id_or_profile_id)
+ .await
+ // Return access forbidden if business profile not found
+ .to_not_found_response(errors::ApiErrorResponse::AccessForbidden {
+ resource: self.merchant_id_or_profile_id.clone(),
+ })
+ .attach_printable("Could not find business profile specified in route")?;
+
+ // Check if merchant (from JWT) has access to business profile that has been requested
+ // through path or query param
+ if payload.merchant_id == business_profile.merchant_id {
+ Ok((
+ (),
+ AuthenticationType::MerchantJwt {
+ merchant_id: payload.merchant_id,
+ user_id: Some(payload.user_id),
+ },
+ ))
+ } else {
+ Err(report!(errors::ApiErrorResponse::InvalidJwtToken))
+ }
+ }
+}
+
pub async fn parse_jwt_payload<A, T>(headers: &HeaderMap, state: &A) -> RouterResult<T>
where
T: serde::de::DeserializeOwned,
diff --git a/crates/router/src/types/api/webhook_events.rs b/crates/router/src/types/api/webhook_events.rs
index 44f9bc7c805..4c702b70385 100644
--- a/crates/router/src/types/api/webhook_events.rs
+++ b/crates/router/src/types/api/webhook_events.rs
@@ -1,5 +1,5 @@
pub use api_models::webhook_events::{
EventListConstraints, EventListConstraintsInternal, EventListItemResponse,
EventListRequestInternal, EventRetrieveResponse, OutgoingWebhookRequestContent,
- OutgoingWebhookResponseContent,
+ OutgoingWebhookResponseContent, WebhookDeliveryAttemptListRequestInternal,
};
diff --git a/openapi/openapi_spec.json b/openapi/openapi_spec.json
index 1868eb9b4d9..2005f9c11e0 100644
--- a/openapi/openapi_spec.json
+++ b/openapi/openapi_spec.json
@@ -4325,19 +4325,19 @@
]
}
},
- "/events/{merchant_id}": {
+ "/events/{merchant_id_or_profile_id}": {
"get": {
"tags": [
"Event"
],
"summary": "Events - List",
- "description": "Events - List\n\nList all Events associated with a Merchant Account.",
- "operationId": "List all Events associated with a Merchant Account",
+ "description": "Events - List\n\nList all Events associated with a Merchant Account or Business Profile.",
+ "operationId": "List all Events associated with a Merchant Account or Business Profile",
"parameters": [
{
- "name": "merchant_id",
+ "name": "merchant_id_or_profile_id",
"in": "path",
- "description": "The unique identifier for the Merchant Account",
+ "description": "The unique identifier for the Merchant Account or Business Profile",
"required": true,
"schema": {
"type": "string"
@@ -4420,7 +4420,7 @@
]
}
},
- "/events/{merchant_id}/{event_id}/attempts": {
+ "/events/{merchant_id_or_profile_id}/{event_id}/attempts": {
"get": {
"tags": [
"Event"
@@ -4430,9 +4430,9 @@
"operationId": "List all delivery attempts for an Event",
"parameters": [
{
- "name": "merchant_id",
+ "name": "merchant_id_or_profile_id",
"in": "path",
- "description": "The unique identifier for the Merchant Account",
+ "description": "The unique identifier for the Merchant Account or Business Profile",
"required": true,
"schema": {
"type": "string"
|
feat
|
allow listing webhook events and webhook delivery attempts by business profile (#4159)
|
78d9906ebbedd9069a15b88f49b9348b663cbee8
|
2024-08-12 18:18:47
|
Sakil Mostak
|
fix(payment_link): remove dynamic section if no fields are present (#5579)
| false
|
diff --git a/crates/router/src/core/payment_link/payment_link_initiate/payment_link.js b/crates/router/src/core/payment_link/payment_link_initiate/payment_link.js
index 0d1b8c64d37..db6a1d71762 100644
--- a/crates/router/src/core/payment_link/payment_link_initiate/payment_link.js
+++ b/crates/router/src/core/payment_link/payment_link_initiate/payment_link.js
@@ -617,29 +617,37 @@ function renderDynamicMerchantDetails(paymentDetails) {
}
function appendMerchantDetails(paymentDetails, merchantDynamicDetails) {
- if (Object.keys(paymentDetails.transaction_details).length === 0) {
+ if (!(typeof paymentDetails.transaction_details === "string" && paymentDetails.transaction_details.length > 0)) {
return;
}
- // render a horizontal line above dynamic merchant details
- let horizontalLineContainer = document.getElementById("hyper-checkout-payment-horizontal-line-container");
- let horizontalLine = document.createElement("hr");
- horizontalLine.className = "hyper-checkout-payment-horizontal-line";
- horizontalLineContainer.append(horizontalLine);
+ try {
+ let merchantDetailsObject = JSON.parse(paymentDetails.transaction_details);
- // max number of items to show in the merchant details
- let maxItemsInDetails = 5;
- let merchantDetailsObject = JSON.parse(paymentDetails.transaction_details);
- for(const key in merchantDetailsObject) {
- var merchantData = document.createElement("div");
- merchantData.className = "hyper-checkout-payment-merchant-dynamic-data";
- merchantData.innerHTML = key+": "+merchantDetailsObject[key].bold();
+ if (Object.keys(merchantDetailsObject).length > 0) {
+ // render a horizontal line above dynamic merchant details
+ var horizontalLineContainer = document.getElementById("hyper-checkout-payment-horizontal-line-container");
+ var horizontalLine = document.createElement("hr");
+ horizontalLine.className = "hyper-checkout-payment-horizontal-line";
+ horizontalLineContainer.append(horizontalLine);
- merchantDynamicDetails.append(merchantData);
- if(--maxItemsInDetails === 0) {
- break;
+ // max number of items to show in the merchant details
+ let maxItemsInDetails = 5;
+ for (var key in merchantDetailsObject) {
+ var merchantData = document.createElement("div");
+ merchantData.className = "hyper-checkout-payment-merchant-dynamic-data";
+ merchantData.innerHTML = key+": "+merchantDetailsObject[key].bold();
+
+ merchantDynamicDetails.append(merchantData);
+ if (--maxItemsInDetails === 0) {
+ break;
+ }
+ }
}
}
+ catch (error) {
+ console.error("Error parsing merchant details", error);
+ }
}
/**
|
fix
|
remove dynamic section if no fields are present (#5579)
|
ecb8cafaed5a29e8ab204992a2f35102d2add09f
|
2024-07-01 20:07:41
|
Shankar Singh C
|
fix(router): mark retry payment as failure if `connector_tokenization` fails (#5114)
| false
|
diff --git a/crates/router/src/connector/stripe/transformers.rs b/crates/router/src/connector/stripe/transformers.rs
index 10d091a3b84..53850e97afc 100644
--- a/crates/router/src/connector/stripe/transformers.rs
+++ b/crates/router/src/connector/stripe/transformers.rs
@@ -33,7 +33,6 @@ use crate::{
storage::enums,
transformers::{ForeignFrom, ForeignTryFrom},
},
- unimplemented_payment_method,
utils::OptionExt,
};
@@ -1761,9 +1760,11 @@ impl TryFrom<(&types::PaymentsAuthorizeRouterData, MinorUnit)> for PaymentIntent
let payment_method_token = match payment_method_token {
types::PaymentMethodToken::Token(payment_method_token) => payment_method_token,
- types::PaymentMethodToken::ApplePayDecrypt(_) => Err(
- unimplemented_payment_method!("Apple Pay", "Simplified", "Stripe"),
- )?,
+ types::PaymentMethodToken::ApplePayDecrypt(_) => {
+ Err(errors::ConnectorError::InvalidWalletToken {
+ wallet_name: "Apple Pay".to_string(),
+ })?
+ }
};
Some(StripePaymentMethodData::Wallet(
StripeWallet::ApplepayPayment(ApplepayPayment {
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index 8290177f21b..69c55b152ed 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -302,6 +302,7 @@ where
#[cfg(not(feature = "frm"))]
None,
&business_profile,
+ false,
)
.await?;
@@ -373,6 +374,7 @@ where
#[cfg(not(feature = "frm"))]
None,
&business_profile,
+ false,
)
.await?;
@@ -1394,6 +1396,7 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest>(
header_payload: HeaderPayload,
frm_suggestion: Option<storage_enums::FrmSuggestion>,
business_profile: &storage::business_profile::BusinessProfile,
+ is_retry_payment: bool,
) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>>
where
F: Send + Clone + Sync,
@@ -1476,7 +1479,7 @@ where
router_data = router_data.add_session_token(state, &connector).await?;
- let mut should_continue_further = access_token::update_router_data_with_access_token_result(
+ let should_continue_further = access_token::update_router_data_with_access_token_result(
&add_access_token_result,
&mut router_data,
&call_connector_action,
@@ -1526,16 +1529,22 @@ where
_ => (),
};
- let pm_token = router_data
- .add_payment_method_token(state, &connector, &tokenization_action)
+ let payment_method_token_response = router_data
+ .add_payment_method_token(
+ state,
+ &connector,
+ &tokenization_action,
+ should_continue_further,
+ )
.await?;
- if let Some(payment_method_token) = pm_token.clone() {
- router_data.payment_method_token = Some(
- hyperswitch_domain_models::router_data::PaymentMethodToken::Token(Secret::new(
- payment_method_token,
- )),
+
+ let mut should_continue_further =
+ tokenization::update_router_data_with_payment_method_token_result(
+ payment_method_token_response,
+ &mut router_data,
+ is_retry_payment,
+ should_continue_further,
);
- };
(router_data, should_continue_further) = complete_preprocessing_steps_if_required(
state,
diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs
index 9ecd0c4c8a0..23ab253ee53 100644
--- a/crates/router/src/core/payments/flows.rs
+++ b/crates/router/src/core/payments/flows.rs
@@ -84,13 +84,17 @@ pub trait Feature<F, T> {
_state: &SessionState,
_connector: &api::ConnectorData,
_tokenization_action: &payments::TokenizationAction,
- ) -> RouterResult<Option<String>>
+ _should_continue_payment: bool,
+ ) -> RouterResult<types::PaymentMethodTokenResult>
where
F: Clone,
Self: Sized,
dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>,
{
- Ok(None)
+ Ok(types::PaymentMethodTokenResult {
+ payment_method_token_result: Ok(None),
+ is_payment_method_tokenization_performed: false,
+ })
}
async fn preprocessing_steps<'a>(
diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs
index 23971f3696c..c06d9a70e16 100644
--- a/crates/router/src/core/payments/flows/authorize_flow.rs
+++ b/crates/router/src/core/payments/flows/authorize_flow.rs
@@ -140,7 +140,8 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu
state: &SessionState,
connector: &api::ConnectorData,
tokenization_action: &payments::TokenizationAction,
- ) -> RouterResult<Option<String>> {
+ should_continue_payment: bool,
+ ) -> RouterResult<types::PaymentMethodTokenResult> {
let request = self.request.clone();
tokenization::add_payment_method_token(
state,
@@ -148,6 +149,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu
tokenization_action,
self,
types::PaymentMethodTokenizationData::try_from(request)?,
+ should_continue_payment,
)
.await
}
diff --git a/crates/router/src/core/payments/flows/complete_authorize_flow.rs b/crates/router/src/core/payments/flows/complete_authorize_flow.rs
index bb56cb5a7c5..6bef7e95859 100644
--- a/crates/router/src/core/payments/flows/complete_authorize_flow.rs
+++ b/crates/router/src/core/payments/flows/complete_authorize_flow.rs
@@ -103,7 +103,8 @@ impl Feature<api::CompleteAuthorize, types::CompleteAuthorizeData>
state: &SessionState,
connector: &api::ConnectorData,
_tokenization_action: &payments::TokenizationAction,
- ) -> RouterResult<Option<String>> {
+ should_continue_payment: bool,
+ ) -> RouterResult<types::PaymentMethodTokenResult> {
// TODO: remove this and handle it in core
if matches!(connector.connector_name, types::Connector::Payme) {
let request = self.request.clone();
@@ -113,10 +114,14 @@ impl Feature<api::CompleteAuthorize, types::CompleteAuthorizeData>
&payments::TokenizationAction::TokenizeInConnector,
self,
types::PaymentMethodTokenizationData::try_from(request)?,
+ should_continue_payment,
)
.await
} else {
- Ok(None)
+ Ok(types::PaymentMethodTokenResult {
+ payment_method_token_result: Ok(None),
+ is_payment_method_tokenization_performed: false,
+ })
}
}
diff --git a/crates/router/src/core/payments/flows/setup_mandate_flow.rs b/crates/router/src/core/payments/flows/setup_mandate_flow.rs
index 07803a0c0fb..773677f3e7c 100644
--- a/crates/router/src/core/payments/flows/setup_mandate_flow.rs
+++ b/crates/router/src/core/payments/flows/setup_mandate_flow.rs
@@ -107,7 +107,8 @@ impl Feature<api::SetupMandate, types::SetupMandateRequestData> for types::Setup
state: &SessionState,
connector: &api::ConnectorData,
tokenization_action: &payments::TokenizationAction,
- ) -> RouterResult<Option<String>> {
+ should_continue_payment: bool,
+ ) -> RouterResult<types::PaymentMethodTokenResult> {
let request = self.request.clone();
tokenization::add_payment_method_token(
state,
@@ -115,6 +116,7 @@ impl Feature<api::SetupMandate, types::SetupMandateRequestData> for types::Setup
tokenization_action,
self,
types::PaymentMethodTokenizationData::try_from(request)?,
+ should_continue_payment,
)
.await
}
diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs
index e8ceeaa7ecf..ef8e0c01fed 100644
--- a/crates/router/src/core/payments/retry.rs
+++ b/crates/router/src/core/payments/retry.rs
@@ -321,6 +321,7 @@ where
api::HeaderPayload::default(),
frm_suggestion,
business_profile,
+ true,
)
.await
}
diff --git a/crates/router/src/core/payments/tokenization.rs b/crates/router/src/core/payments/tokenization.rs
index d6ceeee65e7..da18fd7dd5a 100644
--- a/crates/router/src/core/payments/tokenization.rs
+++ b/crates/router/src/core/payments/tokenization.rs
@@ -784,62 +784,109 @@ pub async fn add_payment_method_token<F: Clone, T: types::Tokenizable + Clone>(
tokenization_action: &payments::TokenizationAction,
router_data: &mut types::RouterData<F, T, types::PaymentsResponseData>,
pm_token_request_data: types::PaymentMethodTokenizationData,
-) -> RouterResult<Option<String>> {
- match tokenization_action {
- payments::TokenizationAction::TokenizeInConnector
- | payments::TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt(_) => {
- let connector_integration: services::BoxedPaymentConnectorIntegrationInterface<
- api::PaymentMethodToken,
- types::PaymentMethodTokenizationData,
- types::PaymentsResponseData,
- > = connector.connector.get_connector_integration();
-
- let pm_token_response_data: Result<types::PaymentsResponseData, types::ErrorResponse> =
- Err(types::ErrorResponse::default());
-
- let pm_token_router_data =
- helpers::router_data_type_conversion::<_, api::PaymentMethodToken, _, _, _, _>(
- router_data.clone(),
- pm_token_request_data,
- pm_token_response_data,
+ should_continue_payment: bool,
+) -> RouterResult<types::PaymentMethodTokenResult> {
+ if should_continue_payment {
+ match tokenization_action {
+ payments::TokenizationAction::TokenizeInConnector
+ | payments::TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt(_) => {
+ let connector_integration: services::BoxedPaymentConnectorIntegrationInterface<
+ api::PaymentMethodToken,
+ types::PaymentMethodTokenizationData,
+ types::PaymentsResponseData,
+ > = connector.connector.get_connector_integration();
+
+ let pm_token_response_data: Result<
+ types::PaymentsResponseData,
+ types::ErrorResponse,
+ > = Err(types::ErrorResponse::default());
+
+ let pm_token_router_data =
+ helpers::router_data_type_conversion::<_, api::PaymentMethodToken, _, _, _, _>(
+ router_data.clone(),
+ pm_token_request_data,
+ pm_token_response_data,
+ );
+
+ router_data
+ .request
+ .set_session_token(pm_token_router_data.session_token.clone());
+
+ let resp = services::execute_connector_processing_step(
+ state,
+ connector_integration,
+ &pm_token_router_data,
+ payments::CallConnectorAction::Trigger,
+ None,
+ )
+ .await
+ .to_payment_failed_response()?;
+
+ metrics::CONNECTOR_PAYMENT_METHOD_TOKENIZATION.add(
+ &metrics::CONTEXT,
+ 1,
+ &add_attributes([
+ ("connector", connector.connector_name.to_string()),
+ ("payment_method", router_data.payment_method.to_string()),
+ ]),
);
- router_data
- .request
- .set_session_token(pm_token_router_data.session_token.clone());
-
- let resp = services::execute_connector_processing_step(
- state,
- connector_integration,
- &pm_token_router_data,
- payments::CallConnectorAction::Trigger,
- None,
- )
- .await
- .to_payment_failed_response()?;
-
- metrics::CONNECTOR_PAYMENT_METHOD_TOKENIZATION.add(
- &metrics::CONTEXT,
- 1,
- &add_attributes([
- ("connector", connector.connector_name.to_string()),
- ("payment_method", router_data.payment_method.to_string()),
- ]),
- );
-
- let pm_token = match resp.response {
- Ok(response) => match response {
- types::PaymentsResponseData::TokenizationResponse { token } => Some(token),
- _ => None,
- },
- Err(err) => {
+ let payment_token_resp = resp.response.map(|res| {
+ if let types::PaymentsResponseData::TokenizationResponse { token } = res {
+ Some(token)
+ } else {
+ None
+ }
+ });
+
+ Ok(types::PaymentMethodTokenResult {
+ payment_method_token_result: payment_token_resp,
+ is_payment_method_tokenization_performed: true,
+ })
+ }
+ _ => Ok(types::PaymentMethodTokenResult {
+ payment_method_token_result: Ok(None),
+ is_payment_method_tokenization_performed: false,
+ }),
+ }
+ } else {
+ logger::debug!("Skipping connector tokenization based on should_continue_payment flag");
+ Ok(types::PaymentMethodTokenResult {
+ payment_method_token_result: Ok(None),
+ is_payment_method_tokenization_performed: false,
+ })
+ }
+}
+
+pub fn update_router_data_with_payment_method_token_result<F: Clone, T>(
+ payment_method_token_result: types::PaymentMethodTokenResult,
+ router_data: &mut types::RouterData<F, T, types::PaymentsResponseData>,
+ is_retry_payment: bool,
+ should_continue_further: bool,
+) -> bool {
+ if payment_method_token_result.is_payment_method_tokenization_performed {
+ match payment_method_token_result.payment_method_token_result {
+ Ok(pm_token_result) => {
+ router_data.payment_method_token = pm_token_result.map(|pm_token| {
+ hyperswitch_domain_models::router_data::PaymentMethodToken::Token(
+ masking::Secret::new(pm_token),
+ )
+ });
+
+ true
+ }
+ Err(err) => {
+ if is_retry_payment {
+ router_data.response = Err(err);
+ false
+ } else {
logger::debug!(payment_method_tokenization_error=?err);
- None
+ true
}
- };
- Ok(pm_token)
+ }
}
- _ => Ok(None),
+ } else {
+ should_continue_further
}
}
diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs
index 607e5bd8234..f0087ef2f39 100644
--- a/crates/router/src/types.rs
+++ b/crates/router/src/types.rs
@@ -545,6 +545,11 @@ pub struct AddAccessTokenResult {
pub connector_supports_access_token: bool,
}
+pub struct PaymentMethodTokenResult {
+ pub payment_method_token_result: Result<Option<String>, ErrorResponse>,
+ pub is_payment_method_tokenization_performed: bool,
+}
+
#[derive(Debug, Clone, Copy)]
pub enum Redirection {
Redirect,
|
fix
|
mark retry payment as failure if `connector_tokenization` fails (#5114)
|
4d0c89362a598dff87ec98b3e68d425cdfeef566
|
2024-06-11 13:17:25
|
Amisha Prabhat
|
refactor(conditional_configs): refactor conditional_configs to use Moka Cache instead of Static Cache (#4814)
| false
|
diff --git a/crates/euclid/src/backend/vir_interpreter.rs b/crates/euclid/src/backend/vir_interpreter.rs
index b7be62cf674..b8d14e228aa 100644
--- a/crates/euclid/src/backend/vir_interpreter.rs
+++ b/crates/euclid/src/backend/vir_interpreter.rs
@@ -1,5 +1,9 @@
pub mod types;
+use std::fmt::Debug;
+
+use serde::{Deserialize, Serialize};
+
use crate::{
backend::{self, inputs, EuclidBackend},
frontend::{
@@ -9,6 +13,7 @@ use crate::{
},
};
+#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct VirInterpreterBackend<O> {
program: vir::ValuedProgram<O>,
}
diff --git a/crates/euclid/src/frontend/vir.rs b/crates/euclid/src/frontend/vir.rs
index 750ff4e61ff..6c8bc7ab2f1 100644
--- a/crates/euclid/src/frontend/vir.rs
+++ b/crates/euclid/src/frontend/vir.rs
@@ -1,13 +1,15 @@
//! Valued Intermediate Representation
+use serde::{Deserialize, Serialize};
+
use crate::types::{EuclidValue, Metadata};
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ValuedComparisonLogic {
NegativeConjunction,
PositiveDisjunction,
}
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ValuedComparison {
pub values: Vec<EuclidValue>,
pub logic: ValuedComparisonLogic,
@@ -16,20 +18,20 @@ pub struct ValuedComparison {
pub type ValuedIfCondition = Vec<ValuedComparison>;
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ValuedIfStatement {
pub condition: ValuedIfCondition,
pub nested: Option<Vec<ValuedIfStatement>>,
}
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ValuedRule<O> {
pub name: String,
pub connector_selection: O,
pub statements: Vec<ValuedIfStatement>,
}
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ValuedProgram<O> {
pub default_selection: O,
pub rules: Vec<ValuedRule<O>>,
diff --git a/crates/euclid/src/types.rs b/crates/euclid/src/types.rs
index 904525d54b7..05d3fe6bb8e 100644
--- a/crates/euclid/src/types.rs
+++ b/crates/euclid/src/types.rs
@@ -1,7 +1,7 @@
pub mod transformers;
use euclid_macros::EnumNums;
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
use strum::VariantNames;
use crate::{
@@ -143,7 +143,7 @@ impl EuclidKey {
enums::collect_variants!(EuclidKey);
-#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum NumValueRefinement {
NotEqual,
@@ -178,18 +178,18 @@ impl From<NumValueRefinement> for ast::ComparisonType {
}
}
-#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, serde::Serialize)]
+#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
pub struct StrValue {
pub value: String,
}
-#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, serde::Serialize)]
+#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
pub struct MetadataValue {
pub key: String,
pub value: String,
}
-#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, serde::Serialize)]
+#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
pub struct NumValue {
pub number: i64,
pub refinement: Option<NumValueRefinement>,
@@ -234,7 +234,7 @@ impl NumValue {
}
}
-#[derive(Debug, Clone, PartialEq, Eq, Hash)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum EuclidValue {
PaymentMethod(enums::PaymentMethod),
CardBin(StrValue),
diff --git a/crates/router/src/core/conditional_config.rs b/crates/router/src/core/conditional_config.rs
index a8bc8a797dc..f740c6dfcc2 100644
--- a/crates/router/src/core/conditional_config.rs
+++ b/crates/router/src/core/conditional_config.rs
@@ -6,6 +6,7 @@ use common_utils::ext_traits::{Encode, StringExt, ValueExt};
use diesel_models::configs;
use error_stack::ResultExt;
use euclid::frontend::ast;
+use storage_impl::redis::cache;
use super::routing::helpers::{
get_payment_config_routing_id, update_merchant_active_algorithm_ref,
@@ -99,8 +100,9 @@ pub async fn upsert_conditional_config(
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Error serializing the config")?;
- algo_id.update_conditional_config_id(key);
- update_merchant_active_algorithm_ref(db, &key_store, algo_id)
+ algo_id.update_conditional_config_id(key.clone());
+ let config_key = cache::CacheKind::DecisionManager(key.into());
+ update_merchant_active_algorithm_ref(db, &key_store, config_key, algo_id)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to update routing algorithm ref")?;
@@ -134,8 +136,9 @@ pub async fn upsert_conditional_config(
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Error fetching the config")?;
- algo_id.update_conditional_config_id(key);
- update_merchant_active_algorithm_ref(db, &key_store, algo_id)
+ algo_id.update_conditional_config_id(key.clone());
+ let config_key = cache::CacheKind::DecisionManager(key.into());
+ update_merchant_active_algorithm_ref(db, &key_store, config_key, algo_id)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to update routing algorithm ref")?;
@@ -164,7 +167,8 @@ pub async fn delete_conditional_config(
.attach_printable("Could not decode the conditional_config algorithm")?
.unwrap_or_default();
algo_id.config_algo_id = None;
- update_merchant_active_algorithm_ref(db, &key_store, algo_id)
+ let config_key = cache::CacheKind::DecisionManager(key.clone().into());
+ update_merchant_active_algorithm_ref(db, &key_store, config_key, algo_id)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to update deleted algorithm ref")?;
diff --git a/crates/router/src/core/payment_methods/surcharge_decision_configs.rs b/crates/router/src/core/payment_methods/surcharge_decision_configs.rs
index 14beb6be131..d708019fe14 100644
--- a/crates/router/src/core/payment_methods/surcharge_decision_configs.rs
+++ b/crates/router/src/core/payment_methods/surcharge_decision_configs.rs
@@ -1,21 +1,21 @@
-use std::sync::Arc;
-
use api_models::{
payment_methods::SurchargeDetailsResponse,
payments, routing,
surcharge_decision_configs::{self, SurchargeDecisionConfigs, SurchargeDecisionManagerRecord},
};
-use common_utils::{ext_traits::StringExt, static_cache::StaticCache, types as common_utils_types};
+use common_utils::{ext_traits::StringExt, types as common_utils_types};
use error_stack::{self, ResultExt};
use euclid::{
backend,
backend::{inputs as dsl_inputs, EuclidBackend},
};
use router_env::{instrument, tracing};
+use serde::{Deserialize, Serialize};
+use storage_impl::redis::cache::{self, SURCHARGE_CACHE};
use crate::{
core::{
- errors::ConditionalConfigError as ConfigError,
+ errors::{self, ConditionalConfigError as ConfigError},
payments::{
conditional_configs::ConditionalConfigResult, routing::make_dsl_input_for_surcharge,
types, PaymentData,
@@ -29,9 +29,8 @@ use crate::{
SessionState,
};
-static CONF_CACHE: StaticCache<VirInterpreterBackendCacheWrapper> = StaticCache::new();
-
-struct VirInterpreterBackendCacheWrapper {
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct VirInterpreterBackendCacheWrapper {
cached_algorithm: backend::VirInterpreterBackend<SurchargeDecisionConfigs>,
merchant_surcharge_configs: surcharge_decision_configs::MerchantSurchargeConfigs,
}
@@ -53,7 +52,7 @@ impl TryFrom<SurchargeDecisionManagerRecord> for VirInterpreterBackendCacheWrapp
enum SurchargeSource {
/// Surcharge will be generated through the surcharge rules
- Generate(Arc<VirInterpreterBackendCacheWrapper>),
+ Generate(VirInterpreterBackendCacheWrapper),
/// Surcharge is predefined by the merchant through payment create request
Predetermined(payments::RequestSurchargeDetails),
}
@@ -116,19 +115,13 @@ pub async fn perform_surcharge_decision_management_for_payment_method_list(
surcharge_decision_configs::MerchantSurchargeConfigs::default(),
),
(None, Some(algorithm_id)) => {
- let key = ensure_algorithm_cached(
+ let cached_algo = ensure_algorithm_cached(
&*state.store,
&payment_attempt.merchant_id,
- algorithm_ref.timestamp,
algorithm_id.as_str(),
)
.await?;
- let cached_algo = CONF_CACHE
- .retrieve(&key)
- .change_context(ConfigError::CacheMiss)
- .attach_printable(
- "Unable to retrieve cached routing algorithm even after refresh",
- )?;
+
let merchant_surcharge_config = cached_algo.merchant_surcharge_configs.clone();
(
SurchargeSource::Generate(cached_algo),
@@ -233,19 +226,13 @@ where
SurchargeSource::Predetermined(request_surcharge_details)
}
(None, Some(algorithm_id)) => {
- let key = ensure_algorithm_cached(
+ let cached_algo = ensure_algorithm_cached(
&*state.store,
&payment_data.payment_attempt.merchant_id,
- algorithm_ref.timestamp,
algorithm_id.as_str(),
)
.await?;
- let cached_algo = CONF_CACHE
- .retrieve(&key)
- .change_context(ConfigError::CacheMiss)
- .attach_printable(
- "Unable to retrieve cached routing algorithm even after refresh",
- )?;
+
SurchargeSource::Generate(cached_algo)
}
(None, None) => return Ok(surcharge_metadata),
@@ -291,19 +278,13 @@ pub async fn perform_surcharge_decision_management_for_saved_cards(
SurchargeSource::Predetermined(request_surcharge_details)
}
(None, Some(algorithm_id)) => {
- let key = ensure_algorithm_cached(
+ let cached_algo = ensure_algorithm_cached(
&*state.store,
&payment_attempt.merchant_id,
- algorithm_ref.timestamp,
algorithm_id.as_str(),
)
.await?;
- let cached_algo = CONF_CACHE
- .retrieve(&key)
- .change_context(ConfigError::CacheMiss)
- .attach_printable(
- "Unable to retrieve cached routing algorithm even after refresh",
- )?;
+
SurchargeSource::Generate(cached_algo)
}
(None, None) => return Ok(surcharge_metadata),
@@ -388,48 +369,31 @@ fn get_surcharge_details_from_surcharge_output(
pub async fn ensure_algorithm_cached(
store: &dyn StorageInterface,
merchant_id: &str,
- timestamp: i64,
algorithm_id: &str,
-) -> ConditionalConfigResult<String> {
+) -> ConditionalConfigResult<VirInterpreterBackendCacheWrapper> {
let key = format!("surcharge_dsl_{merchant_id}");
- let present = CONF_CACHE
- .present(&key)
- .change_context(ConfigError::DslCachePoisoned)
- .attach_printable("Error checking presence of DSL")?;
- let expired = CONF_CACHE
- .expired(&key, timestamp)
- .change_context(ConfigError::DslCachePoisoned)
- .attach_printable("Error checking presence of DSL")?;
- if !present || expired {
- refresh_surcharge_algorithm_cache(store, key.clone(), algorithm_id, timestamp).await?
- }
- Ok(key)
-}
-
-#[instrument(skip_all)]
-pub async fn refresh_surcharge_algorithm_cache(
- store: &dyn StorageInterface,
- key: String,
- algorithm_id: &str,
- timestamp: i64,
-) -> ConditionalConfigResult<()> {
- let config = store
- .find_config_by_key(algorithm_id)
- .await
- .change_context(ConfigError::DslMissingInDb)
- .attach_printable("Error parsing DSL from config")?;
- let record: SurchargeDecisionManagerRecord = config
- .config
- .parse_struct("Program")
- .change_context(ConfigError::DslParsingError)
- .attach_printable("Error parsing routing algorithm from configs")?;
- let value_to_cache = VirInterpreterBackendCacheWrapper::try_from(record)?;
- CONF_CACHE
- .save(key, value_to_cache, timestamp)
- .change_context(ConfigError::DslCachePoisoned)
- .attach_printable("Error saving DSL to cache")?;
- Ok(())
+ let value_to_cache = || async {
+ let config: diesel_models::Config = store.find_config_by_key(algorithm_id).await?;
+ let record: SurchargeDecisionManagerRecord = config
+ .config
+ .parse_struct("Program")
+ .change_context(errors::StorageError::DeserializationFailed)
+ .attach_printable("Error parsing routing algorithm from configs")?;
+ VirInterpreterBackendCacheWrapper::try_from(record)
+ .change_context(errors::StorageError::ValueNotFound("Program".to_string()))
+ .attach_printable("Error initializing DSL interpreter backend")
+ };
+ let interpreter = cache::get_or_populate_in_memory(
+ store.get_cache_store().as_ref(),
+ &key,
+ value_to_cache,
+ &SURCHARGE_CACHE,
+ )
+ .await
+ .change_context(ConfigError::CacheMiss)
+ .attach_printable("Unable to retrieve cached routing algorithm even after refresh")?;
+ Ok(interpreter)
}
pub fn execute_dsl_and_get_conditional_config(
diff --git a/crates/router/src/core/payments/conditional_configs.rs b/crates/router/src/core/payments/conditional_configs.rs
index c73fa3659b7..7ec9a749152 100644
--- a/crates/router/src/core/payments/conditional_configs.rs
+++ b/crates/router/src/core/payments/conditional_configs.rs
@@ -4,19 +4,17 @@ use api_models::{
conditional_configs::{ConditionalConfigs, DecisionManagerRecord},
routing,
};
-use common_utils::{ext_traits::StringExt, static_cache::StaticCache};
+use common_utils::ext_traits::StringExt;
use error_stack::ResultExt;
use euclid::backend::{self, inputs as dsl_inputs, EuclidBackend};
use router_env::{instrument, tracing};
+use storage_impl::redis::cache::{self, DECISION_MANAGER_CACHE};
use super::routing::make_dsl_input;
use crate::{
core::{errors, errors::ConditionalConfigError as ConfigError, payments},
routes,
};
-
-static CONF_CACHE: StaticCache<backend::VirInterpreterBackend<ConditionalConfigs>> =
- StaticCache::new();
pub type ConditionalConfigResult<O> = errors::CustomResult<O, ConfigError>;
#[instrument(skip_all)]
@@ -31,76 +29,40 @@ pub async fn perform_decision_management<F: Clone>(
} else {
return Ok(ConditionalConfigs::default());
};
+ let db = &*state.store;
+
+ let key = format!("dsl_{merchant_id}");
+
+ let find_key_from_db = || async {
+ let config = db.find_config_by_key(&algorithm_id).await?;
+
+ let rec: DecisionManagerRecord = config
+ .config
+ .parse_struct("Program")
+ .change_context(errors::StorageError::DeserializationFailed)
+ .attach_printable("Error parsing routing algorithm from configs")?;
+
+ backend::VirInterpreterBackend::with_program(rec.program)
+ .change_context(errors::StorageError::ValueNotFound("Program".to_string()))
+ .attach_printable("Error initializing DSL interpreter backend")
+ };
- let key = ensure_algorithm_cached(
- state,
- merchant_id,
- algorithm_ref.timestamp,
- algorithm_id.as_str(),
+ let interpreter = cache::get_or_populate_in_memory(
+ db.get_cache_store().as_ref(),
+ &key,
+ find_key_from_db,
+ &DECISION_MANAGER_CACHE,
)
- .await?;
- let cached_algo = CONF_CACHE
- .retrieve(&key)
- .change_context(ConfigError::CacheMiss)
- .attach_printable("Unable to retrieve cached routing algorithm even after refresh")?;
+ .await
+ .change_context(ConfigError::DslCachePoisoned)?;
+
let backend_input =
make_dsl_input(payment_data).change_context(ConfigError::InputConstructionError)?;
- let interpreter = cached_algo.as_ref();
- execute_dsl_and_get_conditional_config(backend_input, interpreter).await
-}
-#[instrument(skip_all)]
-pub async fn ensure_algorithm_cached(
- state: &routes::SessionState,
- merchant_id: &str,
- timestamp: i64,
- algorithm_id: &str,
-) -> ConditionalConfigResult<String> {
- let key = format!("dsl_{merchant_id}");
- let present = CONF_CACHE
- .present(&key)
- .change_context(ConfigError::DslCachePoisoned)
- .attach_printable("Error checking presece of DSL")?;
- let expired = CONF_CACHE
- .expired(&key, timestamp)
- .change_context(ConfigError::DslCachePoisoned)
- .attach_printable("Error checking presence of DSL")?;
- if !present || expired {
- refresh_routing_cache(state, key.clone(), algorithm_id, timestamp).await?;
- };
- Ok(key)
-}
-
-#[instrument(skip_all)]
-pub async fn refresh_routing_cache(
- state: &routes::SessionState,
- key: String,
- algorithm_id: &str,
- timestamp: i64,
-) -> ConditionalConfigResult<()> {
- let config = state
- .store
- .find_config_by_key(algorithm_id)
- .await
- .change_context(ConfigError::DslMissingInDb)
- .attach_printable("Error parsing DSL from config")?;
- let rec: DecisionManagerRecord = config
- .config
- .parse_struct("Program")
- .change_context(ConfigError::DslParsingError)
- .attach_printable("Error parsing routing algorithm from configs")?;
- let interpreter: backend::VirInterpreterBackend<ConditionalConfigs> =
- backend::VirInterpreterBackend::with_program(rec.program)
- .change_context(ConfigError::DslBackendInitError)
- .attach_printable("Error initializing DSL interpreter backend")?;
- CONF_CACHE
- .save(key, interpreter, timestamp)
- .change_context(ConfigError::DslCachePoisoned)
- .attach_printable("Error saving DSL to cache")?;
- Ok(())
+ execute_dsl_and_get_conditional_config(backend_input, &interpreter)
}
-pub async fn execute_dsl_and_get_conditional_config(
+pub fn execute_dsl_and_get_conditional_config(
backend_input: dsl_inputs::BackendInput,
interpreter: &backend::VirInterpreterBackend<ConditionalConfigs>,
) -> ConditionalConfigResult<ConditionalConfigs> {
diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs
index 145800ebc6a..15eda58c913 100644
--- a/crates/router/src/core/payments/routing.rs
+++ b/crates/router/src/core/payments/routing.rs
@@ -558,9 +558,9 @@ pub async fn get_merchant_cgraph<'a>(
#[cfg(not(feature = "business_profile_routing"))]
let key = match transaction_type {
- api_enums::TransactionType::Payment => format!("kgraph_{}", merchant_id),
+ api_enums::TransactionType::Payment => format!("cgraph_{}", merchant_id),
#[cfg(feature = "payouts")]
- api_enums::TransactionType::Payout => format!("kgraph_po_{}", merchant_id),
+ api_enums::TransactionType::Payout => format!("cgraph_po_{}", merchant_id),
};
let cached_cgraph = CGRAPH_CACHE
diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs
index a64dadaa35d..5314de4d2f8 100644
--- a/crates/router/src/core/routing.rs
+++ b/crates/router/src/core/routing.rs
@@ -15,6 +15,8 @@ use diesel_models::configs;
use diesel_models::routing_algorithm::RoutingAlgorithm;
use error_stack::ResultExt;
use rustc_hash::FxHashSet;
+#[cfg(not(feature = "business_profile_routing"))]
+use storage_impl::redis::cache;
use super::payments;
#[cfg(feature = "payouts")]
@@ -232,7 +234,11 @@ pub async fn create_routing_config(
if records_are_empty {
merchant_dictionary.active_id = Some(algorithm_id.clone());
algorithm_ref.update_algorithm_id(algorithm_id);
- helpers::update_merchant_active_algorithm_ref(db, &key_store, algorithm_ref).await?;
+ let key =
+ cache::CacheKind::Routing(format!("dsl_{}", &merchant_account.merchant_id).into());
+
+ helpers::update_merchant_active_algorithm_ref(db, &key_store, key, algorithm_ref)
+ .await?;
}
helpers::update_merchant_routing_dictionary(
@@ -363,7 +369,9 @@ pub async fn link_routing_config(
merchant_dictionary,
)
.await?;
- helpers::update_merchant_active_algorithm_ref(db, &key_store, routing_ref).await?;
+ let key =
+ cache::CacheKind::Routing(format!("dsl_{}", &merchant_account.merchant_id).into());
+ helpers::update_merchant_active_algorithm_ref(db, &key_store, key, routing_ref).await?;
metrics::ROUTING_LINK_CONFIG_SUCCESS_RESPONSE.add(&metrics::CONTEXT, 1, &[]);
Ok(service_api::ApplicationResponse::Json(response))
diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs
index c77802a1503..274d4192710 100644
--- a/crates/router/src/core/routing/helpers.rs
+++ b/crates/router/src/core/routing/helpers.rs
@@ -188,6 +188,7 @@ pub async fn update_routing_algorithm(
pub async fn update_merchant_active_algorithm_ref(
db: &dyn StorageInterface,
key_store: &domain::MerchantKeyStore,
+ config_key: cache::CacheKind<'_>,
algorithm_id: routing_types::RoutingAlgorithmRef,
) -> RouterResult<()> {
let ref_value = algorithm_id
@@ -226,6 +227,11 @@ pub async fn update_merchant_active_algorithm_ref(
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to update routing algorithm ref in merchant account")?;
+ cache::publish_into_redact_channel(db.get_cache_store().as_ref(), [config_key])
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed to invalidate the config cache")?;
+
Ok(())
}
diff --git a/crates/router/src/core/surcharge_decision_config.rs b/crates/router/src/core/surcharge_decision_config.rs
index 7f451e6008f..b35d7c5ad28 100644
--- a/crates/router/src/core/surcharge_decision_config.rs
+++ b/crates/router/src/core/surcharge_decision_config.rs
@@ -9,6 +9,7 @@ use common_utils::ext_traits::{Encode, StringExt, ValueExt};
use diesel_models::configs;
use error_stack::ResultExt;
use euclid::frontend::ast;
+use storage_impl::redis::cache;
use super::routing::helpers::{
get_payment_method_surcharge_routing_id, update_merchant_active_algorithm_ref,
@@ -88,8 +89,9 @@ pub async fn upsert_surcharge_decision_config(
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Error serializing the config")?;
- algo_id.update_surcharge_config_id(key);
- update_merchant_active_algorithm_ref(db, &key_store, algo_id)
+ algo_id.update_surcharge_config_id(key.clone());
+ let config_key = cache::CacheKind::Surcharge(key.into());
+ update_merchant_active_algorithm_ref(db, &key_store, config_key, algo_id)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to update routing algorithm ref")?;
@@ -124,8 +126,9 @@ pub async fn upsert_surcharge_decision_config(
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Error fetching the config")?;
- algo_id.update_surcharge_config_id(key);
- update_merchant_active_algorithm_ref(db, &key_store, algo_id)
+ algo_id.update_surcharge_config_id(key.clone());
+ let config_key = cache::CacheKind::Surcharge(key.clone().into());
+ update_merchant_active_algorithm_ref(db, &key_store, config_key, algo_id)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to update routing algorithm ref")?;
@@ -154,7 +157,8 @@ pub async fn delete_surcharge_decision_config(
.attach_printable("Could not decode the surcharge conditional_config algorithm")?
.unwrap_or_default();
algo_id.surcharge_config_algo_id = None;
- update_merchant_active_algorithm_ref(db, &key_store, algo_id)
+ let config_key = cache::CacheKind::Surcharge(key.clone().into());
+ update_merchant_active_algorithm_ref(db, &key_store, config_key, algo_id)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to update deleted algorithm ref")?;
diff --git a/crates/router/src/db/merchant_account.rs b/crates/router/src/db/merchant_account.rs
index 9b82ef414ce..39d63080a4b 100644
--- a/crates/router/src/db/merchant_account.rs
+++ b/crates/router/src/db/merchant_account.rs
@@ -514,10 +514,10 @@ async fn publish_and_redact_merchant_account_cache(
.map(|publishable_key| CacheKind::Accounts(publishable_key.into()));
#[cfg(feature = "business_profile_routing")]
- let kgraph_key = merchant_account.default_profile.as_ref().map(|profile_id| {
+ let cgraph_key = merchant_account.default_profile.as_ref().map(|profile_id| {
CacheKind::CGraph(
format!(
- "kgraph_{}_{}",
+ "cgraph_{}_{}",
merchant_account.merchant_id.clone(),
profile_id,
)
@@ -526,8 +526,8 @@ async fn publish_and_redact_merchant_account_cache(
});
#[cfg(not(feature = "business_profile_routing"))]
- let kgraph_key = Some(CacheKind::CGraph(
- format!("kgraph_{}", merchant_account.merchant_id.clone()).into(),
+ let cgraph_key = Some(CacheKind::CGraph(
+ format!("cgraph_{}", merchant_account.merchant_id.clone()).into(),
));
let mut cache_keys = vec![CacheKind::Accounts(
@@ -535,7 +535,7 @@ async fn publish_and_redact_merchant_account_cache(
)];
cache_keys.extend(publishable_key.into_iter());
- cache_keys.extend(kgraph_key.into_iter());
+ cache_keys.extend(cgraph_key.into_iter());
cache::publish_into_redact_channel(store.get_cache_store().as_ref(), cache_keys).await?;
Ok(())
diff --git a/crates/storage_impl/src/redis/cache.rs b/crates/storage_impl/src/redis/cache.rs
index 9d1df7b67eb..e4efab0da33 100644
--- a/crates/storage_impl/src/redis/cache.rs
+++ b/crates/storage_impl/src/redis/cache.rs
@@ -28,6 +28,12 @@ const ACCOUNTS_CACHE_PREFIX: &str = "accounts";
/// Prefix for routing cache key
const ROUTING_CACHE_PREFIX: &str = "routing";
+/// Prefix for three ds decision manager cache key
+const DECISION_MANAGER_CACHE_PREFIX: &str = "decision_manager";
+
+/// Prefix for surcharge cache key
+const SURCHARGE_CACHE_PREFIX: &str = "surcharge";
+
/// Prefix for cgraph cache key
const CGRAPH_CACHE_PREFIX: &str = "cgraph";
@@ -57,6 +63,14 @@ pub static ACCOUNTS_CACHE: Lazy<Cache> =
pub static ROUTING_CACHE: Lazy<Cache> =
Lazy::new(|| Cache::new(CACHE_TTL, CACHE_TTI, Some(MAX_CAPACITY)));
+/// 3DS Decision Manager Cache
+pub static DECISION_MANAGER_CACHE: Lazy<Cache> =
+ Lazy::new(|| Cache::new(CACHE_TTL, CACHE_TTI, Some(MAX_CAPACITY)));
+
+/// Surcharge Cache
+pub static SURCHARGE_CACHE: Lazy<Cache> =
+ Lazy::new(|| Cache::new(CACHE_TTL, CACHE_TTI, Some(MAX_CAPACITY)));
+
/// CGraph Cache
pub static CGRAPH_CACHE: Lazy<Cache> =
Lazy::new(|| Cache::new(CACHE_TTL, CACHE_TTI, Some(MAX_CAPACITY)));
@@ -74,6 +88,8 @@ pub enum CacheKind<'a> {
Config(Cow<'a, str>),
Accounts(Cow<'a, str>),
Routing(Cow<'a, str>),
+ DecisionManager(Cow<'a, str>),
+ Surcharge(Cow<'a, str>),
CGraph(Cow<'a, str>),
PmFiltersCGraph(Cow<'a, str>),
All(Cow<'a, str>),
@@ -85,6 +101,8 @@ impl<'a> From<CacheKind<'a>> for RedisValue {
CacheKind::Config(s) => format!("{CONFIG_CACHE_PREFIX},{s}"),
CacheKind::Accounts(s) => format!("{ACCOUNTS_CACHE_PREFIX},{s}"),
CacheKind::Routing(s) => format!("{ROUTING_CACHE_PREFIX},{s}"),
+ CacheKind::DecisionManager(s) => format!("{DECISION_MANAGER_CACHE_PREFIX},{s}"),
+ CacheKind::Surcharge(s) => format!("{SURCHARGE_CACHE_PREFIX},{s}"),
CacheKind::CGraph(s) => format!("{CGRAPH_CACHE_PREFIX},{s}"),
CacheKind::PmFiltersCGraph(s) => format!("{PM_FILTERS_CGRAPH_CACHE_PREFIX},{s}"),
CacheKind::All(s) => format!("{ALL_CACHE_PREFIX},{s}"),
@@ -105,10 +123,15 @@ impl<'a> TryFrom<RedisValue> for CacheKind<'a> {
ACCOUNTS_CACHE_PREFIX => Ok(Self::Accounts(Cow::Owned(split.1.to_string()))),
CONFIG_CACHE_PREFIX => Ok(Self::Config(Cow::Owned(split.1.to_string()))),
ROUTING_CACHE_PREFIX => Ok(Self::Routing(Cow::Owned(split.1.to_string()))),
+ DECISION_MANAGER_CACHE_PREFIX => {
+ Ok(Self::DecisionManager(Cow::Owned(split.1.to_string())))
+ }
+ SURCHARGE_CACHE_PREFIX => Ok(Self::Surcharge(Cow::Owned(split.1.to_string()))),
CGRAPH_CACHE_PREFIX => Ok(Self::CGraph(Cow::Owned(split.1.to_string()))),
PM_FILTERS_CGRAPH_CACHE_PREFIX => {
Ok(Self::PmFiltersCGraph(Cow::Owned(split.1.to_string())))
}
+
ALL_CACHE_PREFIX => Ok(Self::All(Cow::Owned(split.1.to_string()))),
_ => Err(validation_err.into()),
}
diff --git a/crates/storage_impl/src/redis/pub_sub.rs b/crates/storage_impl/src/redis/pub_sub.rs
index e83546c0f8d..7c4bd93681f 100644
--- a/crates/storage_impl/src/redis/pub_sub.rs
+++ b/crates/storage_impl/src/redis/pub_sub.rs
@@ -3,8 +3,8 @@ use redis_interface::{errors as redis_errors, PubsubInterface, RedisValue};
use router_env::{logger, tracing::Instrument};
use crate::redis::cache::{
- CacheKey, CacheKind, ACCOUNTS_CACHE, CGRAPH_CACHE, CONFIG_CACHE, PM_FILTERS_CGRAPH_CACHE,
- ROUTING_CACHE,
+ CacheKey, CacheKind, ACCOUNTS_CACHE, CGRAPH_CACHE, CONFIG_CACHE, DECISION_MANAGER_CACHE,
+ PM_FILTERS_CGRAPH_CACHE, ROUTING_CACHE, SURCHARGE_CACHE,
};
#[async_trait::async_trait]
@@ -119,6 +119,24 @@ impl PubSubInterface for std::sync::Arc<redis_interface::RedisConnectionPool> {
.await;
key
}
+ CacheKind::DecisionManager(key) => {
+ DECISION_MANAGER_CACHE
+ .remove(CacheKey {
+ key: key.to_string(),
+ prefix: self.key_prefix.clone(),
+ })
+ .await;
+ key
+ }
+ CacheKind::Surcharge(key) => {
+ SURCHARGE_CACHE
+ .remove(CacheKey {
+ key: key.to_string(),
+ prefix: self.key_prefix.clone(),
+ })
+ .await;
+ key
+ }
CacheKind::All(key) => {
CONFIG_CACHE
.remove(CacheKey {
@@ -150,6 +168,19 @@ impl PubSubInterface for std::sync::Arc<redis_interface::RedisConnectionPool> {
prefix: self.key_prefix.clone(),
})
.await;
+ DECISION_MANAGER_CACHE
+ .remove(CacheKey {
+ key: key.to_string(),
+ prefix: self.key_prefix.clone(),
+ })
+ .await;
+ SURCHARGE_CACHE
+ .remove(CacheKey {
+ key: key.to_string(),
+ prefix: self.key_prefix.clone(),
+ })
+ .await;
+
key
}
};
|
refactor
|
refactor conditional_configs to use Moka Cache instead of Static Cache (#4814)
|
47c038300adad1c02e4c77d529c7cc2457cf3b91
|
2023-12-06 15:26:38
|
DEEPANSHU BANSAL
|
feat(connector): [BANKOFAMERICA] Implement Apple Pay (#3061)
| false
|
diff --git a/crates/router/src/configs/defaults.rs b/crates/router/src/configs/defaults.rs
index 1394c33b550..744d7883e95 100644
--- a/crates/router/src/configs/defaults.rs
+++ b/crates/router/src/configs/defaults.rs
@@ -4454,6 +4454,93 @@ impl Default for super::settings::RequiredFields {
non_mandate: HashMap::new(),
common: HashMap::new(),
}
+ ),
+ (
+ enums::Connector::Bankofamerica,
+ RequiredFieldFinal {
+ mandate: HashMap::new(),
+ non_mandate: HashMap::from(
+ [
+ (
+ "email".to_string(),
+ RequiredFieldInfo {
+ required_field: "email".to_string(),
+ display_name: "email".to_string(),
+ field_type: enums::FieldType::UserEmailAddress,
+ value: None,
+ }
+ ),
+ (
+ "billing.address.first_name".to_string(),
+ RequiredFieldInfo {
+ required_field: "billing.address.first_name".to_string(),
+ display_name: "billing_first_name".to_string(),
+ field_type: enums::FieldType::UserBillingName,
+ value: None,
+ }
+ ),
+ (
+ "billing.address.last_name".to_string(),
+ RequiredFieldInfo {
+ required_field: "billing.address.last_name".to_string(),
+ display_name: "billing_last_name".to_string(),
+ field_type: enums::FieldType::UserBillingName,
+ value: None,
+ }
+ ),
+ (
+ "billing.address.city".to_string(),
+ RequiredFieldInfo {
+ required_field: "billing.address.city".to_string(),
+ display_name: "city".to_string(),
+ field_type: enums::FieldType::UserAddressCity,
+ value: None,
+ }
+ ),
+ (
+ "billing.address.state".to_string(),
+ RequiredFieldInfo {
+ required_field: "billing.address.state".to_string(),
+ display_name: "state".to_string(),
+ field_type: enums::FieldType::UserAddressState,
+ value: None,
+ }
+ ),
+ (
+ "billing.address.zip".to_string(),
+ RequiredFieldInfo {
+ required_field: "billing.address.zip".to_string(),
+ display_name: "zip".to_string(),
+ field_type: enums::FieldType::UserAddressPincode,
+ value: None,
+ }
+ ),
+ (
+ "billing.address.country".to_string(),
+ RequiredFieldInfo {
+ required_field: "billing.address.country".to_string(),
+ display_name: "country".to_string(),
+ field_type: enums::FieldType::UserAddressCountry{
+ options: vec![
+ "ALL".to_string(),
+ ]
+ },
+ value: None,
+ }
+ ),
+ (
+ "billing.address.line1".to_string(),
+ RequiredFieldInfo {
+ required_field: "billing.address.line1".to_string(),
+ display_name: "line1".to_string(),
+ field_type: enums::FieldType::UserAddressLine1,
+ value: None,
+ }
+ ),
+ ]
+ ),
+ common: HashMap::new(),
+ }
)
]),
},
@@ -4556,7 +4643,7 @@ impl Default for super::settings::RequiredFields {
),
common: HashMap::new(),
}
- ),
+ )
]),
},
),
diff --git a/crates/router/src/connector/bankofamerica/transformers.rs b/crates/router/src/connector/bankofamerica/transformers.rs
index e31a69669c6..bbec9022835 100644
--- a/crates/router/src/connector/bankofamerica/transformers.rs
+++ b/crates/router/src/connector/bankofamerica/transformers.rs
@@ -6,8 +6,8 @@ use serde::{Deserialize, Serialize};
use crate::{
connector::utils::{
- self, AddressDetailsData, CardData, CardIssuer, PaymentsAuthorizeRequestData,
- PaymentsSyncRequestData, RouterData,
+ self, AddressDetailsData, ApplePayDecrypt, CardData, CardIssuer,
+ PaymentsAuthorizeRequestData, PaymentsSyncRequestData, RouterData,
},
consts,
core::errors,
@@ -16,6 +16,7 @@ use crate::{
api::{self, enums as api_enums},
storage::enums,
transformers::ForeignFrom,
+ ApplePayPredecryptData,
},
};
@@ -110,11 +111,18 @@ pub struct GooglePayPaymentInformation {
fluid_data: FluidData,
}
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct ApplePayPaymentInformation {
+ tokenized_card: TokenizedCard,
+}
+
#[derive(Debug, Serialize)]
#[serde(untagged)]
pub enum PaymentInformation {
Cards(CardPaymentInformation),
GooglePay(GooglePayPaymentInformation),
+ ApplePay(ApplePayPaymentInformation),
}
#[derive(Debug, Serialize)]
@@ -128,6 +136,16 @@ pub struct Card {
card_type: Option<String>,
}
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct TokenizedCard {
+ number: Secret<String>,
+ expiration_month: Secret<String>,
+ expiration_year: Secret<String>,
+ cryptogram: Secret<String>,
+ transaction_type: TransactionType,
+}
+
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct FluidData {
@@ -215,6 +233,12 @@ impl From<PaymentSolution> for String {
}
}
+#[derive(Debug, Serialize)]
+pub enum TransactionType {
+ #[serde(rename = "1")]
+ ApplePay,
+}
+
impl
From<(
&BankOfAmericaRouterData<&types::PaymentsAuthorizeRouterData>,
@@ -320,6 +344,48 @@ impl
}
}
+impl
+ TryFrom<(
+ &BankOfAmericaRouterData<&types::PaymentsAuthorizeRouterData>,
+ Box<ApplePayPredecryptData>,
+ )> for BankOfAmericaPaymentsRequest
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ (item, apple_pay_data): (
+ &BankOfAmericaRouterData<&types::PaymentsAuthorizeRouterData>,
+ Box<ApplePayPredecryptData>,
+ ),
+ ) -> Result<Self, Self::Error> {
+ let email = item.router_data.request.get_email()?;
+ let bill_to = build_bill_to(item.router_data.get_billing()?, email)?;
+ let order_information = OrderInformationWithBill::from((item, bill_to));
+ let processing_information =
+ ProcessingInformation::from((item, Some(PaymentSolution::ApplePay)));
+ let client_reference_information = ClientReferenceInformation::from(item);
+
+ let expiration_month = apple_pay_data.get_expiry_month()?;
+ let expiration_year = apple_pay_data.get_four_digit_expiry_year()?;
+
+ let payment_information = PaymentInformation::ApplePay(ApplePayPaymentInformation {
+ tokenized_card: TokenizedCard {
+ number: apple_pay_data.application_primary_account_number,
+ cryptogram: apple_pay_data.payment_data.online_payment_cryptogram,
+ transaction_type: TransactionType::ApplePay,
+ expiration_year,
+ expiration_month,
+ },
+ });
+
+ Ok(Self {
+ processing_information,
+ payment_information,
+ order_information,
+ client_reference_information,
+ })
+ }
+}
+
impl
TryFrom<(
&BankOfAmericaRouterData<&types::PaymentsAuthorizeRouterData>,
@@ -368,6 +434,17 @@ impl TryFrom<&BankOfAmericaRouterData<&types::PaymentsAuthorizeRouterData>>
match item.router_data.request.payment_method_data.clone() {
payments::PaymentMethodData::Card(ccard) => Self::try_from((item, ccard)),
payments::PaymentMethodData::Wallet(wallet_data) => match wallet_data {
+ payments::WalletData::ApplePay(_) => {
+ let payment_method_token = item.router_data.get_payment_method_token()?;
+ match payment_method_token {
+ types::PaymentMethodToken::ApplePayDecrypt(decrypt_data) => {
+ Self::try_from((item, decrypt_data))
+ }
+ types::PaymentMethodToken::Token(_) => {
+ Err(errors::ConnectorError::InvalidWalletToken)?
+ }
+ }
+ }
payments::WalletData::GooglePay(google_pay_data) => {
Self::try_from((item, google_pay_data))
}
@@ -378,7 +455,6 @@ impl TryFrom<&BankOfAmericaRouterData<&types::PaymentsAuthorizeRouterData>>
| payments::WalletData::KakaoPayRedirect(_)
| payments::WalletData::GoPayRedirect(_)
| payments::WalletData::GcashRedirect(_)
- | payments::WalletData::ApplePay(_)
| payments::WalletData::ApplePayRedirect(_)
| payments::WalletData::ApplePayThirdPartySdk(_)
| payments::WalletData::DanaRedirect {}
diff --git a/crates/router/src/connector/checkout/transformers.rs b/crates/router/src/connector/checkout/transformers.rs
index ebe02f30d5f..37c038c22af 100644
--- a/crates/router/src/connector/checkout/transformers.rs
+++ b/crates/router/src/connector/checkout/transformers.rs
@@ -1,12 +1,12 @@
use common_utils::{errors::CustomResult, ext_traits::ByteSliceExt};
use error_stack::{IntoReport, ResultExt};
-use masking::{ExposeInterface, PeekInterface, Secret};
+use masking::{ExposeInterface, Secret};
use serde::{Deserialize, Serialize};
use time::PrimitiveDateTime;
use url::Url;
use crate::{
- connector::utils::{self, PaymentsCaptureRequestData, RouterData, WalletData},
+ connector::utils::{self, ApplePayDecrypt, PaymentsCaptureRequestData, RouterData, WalletData},
consts,
core::errors,
services,
@@ -304,24 +304,8 @@ impl TryFrom<&CheckoutRouterData<&types::PaymentsAuthorizeRouterData>> for Payme
}))
}
types::PaymentMethodToken::ApplePayDecrypt(decrypt_data) => {
- let expiry_year_4_digit = Secret::new(format!(
- "20{}",
- decrypt_data
- .clone()
- .application_expiration_date
- .peek()
- .get(0..2)
- .ok_or(errors::ConnectorError::RequestEncodingFailed)?
- ));
- let exp_month = Secret::new(
- decrypt_data
- .clone()
- .application_expiration_date
- .peek()
- .get(2..4)
- .ok_or(errors::ConnectorError::RequestEncodingFailed)?
- .to_owned(),
- );
+ let exp_month = decrypt_data.get_expiry_month()?;
+ let expiry_year_4_digit = decrypt_data.get_four_digit_expiry_year()?;
Ok(PaymentSource::ApplePayPredecrypt(Box::new(
ApplePayPredecrypt {
token: decrypt_data.application_primary_account_number,
diff --git a/crates/router/src/connector/stripe/transformers.rs b/crates/router/src/connector/stripe/transformers.rs
index 18247960453..fad029c1c9d 100644
--- a/crates/router/src/connector/stripe/transformers.rs
+++ b/crates/router/src/connector/stripe/transformers.rs
@@ -8,7 +8,7 @@ use common_utils::{
};
use data_models::mandates::AcceptanceType;
use error_stack::{IntoReport, ResultExt};
-use masking::{ExposeInterface, ExposeOptionInterface, PeekInterface, Secret};
+use masking::{ExposeInterface, ExposeOptionInterface, Secret};
use serde::{Deserialize, Serialize};
use time::PrimitiveDateTime;
use url::Url;
@@ -16,7 +16,9 @@ use uuid::Uuid;
use crate::{
collect_missing_value_keys,
- connector::utils::{self as connector_util, ApplePay, PaymentsPreProcessingData, RouterData},
+ connector::utils::{
+ self as connector_util, ApplePay, ApplePayDecrypt, PaymentsPreProcessingData, RouterData,
+ },
core::errors,
services,
types::{
@@ -1473,24 +1475,8 @@ impl TryFrom<(&payments::WalletData, Option<types::PaymentMethodToken>)>
if let Some(types::PaymentMethodToken::ApplePayDecrypt(decrypt_data)) =
payment_method_token
{
- let expiry_year_4_digit = Secret::new(format!(
- "20{}",
- decrypt_data
- .clone()
- .application_expiration_date
- .peek()
- .get(0..2)
- .ok_or(errors::ConnectorError::RequestEncodingFailed)?
- ));
- let exp_month = Secret::new(
- decrypt_data
- .clone()
- .application_expiration_date
- .peek()
- .get(2..4)
- .ok_or(errors::ConnectorError::RequestEncodingFailed)?
- .to_owned(),
- );
+ let expiry_year_4_digit = decrypt_data.get_four_digit_expiry_year()?;
+ let exp_month = decrypt_data.get_expiry_month()?;
Some(Self::Wallet(StripeWallet::ApplePayPredecryptToken(
Box::new(StripeApplePayPredecrypt {
diff --git a/crates/router/src/connector/utils.rs b/crates/router/src/connector/utils.rs
index 2580dcd3fc2..3990fc9c7e4 100644
--- a/crates/router/src/connector/utils.rs
+++ b/crates/router/src/connector/utils.rs
@@ -28,7 +28,7 @@ use crate::{
pii::PeekInterface,
types::{
self, api, storage::payment_attempt::PaymentAttemptExt, transformers::ForeignTryFrom,
- PaymentsCancelData, ResponseId,
+ ApplePayPredecryptData, PaymentsCancelData, ResponseId,
},
utils::{OptionExt, ValueExt},
};
@@ -855,6 +855,33 @@ impl ApplePay for payments::ApplePayWalletData {
}
}
+pub trait ApplePayDecrypt {
+ fn get_expiry_month(&self) -> Result<Secret<String>, Error>;
+ fn get_four_digit_expiry_year(&self) -> Result<Secret<String>, Error>;
+}
+
+impl ApplePayDecrypt for Box<ApplePayPredecryptData> {
+ fn get_four_digit_expiry_year(&self) -> Result<Secret<String>, Error> {
+ Ok(Secret::new(format!(
+ "20{}",
+ self.application_expiration_date
+ .peek()
+ .get(0..2)
+ .ok_or(errors::ConnectorError::RequestEncodingFailed)?
+ )))
+ }
+
+ fn get_expiry_month(&self) -> Result<Secret<String>, Error> {
+ Ok(Secret::new(
+ self.application_expiration_date
+ .peek()
+ .get(2..4)
+ .ok_or(errors::ConnectorError::RequestEncodingFailed)?
+ .to_owned(),
+ ))
+ }
+}
+
pub trait CryptoData {
fn get_pay_currency(&self) -> Result<String, Error>;
}
|
feat
|
[BANKOFAMERICA] Implement Apple Pay (#3061)
|
0d45f854a2cc18cc421a3d449a6dc2c830ef9dd5
|
2024-05-16 20:19:49
|
Narayan Bhat
|
refactor(access_token): handle network delays with expiry of access token (#4617)
| false
|
diff --git a/crates/router/src/consts.rs b/crates/router/src/consts.rs
index 0c9e9443ac9..6d9da8f7bb5 100644
--- a/crates/router/src/consts.rs
+++ b/crates/router/src/consts.rs
@@ -118,6 +118,8 @@ pub const POLL_ID_TTL: i64 = 900;
pub const DEFAULT_POLL_DELAY_IN_SECS: i8 = 2;
pub const DEFAULT_POLL_FREQUENCY: i8 = 5;
+// Number of seconds to subtract from access token expiry
+pub(crate) const REDUCE_ACCESS_TOKEN_EXPIRY_TIME: u8 = 15;
pub const CONNECTOR_CREDS_TOKEN_TTL: i64 = 900;
//max_amount allowed is 999999999 in minor units
diff --git a/crates/router/src/core/payments/access_token.rs b/crates/router/src/core/payments/access_token.rs
index 2d4ed2b6e1b..0c5aa13eb2f 100644
--- a/crates/router/src/core/payments/access_token.rs
+++ b/crates/router/src/core/payments/access_token.rs
@@ -91,9 +91,26 @@ pub async fn add_access_token<
connector.connector_name,
access_token.expires
);
+ metrics::ACCESS_TOKEN_CACHE_HIT.add(
+ &metrics::CONTEXT,
+ 1,
+ &[metrics::request::add_attributes(
+ "connector",
+ connector.connector_name.to_string(),
+ )],
+ );
Ok(Some(access_token))
}
None => {
+ metrics::ACCESS_TOKEN_CACHE_MISS.add(
+ &metrics::CONTEXT,
+ 1,
+ &[metrics::request::add_attributes(
+ "connector",
+ connector.connector_name.to_string(),
+ )],
+ );
+
let cloned_router_data = router_data.clone();
let refresh_token_request_data = types::AccessTokenRequestData::try_from(
router_data.connector_auth_type.clone(),
@@ -123,15 +140,31 @@ pub async fn add_access_token<
&refresh_token_router_data,
)
.await?
- .async_map(|access_token| async {
- // Store the access token in redis with expiry
- // The expiry should be adjusted for network delays from the connector
+ .async_map(|access_token| async move {
let store = &*state.store;
+
+ // The expiry should be adjusted for network delays from the connector
+ // The access token might not have been expired when request is sent
+ // But once it reaches the connector, it might expire because of the network delay
+ // Subtract few seconds from the expiry in order to account for these network delays
+ // This will reduce the expiry time by `REDUCE_ACCESS_TOKEN_EXPIRY_TIME` seconds
+ let modified_access_token_with_expiry = types::AccessToken {
+ expires: access_token
+ .expires
+ .saturating_sub(consts::REDUCE_ACCESS_TOKEN_EXPIRY_TIME.into()),
+ ..access_token
+ };
+
+ logger::debug!(
+ access_token_expiry_after_modification =
+ modified_access_token_with_expiry.expires
+ );
+
if let Err(access_token_set_error) = store
.set_access_token(
merchant_id,
&merchant_connector_id_or_connector_name,
- access_token.clone(),
+ modified_access_token_with_expiry.clone(),
)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
@@ -142,7 +175,7 @@ pub async fn add_access_token<
// The next request will create new access token, if required
logger::error!(access_token_set_error=?access_token_set_error);
}
- Some(access_token)
+ Some(modified_access_token_with_expiry)
})
.await
}
diff --git a/crates/router/src/routes/metrics.rs b/crates/router/src/routes/metrics.rs
index 780dd51bbde..1123be1a874 100644
--- a/crates/router/src/routes/metrics.rs
+++ b/crates/router/src/routes/metrics.rs
@@ -52,7 +52,6 @@ counter_metric!(MCA_CREATE, GLOBAL_METER);
// Flow Specific Metrics
-counter_metric!(ACCESS_TOKEN_CREATION, GLOBAL_METER);
histogram_metric!(CONNECTOR_REQUEST_TIME, GLOBAL_METER);
counter_metric!(SESSION_TOKEN_CREATED, GLOBAL_METER);
@@ -123,5 +122,16 @@ counter_metric!(TASKS_ADDED_COUNT, GLOBAL_METER); // Tasks added to process trac
counter_metric!(TASK_ADDITION_FAILURES_COUNT, GLOBAL_METER); // Failures in task addition to process tracker
counter_metric!(TASKS_RESET_COUNT, GLOBAL_METER); // Tasks reset in process tracker for requeue flow
+// Access token metrics
+//
+// A counter to indicate the number of new access tokens created
+counter_metric!(ACCESS_TOKEN_CREATION, GLOBAL_METER);
+
+// A counter to indicate the access token cache hits
+counter_metric!(ACCESS_TOKEN_CACHE_HIT, GLOBAL_METER);
+
+// A counter to indicate the access token cache miss
+counter_metric!(ACCESS_TOKEN_CACHE_MISS, GLOBAL_METER);
+
pub mod request;
pub mod utils;
|
refactor
|
handle network delays with expiry of access token (#4617)
|
8a35f7c926f3cbd0d5cd3c2c9470575246985ca3
|
2023-05-13 15:35:20
|
ThisIsMani
|
feat(connector): add multiple dummy connectors and enable them (#1147)
| false
|
diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs
index ae13a34d103..f391f3a3a60 100644
--- a/crates/api_models/src/enums.rs
+++ b/crates/api_models/src/enums.rs
@@ -596,9 +596,17 @@ pub enum Connector {
Dummy,
Iatapay,
#[cfg(feature = "dummy_connector")]
- #[serde(rename = "dummyconnector")]
- #[strum(serialize = "dummyconnector")]
- DummyConnector,
+ #[serde(rename = "dummyconnector1")]
+ #[strum(serialize = "dummyconnector1")]
+ DummyConnector1,
+ #[cfg(feature = "dummy_connector")]
+ #[serde(rename = "dummyconnector2")]
+ #[strum(serialize = "dummyconnector2")]
+ DummyConnector2,
+ #[cfg(feature = "dummy_connector")]
+ #[serde(rename = "dummyconnector3")]
+ #[strum(serialize = "dummyconnector3")]
+ DummyConnector3,
Opennode,
Bambora,
Dlocal,
@@ -659,9 +667,17 @@ impl Connector {
#[strum(serialize_all = "snake_case")]
pub enum RoutableConnectors {
#[cfg(feature = "dummy_connector")]
- #[serde(rename = "dummyconnector")]
- #[strum(serialize = "dummyconnector")]
- DummyConnector,
+ #[serde(rename = "dummyconnector1")]
+ #[strum(serialize = "dummyconnector1")]
+ DummyConnector1,
+ #[cfg(feature = "dummy_connector")]
+ #[serde(rename = "dummyconnector2")]
+ #[strum(serialize = "dummyconnector2")]
+ DummyConnector2,
+ #[cfg(feature = "dummy_connector")]
+ #[serde(rename = "dummyconnector3")]
+ #[strum(serialize = "dummyconnector3")]
+ DummyConnector3,
Aci,
Adyen,
Airwallex,
diff --git a/crates/router/Cargo.toml b/crates/router/Cargo.toml
index 97fdd0b7fa9..088f6129236 100644
--- a/crates/router/Cargo.toml
+++ b/crates/router/Cargo.toml
@@ -10,7 +10,7 @@ license = "Apache-2.0"
build = "src/build.rs"
[features]
-default = ["kv_store", "stripe", "oltp", "olap", "accounts_cache"]
+default = ["kv_store", "stripe", "oltp", "olap", "accounts_cache", "dummy_connector"]
s3 = ["dep:aws-sdk-s3","dep:aws-config"]
kms = ["external_services/kms","dep:aws-config"]
basilisk = ["kms"]
diff --git a/crates/router/src/connector/dummyconnector.rs b/crates/router/src/connector/dummyconnector.rs
index b7928a18c06..75565174836 100644
--- a/crates/router/src/connector/dummyconnector.rs
+++ b/crates/router/src/connector/dummyconnector.rs
@@ -21,32 +21,33 @@ use crate::{
};
#[derive(Debug, Clone)]
-pub struct DummyConnector;
-
-impl api::Payment for DummyConnector {}
-impl api::PaymentSession for DummyConnector {}
-impl api::ConnectorAccessToken for DummyConnector {}
-impl api::PreVerify for DummyConnector {}
-impl api::PaymentAuthorize for DummyConnector {}
-impl api::PaymentSync for DummyConnector {}
-impl api::PaymentCapture for DummyConnector {}
-impl api::PaymentVoid for DummyConnector {}
-impl api::Refund for DummyConnector {}
-impl api::RefundExecute for DummyConnector {}
-impl api::RefundSync for DummyConnector {}
-impl api::PaymentToken for DummyConnector {}
-
-impl
+pub struct DummyConnector<const T: u8>;
+
+impl<const T: u8> api::Payment for DummyConnector<T> {}
+impl<const T: u8> api::PaymentSession for DummyConnector<T> {}
+impl<const T: u8> api::ConnectorAccessToken for DummyConnector<T> {}
+impl<const T: u8> api::PreVerify for DummyConnector<T> {}
+impl<const T: u8> api::PaymentAuthorize for DummyConnector<T> {}
+impl<const T: u8> api::PaymentSync for DummyConnector<T> {}
+impl<const T: u8> api::PaymentCapture for DummyConnector<T> {}
+impl<const T: u8> api::PaymentVoid for DummyConnector<T> {}
+impl<const T: u8> api::Refund for DummyConnector<T> {}
+impl<const T: u8> api::RefundExecute for DummyConnector<T> {}
+impl<const T: u8> api::RefundSync for DummyConnector<T> {}
+impl<const T: u8> api::PaymentToken for DummyConnector<T> {}
+
+impl<const T: u8>
ConnectorIntegration<
api::PaymentMethodToken,
types::PaymentMethodTokenizationData,
types::PaymentsResponseData,
- > for DummyConnector
+ > for DummyConnector<T>
{
// Not Implemented (R)
}
-impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for DummyConnector
+impl<const T: u8, Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response>
+ for DummyConnector<T>
where
Self: ConnectorIntegration<Flow, Request, Response>,
{
@@ -65,9 +66,14 @@ where
}
}
-impl ConnectorCommon for DummyConnector {
+impl<const T: u8> ConnectorCommon for DummyConnector<T> {
fn id(&self) -> &'static str {
- "dummyconnector"
+ match T {
+ 1 => "dummyconnector1",
+ 2 => "dummyconnector2",
+ 3 => "dummyconnector3",
+ _ => "dummyconnector",
+ }
}
fn common_get_content_type(&self) -> &'static str {
@@ -105,24 +111,28 @@ impl ConnectorCommon for DummyConnector {
}
}
-impl ConnectorIntegration<api::Session, types::PaymentsSessionData, types::PaymentsResponseData>
- for DummyConnector
+impl<const T: u8>
+ ConnectorIntegration<api::Session, types::PaymentsSessionData, types::PaymentsResponseData>
+ for DummyConnector<T>
{
//TODO: implement sessions flow
}
-impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, types::AccessToken>
- for DummyConnector
+impl<const T: u8>
+ ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, types::AccessToken>
+ for DummyConnector<T>
{
}
-impl ConnectorIntegration<api::Verify, types::VerifyRequestData, types::PaymentsResponseData>
- for DummyConnector
+impl<const T: u8>
+ ConnectorIntegration<api::Verify, types::VerifyRequestData, types::PaymentsResponseData>
+ for DummyConnector<T>
{
}
-impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::PaymentsResponseData>
- for DummyConnector
+impl<const T: u8>
+ ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::PaymentsResponseData>
+ for DummyConnector<T>
{
fn get_headers(
&self,
@@ -214,8 +224,9 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
}
}
-impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsResponseData>
- for DummyConnector
+impl<const T: u8>
+ ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsResponseData>
+ for DummyConnector<T>
{
fn get_headers(
&self,
@@ -290,8 +301,9 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
}
}
-impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::PaymentsResponseData>
- for DummyConnector
+impl<const T: u8>
+ ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::PaymentsResponseData>
+ for DummyConnector<T>
{
fn get_headers(
&self,
@@ -362,13 +374,14 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
}
}
-impl ConnectorIntegration<api::Void, types::PaymentsCancelData, types::PaymentsResponseData>
- for DummyConnector
+impl<const T: u8>
+ ConnectorIntegration<api::Void, types::PaymentsCancelData, types::PaymentsResponseData>
+ for DummyConnector<T>
{
}
-impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsResponseData>
- for DummyConnector
+impl<const T: u8> ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsResponseData>
+ for DummyConnector<T>
{
fn get_headers(
&self,
@@ -449,8 +462,8 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
}
}
-impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponseData>
- for DummyConnector
+impl<const T: u8> ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponseData>
+ for DummyConnector<T>
{
fn get_headers(
&self,
@@ -519,7 +532,7 @@ impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponse
}
#[async_trait::async_trait]
-impl api::IncomingWebhook for DummyConnector {
+impl<const T: u8> api::IncomingWebhook for DummyConnector<T> {
fn get_webhook_object_reference_id(
&self,
_request: &api::IncomingWebhookRequestDetails<'_>,
diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs
index 0a1be35c6c1..fa765c3ac8b 100644
--- a/crates/router/src/core/payments/flows.rs
+++ b/crates/router/src/core/payments/flows.rs
@@ -101,7 +101,16 @@ macro_rules! default_imp_for_complete_authorize{
}
#[cfg(feature = "dummy_connector")]
-default_imp_for_complete_authorize!(connector::DummyConnector);
+impl<const T: u8> api::PaymentsCompleteAuthorize for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8>
+ services::ConnectorIntegration<
+ api::CompleteAuthorize,
+ types::CompleteAuthorizeData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+{
+}
default_imp_for_complete_authorize!(
connector::Aci,
@@ -147,7 +156,16 @@ macro_rules! default_imp_for_create_customer{
}
#[cfg(feature = "dummy_connector")]
-default_imp_for_create_customer!(connector::DummyConnector);
+impl<const T: u8> api::ConnectorCustomer for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8>
+ services::ConnectorIntegration<
+ api::CreateConnectorCustomer,
+ types::ConnectorCustomerData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+{
+}
default_imp_for_create_customer!(
connector::Aci,
@@ -201,7 +219,16 @@ macro_rules! default_imp_for_connector_redirect_response{
}
#[cfg(feature = "dummy_connector")]
-default_imp_for_connector_redirect_response!(connector::DummyConnector);
+impl<const T: u8> services::ConnectorRedirectResponse for connector::DummyConnector<T> {
+ fn get_flow_type(
+ &self,
+ _query_params: &str,
+ _json_payload: Option<serde_json::Value>,
+ _action: services::PaymentAction,
+ ) -> CustomResult<payments::CallConnectorAction, ConnectorError> {
+ Ok(payments::CallConnectorAction::Trigger)
+ }
+}
default_imp_for_connector_redirect_response!(
connector::Aci,
@@ -237,7 +264,7 @@ macro_rules! default_imp_for_connector_request_id{
}
#[cfg(feature = "dummy_connector")]
-default_imp_for_connector_request_id!(connector::DummyConnector);
+impl<const T: u8> api::ConnectorTransactionId for connector::DummyConnector<T> {}
default_imp_for_connector_request_id!(
connector::Aci,
@@ -290,7 +317,18 @@ macro_rules! default_imp_for_accept_dispute{
}
#[cfg(feature = "dummy_connector")]
-default_imp_for_accept_dispute!(connector::DummyConnector);
+impl<const T: u8> api::Dispute for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8> api::AcceptDispute for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8>
+ services::ConnectorIntegration<
+ api::Accept,
+ types::AcceptDisputeRequestData,
+ types::AcceptDisputeResponse,
+ > for connector::DummyConnector<T>
+{
+}
default_imp_for_accept_dispute!(
connector::Aci,
@@ -352,7 +390,29 @@ macro_rules! default_imp_for_file_upload{
}
#[cfg(feature = "dummy_connector")]
-default_imp_for_file_upload!(connector::DummyConnector);
+impl<const T: u8> api::FileUpload for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8> api::UploadFile for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8>
+ services::ConnectorIntegration<
+ api::Upload,
+ types::UploadFileRequestData,
+ types::UploadFileResponse,
+ > for connector::DummyConnector<T>
+{
+}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8> api::RetrieveFile for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8>
+ services::ConnectorIntegration<
+ api::Retrieve,
+ types::RetrieveFileRequestData,
+ types::RetrieveFileResponse,
+ > for connector::DummyConnector<T>
+{
+}
default_imp_for_file_upload!(
connector::Aci,
@@ -404,7 +464,16 @@ macro_rules! default_imp_for_submit_evidence{
}
#[cfg(feature = "dummy_connector")]
-default_imp_for_submit_evidence!(connector::DummyConnector);
+impl<const T: u8> api::SubmitEvidence for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8>
+ services::ConnectorIntegration<
+ api::Evidence,
+ types::SubmitEvidenceRequestData,
+ types::SubmitEvidenceResponse,
+ > for connector::DummyConnector<T>
+{
+}
default_imp_for_submit_evidence!(
connector::Aci,
@@ -456,7 +525,16 @@ macro_rules! default_imp_for_defend_dispute{
}
#[cfg(feature = "dummy_connector")]
-default_imp_for_defend_dispute!(connector::DummyConnector);
+impl<const T: u8> api::DefendDispute for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8>
+ services::ConnectorIntegration<
+ api::Defend,
+ types::DefendDisputeRequestData,
+ types::DefendDisputeResponse,
+ > for connector::DummyConnector<T>
+{
+}
default_imp_for_defend_dispute!(
connector::Aci,
diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs
index 8bcd3a056f3..48f7eec8eb7 100644
--- a/crates/router/src/types/api.rs
+++ b/crates/router/src/types/api.rs
@@ -212,7 +212,11 @@ impl ConnectorData {
"cybersource" => Ok(Box::new(&connector::Cybersource)),
"dlocal" => Ok(Box::new(&connector::Dlocal)),
#[cfg(feature = "dummy_connector")]
- "dummyconnector" => Ok(Box::new(&connector::DummyConnector)),
+ "dummyconnector1" => Ok(Box::new(&connector::DummyConnector::<1>)),
+ #[cfg(feature = "dummy_connector")]
+ "dummyconnector2" => Ok(Box::new(&connector::DummyConnector::<2>)),
+ #[cfg(feature = "dummy_connector")]
+ "dummyconnector3" => Ok(Box::new(&connector::DummyConnector::<3>)),
"fiserv" => Ok(Box::new(&connector::Fiserv)),
"forte" => Ok(Box::new(&connector::Forte)),
"globalpay" => Ok(Box::new(&connector::Globalpay)),
diff --git a/crates/router/tests/connectors/dummyconnector.rs b/crates/router/tests/connectors/dummyconnector.rs
index 0449647c3c2..c8a9d1acb89 100644
--- a/crates/router/tests/connectors/dummyconnector.rs
+++ b/crates/router/tests/connectors/dummyconnector.rs
@@ -16,8 +16,8 @@ impl utils::Connector for DummyConnectorTest {
fn get_data(&self) -> types::api::ConnectorData {
use router::connector::DummyConnector;
types::api::ConnectorData {
- connector: Box::new(&DummyConnector),
- connector_name: types::Connector::DummyConnector,
+ connector: Box::new(&DummyConnector::<1>),
+ connector_name: types::Connector::DummyConnector1,
get_token: types::api::GetToken::Connector,
}
}
|
feat
|
add multiple dummy connectors and enable them (#1147)
|
60c5fdb89a771b7d1e4d41f3ed11daa00bd10f91
|
2023-09-11 12:25:44
|
Sai Harsha Vardhan
|
fix(router): `validate_psync_reference_id` only if call_connector_action is trigger in psync flow (#2106)
| false
|
diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs
index 5da9ff035cb..b6920387b13 100644
--- a/crates/router/src/core/payments/flows/psync_flow.rs
+++ b/crates/router/src/core/payments/flows/psync_flow.rs
@@ -9,7 +9,7 @@ use crate::{
payments::{self, access_token, helpers, transformers, PaymentData},
},
routes::AppState,
- services,
+ services::{self, logger},
types::{self, api, domain},
};
@@ -113,16 +113,19 @@ impl Feature<api::PSync, types::PaymentsSyncData>
connector: &api::ConnectorData,
call_connector_action: payments::CallConnectorAction,
) -> RouterResult<(Option<services::Request>, bool)> {
- if connector
- .connector
- .validate_psync_reference_id(self)
- .is_err()
- {
- return Ok((None, false));
- }
-
let request = match call_connector_action {
payments::CallConnectorAction::Trigger => {
+ //validate_psync_reference_id if call_connector_action is trigger
+ if connector
+ .connector
+ .validate_psync_reference_id(self)
+ .is_err()
+ {
+ logger::warn!(
+ "validate_psync_reference_id failed, hence skipping call to connector"
+ );
+ return Ok((None, false));
+ }
let connector_integration: services::BoxedConnectorIntegration<
'_,
api::PSync,
|
fix
|
`validate_psync_reference_id` only if call_connector_action is trigger in psync flow (#2106)
|
0e026b70b6502c4e82f3e8cccc5441deb472119e
|
2024-11-18 17:01:53
|
chikke srujan
|
feat(payments): [Payment links] add hide card nickname field config for secure payment links (#6554)
| false
|
diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json
index d2fa50d8629..f00998f154f 100644
--- a/api-reference-v2/openapi_spec.json
+++ b/api-reference-v2/openapi_spec.json
@@ -11948,7 +11948,8 @@
"seller_name",
"sdk_layout",
"display_sdk_only",
- "enabled_saved_payment_method"
+ "enabled_saved_payment_method",
+ "hide_card_nickname_field"
],
"properties": {
"theme": {
@@ -11975,6 +11976,10 @@
"type": "boolean",
"description": "Enable saved payment method option for payment link"
},
+ "hide_card_nickname_field": {
+ "type": "boolean",
+ "description": "Hide card nickname field option for payment link"
+ },
"allowed_domains": {
"type": "array",
"items": {
@@ -12039,6 +12044,13 @@
"example": true,
"nullable": true
},
+ "hide_card_nickname_field": {
+ "type": "boolean",
+ "description": "Hide card nickname field option for payment link",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
"transaction_details": {
"type": "array",
"items": {
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
index 34d5be1b0ec..d4c5717d215 100644
--- a/api-reference/openapi_spec.json
+++ b/api-reference/openapi_spec.json
@@ -15074,7 +15074,8 @@
"seller_name",
"sdk_layout",
"display_sdk_only",
- "enabled_saved_payment_method"
+ "enabled_saved_payment_method",
+ "hide_card_nickname_field"
],
"properties": {
"theme": {
@@ -15101,6 +15102,10 @@
"type": "boolean",
"description": "Enable saved payment method option for payment link"
},
+ "hide_card_nickname_field": {
+ "type": "boolean",
+ "description": "Hide card nickname field option for payment link"
+ },
"allowed_domains": {
"type": "array",
"items": {
@@ -15165,6 +15170,13 @@
"example": true,
"nullable": true
},
+ "hide_card_nickname_field": {
+ "type": "boolean",
+ "description": "Hide card nickname field option for payment link",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
"transaction_details": {
"type": "array",
"items": {
diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs
index 7f5ae1556d2..d80a4ea11b4 100644
--- a/crates/api_models/src/admin.rs
+++ b/crates/api_models/src/admin.rs
@@ -2692,6 +2692,9 @@ pub struct PaymentLinkConfigRequest {
/// Enable saved payment method option for payment link
#[schema(default = false, example = true)]
pub enabled_saved_payment_method: Option<bool>,
+ /// Hide card nickname field option for payment link
+ #[schema(default = false, example = true)]
+ pub hide_card_nickname_field: Option<bool>,
/// Dynamic details related to merchant to be rendered in payment link
pub transaction_details: Option<Vec<PaymentLinkTransactionDetails>>,
}
@@ -2735,6 +2738,8 @@ pub struct PaymentLinkConfig {
pub display_sdk_only: bool,
/// Enable saved payment method option for payment link
pub enabled_saved_payment_method: bool,
+ /// Hide card nickname field option for payment link
+ pub hide_card_nickname_field: bool,
/// A list of allowed domains (glob patterns) where this link can be embedded / opened from
pub allowed_domains: Option<HashSet<String>>,
/// Dynamic details related to merchant to be rendered in payment link
diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs
index 75dda21097a..37389308aa3 100644
--- a/crates/api_models/src/payments.rs
+++ b/crates/api_models/src/payments.rs
@@ -6556,6 +6556,7 @@ pub struct PaymentLinkDetails {
pub merchant_description: Option<String>,
pub sdk_layout: String,
pub display_sdk_only: bool,
+ pub hide_card_nickname_field: bool,
pub locale: Option<String>,
pub transaction_details: Option<Vec<admin::PaymentLinkTransactionDetails>>,
}
@@ -6563,6 +6564,7 @@ pub struct PaymentLinkDetails {
#[derive(Debug, serde::Serialize, Clone)]
pub struct SecurePaymentLinkDetails {
pub enabled_saved_payment_method: bool,
+ pub hide_card_nickname_field: bool,
#[serde(flatten)]
pub payment_link_details: PaymentLinkDetails,
}
diff --git a/crates/common_utils/src/consts.rs b/crates/common_utils/src/consts.rs
index a50555ced92..b43efcb1feb 100644
--- a/crates/common_utils/src/consts.rs
+++ b/crates/common_utils/src/consts.rs
@@ -1,7 +1,5 @@
//! Commonly used constants
-use std::collections::HashSet;
-
/// Number of characters in a generated ID
pub const ID_LENGTH: usize = 20;
@@ -51,26 +49,12 @@ pub const SURCHARGE_PERCENTAGE_PRECISION_LENGTH: u8 = 2;
/// Header Key for application overhead of a request
pub const X_HS_LATENCY: &str = "x-hs-latency";
-/// Default Payment Link Background color
-pub const DEFAULT_BACKGROUND_COLOR: &str = "#212E46";
-
-/// Default product Img Link
-pub const DEFAULT_PRODUCT_IMG: &str =
- "https://live.hyperswitch.io/payment-link-assets/cart_placeholder.png";
-
-/// Default Merchant Logo Link
-pub const DEFAULT_MERCHANT_LOGO: &str =
- "https://live.hyperswitch.io/payment-link-assets/Merchant_placeholder.png";
-
/// Redirect url for Prophetpay
pub const PROPHETPAY_REDIRECT_URL: &str = "https://ccm-thirdparty.cps.golf/hp/tokenize/";
/// Variable which store the card token for Prophetpay
pub const PROPHETPAY_TOKEN: &str = "cctoken";
-/// Default SDK Layout
-pub const DEFAULT_SDK_LAYOUT: &str = "tabs";
-
/// Payment intent default client secret expiry (in seconds)
pub const DEFAULT_SESSION_EXPIRY: i64 = 15 * 60;
@@ -80,15 +64,6 @@ pub const DEFAULT_INTENT_FULFILLMENT_TIME: i64 = 15 * 60;
/// Payment order fulfillment time (in seconds)
pub const DEFAULT_ORDER_FULFILLMENT_TIME: i64 = 15 * 60;
-/// Default bool for Display sdk only
-pub const DEFAULT_DISPLAY_SDK_ONLY: bool = false;
-
-/// Default bool to enable saved payment method
-pub const DEFAULT_ENABLE_SAVED_PAYMENT_METHOD: bool = false;
-
-/// Default allowed domains for payment links
-pub const DEFAULT_ALLOWED_DOMAINS: Option<HashSet<String>> = None;
-
/// Default ttl for Extended card info in redis (in seconds)
pub const DEFAULT_TTL_FOR_EXTENDED_CARD_INFO: u16 = 15 * 60;
diff --git a/crates/diesel_models/src/business_profile.rs b/crates/diesel_models/src/business_profile.rs
index 05c124c4c9c..f4c7b86850e 100644
--- a/crates/diesel_models/src/business_profile.rs
+++ b/crates/diesel_models/src/business_profile.rs
@@ -542,6 +542,7 @@ pub struct PaymentLinkConfigRequest {
pub sdk_layout: Option<String>,
pub display_sdk_only: Option<bool>,
pub enabled_saved_payment_method: Option<bool>,
+ pub hide_card_nickname_field: Option<bool>,
}
common_utils::impl_to_sql_from_sql_json!(BusinessPaymentLinkConfig);
diff --git a/crates/diesel_models/src/payment_intent.rs b/crates/diesel_models/src/payment_intent.rs
index 18248048110..26cb0b8c8a8 100644
--- a/crates/diesel_models/src/payment_intent.rs
+++ b/crates/diesel_models/src/payment_intent.rs
@@ -152,6 +152,8 @@ pub struct PaymentLinkConfigRequestForPayments {
pub display_sdk_only: Option<bool>,
/// Enable saved payment method option for payment link
pub enabled_saved_payment_method: Option<bool>,
+ /// Hide card nickname field option for payment link
+ pub hide_card_nickname_field: Option<bool>,
/// Dynamic details related to merchant to be rendered in payment link
pub transaction_details: Option<Vec<PaymentLinkTransactionDetails>>,
}
diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs
index 02795481ad9..386e0f01f38 100644
--- a/crates/hyperswitch_domain_models/src/lib.rs
+++ b/crates/hyperswitch_domain_models/src/lib.rs
@@ -190,6 +190,7 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>
sdk_layout: item.sdk_layout,
display_sdk_only: item.display_sdk_only,
enabled_saved_payment_method: item.enabled_saved_payment_method,
+ hide_card_nickname_field: item.hide_card_nickname_field,
transaction_details: item.transaction_details.map(|transaction_details| {
transaction_details
.into_iter()
@@ -210,6 +211,7 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>
sdk_layout,
display_sdk_only,
enabled_saved_payment_method,
+ hide_card_nickname_field,
transaction_details,
} = self;
api_models::admin::PaymentLinkConfigRequest {
@@ -219,6 +221,7 @@ impl ApiModelToDieselModelConvertor<api_models::admin::PaymentLinkConfigRequest>
sdk_layout,
display_sdk_only,
enabled_saved_payment_method,
+ hide_card_nickname_field,
transaction_details: transaction_details.map(|transaction_details| {
transaction_details
.into_iter()
diff --git a/crates/router/src/consts.rs b/crates/router/src/consts.rs
index 3f4faedff81..51385593e9d 100644
--- a/crates/router/src/consts.rs
+++ b/crates/router/src/consts.rs
@@ -3,6 +3,8 @@ pub mod opensearch;
pub mod user;
pub mod user_role;
+use std::collections::HashSet;
+
use common_utils::consts;
pub use hyperswitch_interfaces::consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE};
// ID generation
@@ -145,6 +147,32 @@ pub const RECON_FEATURE_TAG: &str = "RECONCILIATION AND SETTLEMENT";
// Length of the unique reference ID generated for connector mandate requests
pub const CONNECTOR_MANDATE_REQUEST_REFERENCE_ID_LENGTH: usize = 18;
+/// Default allowed domains for payment links
+pub const DEFAULT_ALLOWED_DOMAINS: Option<HashSet<String>> = None;
+
+/// Default hide card nickname field
+pub const DEFAULT_HIDE_CARD_NICKNAME_FIELD: bool = false;
+
+/// Default bool for Display sdk only
+pub const DEFAULT_DISPLAY_SDK_ONLY: bool = false;
+
+/// Default bool to enable saved payment method
+pub const DEFAULT_ENABLE_SAVED_PAYMENT_METHOD: bool = false;
+
+/// Default Merchant Logo Link
+pub const DEFAULT_MERCHANT_LOGO: &str =
+ "https://live.hyperswitch.io/payment-link-assets/Merchant_placeholder.png";
+
+/// Default Payment Link Background color
+pub const DEFAULT_BACKGROUND_COLOR: &str = "#212E46";
+
+/// Default product Img Link
+pub const DEFAULT_PRODUCT_IMG: &str =
+ "https://live.hyperswitch.io/payment-link-assets/cart_placeholder.png";
+
+/// Default SDK Layout
+pub const DEFAULT_SDK_LAYOUT: &str = "tabs";
+
/// Vault Add request url
#[cfg(all(feature = "v2", feature = "payment_methods_v2"))]
pub const ADD_VAULT_REQUEST_URL: &str = "/vault/add";
diff --git a/crates/router/src/core/payment_link.rs b/crates/router/src/core/payment_link.rs
index 09a2457197c..91829e56f2c 100644
--- a/crates/router/src/core/payment_link.rs
+++ b/crates/router/src/core/payment_link.rs
@@ -5,11 +5,7 @@ use api_models::{
payments::{PaymentLinkData, PaymentLinkStatusWrap},
};
use common_utils::{
- consts::{
- DEFAULT_ALLOWED_DOMAINS, DEFAULT_BACKGROUND_COLOR, DEFAULT_DISPLAY_SDK_ONLY,
- DEFAULT_ENABLE_SAVED_PAYMENT_METHOD, DEFAULT_LOCALE, DEFAULT_MERCHANT_LOGO,
- DEFAULT_PRODUCT_IMG, DEFAULT_SDK_LAYOUT, DEFAULT_SESSION_EXPIRY,
- },
+ consts::{DEFAULT_LOCALE, DEFAULT_SESSION_EXPIRY},
ext_traits::{AsyncExt, OptionExt, ValueExt},
types::{AmountConvertor, StringMajorUnitForCore},
};
@@ -25,7 +21,11 @@ use super::{
payments::helpers,
};
use crate::{
- consts,
+ consts::{
+ self, DEFAULT_ALLOWED_DOMAINS, DEFAULT_BACKGROUND_COLOR, DEFAULT_DISPLAY_SDK_ONLY,
+ DEFAULT_ENABLE_SAVED_PAYMENT_METHOD, DEFAULT_HIDE_CARD_NICKNAME_FIELD,
+ DEFAULT_MERCHANT_LOGO, DEFAULT_PRODUCT_IMG, DEFAULT_SDK_LAYOUT,
+ },
errors::RouterResponse,
get_payment_link_config_value, get_payment_link_config_value_based_on_priority,
headers::ACCEPT_LANGUAGE,
@@ -125,6 +125,7 @@ pub async fn form_payment_link_data(
sdk_layout: DEFAULT_SDK_LAYOUT.to_owned(),
display_sdk_only: DEFAULT_DISPLAY_SDK_ONLY,
enabled_saved_payment_method: DEFAULT_ENABLE_SAVED_PAYMENT_METHOD,
+ hide_card_nickname_field: DEFAULT_HIDE_CARD_NICKNAME_FIELD,
allowed_domains: DEFAULT_ALLOWED_DOMAINS,
transaction_details: None,
}
@@ -265,6 +266,7 @@ pub async fn form_payment_link_data(
merchant_description: payment_intent.description,
sdk_layout: payment_link_config.sdk_layout.clone(),
display_sdk_only: payment_link_config.display_sdk_only,
+ hide_card_nickname_field: payment_link_config.hide_card_nickname_field,
locale,
transaction_details: payment_link_config.transaction_details.clone(),
};
@@ -322,6 +324,7 @@ pub async fn initiate_secure_payment_link_flow(
PaymentLinkData::PaymentLinkDetails(link_details) => {
let secure_payment_link_details = api_models::payments::SecurePaymentLinkDetails {
enabled_saved_payment_method: payment_link_config.enabled_saved_payment_method,
+ hide_card_nickname_field: payment_link_config.hide_card_nickname_field,
payment_link_details: *link_details.to_owned(),
};
let js_script = format!(
@@ -607,7 +610,15 @@ pub fn get_payment_link_config_based_on_priority(
(default_domain_name, None, None)
};
- let (theme, logo, seller_name, sdk_layout, display_sdk_only, enabled_saved_payment_method) = get_payment_link_config_value!(
+ let (
+ theme,
+ logo,
+ seller_name,
+ sdk_layout,
+ display_sdk_only,
+ enabled_saved_payment_method,
+ hide_card_nickname_field,
+ ) = get_payment_link_config_value!(
payment_create_link_config,
business_theme_configs,
(theme, DEFAULT_BACKGROUND_COLOR.to_string()),
@@ -618,7 +629,8 @@ pub fn get_payment_link_config_based_on_priority(
(
enabled_saved_payment_method,
DEFAULT_ENABLE_SAVED_PAYMENT_METHOD
- )
+ ),
+ (hide_card_nickname_field, DEFAULT_HIDE_CARD_NICKNAME_FIELD)
);
let payment_link_config = PaymentLinkConfig {
theme,
@@ -627,6 +639,7 @@ pub fn get_payment_link_config_based_on_priority(
sdk_layout,
display_sdk_only,
enabled_saved_payment_method,
+ hide_card_nickname_field,
allowed_domains,
transaction_details: payment_create_link_config
.and_then(|payment_link_config| payment_link_config.theme_config.transaction_details),
@@ -729,6 +742,7 @@ pub async fn get_payment_link_status(
sdk_layout: DEFAULT_SDK_LAYOUT.to_owned(),
display_sdk_only: DEFAULT_DISPLAY_SDK_ONLY,
enabled_saved_payment_method: DEFAULT_ENABLE_SAVED_PAYMENT_METHOD,
+ hide_card_nickname_field: DEFAULT_HIDE_CARD_NICKNAME_FIELD,
allowed_domains: DEFAULT_ALLOWED_DOMAINS,
transaction_details: None,
}
diff --git a/crates/router/src/core/payment_link/payment_link_initiate/payment_link_initiator.js b/crates/router/src/core/payment_link/payment_link_initiate/payment_link_initiator.js
index 8d1183a2535..1264915592d 100644
--- a/crates/router/src/core/payment_link/payment_link_initiate/payment_link_initiator.js
+++ b/crates/router/src/core/payment_link/payment_link_initiate/payment_link_initiator.js
@@ -56,6 +56,7 @@ function initializeSDK() {
height: 55,
},
},
+ hideCardNicknameField: false,
};
// @ts-ignore
unifiedCheckout = widgets.create("payment", unifiedCheckoutOptions);
diff --git a/crates/router/src/core/payment_link/payment_link_initiate/secure_payment_link_initiator.js b/crates/router/src/core/payment_link/payment_link_initiate/secure_payment_link_initiator.js
index c901148bbfa..5080970ce3c 100644
--- a/crates/router/src/core/payment_link/payment_link_initiate/secure_payment_link_initiator.js
+++ b/crates/router/src/core/payment_link/payment_link_initiate/secure_payment_link_initiator.js
@@ -63,6 +63,7 @@ if (!isFramed) {
: paymentDetails.sdk_layout;
var enableSavedPaymentMethod = paymentDetails.enabled_saved_payment_method;
+ var hideCardNicknameField = paymentDetails.hide_card_nickname_field;
var unifiedCheckoutOptions = {
displaySavedPaymentMethodsCheckbox: enableSavedPaymentMethod,
displaySavedPaymentMethods: enableSavedPaymentMethod,
@@ -79,6 +80,7 @@ if (!isFramed) {
height: 55,
},
},
+ hideCardNicknameField: hideCardNicknameField,
};
// @ts-ignore
unifiedCheckout = widgets.create("payment", unifiedCheckoutOptions);
diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs
index b09034e28cb..8a0983eccab 100644
--- a/crates/router/src/core/payments/transformers.rs
+++ b/crates/router/src/core/payments/transformers.rs
@@ -3518,6 +3518,7 @@ impl ForeignFrom<api_models::admin::PaymentLinkConfigRequest>
sdk_layout: config.sdk_layout,
display_sdk_only: config.display_sdk_only,
enabled_saved_payment_method: config.enabled_saved_payment_method,
+ hide_card_nickname_field: config.hide_card_nickname_field,
transaction_details: config.transaction_details.map(|transaction_details| {
transaction_details
.iter()
@@ -3570,6 +3571,7 @@ impl ForeignFrom<diesel_models::PaymentLinkConfigRequestForPayments>
sdk_layout: config.sdk_layout,
display_sdk_only: config.display_sdk_only,
enabled_saved_payment_method: config.enabled_saved_payment_method,
+ hide_card_nickname_field: config.hide_card_nickname_field,
transaction_details: config.transaction_details.map(|transaction_details| {
transaction_details
.iter()
diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs
index c97084a2297..36865f5ce09 100644
--- a/crates/router/src/types/transformers.rs
+++ b/crates/router/src/types/transformers.rs
@@ -1987,6 +1987,7 @@ impl ForeignFrom<api_models::admin::PaymentLinkConfigRequest>
sdk_layout: item.sdk_layout,
display_sdk_only: item.display_sdk_only,
enabled_saved_payment_method: item.enabled_saved_payment_method,
+ hide_card_nickname_field: item.hide_card_nickname_field,
}
}
}
@@ -2002,6 +2003,7 @@ impl ForeignFrom<diesel_models::business_profile::PaymentLinkConfigRequest>
sdk_layout: item.sdk_layout,
display_sdk_only: item.display_sdk_only,
enabled_saved_payment_method: item.enabled_saved_payment_method,
+ hide_card_nickname_field: item.hide_card_nickname_field,
transaction_details: None,
}
}
|
feat
|
[Payment links] add hide card nickname field config for secure payment links (#6554)
|
8fa2cd556bf898621a1a8722a0af99d174447485
|
2024-05-22 13:58:42
|
Mani Chandra
|
feat(users): Create generate recovery codes API (#4708)
| false
|
diff --git a/crates/api_models/src/events/user.rs b/crates/api_models/src/events/user.rs
index e9eb5157095..b7d7adbf8e3 100644
--- a/crates/api_models/src/events/user.rs
+++ b/crates/api_models/src/events/user.rs
@@ -14,10 +14,10 @@ use crate::user::{
ConnectAccountRequest, CreateInternalUserRequest, DashboardEntryResponse,
ForgotPasswordRequest, GetUserDetailsResponse, GetUserRoleDetailsRequest,
GetUserRoleDetailsResponse, InviteUserRequest, ListUsersResponse, ReInviteUserRequest,
- ResetPasswordRequest, RotatePasswordRequest, SendVerifyEmailRequest, SignInResponse,
- SignUpRequest, SignUpWithMerchantIdRequest, SwitchMerchantIdRequest, TokenOrPayloadResponse,
- TokenResponse, UpdateUserAccountDetailsRequest, UserFromEmailRequest, UserMerchantCreate,
- VerifyEmailRequest, VerifyTotpRequest,
+ RecoveryCodes, ResetPasswordRequest, RotatePasswordRequest, SendVerifyEmailRequest,
+ SignInResponse, SignUpRequest, SignUpWithMerchantIdRequest, SwitchMerchantIdRequest,
+ TokenOrPayloadResponse, TokenResponse, UpdateUserAccountDetailsRequest, UserFromEmailRequest,
+ UserMerchantCreate, VerifyEmailRequest, VerifyTotpRequest,
};
impl ApiEventMetric for DashboardEntryResponse {
@@ -75,7 +75,8 @@ common_utils::impl_misc_api_event_type!(
TokenResponse,
UserFromEmailRequest,
BeginTotpResponse,
- VerifyTotpRequest
+ VerifyTotpRequest,
+ RecoveryCodes
);
#[cfg(feature = "dummy_connector")]
diff --git a/crates/api_models/src/user.rs b/crates/api_models/src/user.rs
index 7dbf867d1a0..7864117856e 100644
--- a/crates/api_models/src/user.rs
+++ b/crates/api_models/src/user.rs
@@ -257,3 +257,8 @@ pub struct TotpSecret {
pub struct VerifyTotpRequest {
pub totp: Option<Secret<String>>,
}
+
+#[derive(Debug, serde::Deserialize, serde::Serialize)]
+pub struct RecoveryCodes {
+ pub recovery_codes: Vec<Secret<String>>,
+}
diff --git a/crates/router/src/consts/user.rs b/crates/router/src/consts/user.rs
index 8d6aa6265d8..33642205d57 100644
--- a/crates/router/src/consts/user.rs
+++ b/crates/router/src/consts/user.rs
@@ -12,3 +12,5 @@ pub const TOTP_VALIDITY_DURATION_IN_SECONDS: u64 = 30;
pub const TOTP_TOLERANCE: u8 = 1;
pub const MAX_PASSWORD_LENGTH: usize = 70;
pub const MIN_PASSWORD_LENGTH: usize = 8;
+
+pub const TOTP_PREFIX: &str = "TOTP_";
diff --git a/crates/router/src/core/errors/user.rs b/crates/router/src/core/errors/user.rs
index 580e34ba7e8..2d1c196f5df 100644
--- a/crates/router/src/core/errors/user.rs
+++ b/crates/router/src/core/errors/user.rs
@@ -66,10 +66,12 @@ pub enum UserErrors {
RoleNameParsingError,
#[error("RoleNameAlreadyExists")]
RoleNameAlreadyExists,
- #[error("TOTPNotSetup")]
+ #[error("TotpNotSetup")]
TotpNotSetup,
- #[error("InvalidTOTP")]
+ #[error("InvalidTotp")]
InvalidTotp,
+ #[error("TotpRequired")]
+ TotpRequired,
}
impl common_utils::errors::ErrorSwitch<api_models::errors::types::ApiErrorResponse> for UserErrors {
@@ -179,6 +181,9 @@ impl common_utils::errors::ErrorSwitch<api_models::errors::types::ApiErrorRespon
Self::InvalidTotp => {
AER::BadRequest(ApiError::new(sub_code, 37, self.get_error_message(), None))
}
+ Self::TotpRequired => {
+ AER::BadRequest(ApiError::new(sub_code, 38, self.get_error_message(), None))
+ }
}
}
}
@@ -217,6 +222,7 @@ impl UserErrors {
Self::RoleNameAlreadyExists => "Role name already exists",
Self::TotpNotSetup => "TOTP not setup",
Self::InvalidTotp => "Invalid TOTP",
+ Self::TotpRequired => "TOTP required",
}
}
}
diff --git a/crates/router/src/core/user.rs b/crates/router/src/core/user.rs
index 5d1eaeaeb8d..7a0ef683e7a 100644
--- a/crates/router/src/core/user.rs
+++ b/crates/router/src/core/user.rs
@@ -1631,7 +1631,7 @@ pub async fn begin_totp(
}));
}
- let totp = utils::user::generate_default_totp(user_from_db.get_email(), None)?;
+ let totp = utils::user::two_factor_auth::generate_default_totp(user_from_db.get_email(), None)?;
let recovery_codes = domain::RecoveryCodes::generate_new();
let key_store = user_from_db.get_or_create_key_store(&state).await?;
@@ -1693,8 +1693,10 @@ pub async fn verify_totp(
.await?
.ok_or(UserErrors::InternalServerError)?;
- let totp =
- utils::user::generate_default_totp(user_from_db.get_email(), Some(user_totp_secret))?;
+ let totp = utils::user::two_factor_auth::generate_default_totp(
+ user_from_db.get_email(),
+ Some(user_totp_secret),
+ )?;
if totp
.generate_current()
@@ -1732,3 +1734,35 @@ pub async fn verify_totp(
token,
)
}
+
+pub async fn generate_recovery_codes(
+ state: AppState,
+ user_token: auth::UserFromSinglePurposeToken,
+) -> UserResponse<user_api::RecoveryCodes> {
+ if !utils::user::two_factor_auth::check_totp_in_redis(&state, &user_token.user_id).await? {
+ return Err(UserErrors::TotpRequired.into());
+ }
+
+ let recovery_codes = domain::RecoveryCodes::generate_new();
+
+ state
+ .store
+ .update_user_by_user_id(
+ &user_token.user_id,
+ storage_user::UserUpdate::TotpUpdate {
+ totp_status: None,
+ totp_secret: None,
+ totp_recovery_codes: Some(
+ recovery_codes
+ .get_hashed()
+ .change_context(UserErrors::InternalServerError)?,
+ ),
+ },
+ )
+ .await
+ .change_context(UserErrors::InternalServerError)?;
+
+ Ok(ApplicationResponse::Json(user_api::RecoveryCodes {
+ recovery_codes: recovery_codes.into_inner(),
+ }))
+}
diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs
index c00c0e17ff8..0e152ec32c1 100644
--- a/crates/router/src/routes/app.rs
+++ b/crates/router/src/routes/app.rs
@@ -1211,7 +1211,11 @@ impl User {
.route(web::post().to(set_dashboard_metadata)),
)
.service(web::resource("/totp/begin").route(web::get().to(totp_begin)))
- .service(web::resource("/totp/verify").route(web::post().to(totp_verify)));
+ .service(web::resource("/totp/verify").route(web::post().to(totp_verify)))
+ .service(
+ web::resource("/recovery_codes/generate")
+ .route(web::get().to(generate_recovery_codes)),
+ );
#[cfg(feature = "email")]
{
diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs
index 6a73643ce68..706726979dc 100644
--- a/crates/router/src/routes/lock_utils.rs
+++ b/crates/router/src/routes/lock_utils.rs
@@ -214,7 +214,8 @@ impl From<Flow> for ApiIdentifier {
| Flow::VerifyEmailRequest
| Flow::UpdateUserAccountDetails
| Flow::TotpBegin
- | Flow::TotpVerify => Self::User,
+ | Flow::TotpVerify
+ | Flow::GenerateRecoveryCodes => Self::User,
Flow::ListRoles
| Flow::GetRole
diff --git a/crates/router/src/routes/user.rs b/crates/router/src/routes/user.rs
index f28064901e5..f542c446e49 100644
--- a/crates/router/src/routes/user.rs
+++ b/crates/router/src/routes/user.rs
@@ -665,3 +665,17 @@ pub async fn totp_verify(
))
.await
}
+
+pub async fn generate_recovery_codes(state: web::Data<AppState>, req: HttpRequest) -> HttpResponse {
+ let flow = Flow::GenerateRecoveryCodes;
+ Box::pin(api::server_wrap(
+ flow,
+ state.clone(),
+ &req,
+ (),
+ |state, user, _, _| user_core::generate_recovery_codes(state, user),
+ &auth::SinglePurposeJWTAuth(TokenPurpose::TOTP),
+ api_locking::LockAction::NotApplicable,
+ ))
+ .await
+}
diff --git a/crates/router/src/utils/user.rs b/crates/router/src/utils/user.rs
index 4980958c9ac..9c67dbfcab5 100644
--- a/crates/router/src/utils/user.rs
+++ b/crates/router/src/utils/user.rs
@@ -1,14 +1,11 @@
use std::collections::HashMap;
use api_models::user as user_api;
-use common_utils::{errors::CustomResult, pii};
+use common_utils::errors::CustomResult;
use diesel_models::{enums::UserStatus, user_role::UserRole};
use error_stack::ResultExt;
-use masking::ExposeInterface;
-use totp_rs::{Algorithm, TOTP};
use crate::{
- consts,
core::errors::{StorageError, UserErrors, UserResult},
routes::AppState,
services::{
@@ -22,6 +19,7 @@ pub mod dashboard_metadata;
pub mod password;
#[cfg(feature = "dummy_connector")]
pub mod sample_data;
+pub mod two_factor_auth;
impl UserFromToken {
pub async fn get_merchant_account_from_db(
@@ -193,25 +191,3 @@ pub fn get_token_from_signin_response(resp: &user_api::SignInResponse) -> maskin
user_api::SignInResponse::MerchantSelect(data) => data.token.clone(),
}
}
-
-pub fn generate_default_totp(
- email: pii::Email,
- secret: Option<masking::Secret<String>>,
-) -> UserResult<TOTP> {
- let secret = secret
- .map(|sec| totp_rs::Secret::Encoded(sec.expose()))
- .unwrap_or_else(totp_rs::Secret::generate_secret)
- .to_bytes()
- .change_context(UserErrors::InternalServerError)?;
-
- TOTP::new(
- Algorithm::SHA1,
- consts::user::TOTP_DIGITS,
- consts::user::TOTP_TOLERANCE,
- consts::user::TOTP_VALIDITY_DURATION_IN_SECONDS,
- secret,
- Some(consts::user::TOTP_ISSUER_NAME.to_string()),
- email.expose().expose(),
- )
- .change_context(UserErrors::InternalServerError)
-}
diff --git a/crates/router/src/utils/user/two_factor_auth.rs b/crates/router/src/utils/user/two_factor_auth.rs
new file mode 100644
index 00000000000..62bcf2f7eb1
--- /dev/null
+++ b/crates/router/src/utils/user/two_factor_auth.rs
@@ -0,0 +1,52 @@
+use std::sync::Arc;
+
+use common_utils::pii;
+use error_stack::ResultExt;
+use masking::ExposeInterface;
+use redis_interface::RedisConnectionPool;
+use totp_rs::{Algorithm, TOTP};
+
+use crate::{
+ consts,
+ core::errors::{UserErrors, UserResult},
+ routes::AppState,
+};
+
+pub fn generate_default_totp(
+ email: pii::Email,
+ secret: Option<masking::Secret<String>>,
+) -> UserResult<TOTP> {
+ let secret = secret
+ .map(|sec| totp_rs::Secret::Encoded(sec.expose()))
+ .unwrap_or_else(totp_rs::Secret::generate_secret)
+ .to_bytes()
+ .change_context(UserErrors::InternalServerError)?;
+
+ TOTP::new(
+ Algorithm::SHA1,
+ consts::user::TOTP_DIGITS,
+ consts::user::TOTP_TOLERANCE,
+ consts::user::TOTP_VALIDITY_DURATION_IN_SECONDS,
+ secret,
+ Some(consts::user::TOTP_ISSUER_NAME.to_string()),
+ email.expose().expose(),
+ )
+ .change_context(UserErrors::InternalServerError)
+}
+
+pub async fn check_totp_in_redis(state: &AppState, user_id: &str) -> UserResult<bool> {
+ let redis_conn = get_redis_connection(state)?;
+ let key = format!("{}{}", consts::user::TOTP_PREFIX, user_id);
+ redis_conn
+ .exists::<()>(&key)
+ .await
+ .change_context(UserErrors::InternalServerError)
+}
+
+fn get_redis_connection(state: &AppState) -> UserResult<Arc<RedisConnectionPool>> {
+ state
+ .store
+ .get_redis_conn()
+ .change_context(UserErrors::InternalServerError)
+ .attach_printable("Failed to get redis connection")
+}
diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs
index 07a45f5cdbc..0e35aba3174 100644
--- a/crates/router_env/src/logger/types.rs
+++ b/crates/router_env/src/logger/types.rs
@@ -406,6 +406,8 @@ pub enum Flow {
TotpBegin,
/// Verify TOTP
TotpVerify,
+ /// Generate or Regenerate recovery codes
+ GenerateRecoveryCodes,
/// List initial webhook delivery attempts
WebhookEventInitialDeliveryAttemptList,
/// List delivery attempts for a webhook event
|
feat
|
Create generate recovery codes API (#4708)
|
a05059b7cff97dd858fc687cc01b62fed392c13a
|
2023-03-30 04:27:04
|
Abhishek
|
enhance(storage_models): delete client secret when status is succeeded, failed, cancelled (#724)
| false
|
diff --git a/crates/router/src/connector/stripe/transformers.rs b/crates/router/src/connector/stripe/transformers.rs
index 6875b5a4699..4cbdc63328b 100644
--- a/crates/router/src/connector/stripe/transformers.rs
+++ b/crates/router/src/connector/stripe/transformers.rs
@@ -1126,7 +1126,7 @@ impl TryFrom<&types::PaymentsCancelRouterData> for CancelRequest {
Some(c) => Some(
CancellationReason::from_str(c)
.into_report()
- .change_context(errors::ConnectorError::ResponseDeserializationFailed)?,
+ .change_context(errors::ConnectorError::RequestEncodingFailed)?,
),
None => None,
};
diff --git a/crates/storage_models/src/payment_intent.rs b/crates/storage_models/src/payment_intent.rs
index af53f8815e0..39447215e38 100644
--- a/crates/storage_models/src/payment_intent.rs
+++ b/crates/storage_models/src/payment_intent.rs
@@ -178,7 +178,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
status: Some(status),
setup_future_usage,
customer_id,
- client_secret: make_client_secret_null_if_success(Some(status)),
+ client_secret: make_client_secret_null_based_on_status(status),
shipping_address_id,
billing_address_id,
modified_at: Some(common_utils::date_time::now()),
@@ -199,7 +199,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
} => Self {
return_url,
status,
- client_secret: make_client_secret_null_if_success(status),
+ client_secret: status.and_then(make_client_secret_null_based_on_status),
customer_id,
shipping_address_id,
billing_address_id,
@@ -209,6 +209,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
PaymentIntentUpdate::PGStatusUpdate { status } => Self {
status: Some(status),
modified_at: Some(common_utils::date_time::now()),
+ client_secret: make_client_secret_null_based_on_status(status),
..Default::default()
},
PaymentIntentUpdate::MerchantStatusUpdate {
@@ -217,7 +218,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
billing_address_id,
} => Self {
status: Some(status),
- client_secret: make_client_secret_null_if_success(Some(status)),
+ client_secret: make_client_secret_null_based_on_status(status),
shipping_address_id,
billing_address_id,
modified_at: Some(common_utils::date_time::now()),
@@ -237,7 +238,7 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
amount_captured,
// customer_id,
return_url,
- client_secret: make_client_secret_null_if_success(Some(status)),
+ client_secret: make_client_secret_null_based_on_status(status),
modified_at: Some(common_utils::date_time::now()),
..Default::default()
},
@@ -245,12 +246,17 @@ impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
}
}
-fn make_client_secret_null_if_success(
- status: Option<storage_enums::IntentStatus>,
+fn make_client_secret_null_based_on_status(
+ status: storage_enums::IntentStatus,
) -> Option<Option<String>> {
- if status == Some(storage_enums::IntentStatus::Succeeded) {
- Some(None)
- } else {
- None
+ match status {
+ storage_enums::IntentStatus::Succeeded
+ | storage_enums::IntentStatus::Failed
+ | storage_enums::IntentStatus::Cancelled => Some(None),
+ storage_enums::IntentStatus::Processing
+ | storage_enums::IntentStatus::RequiresCustomerAction
+ | storage_enums::IntentStatus::RequiresPaymentMethod
+ | storage_enums::IntentStatus::RequiresConfirmation
+ | storage_enums::IntentStatus::RequiresCapture => None,
}
}
|
enhance
|
delete client secret when status is succeeded, failed, cancelled (#724)
|
1d9e6396522fc0b6cbe0b7ff1be2377098655690
|
2024-09-17 20:53:54
|
Swangi Kumari
|
refactor(connector): Move connector Volt and Mollie from Router to HyperswitchConnector Trait (#5612)
| false
|
diff --git a/Cargo.lock b/Cargo.lock
index ac324d9c310..11036b42dc4 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -4004,6 +4004,7 @@ dependencies = [
"strum 0.26.3",
"thiserror",
"time",
+ "url",
]
[[package]]
diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs
index 037f91e90ca..48c50936d60 100644
--- a/crates/hyperswitch_connectors/src/connectors.rs
+++ b/crates/hyperswitch_connectors/src/connectors.rs
@@ -6,6 +6,7 @@ pub mod fiservemea;
pub mod fiuu;
pub mod globepay;
pub mod helcim;
+pub mod mollie;
pub mod nexixpay;
pub mod novalnet;
pub mod powertranz;
@@ -13,11 +14,12 @@ pub mod stax;
pub mod taxjar;
pub mod thunes;
pub mod tsys;
+pub mod volt;
pub mod worldline;
pub use self::{
bambora::Bambora, bitpay::Bitpay, deutschebank::Deutschebank, fiserv::Fiserv,
- fiservemea::Fiservemea, fiuu::Fiuu, globepay::Globepay, helcim::Helcim, nexixpay::Nexixpay,
- novalnet::Novalnet, powertranz::Powertranz, stax::Stax, taxjar::Taxjar, thunes::Thunes,
- tsys::Tsys, worldline::Worldline,
+ fiservemea::Fiservemea, fiuu::Fiuu, globepay::Globepay, helcim::Helcim, mollie::Mollie,
+ nexixpay::Nexixpay, novalnet::Novalnet, powertranz::Powertranz, stax::Stax, taxjar::Taxjar,
+ thunes::Thunes, tsys::Tsys, volt::Volt, worldline::Worldline,
};
diff --git a/crates/router/src/connector/mollie.rs b/crates/hyperswitch_connectors/src/connectors/mollie.rs
similarity index 64%
rename from crates/router/src/connector/mollie.rs
rename to crates/hyperswitch_connectors/src/connectors/mollie.rs
index cb001ef7c3f..5066fb422fa 100644
--- a/crates/router/src/connector/mollie.rs
+++ b/crates/hyperswitch_connectors/src/connectors/mollie.rs
@@ -2,32 +2,48 @@ pub mod transformers;
use std::fmt::Debug;
-use common_utils::request::RequestContent;
+use common_enums::enums;
+use common_utils::{
+ errors::CustomResult,
+ ext_traits::BytesExt,
+ request::{Method, Request, RequestBuilder, RequestContent},
+};
use error_stack::{report, ResultExt};
-use masking::PeekInterface;
-use transformers as mollie;
-
-use crate::{
- configs::settings,
- consts,
- core::{
- errors::{self, CustomResult},
- payments,
+use hyperswitch_domain_models::{
+ router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData},
+ router_flow_types::{
+ access_token_auth::AccessTokenAuth,
+ payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void},
+ refunds::{Execute, RSync},
+ CompleteAuthorize,
},
- events::connector_api_logs::ConnectorEvent,
- headers,
- services::{
- self,
- request::{self, Mask},
- ConnectorIntegration, ConnectorValidation,
+ router_request_types::{
+ AccessTokenRequestData, CompleteAuthorizeData, PaymentMethodTokenizationData,
+ PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData,
+ PaymentsSyncData, RefundsData, SetupMandateRequestData,
},
+ router_response_types::{PaymentsResponseData, RefundsResponseData},
types::{
- self,
- api::{self, ConnectorCommon, ConnectorCommonExt},
- ErrorResponse, Response,
+ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData,
+ PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, TokenizationRouterData,
},
- utils::BytesExt,
};
+use hyperswitch_interfaces::{
+ api::{
+ self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorRedirectResponse,
+ ConnectorValidation,
+ },
+ configs::Connectors,
+ consts, errors,
+ events::connector_api_logs::ConnectorEvent,
+ types::{self, Response},
+ webhooks,
+};
+use masking::{Mask, PeekInterface};
+use transformers as mollie;
+
+// use self::mollie::{webhook_headers, VoltWebhookBodyEventType};
+use crate::{constants::headers, types::ResponseRouterData};
#[derive(Debug, Clone)]
pub struct Mollie;
@@ -52,9 +68,9 @@ where
{
fn build_headers(
&self,
- req: &types::RouterData<Flow, Request, Response>,
- _connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &RouterData<Flow, Request, Response>,
+ _connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.get_auth_header(&req.connector_auth_type)
}
}
@@ -68,14 +84,14 @@ impl ConnectorCommon for Mollie {
api::CurrencyUnit::Base
}
- fn base_url<'a>(&self, connectors: &'a settings::Connectors) -> &'a str {
+ fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str {
connectors.mollie.base_url.as_ref()
}
fn get_auth_header(
&self,
- auth_type: &types::ConnectorAuthType,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ auth_type: &ConnectorAuthType,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
let auth = mollie::MollieAuthType::try_from(auth_type)
.change_context(errors::ConnectorError::FailedToObtainAuthType)?;
Ok(vec![(
@@ -89,7 +105,7 @@ impl ConnectorCommon for Mollie {
res: Response,
event_builder: Option<&mut ConnectorEvent>,
) -> CustomResult<ErrorResponse, errors::ConnectorError> {
- let response: mollie::ErrorResponse = res
+ let response: mollie::MollieErrorResponse = res
.response
.parse_struct("MollieErrorResponse")
.change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
@@ -112,28 +128,18 @@ impl ConnectorCommon for Mollie {
impl ConnectorValidation for Mollie {}
-impl ConnectorIntegration<api::Session, types::PaymentsSessionData, types::PaymentsResponseData>
- for Mollie
-{
-}
+impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Mollie {}
-impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, types::AccessToken>
- for Mollie
-{
-}
+impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Mollie {}
-impl
- ConnectorIntegration<
- api::PaymentMethodToken,
- types::PaymentMethodTokenizationData,
- types::PaymentsResponseData,
- > for Mollie
+impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>
+ for Mollie
{
fn get_headers(
&self,
- req: &types::TokenizationRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &TokenizationRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.build_headers(req, connectors)
}
@@ -143,8 +149,8 @@ impl
fn get_url(
&self,
- _req: &types::TokenizationRouterData,
- connectors: &settings::Connectors,
+ _req: &TokenizationRouterData,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
let base_url = connectors
.mollie
@@ -156,20 +162,20 @@ impl
fn get_request_body(
&self,
- req: &types::TokenizationRouterData,
- _connectors: &settings::Connectors,
+ req: &TokenizationRouterData,
+ _connectors: &Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
let connector_req = mollie::MollieCardTokenRequest::try_from(req)?;
Ok(RequestContent::Json(Box::new(connector_req)))
}
fn build_request(
&self,
- req: &types::TokenizationRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ req: &TokenizationRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Ok(Some(
- services::RequestBuilder::new()
- .method(services::Method::Post)
+ RequestBuilder::new()
+ .method(Method::Post)
.url(&types::TokenizationType::get_url(self, req, connectors)?)
.attach_default_headers()
.headers(types::TokenizationType::get_headers(self, req, connectors)?)
@@ -182,12 +188,12 @@ impl
fn handle_response(
&self,
- data: &types::TokenizationRouterData,
+ data: &TokenizationRouterData,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::TokenizationRouterData, errors::ConnectorError>
+ ) -> CustomResult<TokenizationRouterData, errors::ConnectorError>
where
- types::PaymentsResponseData: Clone,
+ PaymentsResponseData: Clone,
{
let response: mollie::MollieCardTokenResponse = res
.response
@@ -197,7 +203,7 @@ impl
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -213,22 +219,12 @@ impl
}
}
-impl
- ConnectorIntegration<
- api::SetupMandate,
- types::SetupMandateRequestData,
- types::PaymentsResponseData,
- > for Mollie
-{
+impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Mollie {
fn build_request(
&self,
- _req: &types::RouterData<
- api::SetupMandate,
- types::SetupMandateRequestData,
- types::PaymentsResponseData,
- >,
- _connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ _req: &RouterData<SetupMandate, SetupMandateRequestData, PaymentsResponseData>,
+ _connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Err(
errors::ConnectorError::NotImplemented("Setup Mandate flow for Mollie".to_string())
.into(),
@@ -236,29 +232,27 @@ impl
}
}
-impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::PaymentsResponseData>
- for Mollie
-{
+impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Mollie {
fn get_headers(
&self,
- req: &types::PaymentsAuthorizeRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &PaymentsAuthorizeRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.build_headers(req, connectors)
}
fn get_url(
&self,
- _req: &types::PaymentsAuthorizeRouterData,
- connectors: &settings::Connectors,
+ _req: &PaymentsAuthorizeRouterData,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
Ok(format!("{}payments", self.base_url(connectors)))
}
fn get_request_body(
&self,
- req: &types::PaymentsAuthorizeRouterData,
- _connectors: &settings::Connectors,
+ req: &PaymentsAuthorizeRouterData,
+ _connectors: &Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
let router_obj = mollie::MollieRouterData::try_from((
&self.get_currency_unit(),
@@ -272,12 +266,12 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
fn build_request(
&self,
- req: &types::PaymentsAuthorizeRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ req: &PaymentsAuthorizeRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Ok(Some(
- services::RequestBuilder::new()
- .method(services::Method::Post)
+ RequestBuilder::new()
+ .method(Method::Post)
.url(&types::PaymentsAuthorizeType::get_url(
self, req, connectors,
)?)
@@ -294,10 +288,10 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
fn handle_response(
&self,
- data: &types::PaymentsAuthorizeRouterData,
+ data: &PaymentsAuthorizeRouterData,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::PaymentsAuthorizeRouterData, errors::ConnectorError> {
+ ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> {
let response: mollie::MolliePaymentsResponse = res
.response
.parse_struct("MolliePaymentsResponse")
@@ -306,7 +300,7 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -322,30 +316,24 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
}
}
-impl
- ConnectorIntegration<
- api::CompleteAuthorize,
- types::CompleteAuthorizeData,
- types::PaymentsResponseData,
- > for Mollie
+impl ConnectorIntegration<CompleteAuthorize, CompleteAuthorizeData, PaymentsResponseData>
+ for Mollie
{
}
-impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsResponseData>
- for Mollie
-{
+impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Mollie {
fn get_headers(
&self,
- req: &types::PaymentsSyncRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &PaymentsSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.build_headers(req, connectors)
}
fn get_url(
&self,
- req: &types::PaymentsSyncRouterData,
- connectors: &settings::Connectors,
+ req: &PaymentsSyncRouterData,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
Ok(format!(
"{}payments/{}",
@@ -359,12 +347,12 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
fn build_request(
&self,
- req: &types::PaymentsSyncRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ req: &PaymentsSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Ok(Some(
- services::RequestBuilder::new()
- .method(services::Method::Get)
+ RequestBuilder::new()
+ .method(Method::Get)
.url(&types::PaymentsSyncType::get_url(self, req, connectors)?)
.attach_default_headers()
.headers(types::PaymentsSyncType::get_headers(self, req, connectors)?)
@@ -374,10 +362,10 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
fn handle_response(
&self,
- data: &types::PaymentsSyncRouterData,
+ data: &PaymentsSyncRouterData,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::PaymentsSyncRouterData, errors::ConnectorError> {
+ ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> {
let response: mollie::MolliePaymentsResponse = res
.response
.parse_struct("mollie PaymentsSyncResponse")
@@ -386,7 +374,7 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -402,14 +390,12 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
}
}
-impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::PaymentsResponseData>
- for Mollie
-{
+impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Mollie {
fn build_request(
&self,
- _req: &types::PaymentsCaptureRouterData,
- _connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ _req: &PaymentsCaptureRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Err(errors::ConnectorError::FlowNotSupported {
flow: "Capture".to_string(),
connector: self.id().to_string(),
@@ -418,14 +404,12 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
}
}
-impl ConnectorIntegration<api::Void, types::PaymentsCancelData, types::PaymentsResponseData>
- for Mollie
-{
+impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Mollie {
fn build_request(
&self,
- _req: &types::PaymentsCancelRouterData,
- _connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ _req: &PaymentsCancelRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Err(errors::ConnectorError::FlowNotSupported {
flow: "Void".to_string(),
connector: self.id().to_string(),
@@ -434,12 +418,12 @@ impl ConnectorIntegration<api::Void, types::PaymentsCancelData, types::PaymentsR
}
}
-impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsResponseData> for Mollie {
+impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Mollie {
fn get_headers(
&self,
- req: &types::RefundsRouterData<api::Execute>,
- connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &RefundsRouterData<Execute>,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.build_headers(req, connectors)
}
@@ -449,8 +433,8 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
fn get_url(
&self,
- req: &types::RefundsRouterData<api::Execute>,
- connectors: &settings::Connectors,
+ req: &RefundsRouterData<Execute>,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
Ok(format!(
"{}payments/{}/refunds",
@@ -461,8 +445,8 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
fn get_request_body(
&self,
- req: &types::RefundsRouterData<api::Execute>,
- _connectors: &settings::Connectors,
+ req: &RefundsRouterData<Execute>,
+ _connectors: &Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
let router_obj = mollie::MollieRouterData::try_from((
&self.get_currency_unit(),
@@ -476,11 +460,11 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
fn build_request(
&self,
- req: &types::RefundsRouterData<api::Execute>,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
- let request = services::RequestBuilder::new()
- .method(services::Method::Post)
+ req: &RefundsRouterData<Execute>,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ let request = RequestBuilder::new()
+ .method(Method::Post)
.url(&types::RefundExecuteType::get_url(self, req, connectors)?)
.attach_default_headers()
.headers(types::RefundExecuteType::get_headers(
@@ -495,10 +479,10 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
fn handle_response(
&self,
- data: &types::RefundsRouterData<api::Execute>,
+ data: &RefundsRouterData<Execute>,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::RefundsRouterData<api::Execute>, errors::ConnectorError> {
+ ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> {
let response: mollie::RefundResponse = res
.response
.parse_struct("MollieRefundResponse")
@@ -507,7 +491,7 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -523,12 +507,12 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
}
}
-impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponseData> for Mollie {
+impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Mollie {
fn get_headers(
&self,
- req: &types::RefundSyncRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &RefundSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.build_headers(req, connectors)
}
@@ -538,8 +522,8 @@ impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponse
fn get_url(
&self,
- req: &types::RefundSyncRouterData,
- connectors: &settings::Connectors,
+ req: &RefundSyncRouterData,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
let connector_refund_id = req
.request
@@ -556,12 +540,12 @@ impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponse
fn build_request(
&self,
- req: &types::RefundSyncRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ req: &RefundSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Ok(Some(
- services::RequestBuilder::new()
- .method(services::Method::Get)
+ RequestBuilder::new()
+ .method(Method::Get)
.url(&types::RefundSyncType::get_url(self, req, connectors)?)
.attach_default_headers()
.headers(types::RefundSyncType::get_headers(self, req, connectors)?)
@@ -571,10 +555,10 @@ impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponse
fn handle_response(
&self,
- data: &types::RefundSyncRouterData,
+ data: &RefundSyncRouterData,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::RefundSyncRouterData, errors::ConnectorError> {
+ ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> {
let response: mollie::RefundResponse = res
.response
.parse_struct("MollieRefundSyncResponse")
@@ -583,7 +567,7 @@ impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponse
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -600,41 +584,41 @@ impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponse
}
#[async_trait::async_trait]
-impl api::IncomingWebhook for Mollie {
+impl webhooks::IncomingWebhook for Mollie {
fn get_webhook_object_reference_id(
&self,
- _request: &api::IncomingWebhookRequestDetails<'_>,
+ _request: &webhooks::IncomingWebhookRequestDetails<'_>,
) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> {
Err(report!(errors::ConnectorError::WebhooksNotImplemented))
}
fn get_webhook_event_type(
&self,
- _request: &api::IncomingWebhookRequestDetails<'_>,
- ) -> CustomResult<api::IncomingWebhookEvent, errors::ConnectorError> {
- Ok(api::IncomingWebhookEvent::EventNotSupported)
+ _request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> {
+ Ok(api_models::webhooks::IncomingWebhookEvent::EventNotSupported)
}
fn get_webhook_resource_object(
&self,
- _request: &api::IncomingWebhookRequestDetails<'_>,
+ _request: &webhooks::IncomingWebhookRequestDetails<'_>,
) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> {
Err(report!(errors::ConnectorError::WebhooksNotImplemented))
}
}
-impl services::ConnectorRedirectResponse for Mollie {
+impl ConnectorRedirectResponse for Mollie {
fn get_flow_type(
&self,
_query_params: &str,
_json_payload: Option<serde_json::Value>,
- action: services::PaymentAction,
- ) -> CustomResult<payments::CallConnectorAction, errors::ConnectorError> {
+ action: enums::PaymentAction,
+ ) -> CustomResult<enums::CallConnectorAction, errors::ConnectorError> {
match action {
- services::PaymentAction::PSync
- | services::PaymentAction::CompleteAuthorize
- | services::PaymentAction::PaymentAuthenticateCompleteAuthorize => {
- Ok(payments::CallConnectorAction::Trigger)
+ enums::PaymentAction::PSync
+ | enums::PaymentAction::CompleteAuthorize
+ | enums::PaymentAction::PaymentAuthenticateCompleteAuthorize => {
+ Ok(enums::CallConnectorAction::Trigger)
}
}
}
diff --git a/crates/router/src/connector/mollie/transformers.rs b/crates/hyperswitch_connectors/src/connectors/mollie/transformers.rs
similarity index 79%
rename from crates/router/src/connector/mollie/transformers.rs
rename to crates/hyperswitch_connectors/src/connectors/mollie/transformers.rs
index f755ca6029b..d0525921632 100644
--- a/crates/router/src/connector/mollie/transformers.rs
+++ b/crates/hyperswitch_connectors/src/connectors/mollie/transformers.rs
@@ -1,20 +1,25 @@
-use api_models::payments;
use cards::CardNumber;
-use common_utils::pii::Email;
-use diesel_models::enums;
+use common_enums::enums;
+use common_utils::{pii::Email, request::Method};
+use hyperswitch_domain_models::{
+ payment_method_data::{BankDebitData, BankRedirectData, PaymentMethodData, WalletData},
+ router_data::{ConnectorAuthType, PaymentMethodToken, RouterData},
+ router_request_types::ResponseId,
+ router_response_types::{PaymentsResponseData, RedirectForm, RefundsResponseData},
+ types,
+};
+use hyperswitch_interfaces::{api, errors};
use masking::{ExposeInterface, Secret};
use serde::{Deserialize, Serialize};
use url::Url;
use crate::{
- connector::utils::{
- self, AddressDetailsData, BrowserInformationData, CardData,
- PaymentMethodTokenizationRequestData, PaymentsAuthorizeRequestData, RouterData,
- },
- core::errors,
- services, types,
- types::{domain, storage::enums as storage_enums},
+ types::{RefundsResponseRouterData, ResponseRouterData},
unimplemented_payment_method,
+ utils::{
+ self, AddressDetailsData, BrowserInformationData, CardData as CardDataUtil,
+ PaymentMethodTokenizationRequestData, PaymentsAuthorizeRequestData, RouterData as _,
+ },
};
type Error = error_stack::Report<errors::ConnectorError>;
@@ -25,20 +30,13 @@ pub struct MollieRouterData<T> {
pub router_data: T,
}
-impl<T>
- TryFrom<(
- &types::api::CurrencyUnit,
- types::storage::enums::Currency,
- i64,
- T,
- )> for MollieRouterData<T>
-{
+impl<T> TryFrom<(&api::CurrencyUnit, enums::Currency, i64, T)> for MollieRouterData<T> {
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(
(currency_unit, currency, amount, router_data): (
- &types::api::CurrencyUnit,
- types::storage::enums::Currency,
+ &api::CurrencyUnit,
+ enums::Currency,
i64,
T,
),
@@ -61,7 +59,7 @@ pub struct MolliePaymentsRequest {
webhook_url: String,
locale: Option<String>,
#[serde(flatten)]
- payment_method_data: PaymentMethodData,
+ payment_method_data: MolliePaymentMethodData,
metadata: Option<MollieMetadata>,
sequence_type: SequenceType,
mandate_id: Option<Secret<String>>,
@@ -76,7 +74,7 @@ pub struct Amount {
#[derive(Debug, Serialize)]
#[serde(tag = "method")]
#[serde(rename_all = "lowercase")]
-pub enum PaymentMethodData {
+pub enum MolliePaymentMethodData {
Applepay(Box<ApplePayMethodData>),
Eps,
Giropay,
@@ -169,15 +167,15 @@ impl TryFrom<&MollieRouterData<&types::PaymentsAuthorizeRouterData>> for MollieP
{
enums::CaptureMethod::Automatic => {
match &item.router_data.request.payment_method_data {
- domain::PaymentMethodData::Card(_) => {
+ PaymentMethodData::Card(_) => {
let pm_token = item.router_data.get_payment_method_token()?;
- Ok(PaymentMethodData::CreditCard(Box::new(
+ Ok(MolliePaymentMethodData::CreditCard(Box::new(
CreditCardMethodData {
billing_address: get_billing_details(item.router_data)?,
shipping_address: get_shipping_details(item.router_data)?,
card_token: Some(match pm_token {
- types::PaymentMethodToken::Token(token) => token,
- types::PaymentMethodToken::ApplePayDecrypt(_) => {
+ PaymentMethodToken::Token(token) => token,
+ PaymentMethodToken::ApplePayDecrypt(_) => {
Err(unimplemented_payment_method!(
"Apple Pay",
"Simplified",
@@ -188,14 +186,14 @@ impl TryFrom<&MollieRouterData<&types::PaymentsAuthorizeRouterData>> for MollieP
},
)))
}
- domain::PaymentMethodData::BankRedirect(ref redirect_data) => {
- PaymentMethodData::try_from((item.router_data, redirect_data))
+ PaymentMethodData::BankRedirect(ref redirect_data) => {
+ MolliePaymentMethodData::try_from((item.router_data, redirect_data))
}
- domain::PaymentMethodData::Wallet(ref wallet_data) => {
+ PaymentMethodData::Wallet(ref wallet_data) => {
get_payment_method_for_wallet(item.router_data, wallet_data)
}
- domain::PaymentMethodData::BankDebit(ref directdebit_data) => {
- PaymentMethodData::try_from((directdebit_data, item.router_data))
+ PaymentMethodData::BankDebit(ref directdebit_data) => {
+ MolliePaymentMethodData::try_from((directdebit_data, item.router_data))
}
_ => Err(
errors::ConnectorError::NotImplemented("Payment Method".to_string()).into(),
@@ -230,47 +228,39 @@ impl TryFrom<&MollieRouterData<&types::PaymentsAuthorizeRouterData>> for MollieP
}
}
-impl
- TryFrom<(
- &types::PaymentsAuthorizeRouterData,
- &domain::BankRedirectData,
- )> for PaymentMethodData
-{
+impl TryFrom<(&types::PaymentsAuthorizeRouterData, &BankRedirectData)> for MolliePaymentMethodData {
type Error = Error;
fn try_from(
- (item, value): (
- &types::PaymentsAuthorizeRouterData,
- &domain::BankRedirectData,
- ),
+ (item, value): (&types::PaymentsAuthorizeRouterData, &BankRedirectData),
) -> Result<Self, Self::Error> {
match value {
- domain::BankRedirectData::Eps { .. } => Ok(Self::Eps),
- domain::BankRedirectData::Giropay { .. } => Ok(Self::Giropay),
- domain::BankRedirectData::Ideal { .. } => {
+ BankRedirectData::Eps { .. } => Ok(Self::Eps),
+ BankRedirectData::Giropay { .. } => Ok(Self::Giropay),
+ BankRedirectData::Ideal { .. } => {
Ok(Self::Ideal(Box::new(IdealMethodData {
// To do if possible this should be from the payment request
issuer: None,
})))
}
- domain::BankRedirectData::Sofort { .. } => Ok(Self::Sofort),
- domain::BankRedirectData::Przelewy24 { .. } => {
+ BankRedirectData::Sofort { .. } => Ok(Self::Sofort),
+ BankRedirectData::Przelewy24 { .. } => {
Ok(Self::Przelewy24(Box::new(Przelewy24MethodData {
billing_email: item.get_optional_billing_email(),
})))
}
- domain::BankRedirectData::BancontactCard { .. } => Ok(Self::Bancontact),
+ BankRedirectData::BancontactCard { .. } => Ok(Self::Bancontact),
_ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()),
}
}
}
-impl TryFrom<(&domain::BankDebitData, &types::PaymentsAuthorizeRouterData)> for PaymentMethodData {
+impl TryFrom<(&BankDebitData, &types::PaymentsAuthorizeRouterData)> for MolliePaymentMethodData {
type Error = Error;
fn try_from(
- (bank_debit_data, item): (&domain::BankDebitData, &types::PaymentsAuthorizeRouterData),
+ (bank_debit_data, item): (&BankDebitData, &types::PaymentsAuthorizeRouterData),
) -> Result<Self, Self::Error> {
match bank_debit_data {
- domain::BankDebitData::SepaBankDebit { iban, .. } => {
+ BankDebitData::SepaBankDebit { iban, .. } => {
Ok(Self::DirectDebit(Box::new(DirectDebitMethodData {
consumer_name: item.get_optional_billing_full_name(),
consumer_account: iban.clone(),
@@ -297,7 +287,7 @@ impl TryFrom<&types::TokenizationRouterData> for MollieCardTokenRequest {
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(item: &types::TokenizationRouterData) -> Result<Self, Self::Error> {
match item.request.payment_method_data.clone() {
- domain::PaymentMethodData::Card(ccard) => {
+ PaymentMethodData::Card(ccard) => {
let auth = MollieAuthType::try_from(&item.connector_auth_type)?;
let card_holder = item
.get_optional_billing_full_name()
@@ -334,20 +324,20 @@ impl TryFrom<&types::TokenizationRouterData> for MollieCardTokenRequest {
fn get_payment_method_for_wallet(
item: &types::PaymentsAuthorizeRouterData,
- wallet_data: &domain::WalletData,
-) -> Result<PaymentMethodData, Error> {
+ wallet_data: &WalletData,
+) -> Result<MolliePaymentMethodData, Error> {
match wallet_data {
- domain::WalletData::PaypalRedirect { .. } => {
- Ok(PaymentMethodData::Paypal(Box::new(PaypalMethodData {
+ WalletData::PaypalRedirect { .. } => Ok(MolliePaymentMethodData::Paypal(Box::new(
+ PaypalMethodData {
billing_address: get_billing_details(item)?,
shipping_address: get_shipping_details(item)?,
- })))
- }
- domain::WalletData::ApplePay(applepay_wallet_data) => {
- Ok(PaymentMethodData::Applepay(Box::new(ApplePayMethodData {
+ },
+ ))),
+ WalletData::ApplePay(applepay_wallet_data) => Ok(MolliePaymentMethodData::Applepay(
+ Box::new(ApplePayMethodData {
apple_pay_payment_token: Secret::new(applepay_wallet_data.payment_data.to_owned()),
- })))
- }
+ }),
+ )),
_ => Err(errors::ConnectorError::NotImplemented("Payment Method".to_string()).into()),
}
}
@@ -371,7 +361,7 @@ fn get_billing_details(
}
fn get_address_details(
- address: Option<&payments::AddressDetails>,
+ address: Option<&api_models::payments::AddressDetails>,
) -> Result<Option<Address>, Error> {
let address_details = match address {
Some(address) => {
@@ -467,15 +457,15 @@ pub struct MollieAuthType {
pub(super) profile_token: Option<Secret<String>>,
}
-impl TryFrom<&types::ConnectorAuthType> for MollieAuthType {
+impl TryFrom<&ConnectorAuthType> for MollieAuthType {
type Error = Error;
- fn try_from(auth_type: &types::ConnectorAuthType) -> Result<Self, Self::Error> {
+ fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> {
match auth_type {
- types::ConnectorAuthType::HeaderKey { api_key } => Ok(Self {
+ ConnectorAuthType::HeaderKey { api_key } => Ok(Self {
api_key: api_key.to_owned(),
profile_token: None,
}),
- types::ConnectorAuthType::BodyKey { api_key, key1 } => Ok(Self {
+ ConnectorAuthType::BodyKey { api_key, key1 } => Ok(Self {
api_key: api_key.to_owned(),
profile_token: Some(key1.to_owned()),
}),
@@ -490,20 +480,17 @@ pub struct MollieCardTokenResponse {
card_token: Secret<String>,
}
-impl<F, T>
- TryFrom<types::ResponseRouterData<F, MollieCardTokenResponse, T, types::PaymentsResponseData>>
- for types::RouterData<F, T, types::PaymentsResponseData>
+impl<F, T> TryFrom<ResponseRouterData<F, MollieCardTokenResponse, T, PaymentsResponseData>>
+ for RouterData<F, T, PaymentsResponseData>
{
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(
- item: types::ResponseRouterData<F, MollieCardTokenResponse, T, types::PaymentsResponseData>,
+ item: ResponseRouterData<F, MollieCardTokenResponse, T, PaymentsResponseData>,
) -> Result<Self, Self::Error> {
Ok(Self {
- status: storage_enums::AttemptStatus::Pending,
- payment_method_token: Some(types::PaymentMethodToken::Token(
- item.response.card_token.clone(),
- )),
- response: Ok(types::PaymentsResponseData::TokenizationResponse {
+ status: enums::AttemptStatus::Pending,
+ payment_method_token: Some(PaymentMethodToken::Token(item.response.card_token.clone())),
+ response: Ok(PaymentsResponseData::TokenizationResponse {
token: item.response.card_token.expose(),
}),
..item.data
@@ -511,23 +498,22 @@ impl<F, T>
}
}
-impl<F, T>
- TryFrom<types::ResponseRouterData<F, MolliePaymentsResponse, T, types::PaymentsResponseData>>
- for types::RouterData<F, T, types::PaymentsResponseData>
+impl<F, T> TryFrom<ResponseRouterData<F, MolliePaymentsResponse, T, PaymentsResponseData>>
+ for RouterData<F, T, PaymentsResponseData>
{
type Error = Error;
fn try_from(
- item: types::ResponseRouterData<F, MolliePaymentsResponse, T, types::PaymentsResponseData>,
+ item: ResponseRouterData<F, MolliePaymentsResponse, T, PaymentsResponseData>,
) -> Result<Self, Self::Error> {
let url = item
.response
.links
.checkout
- .map(|link| services::RedirectForm::from((link.href, services::Method::Get)));
+ .map(|link| RedirectForm::from((link.href, Method::Get)));
Ok(Self {
status: enums::AttemptStatus::from(item.response.status),
- response: Ok(types::PaymentsResponseData::TransactionResponse {
- resource_id: types::ResponseId::ConnectorTransactionId(item.response.id.clone()),
+ response: Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(item.response.id.clone()),
redirection_data: url,
mandate_reference: None,
connector_metadata: None,
@@ -608,15 +594,11 @@ impl From<MollieRefundStatus> for enums::RefundStatus {
}
}
-impl<T> TryFrom<types::RefundsResponseRouterData<T, RefundResponse>>
- for types::RefundsRouterData<T>
-{
+impl<T> TryFrom<RefundsResponseRouterData<T, RefundResponse>> for types::RefundsRouterData<T> {
type Error = Error;
- fn try_from(
- item: types::RefundsResponseRouterData<T, RefundResponse>,
- ) -> Result<Self, Self::Error> {
+ fn try_from(item: RefundsResponseRouterData<T, RefundResponse>) -> Result<Self, Self::Error> {
Ok(Self {
- response: Ok(types::RefundsResponseData {
+ response: Ok(RefundsResponseData {
connector_refund_id: item.response.id,
refund_status: enums::RefundStatus::from(item.response.status),
}),
@@ -626,7 +608,7 @@ impl<T> TryFrom<types::RefundsResponseRouterData<T, RefundResponse>>
}
#[derive(Debug, Deserialize, Serialize)]
-pub struct ErrorResponse {
+pub struct MollieErrorResponse {
pub status: u16,
pub title: Option<String>,
pub detail: String,
diff --git a/crates/router/src/connector/volt.rs b/crates/hyperswitch_connectors/src/connectors/volt.rs
similarity index 69%
rename from crates/router/src/connector/volt.rs
rename to crates/hyperswitch_connectors/src/connectors/volt.rs
index 202dcba7ed1..e9024897014 100644
--- a/crates/router/src/connector/volt.rs
+++ b/crates/hyperswitch_connectors/src/connectors/volt.rs
@@ -1,36 +1,48 @@
pub mod transformers;
+use api_models::webhooks::IncomingWebhookEvent;
use common_utils::{
crypto,
+ errors::CustomResult,
ext_traits::ByteSliceExt,
- request::RequestContent,
+ request::{Method, Request, RequestBuilder, RequestContent},
types::{AmountConvertor, MinorUnit, MinorUnitForConnector},
};
use error_stack::ResultExt;
-use masking::{ExposeInterface, PeekInterface};
-use transformers as volt;
-
-use self::transformers::webhook_headers;
-use super::{
- utils,
- utils::{self as connector_utils},
-};
-use crate::{
- configs::settings,
- core::errors::{self, CustomResult},
- events::connector_api_logs::ConnectorEvent,
- headers,
- services::{
- self,
- request::{self, Mask},
- ConnectorIntegration, ConnectorValidation,
+use hyperswitch_domain_models::{
+ router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData},
+ router_flow_types::{
+ access_token_auth::AccessTokenAuth,
+ payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void},
+ refunds::{Execute, RSync},
},
+ router_request_types::{
+ AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData,
+ PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData,
+ RefundsData, SetupMandateRequestData,
+ },
+ router_response_types::{PaymentsResponseData, RefundsResponseData},
types::{
- self,
- api::{self, ConnectorCommon, ConnectorCommonExt},
- ErrorResponse, Response,
+ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData,
+ RefreshTokenRouterData, RefundsRouterData,
},
- utils::BytesExt,
+};
+use hyperswitch_interfaces::{
+ api::{self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorValidation},
+ configs::Connectors,
+ errors,
+ events::connector_api_logs::ConnectorEvent,
+ types::{self, PaymentsAuthorizeType, RefreshTokenType, Response},
+ webhooks,
+};
+use masking::{ExposeInterface, Mask, PeekInterface};
+use transformers as volt;
+
+use self::volt::{webhook_headers, VoltWebhookBodyEventType};
+use crate::{
+ constants::headers,
+ types::ResponseRouterData,
+ utils::{self},
};
#[derive(Clone)]
@@ -59,12 +71,8 @@ impl api::RefundExecute for Volt {}
impl api::RefundSync for Volt {}
impl api::PaymentToken for Volt {}
-impl
- ConnectorIntegration<
- api::PaymentMethodToken,
- types::PaymentMethodTokenizationData,
- types::PaymentsResponseData,
- > for Volt
+impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>
+ for Volt
{
// Not Implemented (R)
}
@@ -75,12 +83,12 @@ where
{
fn build_headers(
&self,
- req: &types::RouterData<Flow, Request, Response>,
- _connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &RouterData<Flow, Request, Response>,
+ _connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
let mut header = vec![(
headers::CONTENT_TYPE.to_string(),
- types::PaymentsAuthorizeType::get_content_type(self)
+ PaymentsAuthorizeType::get_content_type(self)
.to_string()
.into(),
)];
@@ -110,14 +118,14 @@ impl ConnectorCommon for Volt {
"application/json"
}
- fn base_url<'a>(&self, connectors: &'a settings::Connectors) -> &'a str {
+ fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str {
connectors.volt.base_url.as_ref()
}
fn get_auth_header(
&self,
- auth_type: &types::ConnectorAuthType,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ auth_type: &ConnectorAuthType,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
let auth = volt::VoltAuthType::try_from(auth_type)
.change_context(errors::ConnectorError::FailedToObtainAuthType)?;
Ok(vec![(
@@ -163,19 +171,15 @@ impl ConnectorValidation for Volt {
//TODO: implement functions when support enabled
}
-impl ConnectorIntegration<api::Session, types::PaymentsSessionData, types::PaymentsResponseData>
- for Volt
-{
+impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Volt {
//TODO: implement sessions flow
}
-impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, types::AccessToken>
- for Volt
-{
+impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Volt {
fn get_url(
&self,
- _req: &types::RefreshTokenRouterData,
- connectors: &settings::Connectors,
+ _req: &RefreshTokenRouterData,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
Ok(format!("{}oauth", self.base_url(connectors)))
}
@@ -185,21 +189,19 @@ impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, t
}
fn get_headers(
&self,
- _req: &types::RefreshTokenRouterData,
- _connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ _req: &RefreshTokenRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
Ok(vec![(
headers::CONTENT_TYPE.to_string(),
- types::RefreshTokenType::get_content_type(self)
- .to_string()
- .into(),
+ RefreshTokenType::get_content_type(self).to_string().into(),
)])
}
fn get_request_body(
&self,
- req: &types::RefreshTokenRouterData,
- _connectors: &settings::Connectors,
+ req: &RefreshTokenRouterData,
+ _connectors: &Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
let connector_req = volt::VoltAuthUpdateRequest::try_from(req)?;
@@ -208,18 +210,16 @@ impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, t
fn build_request(
&self,
- req: &types::RefreshTokenRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ req: &RefreshTokenRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
let req = Some(
- services::RequestBuilder::new()
- .method(services::Method::Post)
+ RequestBuilder::new()
+ .method(Method::Post)
.attach_default_headers()
- .headers(types::RefreshTokenType::get_headers(self, req, connectors)?)
- .url(&types::RefreshTokenType::get_url(self, req, connectors)?)
- .set_body(types::RefreshTokenType::get_request_body(
- self, req, connectors,
- )?)
+ .headers(RefreshTokenType::get_headers(self, req, connectors)?)
+ .url(&RefreshTokenType::get_url(self, req, connectors)?)
+ .set_body(RefreshTokenType::get_request_body(self, req, connectors)?)
.build(),
);
Ok(req)
@@ -227,10 +227,10 @@ impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, t
fn handle_response(
&self,
- data: &types::RefreshTokenRouterData,
+ data: &RefreshTokenRouterData,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::RefreshTokenRouterData, errors::ConnectorError> {
+ ) -> CustomResult<RefreshTokenRouterData, errors::ConnectorError> {
let response: volt::VoltAuthUpdateResponse = res
.response
.parse_struct("Volt VoltAuthUpdateResponse")
@@ -239,7 +239,7 @@ impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, t
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -271,22 +271,12 @@ impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, t
}
}
-impl
- ConnectorIntegration<
- api::SetupMandate,
- types::SetupMandateRequestData,
- types::PaymentsResponseData,
- > for Volt
-{
+impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Volt {
fn build_request(
&self,
- _req: &types::RouterData<
- api::SetupMandate,
- types::SetupMandateRequestData,
- types::PaymentsResponseData,
- >,
- _connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ _req: &RouterData<SetupMandate, SetupMandateRequestData, PaymentsResponseData>,
+ _connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Err(
errors::ConnectorError::NotImplemented("Setup Mandate flow for Volt".to_string())
.into(),
@@ -294,14 +284,12 @@ impl
}
}
-impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::PaymentsResponseData>
- for Volt
-{
+impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Volt {
fn get_headers(
&self,
- req: &types::PaymentsAuthorizeRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &PaymentsAuthorizeRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.build_headers(req, connectors)
}
@@ -311,18 +299,18 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
fn get_url(
&self,
- _req: &types::PaymentsAuthorizeRouterData,
- connectors: &settings::Connectors,
+ _req: &PaymentsAuthorizeRouterData,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
Ok(format!("{}v2/payments", self.base_url(connectors)))
}
fn get_request_body(
&self,
- req: &types::PaymentsAuthorizeRouterData,
- _connectors: &settings::Connectors,
+ req: &PaymentsAuthorizeRouterData,
+ _connectors: &Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
- let amount = connector_utils::convert_amount(
+ let amount = utils::convert_amount(
self.amount_converter,
req.request.minor_amount,
req.request.currency,
@@ -334,20 +322,16 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
fn build_request(
&self,
- req: &types::PaymentsAuthorizeRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ req: &PaymentsAuthorizeRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Ok(Some(
- services::RequestBuilder::new()
- .method(services::Method::Post)
- .url(&types::PaymentsAuthorizeType::get_url(
- self, req, connectors,
- )?)
+ RequestBuilder::new()
+ .method(Method::Post)
+ .url(&PaymentsAuthorizeType::get_url(self, req, connectors)?)
.attach_default_headers()
- .headers(types::PaymentsAuthorizeType::get_headers(
- self, req, connectors,
- )?)
- .set_body(types::PaymentsAuthorizeType::get_request_body(
+ .headers(PaymentsAuthorizeType::get_headers(self, req, connectors)?)
+ .set_body(PaymentsAuthorizeType::get_request_body(
self, req, connectors,
)?)
.build(),
@@ -356,10 +340,10 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
fn handle_response(
&self,
- data: &types::PaymentsAuthorizeRouterData,
+ data: &PaymentsAuthorizeRouterData,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::PaymentsAuthorizeRouterData, errors::ConnectorError> {
+ ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> {
let response: volt::VoltPaymentsResponse = res
.response
.parse_struct("Volt PaymentsAuthorizeResponse")
@@ -368,7 +352,7 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -384,14 +368,12 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
}
}
-impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsResponseData>
- for Volt
-{
+impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Volt {
fn get_headers(
&self,
- req: &types::PaymentsSyncRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &PaymentsSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.build_headers(req, connectors)
}
@@ -401,8 +383,8 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
fn get_url(
&self,
- req: &types::PaymentsSyncRouterData,
- connectors: &settings::Connectors,
+ req: &PaymentsSyncRouterData,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
let connector_payment_id = req
.request
@@ -417,12 +399,12 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
fn build_request(
&self,
- req: &types::PaymentsSyncRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ req: &PaymentsSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Ok(Some(
- services::RequestBuilder::new()
- .method(services::Method::Get)
+ RequestBuilder::new()
+ .method(Method::Get)
.url(&types::PaymentsSyncType::get_url(self, req, connectors)?)
.attach_default_headers()
.headers(types::PaymentsSyncType::get_headers(self, req, connectors)?)
@@ -432,10 +414,10 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
fn handle_response(
&self,
- data: &types::PaymentsSyncRouterData,
+ data: &PaymentsSyncRouterData,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::PaymentsSyncRouterData, errors::ConnectorError> {
+ ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> {
let response: volt::VoltPaymentsResponseData = res
.response
.parse_struct("volt PaymentsSyncResponse")
@@ -444,7 +426,7 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -460,14 +442,12 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
}
}
-impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::PaymentsResponseData>
- for Volt
-{
+impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Volt {
fn get_headers(
&self,
- req: &types::PaymentsCaptureRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &PaymentsCaptureRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.build_headers(req, connectors)
}
@@ -477,28 +457,28 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
fn get_url(
&self,
- _req: &types::PaymentsCaptureRouterData,
- _connectors: &settings::Connectors,
+ _req: &PaymentsCaptureRouterData,
+ _connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
}
fn get_request_body(
&self,
- _req: &types::PaymentsCaptureRouterData,
- _connectors: &settings::Connectors,
+ _req: &PaymentsCaptureRouterData,
+ _connectors: &Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into())
}
fn build_request(
&self,
- req: &types::PaymentsCaptureRouterData,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ req: &PaymentsCaptureRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
Ok(Some(
- services::RequestBuilder::new()
- .method(services::Method::Post)
+ RequestBuilder::new()
+ .method(Method::Post)
.url(&types::PaymentsCaptureType::get_url(self, req, connectors)?)
.attach_default_headers()
.headers(types::PaymentsCaptureType::get_headers(
@@ -513,10 +493,10 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
fn handle_response(
&self,
- data: &types::PaymentsCaptureRouterData,
+ data: &PaymentsCaptureRouterData,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::PaymentsCaptureRouterData, errors::ConnectorError> {
+ ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> {
let response: volt::VoltPaymentsResponse = res
.response
.parse_struct("Volt PaymentsCaptureResponse")
@@ -525,7 +505,7 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -541,17 +521,14 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
}
}
-impl ConnectorIntegration<api::Void, types::PaymentsCancelData, types::PaymentsResponseData>
- for Volt
-{
-}
+impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Volt {}
-impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsResponseData> for Volt {
+impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Volt {
fn get_headers(
&self,
- req: &types::RefundsRouterData<api::Execute>,
- connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
+ req: &RefundsRouterData<Execute>,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
self.build_headers(req, connectors)
}
@@ -561,8 +538,8 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
fn get_url(
&self,
- req: &types::RefundsRouterData<api::Execute>,
- connectors: &settings::Connectors,
+ req: &RefundsRouterData<Execute>,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
let connector_payment_id = req.request.connector_transaction_id.clone();
Ok(format!(
@@ -573,10 +550,10 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
fn get_request_body(
&self,
- req: &types::RefundsRouterData<api::Execute>,
- _connectors: &settings::Connectors,
+ req: &RefundsRouterData<Execute>,
+ _connectors: &Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
- let amount = connector_utils::convert_amount(
+ let amount = utils::convert_amount(
self.amount_converter,
req.request.minor_refund_amount,
req.request.currency,
@@ -588,11 +565,11 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
fn build_request(
&self,
- req: &types::RefundsRouterData<api::Execute>,
- connectors: &settings::Connectors,
- ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
- let request = services::RequestBuilder::new()
- .method(services::Method::Post)
+ req: &RefundsRouterData<Execute>,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ let request = RequestBuilder::new()
+ .method(Method::Post)
.url(&types::RefundExecuteType::get_url(self, req, connectors)?)
.attach_default_headers()
.headers(types::RefundExecuteType::get_headers(
@@ -607,10 +584,10 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
fn handle_response(
&self,
- data: &types::RefundsRouterData<api::Execute>,
+ data: &RefundsRouterData<Execute>,
event_builder: Option<&mut ConnectorEvent>,
res: Response,
- ) -> CustomResult<types::RefundsRouterData<api::Execute>, errors::ConnectorError> {
+ ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> {
let response: volt::RefundResponse = res
.response
.parse_struct("volt RefundResponse")
@@ -619,7 +596,7 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
event_builder.map(|i| i.set_response_body(&response));
router_env::logger::info!(connector_response=?response);
- types::RouterData::try_from(types::ResponseRouterData {
+ RouterData::try_from(ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
@@ -635,22 +612,22 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
}
}
-impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponseData> for Volt {
+impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Volt {
//Volt does not support Refund Sync
}
#[async_trait::async_trait]
-impl api::IncomingWebhook for Volt {
+impl webhooks::IncomingWebhook for Volt {
fn get_webhook_source_verification_algorithm(
&self,
- _request: &api::IncomingWebhookRequestDetails<'_>,
+ _request: &webhooks::IncomingWebhookRequestDetails<'_>,
) -> CustomResult<Box<dyn crypto::VerifySignature + Send>, errors::ConnectorError> {
Ok(Box::new(crypto::HmacSha256))
}
fn get_webhook_source_verification_signature(
&self,
- request: &api::IncomingWebhookRequestDetails<'_>,
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
_connector_webhook_secrets: &api_models::webhooks::ConnectorWebhookSecrets,
) -> CustomResult<Vec<u8>, errors::ConnectorError> {
let signature =
@@ -663,7 +640,7 @@ impl api::IncomingWebhook for Volt {
fn get_webhook_source_verification_message(
&self,
- request: &api::IncomingWebhookRequestDetails<'_>,
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
_merchant_id: &common_utils::id_type::MerchantId,
_connector_webhook_secrets: &api_models::webhooks::ConnectorWebhookSecrets,
) -> CustomResult<Vec<u8>, errors::ConnectorError> {
@@ -685,8 +662,8 @@ impl api::IncomingWebhook for Volt {
fn get_webhook_object_reference_id(
&self,
- request: &api::IncomingWebhookRequestDetails<'_>,
- ) -> CustomResult<api::webhooks::ObjectReferenceId, errors::ConnectorError> {
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> {
let parsed_webhook_response = request
.body
.parse_struct::<volt::WebhookResponse>("VoltRefundWebhookBodyReference")
@@ -726,22 +703,22 @@ impl api::IncomingWebhook for Volt {
fn get_webhook_event_type(
&self,
- request: &api::IncomingWebhookRequestDetails<'_>,
- ) -> CustomResult<api::IncomingWebhookEvent, errors::ConnectorError> {
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<IncomingWebhookEvent, errors::ConnectorError> {
if request.body.is_empty() {
- Ok(api::IncomingWebhookEvent::EndpointVerification)
+ Ok(IncomingWebhookEvent::EndpointVerification)
} else {
- let payload: volt::VoltWebhookBodyEventType = request
+ let payload: VoltWebhookBodyEventType = request
.body
.parse_struct("VoltWebhookBodyEventType")
.change_context(errors::ConnectorError::WebhookEventTypeNotFound)?;
- Ok(api::IncomingWebhookEvent::from(payload))
+ Ok(IncomingWebhookEvent::from(payload))
}
}
fn get_webhook_resource_object(
&self,
- request: &api::IncomingWebhookRequestDetails<'_>,
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> {
let details: volt::VoltWebhookObjectResource = request
.body
diff --git a/crates/router/src/connector/volt/transformers.rs b/crates/hyperswitch_connectors/src/connectors/volt/transformers.rs
similarity index 79%
rename from crates/router/src/connector/volt/transformers.rs
rename to crates/hyperswitch_connectors/src/connectors/volt/transformers.rs
index 451c70279cc..1093ef4e6f0 100644
--- a/crates/router/src/connector/volt/transformers.rs
+++ b/crates/hyperswitch_connectors/src/connectors/volt/transformers.rs
@@ -1,14 +1,20 @@
-use common_utils::{id_type, pii::Email, types::MinorUnit};
-use diesel_models::enums;
+use common_enums::enums;
+use common_utils::{id_type, pii::Email, request::Method, types::MinorUnit};
+use hyperswitch_domain_models::{
+ payment_method_data::{BankRedirectData, PaymentMethodData},
+ router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData},
+ router_flow_types::refunds::Execute,
+ router_request_types::ResponseId,
+ router_response_types::{PaymentsResponseData, RedirectForm, RefundsResponseData},
+ types,
+};
+use hyperswitch_interfaces::{consts, errors};
use masking::Secret;
use serde::{Deserialize, Serialize};
use crate::{
- connector::utils::{self, AddressDetailsData, RouterData},
- consts,
- core::errors,
- services,
- types::{self, api, domain, storage::enums as storage_enums},
+ types::{RefreshTokenRouterData, RefundsResponseRouterData, ResponseRouterData},
+ utils::{self, AddressDetailsData, RouterData as _},
};
const PASSWORD: &str = "password";
@@ -37,7 +43,7 @@ pub mod webhook_headers {
#[serde(rename_all = "camelCase")]
pub struct VoltPaymentsRequest {
amount: MinorUnit,
- currency_code: storage_enums::Currency,
+ currency_code: enums::Currency,
#[serde(rename = "type")]
transaction_type: TransactionType,
merchant_internal_reference: String,
@@ -72,8 +78,8 @@ impl TryFrom<&VoltRouterData<&types::PaymentsAuthorizeRouterData>> for VoltPayme
item: &VoltRouterData<&types::PaymentsAuthorizeRouterData>,
) -> Result<Self, Self::Error> {
match item.router_data.request.payment_method_data.clone() {
- domain::PaymentMethodData::BankRedirect(ref bank_redirect) => match bank_redirect {
- domain::BankRedirectData::OpenBankingUk { .. } => {
+ PaymentMethodData::BankRedirect(ref bank_redirect) => match bank_redirect {
+ BankRedirectData::OpenBankingUk { .. } => {
let amount = item.amount;
let currency_code = item.router_data.request.currency;
let merchant_internal_reference =
@@ -104,50 +110,48 @@ impl TryFrom<&VoltRouterData<&types::PaymentsAuthorizeRouterData>> for VoltPayme
transaction_type,
})
}
- domain::BankRedirectData::BancontactCard { .. }
- | domain::BankRedirectData::Bizum {}
- | domain::BankRedirectData::Blik { .. }
- | domain::BankRedirectData::Eps { .. }
- | domain::BankRedirectData::Giropay { .. }
- | domain::BankRedirectData::Ideal { .. }
- | domain::BankRedirectData::Interac { .. }
- | domain::BankRedirectData::OnlineBankingCzechRepublic { .. }
- | domain::BankRedirectData::OnlineBankingFinland { .. }
- | domain::BankRedirectData::OnlineBankingPoland { .. }
- | domain::BankRedirectData::OnlineBankingSlovakia { .. }
- | domain::BankRedirectData::Przelewy24 { .. }
- | domain::BankRedirectData::Sofort { .. }
- | domain::BankRedirectData::Trustly { .. }
- | domain::BankRedirectData::OnlineBankingFpx { .. }
- | domain::BankRedirectData::OnlineBankingThailand { .. }
- | domain::BankRedirectData::LocalBankRedirect {} => {
+ BankRedirectData::BancontactCard { .. }
+ | BankRedirectData::Bizum {}
+ | BankRedirectData::Blik { .. }
+ | BankRedirectData::Eps { .. }
+ | BankRedirectData::Giropay { .. }
+ | BankRedirectData::Ideal { .. }
+ | BankRedirectData::Interac { .. }
+ | BankRedirectData::OnlineBankingCzechRepublic { .. }
+ | BankRedirectData::OnlineBankingFinland { .. }
+ | BankRedirectData::OnlineBankingPoland { .. }
+ | BankRedirectData::OnlineBankingSlovakia { .. }
+ | BankRedirectData::Przelewy24 { .. }
+ | BankRedirectData::Sofort { .. }
+ | BankRedirectData::Trustly { .. }
+ | BankRedirectData::OnlineBankingFpx { .. }
+ | BankRedirectData::OnlineBankingThailand { .. }
+ | BankRedirectData::LocalBankRedirect {} => {
Err(errors::ConnectorError::NotImplemented(
utils::get_unimplemented_payment_method_error_message("Volt"),
)
.into())
}
},
- domain::PaymentMethodData::Card(_)
- | domain::PaymentMethodData::CardRedirect(_)
- | domain::PaymentMethodData::Wallet(_)
- | domain::PaymentMethodData::PayLater(_)
- | domain::PaymentMethodData::BankDebit(_)
- | domain::PaymentMethodData::BankTransfer(_)
- | domain::PaymentMethodData::Crypto(_)
- | domain::PaymentMethodData::MandatePayment
- | domain::PaymentMethodData::Reward
- | domain::PaymentMethodData::RealTimePayment(_)
- | domain::PaymentMethodData::Upi(_)
- | domain::PaymentMethodData::Voucher(_)
- | domain::PaymentMethodData::GiftCard(_)
- | domain::PaymentMethodData::OpenBanking(_)
- | domain::PaymentMethodData::CardToken(_)
- | domain::PaymentMethodData::NetworkToken(_) => {
- Err(errors::ConnectorError::NotImplemented(
- utils::get_unimplemented_payment_method_error_message("Volt"),
- )
- .into())
- }
+ PaymentMethodData::Card(_)
+ | PaymentMethodData::CardRedirect(_)
+ | PaymentMethodData::Wallet(_)
+ | PaymentMethodData::PayLater(_)
+ | PaymentMethodData::BankDebit(_)
+ | PaymentMethodData::BankTransfer(_)
+ | PaymentMethodData::Crypto(_)
+ | PaymentMethodData::MandatePayment
+ | PaymentMethodData::Reward
+ | PaymentMethodData::RealTimePayment(_)
+ | PaymentMethodData::Upi(_)
+ | PaymentMethodData::Voucher(_)
+ | PaymentMethodData::GiftCard(_)
+ | PaymentMethodData::OpenBanking(_)
+ | PaymentMethodData::CardToken(_)
+ | PaymentMethodData::NetworkToken(_) => Err(errors::ConnectorError::NotImplemented(
+ utils::get_unimplemented_payment_method_error_message("Volt"),
+ )
+ .into()),
}
}
}
@@ -161,9 +165,9 @@ pub struct VoltAuthUpdateRequest {
password: Secret<String>,
}
-impl TryFrom<&types::RefreshTokenRouterData> for VoltAuthUpdateRequest {
+impl TryFrom<&RefreshTokenRouterData> for VoltAuthUpdateRequest {
type Error = error_stack::Report<errors::ConnectorError>;
- fn try_from(item: &types::RefreshTokenRouterData) -> Result<Self, Self::Error> {
+ fn try_from(item: &RefreshTokenRouterData) -> Result<Self, Self::Error> {
let auth = VoltAuthType::try_from(&item.connector_auth_type)?;
Ok(Self {
grant_type: PASSWORD.to_string(),
@@ -183,15 +187,15 @@ pub struct VoltAuthUpdateResponse {
pub refresh_token: Secret<String>,
}
-impl<F, T> TryFrom<types::ResponseRouterData<F, VoltAuthUpdateResponse, T, types::AccessToken>>
- for types::RouterData<F, T, types::AccessToken>
+impl<F, T> TryFrom<ResponseRouterData<F, VoltAuthUpdateResponse, T, AccessToken>>
+ for RouterData<F, T, AccessToken>
{
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(
- item: types::ResponseRouterData<F, VoltAuthUpdateResponse, T, types::AccessToken>,
+ item: ResponseRouterData<F, VoltAuthUpdateResponse, T, AccessToken>,
) -> Result<Self, Self::Error> {
Ok(Self {
- response: Ok(types::AccessToken {
+ response: Ok(AccessToken {
token: item.response.access_token,
expires: item.response.expires_in,
}),
@@ -207,11 +211,11 @@ pub struct VoltAuthType {
pub(super) client_secret: Secret<String>,
}
-impl TryFrom<&types::ConnectorAuthType> for VoltAuthType {
+impl TryFrom<&ConnectorAuthType> for VoltAuthType {
type Error = error_stack::Report<errors::ConnectorError>;
- fn try_from(auth_type: &types::ConnectorAuthType) -> Result<Self, Self::Error> {
+ fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> {
match auth_type {
- types::ConnectorAuthType::MultiAuthKey {
+ ConnectorAuthType::MultiAuthKey {
api_key,
key1,
api_secret,
@@ -253,24 +257,23 @@ pub struct VoltPaymentsResponse {
id: String,
}
-impl<F, T>
- TryFrom<types::ResponseRouterData<F, VoltPaymentsResponse, T, types::PaymentsResponseData>>
- for types::RouterData<F, T, types::PaymentsResponseData>
+impl<F, T> TryFrom<ResponseRouterData<F, VoltPaymentsResponse, T, PaymentsResponseData>>
+ for RouterData<F, T, PaymentsResponseData>
{
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(
- item: types::ResponseRouterData<F, VoltPaymentsResponse, T, types::PaymentsResponseData>,
+ item: ResponseRouterData<F, VoltPaymentsResponse, T, PaymentsResponseData>,
) -> Result<Self, Self::Error> {
let url = item.response.checkout_url;
- let redirection_data = Some(services::RedirectForm::Form {
+ let redirection_data = Some(RedirectForm::Form {
endpoint: url,
- method: services::Method::Get,
+ method: Method::Get,
form_fields: Default::default(),
});
Ok(Self {
status: enums::AttemptStatus::AuthenticationPending,
- response: Ok(types::PaymentsResponseData::TransactionResponse {
- resource_id: types::ResponseId::ConnectorTransactionId(item.response.id.clone()),
+ response: Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(item.response.id.clone()),
redirection_data,
mandate_reference: None,
connector_metadata: None,
@@ -319,18 +322,12 @@ pub struct VoltPsyncResponse {
merchant_internal_reference: Option<String>,
}
-impl<F, T>
- TryFrom<types::ResponseRouterData<F, VoltPaymentsResponseData, T, types::PaymentsResponseData>>
- for types::RouterData<F, T, types::PaymentsResponseData>
+impl<F, T> TryFrom<ResponseRouterData<F, VoltPaymentsResponseData, T, PaymentsResponseData>>
+ for RouterData<F, T, PaymentsResponseData>
{
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(
- item: types::ResponseRouterData<
- F,
- VoltPaymentsResponseData,
- T,
- types::PaymentsResponseData,
- >,
+ item: ResponseRouterData<F, VoltPaymentsResponseData, T, PaymentsResponseData>,
) -> Result<Self, Self::Error> {
match item.response {
VoltPaymentsResponseData::PsyncResponse(payment_response) => {
@@ -338,7 +335,7 @@ impl<F, T>
Ok(Self {
status,
response: if is_payment_failure(status) {
- Err(types::ErrorResponse {
+ Err(ErrorResponse {
code: payment_response.status.clone().to_string(),
message: payment_response.status.clone().to_string(),
reason: Some(payment_response.status.to_string()),
@@ -347,8 +344,8 @@ impl<F, T>
connector_transaction_id: Some(payment_response.id),
})
} else {
- Ok(types::PaymentsResponseData::TransactionResponse {
- resource_id: types::ResponseId::ConnectorTransactionId(
+ Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(
payment_response.id.clone(),
),
redirection_data: None,
@@ -371,7 +368,7 @@ impl<F, T>
Ok(Self {
status,
response: if is_payment_failure(status) {
- Err(types::ErrorResponse {
+ Err(ErrorResponse {
code: detailed_status
.clone()
.map(|volt_status| volt_status.to_string())
@@ -388,8 +385,8 @@ impl<F, T>
connector_transaction_id: Some(webhook_response.payment.clone()),
})
} else {
- Ok(types::PaymentsResponseData::TransactionResponse {
- resource_id: types::ResponseId::ConnectorTransactionId(
+ Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(
webhook_response.payment.clone(),
),
redirection_data: None,
@@ -447,15 +444,15 @@ pub struct RefundResponse {
id: String,
}
-impl TryFrom<types::RefundsResponseRouterData<api::Execute, RefundResponse>>
- for types::RefundsRouterData<api::Execute>
+impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>>
+ for types::RefundsRouterData<Execute>
{
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(
- item: types::RefundsResponseRouterData<api::Execute, RefundResponse>,
+ item: RefundsResponseRouterData<Execute, RefundResponse>,
) -> Result<Self, Self::Error> {
Ok(Self {
- response: Ok(types::RefundsResponseData {
+ response: Ok(RefundsResponseData {
connector_refund_id: item.response.id.to_string(),
refund_status: enums::RefundStatus::Pending, //We get Refund Status only by Webhooks
}),
@@ -564,7 +561,7 @@ pub enum VoltDetailedStatus {
AwaitingCheckoutAuthorisation,
}
-impl From<VoltWebhookBodyEventType> for api::IncomingWebhookEvent {
+impl From<VoltWebhookBodyEventType> for api_models::webhooks::IncomingWebhookEvent {
fn from(status: VoltWebhookBodyEventType) -> Self {
match status {
VoltWebhookBodyEventType::Payment(payment_data) => match payment_data.status {
diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs
index b9ae736e435..a667c5ddc3c 100644
--- a/crates/hyperswitch_connectors/src/default_implementations.rs
+++ b/crates/hyperswitch_connectors/src/default_implementations.rs
@@ -100,8 +100,10 @@ default_imp_for_authorize_session_token!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
+ connectors::Volt,
connectors::Thunes,
connectors::Tsys,
connectors::Worldline
@@ -129,6 +131,7 @@ default_imp_for_calculate_tax!(
connectors::Helcim,
connectors::Stax,
connectors::Novalnet,
+ connectors::Mollie,
connectors::Nexixpay,
connectors::Fiuu,
connectors::Globepay,
@@ -136,6 +139,7 @@ default_imp_for_calculate_tax!(
connectors::Powertranz,
connectors::Thunes,
connectors::Tsys,
+ connectors::Volt,
connectors::Deutschebank
);
@@ -161,6 +165,7 @@ default_imp_for_session_update!(
connectors::Helcim,
connectors::Stax,
connectors::Taxjar,
+ connectors::Mollie,
connectors::Novalnet,
connectors::Nexixpay,
connectors::Fiuu,
@@ -169,7 +174,8 @@ default_imp_for_session_update!(
connectors::Powertranz,
connectors::Thunes,
connectors::Tsys,
- connectors::Deutschebank
+ connectors::Deutschebank,
+ connectors::Volt
);
use crate::connectors;
@@ -201,7 +207,8 @@ default_imp_for_complete_authorize!(
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_incremental_authorization {
@@ -231,11 +238,13 @@ default_imp_for_incremental_authorization!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_create_customer {
@@ -262,13 +271,15 @@ default_imp_for_create_customer!(
connectors::Fiuu,
connectors::Globepay,
connectors::Helcim,
+ connectors::Mollie,
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_connector_redirect_response {
@@ -302,7 +313,8 @@ default_imp_for_connector_redirect_response!(
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_pre_processing_steps{
@@ -332,11 +344,13 @@ default_imp_for_pre_processing_steps!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_post_processing_steps{
@@ -366,11 +380,13 @@ default_imp_for_post_processing_steps!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_approve {
@@ -400,11 +416,13 @@ default_imp_for_approve!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_reject {
@@ -434,11 +452,13 @@ default_imp_for_reject!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_webhook_source_verification {
@@ -468,11 +488,13 @@ default_imp_for_webhook_source_verification!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_accept_dispute {
@@ -503,11 +525,13 @@ default_imp_for_accept_dispute!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_submit_evidence {
@@ -537,11 +561,13 @@ default_imp_for_submit_evidence!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_defend_dispute {
@@ -571,11 +597,13 @@ default_imp_for_defend_dispute!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_file_upload {
@@ -614,11 +642,13 @@ default_imp_for_file_upload!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -650,11 +680,13 @@ default_imp_for_payouts_create!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -686,11 +718,13 @@ default_imp_for_payouts_retrieve!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -722,11 +756,13 @@ default_imp_for_payouts_eligibility!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -758,11 +794,13 @@ default_imp_for_payouts_fulfill!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -794,11 +832,13 @@ default_imp_for_payouts_cancel!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -830,11 +870,13 @@ default_imp_for_payouts_quote!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -866,11 +908,13 @@ default_imp_for_payouts_recipient!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -902,11 +946,13 @@ default_imp_for_payouts_recipient_account!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -938,11 +984,13 @@ default_imp_for_frm_sale!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -974,11 +1022,13 @@ default_imp_for_frm_checkout!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -1010,11 +1060,13 @@ default_imp_for_frm_transaction!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -1046,11 +1098,13 @@ default_imp_for_frm_fulfillment!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -1082,11 +1136,13 @@ default_imp_for_frm_record_return!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_revoking_mandates {
@@ -1115,9 +1171,11 @@ default_imp_for_revoking_mandates!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs
index 82ac725de3c..3bb1abfef21 100644
--- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs
+++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs
@@ -207,11 +207,13 @@ default_imp_for_new_connector_integration_payment!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_new_connector_integration_refund {
@@ -242,11 +244,13 @@ default_imp_for_new_connector_integration_refund!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_new_connector_integration_connector_access_token {
@@ -272,11 +276,13 @@ default_imp_for_new_connector_integration_connector_access_token!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_new_connector_integration_accept_dispute {
@@ -308,11 +314,13 @@ default_imp_for_new_connector_integration_accept_dispute!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_new_connector_integration_submit_evidence {
@@ -343,11 +351,13 @@ default_imp_for_new_connector_integration_submit_evidence!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_new_connector_integration_defend_dispute {
@@ -378,11 +388,13 @@ default_imp_for_new_connector_integration_defend_dispute!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_new_connector_integration_file_upload {
@@ -423,11 +435,13 @@ default_imp_for_new_connector_integration_file_upload!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -460,11 +474,13 @@ default_imp_for_new_connector_integration_payouts_create!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -497,11 +513,13 @@ default_imp_for_new_connector_integration_payouts_eligibility!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -534,11 +552,13 @@ default_imp_for_new_connector_integration_payouts_fulfill!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -571,11 +591,13 @@ default_imp_for_new_connector_integration_payouts_cancel!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -608,11 +630,13 @@ default_imp_for_new_connector_integration_payouts_quote!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -645,11 +669,13 @@ default_imp_for_new_connector_integration_payouts_recipient!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -682,11 +708,13 @@ default_imp_for_new_connector_integration_payouts_sync!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "payouts")]
@@ -719,11 +747,13 @@ default_imp_for_new_connector_integration_payouts_recipient_account!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_new_connector_integration_webhook_source_verification {
@@ -754,11 +784,13 @@ default_imp_for_new_connector_integration_webhook_source_verification!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -791,11 +823,13 @@ default_imp_for_new_connector_integration_frm_sale!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -828,11 +862,13 @@ default_imp_for_new_connector_integration_frm_checkout!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -865,11 +901,13 @@ default_imp_for_new_connector_integration_frm_transaction!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -902,11 +940,13 @@ default_imp_for_new_connector_integration_frm_fulfillment!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
#[cfg(feature = "frm")]
@@ -939,11 +979,13 @@ default_imp_for_new_connector_integration_frm_record_return!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
macro_rules! default_imp_for_new_connector_integration_revoking_mandates {
@@ -973,9 +1015,11 @@ default_imp_for_new_connector_integration_revoking_mandates!(
connectors::Novalnet,
connectors::Nexixpay,
connectors::Powertranz,
+ connectors::Mollie,
connectors::Stax,
connectors::Taxjar,
connectors::Thunes,
connectors::Tsys,
- connectors::Worldline
+ connectors::Worldline,
+ connectors::Volt
);
diff --git a/crates/hyperswitch_connectors/src/types.rs b/crates/hyperswitch_connectors/src/types.rs
index 1624b03171b..05279b53ef8 100644
--- a/crates/hyperswitch_connectors/src/types.rs
+++ b/crates/hyperswitch_connectors/src/types.rs
@@ -1,8 +1,9 @@
use hyperswitch_domain_models::{
- router_data::RouterData,
- router_flow_types::{Capture, PSync, Void},
+ router_data::{AccessToken, RouterData},
+ router_flow_types::{AccessTokenAuth, Capture, PSync, Void},
router_request_types::{
- PaymentsCancelData, PaymentsCaptureData, PaymentsSyncData, RefundsData,
+ AccessTokenRequestData, PaymentsCancelData, PaymentsCaptureData, PaymentsSyncData,
+ RefundsData,
},
router_response_types::{PaymentsResponseData, RefundsResponseData},
};
@@ -14,6 +15,8 @@ pub type PaymentsCaptureResponseRouterData<R> =
ResponseRouterData<Capture, R, PaymentsCaptureData, PaymentsResponseData>;
pub(crate) type RefundsResponseRouterData<F, R> =
ResponseRouterData<F, R, RefundsData, RefundsResponseData>;
+pub(crate) type RefreshTokenRouterData =
+ RouterData<AccessTokenAuth, AccessTokenRequestData, AccessToken>;
pub type PaymentsCancelResponseRouterData<R> =
ResponseRouterData<Void, R, PaymentsCancelData, PaymentsResponseData>;
diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs
index a60a0d73ff3..bc8502cdd8b 100644
--- a/crates/hyperswitch_connectors/src/utils.rs
+++ b/crates/hyperswitch_connectors/src/utils.rs
@@ -19,9 +19,9 @@ use hyperswitch_domain_models::{
payment_method_data::{Card, PaymentMethodData},
router_data::{PaymentMethodToken, RecurringMandatePaymentData},
router_request_types::{
- AuthenticationData, BrowserInformation, CompleteAuthorizeData, PaymentsAuthorizeData,
- PaymentsCancelData, PaymentsCaptureData, PaymentsSyncData, RefundsData, ResponseId,
- SetupMandateRequestData,
+ AuthenticationData, BrowserInformation, CompleteAuthorizeData,
+ PaymentMethodTokenizationData, PaymentsAuthorizeData, PaymentsCancelData,
+ PaymentsCaptureData, PaymentsSyncData, RefundsData, ResponseId, SetupMandateRequestData,
},
};
use hyperswitch_interfaces::{api, errors};
@@ -1311,6 +1311,18 @@ impl PaymentsSetupMandateRequestData for SetupMandateRequestData {
}
}
+pub trait PaymentMethodTokenizationRequestData {
+ fn get_browser_info(&self) -> Result<BrowserInformation, Error>;
+}
+
+impl PaymentMethodTokenizationRequestData for PaymentMethodTokenizationData {
+ fn get_browser_info(&self) -> Result<BrowserInformation, Error> {
+ self.browser_info
+ .clone()
+ .ok_or_else(missing_field_err("browser_info"))
+ }
+}
+
pub trait PaymentsCompleteAuthorizeRequestData {
fn is_auto_capture(&self) -> Result<bool, Error>;
fn get_email(&self) -> Result<Email, Error>;
diff --git a/crates/hyperswitch_interfaces/Cargo.toml b/crates/hyperswitch_interfaces/Cargo.toml
index b225f897871..7ab885de3a3 100644
--- a/crates/hyperswitch_interfaces/Cargo.toml
+++ b/crates/hyperswitch_interfaces/Cargo.toml
@@ -28,6 +28,7 @@ serde_json = "1.0.115"
strum = { version = "0.26", features = ["derive"] }
thiserror = "1.0.58"
time = "0.3.35"
+url = "2.5.0"
# First party crates
hyperswitch_domain_models = { version = "0.1.0", path = "../hyperswitch_domain_models", default-features = false }
diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs
index caa5b13b51c..b505f8c8c52 100644
--- a/crates/router/src/connector.rs
+++ b/crates/router/src/connector.rs
@@ -27,7 +27,6 @@ pub mod iatapay;
pub mod itaubank;
pub mod klarna;
pub mod mifinity;
-pub mod mollie;
pub mod multisafepay;
pub mod netcetera;
pub mod nexinets;
@@ -55,7 +54,6 @@ pub mod stripe;
pub mod threedsecureio;
pub mod trustpay;
pub mod utils;
-pub mod volt;
pub mod wellsfargo;
pub mod wellsfargopayout;
pub mod wise;
@@ -66,9 +64,10 @@ pub mod zsl;
pub use hyperswitch_connectors::connectors::{
bambora, bambora::Bambora, bitpay, bitpay::Bitpay, deutschebank, deutschebank::Deutschebank,
fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, globepay,
- globepay::Globepay, helcim, helcim::Helcim, nexixpay, nexixpay::Nexixpay, novalnet,
- novalnet::Novalnet, powertranz, powertranz::Powertranz, stax, stax::Stax, taxjar,
- taxjar::Taxjar, thunes, thunes::Thunes, tsys, tsys::Tsys, worldline, worldline::Worldline,
+ globepay::Globepay, helcim, helcim::Helcim, mollie, mollie::Mollie, nexixpay,
+ nexixpay::Nexixpay, novalnet, novalnet::Novalnet, powertranz, powertranz::Powertranz, stax,
+ stax::Stax, taxjar, taxjar::Taxjar, thunes, thunes::Thunes, tsys, tsys::Tsys, volt, volt::Volt,
+ worldline, worldline::Worldline,
};
#[cfg(feature = "dummy_connector")]
@@ -80,12 +79,12 @@ pub use self::{
cashtocode::Cashtocode, checkout::Checkout, coinbase::Coinbase, cryptopay::Cryptopay,
cybersource::Cybersource, datatrans::Datatrans, dlocal::Dlocal, ebanx::Ebanx, forte::Forte,
globalpay::Globalpay, gocardless::Gocardless, gpayments::Gpayments, iatapay::Iatapay,
- itaubank::Itaubank, klarna::Klarna, mifinity::Mifinity, mollie::Mollie,
- multisafepay::Multisafepay, netcetera::Netcetera, nexinets::Nexinets, nmi::Nmi, noon::Noon,
- nuvei::Nuvei, opayo::Opayo, opennode::Opennode, paybox::Paybox, payeezy::Payeezy, payme::Payme,
- payone::Payone, paypal::Paypal, payu::Payu, placetopay::Placetopay, plaid::Plaid,
- prophetpay::Prophetpay, rapyd::Rapyd, razorpay::Razorpay, riskified::Riskified, shift4::Shift4,
- signifyd::Signifyd, square::Square, stripe::Stripe, threedsecureio::Threedsecureio,
- trustpay::Trustpay, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout,
- wise::Wise, worldpay::Worldpay, zen::Zen, zsl::Zsl,
+ itaubank::Itaubank, klarna::Klarna, mifinity::Mifinity, multisafepay::Multisafepay,
+ netcetera::Netcetera, nexinets::Nexinets, nmi::Nmi, noon::Noon, nuvei::Nuvei, opayo::Opayo,
+ opennode::Opennode, paybox::Paybox, payeezy::Payeezy, payme::Payme, payone::Payone,
+ paypal::Paypal, payu::Payu, placetopay::Placetopay, plaid::Plaid, prophetpay::Prophetpay,
+ rapyd::Rapyd, razorpay::Razorpay, riskified::Riskified, shift4::Shift4, signifyd::Signifyd,
+ square::Square, stripe::Stripe, threedsecureio::Threedsecureio, trustpay::Trustpay,
+ wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldpay::Worldpay,
+ zen::Zen, zsl::Zsl,
};
diff --git a/crates/router/src/core/payments/connector_integration_v2_impls.rs b/crates/router/src/core/payments/connector_integration_v2_impls.rs
index 19d67733d3b..041b5bb7359 100644
--- a/crates/router/src/core/payments/connector_integration_v2_impls.rs
+++ b/crates/router/src/core/payments/connector_integration_v2_impls.rs
@@ -698,7 +698,6 @@ default_imp_for_new_connector_integration_payment!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -724,7 +723,6 @@ default_imp_for_new_connector_integration_payment!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -778,7 +776,6 @@ default_imp_for_new_connector_integration_refund!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -804,7 +801,6 @@ default_imp_for_new_connector_integration_refund!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -852,7 +848,6 @@ default_imp_for_new_connector_integration_connector_access_token!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -878,7 +873,6 @@ default_imp_for_new_connector_integration_connector_access_token!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -948,7 +942,6 @@ default_imp_for_new_connector_integration_accept_dispute!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -974,7 +967,6 @@ default_imp_for_new_connector_integration_accept_dispute!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1026,7 +1018,6 @@ default_imp_for_new_connector_integration_defend_dispute!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1052,7 +1043,6 @@ default_imp_for_new_connector_integration_defend_dispute!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1088,7 +1078,6 @@ default_imp_for_new_connector_integration_submit_evidence!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1114,7 +1103,6 @@ default_imp_for_new_connector_integration_submit_evidence!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1177,7 +1165,6 @@ default_imp_for_new_connector_integration_file_upload!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1203,7 +1190,6 @@ default_imp_for_new_connector_integration_file_upload!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1345,7 +1331,6 @@ default_imp_for_new_connector_integration_payouts_create!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1371,7 +1356,6 @@ default_imp_for_new_connector_integration_payouts_create!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1426,7 +1410,6 @@ default_imp_for_new_connector_integration_payouts_eligibility!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1452,7 +1435,6 @@ default_imp_for_new_connector_integration_payouts_eligibility!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1507,7 +1489,6 @@ default_imp_for_new_connector_integration_payouts_fulfill!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1533,7 +1514,6 @@ default_imp_for_new_connector_integration_payouts_fulfill!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1588,7 +1568,6 @@ default_imp_for_new_connector_integration_payouts_cancel!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1614,7 +1593,6 @@ default_imp_for_new_connector_integration_payouts_cancel!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1669,7 +1647,6 @@ default_imp_for_new_connector_integration_payouts_quote!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1695,7 +1672,6 @@ default_imp_for_new_connector_integration_payouts_quote!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1750,7 +1726,6 @@ default_imp_for_new_connector_integration_payouts_recipient!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1776,7 +1751,6 @@ default_imp_for_new_connector_integration_payouts_recipient!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1831,7 +1805,6 @@ default_imp_for_new_connector_integration_payouts_sync!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1857,7 +1830,6 @@ default_imp_for_new_connector_integration_payouts_sync!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1912,7 +1884,6 @@ default_imp_for_new_connector_integration_payouts_recipient_account!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1938,7 +1909,6 @@ default_imp_for_new_connector_integration_payouts_recipient_account!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -1991,7 +1961,6 @@ default_imp_for_new_connector_integration_webhook_source_verification!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2017,7 +1986,6 @@ default_imp_for_new_connector_integration_webhook_source_verification!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -2159,7 +2127,6 @@ default_imp_for_new_connector_integration_frm_sale!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2185,7 +2152,6 @@ default_imp_for_new_connector_integration_frm_sale!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -2240,7 +2206,6 @@ default_imp_for_new_connector_integration_frm_checkout!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2266,7 +2231,6 @@ default_imp_for_new_connector_integration_frm_checkout!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -2321,7 +2285,6 @@ default_imp_for_new_connector_integration_frm_transaction!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2347,7 +2310,6 @@ default_imp_for_new_connector_integration_frm_transaction!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -2402,7 +2364,6 @@ default_imp_for_new_connector_integration_frm_fulfillment!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2428,7 +2389,6 @@ default_imp_for_new_connector_integration_frm_fulfillment!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -2483,7 +2443,6 @@ default_imp_for_new_connector_integration_frm_record_return!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2509,7 +2468,6 @@ default_imp_for_new_connector_integration_frm_record_return!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
@@ -2561,7 +2519,6 @@ default_imp_for_new_connector_integration_revoking_mandates!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2587,7 +2544,6 @@ default_imp_for_new_connector_integration_revoking_mandates!(
connector::Shift4,
connector::Trustpay,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wise,
connector::Worldpay,
diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs
index 1dec8911d31..984b24ab785 100644
--- a/crates/router/src/core/payments/flows.rs
+++ b/crates/router/src/core/payments/flows.rs
@@ -241,7 +241,6 @@ default_imp_for_complete_authorize!(
connector::Stripe,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wise,
connector::Wellsfargo,
connector::Wellsfargopayout,
@@ -303,7 +302,6 @@ default_imp_for_webhook_source_verification!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -329,7 +327,6 @@ default_imp_for_webhook_source_verification!(
connector::Stripe,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -392,7 +389,6 @@ default_imp_for_create_customer!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -418,7 +414,6 @@ default_imp_for_create_customer!(
connector::Square,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -497,7 +492,6 @@ default_imp_for_connector_redirect_response!(
connector::Signifyd,
connector::Square,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -649,7 +643,6 @@ default_imp_for_accept_dispute!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -676,7 +669,6 @@ default_imp_for_accept_dispute!(
connector::Stripe,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -760,7 +752,6 @@ default_imp_for_file_upload!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -785,7 +776,6 @@ default_imp_for_file_upload!(
connector::Square,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Opennode,
connector::Wellsfargo,
connector::Wellsfargopayout,
@@ -848,7 +838,6 @@ default_imp_for_submit_evidence!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -873,7 +862,6 @@ default_imp_for_submit_evidence!(
connector::Square,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Opennode,
connector::Wellsfargo,
connector::Wellsfargopayout,
@@ -928,15 +916,14 @@ default_imp_for_defend_dispute!(
connector::Datatrans,
connector::Dlocal,
connector::Ebanx,
- connector::Forte,
connector::Globalpay,
+ connector::Forte,
connector::Gocardless,
connector::Gpayments,
connector::Iatapay,
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -962,7 +949,6 @@ default_imp_for_defend_dispute!(
connector::Stripe,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Opennode,
connector::Wellsfargo,
connector::Wellsfargopayout,
@@ -1038,7 +1024,6 @@ default_imp_for_pre_processing_steps!(
connector::Gpayments,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1058,7 +1043,6 @@ default_imp_for_pre_processing_steps!(
connector::Signifyd,
connector::Square,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -1114,7 +1098,6 @@ default_imp_for_post_processing_steps!(
connector::Gpayments,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1132,7 +1115,6 @@ default_imp_for_post_processing_steps!(
connector::Signifyd,
connector::Square,
connector::Threedsecureio,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -1278,7 +1260,6 @@ default_imp_for_payouts_create!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1303,7 +1284,6 @@ default_imp_for_payouts_create!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Worldpay,
@@ -1367,7 +1347,6 @@ default_imp_for_payouts_retrieve!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1393,7 +1372,6 @@ default_imp_for_payouts_retrieve!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -1459,7 +1437,6 @@ default_imp_for_payouts_eligibility!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1486,7 +1463,6 @@ default_imp_for_payouts_eligibility!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Worldpay,
@@ -1546,7 +1522,6 @@ default_imp_for_payouts_fulfill!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1570,7 +1545,6 @@ default_imp_for_payouts_fulfill!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Worldpay,
@@ -1632,7 +1606,6 @@ default_imp_for_payouts_cancel!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1658,7 +1631,6 @@ default_imp_for_payouts_cancel!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Worldpay,
@@ -1721,7 +1693,6 @@ default_imp_for_payouts_quote!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1748,7 +1719,6 @@ default_imp_for_payouts_quote!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Worldpay,
@@ -1811,7 +1781,6 @@ default_imp_for_payouts_recipient!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1837,7 +1806,6 @@ default_imp_for_payouts_recipient!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Worldpay,
@@ -1904,7 +1872,6 @@ default_imp_for_payouts_recipient_account!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -1930,7 +1897,6 @@ default_imp_for_payouts_recipient_account!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -1994,7 +1960,6 @@ default_imp_for_approve!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2021,7 +1986,6 @@ default_imp_for_approve!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -2085,7 +2049,6 @@ default_imp_for_reject!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2112,7 +2075,6 @@ default_imp_for_reject!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -2266,7 +2228,6 @@ default_imp_for_frm_sale!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2291,7 +2252,6 @@ default_imp_for_frm_sale!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -2357,7 +2317,6 @@ default_imp_for_frm_checkout!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2382,7 +2341,6 @@ default_imp_for_frm_checkout!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -2448,7 +2406,6 @@ default_imp_for_frm_transaction!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2473,7 +2430,6 @@ default_imp_for_frm_transaction!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -2539,7 +2495,6 @@ default_imp_for_frm_fulfillment!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2564,7 +2519,6 @@ default_imp_for_frm_fulfillment!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -2630,7 +2584,6 @@ default_imp_for_frm_record_return!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2655,7 +2608,6 @@ default_imp_for_frm_record_return!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -2718,7 +2670,6 @@ default_imp_for_incremental_authorization!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2745,7 +2696,6 @@ default_imp_for_incremental_authorization!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargopayout,
connector::Wise,
connector::Worldpay,
@@ -2805,7 +2755,6 @@ default_imp_for_revoking_mandates!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -2831,7 +2780,6 @@ default_imp_for_revoking_mandates!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wise,
connector::Worldpay,
connector::Zen,
@@ -3052,7 +3000,6 @@ default_imp_for_authorize_session_token!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -3077,7 +3024,6 @@ default_imp_for_authorize_session_token!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -3139,7 +3085,6 @@ default_imp_for_calculate_tax!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -3166,7 +3111,6 @@ default_imp_for_calculate_tax!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
@@ -3228,7 +3172,6 @@ default_imp_for_session_update!(
connector::Itaubank,
connector::Klarna,
connector::Mifinity,
- connector::Mollie,
connector::Multisafepay,
connector::Netcetera,
connector::Nexinets,
@@ -3255,7 +3198,6 @@ default_imp_for_session_update!(
connector::Shift4,
connector::Threedsecureio,
connector::Trustpay,
- connector::Volt,
connector::Wellsfargo,
connector::Wellsfargopayout,
connector::Wise,
|
refactor
|
Move connector Volt and Mollie from Router to HyperswitchConnector Trait (#5612)
|
8947e1c9dba3585c3d998110b53747cbc1007bc2
|
2023-05-18 23:04:29
|
Sampras Lopes
|
feat(traces): add support for aws xray (#1194)
| false
|
diff --git a/config/config.example.toml b/config/config.example.toml
index 85b7ad83c84..c5e84d38b34 100644
--- a/config/config.example.toml
+++ b/config/config.example.toml
@@ -92,6 +92,7 @@ ignore_errors = false # boolean [true or false],
sampling_rate = 0.1 # decimal rate between 0.0 - 1.0
otel_exporter_otlp_endpoint = "http://localhost:4317" # endpoint to send metrics and traces to, can include port number
otel_exporter_otlp_timeout = 5000 # timeout (in milliseconds) for sending metrics and traces
+use_xray_generator = false # Set this to true for AWS X-ray compatible traces
# This section provides some secret values.
[secrets]
diff --git a/config/development.toml b/config/development.toml
index 692712b79c4..79b760d8ed6 100644
--- a/config/development.toml
+++ b/config/development.toml
@@ -9,6 +9,7 @@ log_format = "default"
[log.telemetry]
traces_enabled = false
metrics_enabled = false
+use_xray_generator = false
# TODO: Update database credentials before running application
[master_database]
diff --git a/config/docker_compose.toml b/config/docker_compose.toml
index 80ede116f57..3efbdcd0217 100644
--- a/config/docker_compose.toml
+++ b/config/docker_compose.toml
@@ -18,6 +18,7 @@ traces_enabled = false # Whether traces are
metrics_enabled = false # Whether metrics are enabled.
ignore_errors = false # Whether to ignore errors during traces or metrics pipeline setup.
otel_exporter_otlp_endpoint = "https://otel-collector:4317" # Endpoint to send metrics and traces to.
+use_xray_generator = false
[master_database]
username = "db_user"
diff --git a/crates/router_env/src/logger/config.rs b/crates/router_env/src/logger/config.rs
index c87a2c8a449..e2437422833 100644
--- a/crates/router_env/src/logger/config.rs
+++ b/crates/router_env/src/logger/config.rs
@@ -99,6 +99,8 @@ pub struct LogTelemetry {
pub otel_exporter_otlp_endpoint: Option<String>,
/// Timeout (in milliseconds) for sending metrics and traces.
pub otel_exporter_otlp_timeout: Option<u64>,
+ /// Whether to use xray ID generator, (enable this if you plan to use AWS-XRAY)
+ pub use_xray_generator: bool,
}
/// Telemetry / tracing.
diff --git a/crates/router_env/src/logger/setup.rs b/crates/router_env/src/logger/setup.rs
index c30eee6270f..eb70e58da26 100644
--- a/crates/router_env/src/logger/setup.rs
+++ b/crates/router_env/src/logger/setup.rs
@@ -134,7 +134,7 @@ fn setup_tracing_pipeline(
{
global::set_text_map_propagator(TraceContextPropagator::new());
- let trace_config = trace::config()
+ let mut trace_config = trace::config()
.with_sampler(trace::Sampler::TraceIdRatioBased(
config.sampling_rate.unwrap_or(1.0),
))
@@ -142,6 +142,9 @@ fn setup_tracing_pipeline(
"service.name",
service_name,
)]));
+ if config.use_xray_generator {
+ trace_config = trace_config.with_id_generator(trace::XrayIdGenerator::default());
+ }
let traces_layer_result = opentelemetry_otlp::new_pipeline()
.tracing()
.with_exporter(get_opentelemetry_exporter(config))
|
feat
|
add support for aws xray (#1194)
|
5c6bcb594eca050c2abbd3cc622c7e2d527b31be
|
2023-07-25 15:33:48
|
SamraatBansal
|
fix(connector): [Bluesnap] Populate Error Reason and Update error handling (#1787)
| false
|
diff --git a/crates/router/src/connector/bluesnap.rs b/crates/router/src/connector/bluesnap.rs
index fadb25e3b7d..78a8b8dc2d4 100644
--- a/crates/router/src/connector/bluesnap.rs
+++ b/crates/router/src/connector/bluesnap.rs
@@ -98,7 +98,7 @@ impl ConnectorCommon for Bluesnap {
router_env::logger::info!(error_response=?response);
let response_error_message = match response {
- bluesnap::BluesnapErrors::PaymentError(error_res) => error_res.message.first().map_or(
+ bluesnap::BluesnapErrors::Payment(error_res) => error_res.message.first().map_or(
ErrorResponse {
status_code: res.status_code,
code: consts::NO_ERROR_CODE.to_string(),
@@ -109,14 +109,20 @@ impl ConnectorCommon for Bluesnap {
status_code: res.status_code,
code: error_response.code.clone(),
message: error_response.description.clone(),
- reason: None,
+ reason: Some(error_response.description.clone()),
},
),
- bluesnap::BluesnapErrors::AuthError(error_res) => ErrorResponse {
+ bluesnap::BluesnapErrors::Auth(error_res) => ErrorResponse {
status_code: res.status_code,
code: error_res.error_code.clone(),
- message: error_res.error_description,
- reason: None,
+ message: error_res.error_description.clone(),
+ reason: Some(error_res.error_description),
+ },
+ bluesnap::BluesnapErrors::General(error_response) => ErrorResponse {
+ status_code: res.status_code,
+ code: consts::NO_ERROR_CODE.to_string(),
+ message: error_response.clone(),
+ reason: Some(error_response),
},
};
Ok(response_error_message)
@@ -393,12 +399,11 @@ impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsRe
.parse_struct("BluesnapPaymentsResponse")
.change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
router_env::logger::info!(connector_response=?response);
- types::ResponseRouterData {
+ types::RouterData::try_from(types::ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
- }
- .try_into()
+ })
.change_context(errors::ConnectorError::ResponseHandlingFailed)
}
}
@@ -471,12 +476,11 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
.parse_struct("Bluesnap BluesnapPaymentsResponse")
.change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
router_env::logger::info!(connector_response=?response);
- types::ResponseRouterData {
+ types::RouterData::try_from(types::ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
- }
- .try_into()
+ })
.change_context(errors::ConnectorError::ResponseHandlingFailed)
}
@@ -484,18 +488,7 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
&self,
res: Response,
) -> CustomResult<ErrorResponse, errors::ConnectorError> {
- let response: String = res
- .response
- .parse_struct("ErrorResponse")
- .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
- logger::debug!(bluesnap_error_response=?res);
-
- Ok(ErrorResponse {
- status_code: res.status_code,
- code: consts::NO_ERROR_CODE.to_string(),
- message: response,
- reason: None,
- })
+ self.build_error_response(res)
}
}
@@ -866,12 +859,11 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
.parse_struct("bluesnap RefundResponse")
.change_context(errors::ConnectorError::RequestEncodingFailed)?;
router_env::logger::info!(connector_response=?response);
- types::ResponseRouterData {
+ types::RouterData::try_from(types::ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
- }
- .try_into()
+ })
.change_context(errors::ConnectorError::ResponseHandlingFailed)
}
@@ -934,12 +926,11 @@ impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponse
.parse_struct("bluesnap BluesnapPaymentsResponse")
.change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
router_env::logger::info!(connector_response=?response);
- types::ResponseRouterData {
+ types::RouterData::try_from(types::ResponseRouterData {
response,
data: data.clone(),
http_code: res.status_code,
- }
- .try_into()
+ })
.change_context(errors::ConnectorError::ResponseHandlingFailed)
}
diff --git a/crates/router/src/connector/bluesnap/transformers.rs b/crates/router/src/connector/bluesnap/transformers.rs
index fae7588fbd3..c754ae6d1c8 100644
--- a/crates/router/src/connector/bluesnap/transformers.rs
+++ b/crates/router/src/connector/bluesnap/transformers.rs
@@ -810,8 +810,9 @@ pub struct BluesnapAuthErrorResponse {
#[derive(Debug, Clone, Deserialize)]
#[serde(untagged)]
pub enum BluesnapErrors {
- PaymentError(BluesnapErrorResponse),
- AuthError(BluesnapAuthErrorResponse),
+ Payment(BluesnapErrorResponse),
+ Auth(BluesnapAuthErrorResponse),
+ General(String),
}
fn get_card_holder_info(
|
fix
|
[Bluesnap] Populate Error Reason and Update error handling (#1787)
|
9a3fa00426d74f6d18b3c712b292d98d80d517ba
|
2023-11-23 18:54:23
|
github-actions
|
test(postman): update postman collection files
| false
|
diff --git a/postman/collection-json/stripe.postman_collection.json b/postman/collection-json/stripe.postman_collection.json
index 9bdb5fdb44d..4d3e548f535 100644
--- a/postman/collection-json/stripe.postman_collection.json
+++ b/postman/collection-json/stripe.postman_collection.json
@@ -14445,7 +14445,7 @@
"language": "json"
}
},
- "raw": "{\"amount\":8000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ "raw": "{\"amount\":8000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":8000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
},
"url": {
"raw": "{{baseUrl}}/payments",
|
test
|
update postman collection files
|
cfcf9187b9d97fba8b1eb82f988b967957fb90c6
|
2024-09-26 22:01:24
|
Shankar Singh C
|
refactor(router): restructure `Samsung Pay` connector wallet details (#6089)
| false
|
diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs
index aa14e2e7431..58b3fb47ac4 100644
--- a/crates/api_models/src/payments.rs
+++ b/crates/api_models/src/payments.rs
@@ -4921,20 +4921,37 @@ pub struct GpaySessionTokenData {
pub data: GpayMetaData,
}
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+#[serde(rename_all = "snake_case")]
+pub enum SamsungPayCombinedMetadata {
+ // This is to support the Samsung Pay decryption flow with application credentials,
+ // where the private key, certificates, or any other information required for decryption
+ // will be obtained from the environment variables.
+ ApplicationCredentials(SamsungPayApplicationCredentials),
+ MerchantCredentials(SamsungPayMerchantCredentials),
+}
+
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct SamsungPaySessionTokenData {
#[serde(rename = "samsung_pay")]
- pub data: SamsungPayMetadata,
+ pub data: SamsungPayCombinedMetadata,
}
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
-pub struct SamsungPayMetadata {
+pub struct SamsungPayMerchantCredentials {
pub service_id: String,
pub merchant_display_name: String,
pub merchant_business_country: api_enums::CountryAlpha2,
pub allowed_brands: Vec<String>,
}
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+pub struct SamsungPayApplicationCredentials {
+ pub merchant_display_name: String,
+ pub merchant_business_country: api_enums::CountryAlpha2,
+ pub allowed_brands: Vec<String>,
+}
+
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct PaypalSdkMetaData {
pub client_id: String,
diff --git a/crates/router/src/core/payments/flows/session_flow.rs b/crates/router/src/core/payments/flows/session_flow.rs
index 5bd81897dd8..ee657bc3949 100644
--- a/crates/router/src/core/payments/flows/session_flow.rs
+++ b/crates/router/src/core/payments/flows/session_flow.rs
@@ -502,7 +502,7 @@ fn create_samsung_pay_session_token(
router_data: &types::PaymentsSessionRouterData,
header_payload: api_models::payments::HeaderPayload,
) -> RouterResult<types::PaymentsSessionRouterData> {
- let samsung_pay_wallet_details = router_data
+ let samsung_pay_session_token_data = router_data
.connector_wallets_details
.clone()
.parse_value::<payment_types::SamsungPaySessionTokenData>("SamsungPaySessionTokenData")
@@ -527,18 +527,30 @@ fn create_samsung_pay_session_token(
.get_required_value("samsung pay domain")
.attach_printable("Failed to get domain for samsung pay session call")?;
+ let samsung_pay_wallet_details = match samsung_pay_session_token_data.data {
+ payment_types::SamsungPayCombinedMetadata::MerchantCredentials(
+ samsung_pay_merchant_credentials,
+ ) => samsung_pay_merchant_credentials,
+ payment_types::SamsungPayCombinedMetadata::ApplicationCredentials(
+ _samsung_pay_application_credentials,
+ ) => Err(errors::ApiErrorResponse::NotSupported {
+ message: "Samsung Pay decryption flow with application credentials is not implemented"
+ .to_owned(),
+ })?,
+ };
+
Ok(types::PaymentsSessionRouterData {
response: Ok(types::PaymentsResponseData::SessionResponse {
session_token: payment_types::SessionToken::SamsungPay(Box::new(
payment_types::SamsungPaySessionTokenResponse {
version: "2".to_string(),
- service_id: samsung_pay_wallet_details.data.service_id,
+ service_id: samsung_pay_wallet_details.service_id,
order_number: router_data.payment_id.clone(),
merchant_payment_information:
payment_types::SamsungPayMerchantPaymentInformation {
- name: samsung_pay_wallet_details.data.merchant_display_name,
+ name: samsung_pay_wallet_details.merchant_display_name,
url: merchant_domain,
- country_code: samsung_pay_wallet_details.data.merchant_business_country,
+ country_code: samsung_pay_wallet_details.merchant_business_country,
},
amount: payment_types::SamsungPayAmountDetails {
amount_format: payment_types::SamsungPayAmountFormat::FormatTotalPriceOnly,
@@ -546,7 +558,7 @@ fn create_samsung_pay_session_token(
total_amount: samsung_pay_amount,
},
protocol: payment_types::SamsungPayProtocolType::Protocol3ds,
- allowed_brands: samsung_pay_wallet_details.data.allowed_brands,
+ allowed_brands: samsung_pay_wallet_details.allowed_brands,
},
)),
}),
|
refactor
|
restructure `Samsung Pay` connector wallet details (#6089)
|
b3d147373499743a53e1dc1841960a172928c766
|
2023-04-11 13:05:57
|
Arvind Patel
|
feat(connector): [Coinbase] [Opennode] Add support for crypto payments via PG redirection (#834)
| false
|
diff --git a/config/Development.toml b/config/Development.toml
index 25110882c8d..1537a425b4d 100644
--- a/config/Development.toml
+++ b/config/Development.toml
@@ -60,6 +60,7 @@ cards = [
"bluesnap",
"braintree",
"checkout",
+ "coinbase",
"cybersource",
"dlocal",
"fiserv",
@@ -67,6 +68,7 @@ cards = [
"mollie",
"multisafepay",
"nuvei",
+ "opennode",
"paypal",
"payu",
"shift4",
@@ -99,6 +101,7 @@ bambora.base_url = "https://api.na.bambora.com"
bluesnap.base_url = "https://sandbox.bluesnap.com/"
braintree.base_url = "https://api.sandbox.braintreegateway.com/"
checkout.base_url = "https://api.sandbox.checkout.com/"
+coinbase.base_url = "https://api.commerce.coinbase.com"
cybersource.base_url = "https://apitest.cybersource.com/"
dlocal.base_url = "https://sandbox.dlocal.com/"
fiserv.base_url = "https://cert.api.fiservapps.com/"
@@ -107,6 +110,7 @@ klarna.base_url = "https://api-na.playground.klarna.com/"
mollie.base_url = "https://api.mollie.com/v2/"
multisafepay.base_url = "https://testapi.multisafepay.com/"
nuvei.base_url = "https://ppp-test.nuvei.com/"
+opennode.base_url = "https://dev-api.opennode.com"
paypal.base_url = "https://www.sandbox.paypal.com/"
payu.base_url = "https://secure.snd.payu.com/"
rapyd.base_url = "https://sandboxapi.rapyd.net"
diff --git a/config/config.example.toml b/config/config.example.toml
index 597d1181da3..cb8a459ded2 100644
--- a/config/config.example.toml
+++ b/config/config.example.toml
@@ -133,6 +133,7 @@ bambora.base_url = "https://api.na.bambora.com"
bluesnap.base_url = "https://sandbox.bluesnap.com/"
braintree.base_url = "https://api.sandbox.braintreegateway.com/"
checkout.base_url = "https://api.sandbox.checkout.com/"
+coinbase.base_url = "https://api.commerce.coinbase.com"
cybersource.base_url = "https://apitest.cybersource.com/"
dlocal.base_url = "https://sandbox.dlocal.com/"
fiserv.base_url = "https://cert.api.fiservapps.com/"
@@ -141,6 +142,7 @@ klarna.base_url = "https://api-na.playground.klarna.com/"
mollie.base_url = "https://api.mollie.com/v2/"
multisafepay.base_url = "https://testapi.multisafepay.com/"
nuvei.base_url = "https://ppp-test.nuvei.com/"
+opennode.base_url = "https://dev-api.opennode.com"
paypal.base_url = "https://www.sandbox.paypal.com/"
payu.base_url = "https://secure.snd.payu.com/"
rapyd.base_url = "https://sandboxapi.rapyd.net"
@@ -157,6 +159,7 @@ wallets = ["klarna", "braintree", "applepay"]
cards = [
"adyen",
"authorizedotnet",
+ "coinbase",
"braintree",
"checkout",
"cybersource",
diff --git a/config/docker_compose.toml b/config/docker_compose.toml
index 50de78bf669..0c352b34242 100644
--- a/config/docker_compose.toml
+++ b/config/docker_compose.toml
@@ -78,6 +78,7 @@ bambora.base_url = "https://api.na.bambora.com"
bluesnap.base_url = "https://sandbox.bluesnap.com/"
braintree.base_url = "https://api.sandbox.braintreegateway.com/"
checkout.base_url = "https://api.sandbox.checkout.com/"
+coinbase.base_url = "https://api.commerce.coinbase.com"
cybersource.base_url = "https://apitest.cybersource.com/"
dlocal.base_url = "https://sandbox.dlocal.com/"
fiserv.base_url = "https://cert.api.fiservapps.com/"
@@ -86,6 +87,7 @@ klarna.base_url = "https://api-na.playground.klarna.com/"
mollie.base_url = "https://api.mollie.com/v2/"
multisafepay.base_url = "https://testapi.multisafepay.com/"
nuvei.base_url = "https://ppp-test.nuvei.com/"
+opennode.base_url = "https://dev-api.opennode.com"
paypal.base_url = "https://www.sandbox.paypal.com/"
payu.base_url = "https://secure.snd.payu.com/"
rapyd.base_url = "https://sandboxapi.rapyd.net"
@@ -108,6 +110,7 @@ cards = [
"bluesnap",
"braintree",
"checkout",
+ "coinbase",
"cybersource",
"dlocal",
"fiserv",
@@ -115,6 +118,7 @@ cards = [
"mollie",
"multisafepay",
"nuvei",
+ "opennode",
"paypal",
"payu",
"shift4",
diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs
index 20a77790965..5a66f45033e 100644
--- a/crates/api_models/src/enums.rs
+++ b/crates/api_models/src/enums.rs
@@ -34,6 +34,7 @@ pub enum AttemptStatus {
VoidFailed,
AutoRefunded,
PartialCharged,
+ Unresolved,
#[default]
Pending,
Failure,
@@ -266,6 +267,8 @@ pub enum Currency {
#[strum(serialize_all = "snake_case")]
pub enum EventType {
PaymentSucceeded,
+ PaymentProcessing,
+ ActionRequired,
RefundSucceeded,
RefundFailed,
DisputeOpened,
@@ -299,6 +302,7 @@ pub enum IntentStatus {
Cancelled,
Processing,
RequiresCustomerAction,
+ RequiresMerchantAction,
RequiresPaymentMethod,
#[default]
RequiresConfirmation,
@@ -416,6 +420,7 @@ pub enum PaymentMethodType {
GooglePay,
ApplePay,
Paypal,
+ CryptoCurrency,
}
#[derive(
@@ -441,6 +446,7 @@ pub enum PaymentMethod {
PayLater,
Wallet,
BankRedirect,
+ Crypto,
}
#[derive(
@@ -561,9 +567,11 @@ pub enum Connector {
Bluesnap,
Braintree,
Checkout,
+ Coinbase,
Cybersource,
#[default]
Dummy,
+ Opennode,
Bambora,
Dlocal,
Fiserv,
@@ -618,6 +626,7 @@ pub enum RoutableConnectors {
Bluesnap,
Braintree,
Checkout,
+ Coinbase,
Cybersource,
Dlocal,
Fiserv,
@@ -626,6 +635,7 @@ pub enum RoutableConnectors {
Mollie,
Multisafepay,
Nuvei,
+ Opennode,
Paypal,
Payu,
Rapyd,
@@ -758,6 +768,7 @@ impl From<AttemptStatus> for IntentStatus {
AttemptStatus::Authorized => Self::RequiresCapture,
AttemptStatus::AuthenticationPending => Self::RequiresCustomerAction,
+ AttemptStatus::Unresolved => Self::RequiresMerchantAction,
AttemptStatus::PartialCharged
| AttemptStatus::Started
@@ -826,3 +837,10 @@ pub enum DisputeStatus {
// dispute has been unsuccessfully challenged
DisputeLost,
}
+
+#[derive(Debug, Eq, PartialEq, Clone, serde::Serialize, serde::Deserialize)]
+pub struct UnresolvedResponseReason {
+ pub code: String,
+ /// A message to merchant to give hint on next action he/she should do to resolve
+ pub message: String,
+}
diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs
index 95f54e2786f..b24b304a003 100644
--- a/crates/api_models/src/payments.rs
+++ b/crates/api_models/src/payments.rs
@@ -441,6 +441,7 @@ pub enum PaymentMethodData {
Wallet(WalletData),
PayLater(PayLaterData),
BankRedirect(BankRedirectData),
+ Crypto(CryptoData),
}
#[derive(Debug, Clone, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
@@ -455,6 +456,7 @@ pub enum AdditionalPaymentData {
},
Wallet {},
PayLater {},
+ Crypto {},
}
impl From<&PaymentMethodData> for AdditionalPaymentData {
@@ -478,6 +480,7 @@ impl From<&PaymentMethodData> for AdditionalPaymentData {
},
PaymentMethodData::Wallet(_) => Self::Wallet {},
PaymentMethodData::PayLater(_) => Self::PayLater {},
+ PaymentMethodData::Crypto(_) => Self::Crypto {},
}
}
}
@@ -516,6 +519,10 @@ pub enum BankRedirectData {
},
}
+#[derive(Debug, Clone, Eq, PartialEq, serde::Deserialize, serde::Serialize, ToSchema)]
+#[serde(rename_all = "snake_case")]
+pub struct CryptoData {}
+
#[derive(Debug, Clone, Eq, PartialEq, serde::Deserialize, serde::Serialize, ToSchema)]
pub struct SofortBilling {
/// The country associated with the billing
@@ -620,6 +627,7 @@ pub enum PaymentMethodDataResponse {
PayLater(PayLaterData),
Paypal,
BankRedirect(BankRedirectData),
+ Crypto(CryptoData),
}
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize, ToSchema)]
@@ -1125,6 +1133,7 @@ impl From<PaymentMethodData> for PaymentMethodDataResponse {
PaymentMethodData::BankRedirect(bank_redirect_data) => {
Self::BankRedirect(bank_redirect_data)
}
+ PaymentMethodData::Crypto(crpto_data) => Self::Crypto(crpto_data),
}
}
}
diff --git a/crates/api_models/src/webhooks.rs b/crates/api_models/src/webhooks.rs
index 0cdf3bb6bc8..edb96b4c208 100644
--- a/crates/api_models/src/webhooks.rs
+++ b/crates/api_models/src/webhooks.rs
@@ -9,6 +9,9 @@ use crate::{disputes, enums as api_enums, payments, refunds};
pub enum IncomingWebhookEvent {
PaymentIntentFailure,
PaymentIntentSuccess,
+ PaymentIntentProcessing,
+ PaymentActionRequired,
+ EventNotSupported,
RefundFailure,
RefundSuccess,
DisputeOpened,
@@ -36,6 +39,9 @@ impl From<IncomingWebhookEvent> for WebhookFlow {
match evt {
IncomingWebhookEvent::PaymentIntentFailure => Self::Payment,
IncomingWebhookEvent::PaymentIntentSuccess => Self::Payment,
+ IncomingWebhookEvent::PaymentIntentProcessing => Self::Payment,
+ IncomingWebhookEvent::PaymentActionRequired => Self::Payment,
+ IncomingWebhookEvent::EventNotSupported => Self::Payment,
IncomingWebhookEvent::RefundSuccess => Self::Refund,
IncomingWebhookEvent::RefundFailure => Self::Refund,
IncomingWebhookEvent::DisputeOpened => Self::Dispute,
diff --git a/crates/router/src/compatibility/stripe/payment_intents/types.rs b/crates/router/src/compatibility/stripe/payment_intents/types.rs
index 2af6bfddbfb..648170e5cf9 100644
--- a/crates/router/src/compatibility/stripe/payment_intents/types.rs
+++ b/crates/router/src/compatibility/stripe/payment_intents/types.rs
@@ -221,6 +221,7 @@ impl From<api_enums::IntentStatus> for StripePaymentStatus {
api_enums::IntentStatus::Failed => Self::Canceled,
api_enums::IntentStatus::Processing => Self::Processing,
api_enums::IntentStatus::RequiresCustomerAction => Self::RequiresAction,
+ api_enums::IntentStatus::RequiresMerchantAction => Self::RequiresAction,
api_enums::IntentStatus::RequiresPaymentMethod => Self::RequiresPaymentMethod,
api_enums::IntentStatus::RequiresConfirmation => Self::RequiresConfirmation,
api_enums::IntentStatus::RequiresCapture => Self::RequiresCapture,
diff --git a/crates/router/src/compatibility/stripe/setup_intents/types.rs b/crates/router/src/compatibility/stripe/setup_intents/types.rs
index d9e58f3fe5b..87f77220426 100644
--- a/crates/router/src/compatibility/stripe/setup_intents/types.rs
+++ b/crates/router/src/compatibility/stripe/setup_intents/types.rs
@@ -187,6 +187,7 @@ impl From<api_enums::IntentStatus> for StripeSetupStatus {
api_enums::IntentStatus::Failed => Self::Canceled,
api_enums::IntentStatus::Processing => Self::Processing,
api_enums::IntentStatus::RequiresCustomerAction => Self::RequiresAction,
+ api_enums::IntentStatus::RequiresMerchantAction => Self::RequiresAction,
api_enums::IntentStatus::RequiresPaymentMethod => Self::RequiresPaymentMethod,
api_enums::IntentStatus::RequiresConfirmation => Self::RequiresConfirmation,
api_enums::IntentStatus::RequiresCapture => {
diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs
index 70833e20cbd..d27aa711e9a 100644
--- a/crates/router/src/configs/settings.rs
+++ b/crates/router/src/configs/settings.rs
@@ -255,6 +255,7 @@ pub struct Connectors {
pub bluesnap: ConnectorParams,
pub braintree: ConnectorParams,
pub checkout: ConnectorParams,
+ pub coinbase: ConnectorParams,
pub cybersource: ConnectorParams,
pub dlocal: ConnectorParams,
pub fiserv: ConnectorParams,
@@ -263,6 +264,7 @@ pub struct Connectors {
pub mollie: ConnectorParams,
pub multisafepay: ConnectorParams,
pub nuvei: ConnectorParams,
+ pub opennode: ConnectorParams,
pub paypal: ConnectorParams,
pub payu: ConnectorParams,
pub rapyd: ConnectorParams,
diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs
index 4a3299daffe..9f00f498610 100644
--- a/crates/router/src/connector.rs
+++ b/crates/router/src/connector.rs
@@ -7,6 +7,7 @@ pub mod bambora;
pub mod bluesnap;
pub mod braintree;
pub mod checkout;
+pub mod coinbase;
pub mod cybersource;
pub mod dlocal;
pub mod fiserv;
@@ -14,6 +15,7 @@ pub mod globalpay;
pub mod klarna;
pub mod multisafepay;
pub mod nuvei;
+pub mod opennode;
pub mod paypal;
pub mod payu;
pub mod rapyd;
@@ -29,8 +31,9 @@ pub mod mollie;
pub use self::{
aci::Aci, adyen::Adyen, airwallex::Airwallex, applepay::Applepay,
authorizedotnet::Authorizedotnet, bambora::Bambora, bluesnap::Bluesnap, braintree::Braintree,
- checkout::Checkout, cybersource::Cybersource, dlocal::Dlocal, fiserv::Fiserv,
- globalpay::Globalpay, klarna::Klarna, mollie::Mollie, multisafepay::Multisafepay, nuvei::Nuvei,
- paypal::Paypal, payu::Payu, rapyd::Rapyd, shift4::Shift4, stripe::Stripe, trustpay::Trustpay,
- worldline::Worldline, worldpay::Worldpay,
+ checkout::Checkout, coinbase::Coinbase, cybersource::Cybersource, dlocal::Dlocal,
+ fiserv::Fiserv, globalpay::Globalpay, klarna::Klarna, mollie::Mollie,
+ multisafepay::Multisafepay, nuvei::Nuvei, opennode::Opennode, paypal::Paypal, payu::Payu,
+ rapyd::Rapyd, shift4::Shift4, stripe::Stripe, trustpay::Trustpay, worldline::Worldline,
+ worldpay::Worldpay,
};
diff --git a/crates/router/src/connector/aci/transformers.rs b/crates/router/src/connector/aci/transformers.rs
index 47702ce119a..644d148b34f 100644
--- a/crates/router/src/connector/aci/transformers.rs
+++ b/crates/router/src/connector/aci/transformers.rs
@@ -111,6 +111,11 @@ impl TryFrom<&types::PaymentsAuthorizeRouterData> for AciPaymentsRequest {
api::PaymentMethodData::PayLater(_) => PaymentDetails::Klarna,
api::PaymentMethodData::Wallet(_) => PaymentDetails::Wallet,
api::PaymentMethodData::BankRedirect(_) => PaymentDetails::BankRedirect,
+ api::PaymentMethodData::Crypto(_) => Err(errors::ConnectorError::NotSupported {
+ payment_method: format!("{:?}", item.payment_method),
+ connector: "Aci",
+ payment_experience: api_models::enums::PaymentExperience::RedirectToUrl.to_string(),
+ })?,
};
let auth = AciAuthType::try_from(&item.connector_auth_type)?;
diff --git a/crates/router/src/connector/adyen/transformers.rs b/crates/router/src/connector/adyen/transformers.rs
index ff2daf137e3..1be3d1dc161 100644
--- a/crates/router/src/connector/adyen/transformers.rs
+++ b/crates/router/src/connector/adyen/transformers.rs
@@ -431,6 +431,14 @@ impl<'a> TryFrom<&types::PaymentsAuthorizeRouterData> for AdyenPaymentRequest<'a
storage_models::enums::PaymentMethod::BankRedirect => {
get_bank_redirect_specific_payment_data(item)
}
+ storage_models::enums::PaymentMethod::Crypto => {
+ Err(errors::ConnectorError::NotSupported {
+ payment_method: format!("{:?}", item.payment_method),
+ connector: "Adyen",
+ payment_experience: api_models::enums::PaymentExperience::RedirectToUrl
+ .to_string(),
+ })?
+ }
}
}
}
@@ -645,6 +653,11 @@ fn get_payment_method_data<'a>(
}
}
}
+ api::PaymentMethodData::Crypto(_) => Err(errors::ConnectorError::NotSupported {
+ payment_method: format!("{:?}", item.payment_method),
+ connector: "Adyen",
+ payment_experience: api_models::enums::PaymentExperience::RedirectToUrl.to_string(),
+ })?,
}
}
diff --git a/crates/router/src/connector/authorizedotnet/transformers.rs b/crates/router/src/connector/authorizedotnet/transformers.rs
index 40c29a1b9dc..e8da467c383 100644
--- a/crates/router/src/connector/authorizedotnet/transformers.rs
+++ b/crates/router/src/connector/authorizedotnet/transformers.rs
@@ -68,11 +68,12 @@ enum PaymentDetails {
BankRedirect,
}
-impl From<api_models::payments::PaymentMethodData> for PaymentDetails {
- fn from(value: api_models::payments::PaymentMethodData) -> Self {
+impl TryFrom<api_models::payments::PaymentMethodData> for PaymentDetails {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(value: api_models::payments::PaymentMethodData) -> Result<Self, Self::Error> {
match value {
api::PaymentMethodData::Card(ref ccard) => {
- Self::CreditCard(CreditCardDetails {
+ Ok(Self::CreditCard(CreditCardDetails {
card_number: ccard.card_number.clone(),
// expiration_date: format!("{expiry_year}-{expiry_month}").into(),
expiration_date: ccard
@@ -81,11 +82,16 @@ impl From<api_models::payments::PaymentMethodData> for PaymentDetails {
.zip(ccard.card_exp_year.clone())
.map(|(expiry_month, expiry_year)| format!("{expiry_year}-{expiry_month}")),
card_code: Some(ccard.card_cvc.clone()),
- })
+ }))
}
- api::PaymentMethodData::PayLater(_) => Self::Klarna,
- api::PaymentMethodData::Wallet(_) => Self::Wallet,
- api::PaymentMethodData::BankRedirect(_) => Self::BankRedirect,
+ api::PaymentMethodData::PayLater(_) => Ok(Self::Klarna),
+ api::PaymentMethodData::Wallet(_) => Ok(Self::Wallet),
+ api::PaymentMethodData::BankRedirect(_) => Ok(Self::BankRedirect),
+ api::PaymentMethodData::Crypto(_) => Err(errors::ConnectorError::NotSupported {
+ payment_method: format!("{value:?}"),
+ connector: "AuthorizeDotNet",
+ payment_experience: api_models::enums::PaymentExperience::RedirectToUrl.to_string(),
+ })?,
}
}
}
@@ -159,7 +165,7 @@ impl From<enums::CaptureMethod> for AuthorizationType {
impl TryFrom<&types::PaymentsAuthorizeRouterData> for CreateTransactionRequest {
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(item: &types::PaymentsAuthorizeRouterData) -> Result<Self, Self::Error> {
- let payment_details = item.request.payment_method_data.clone().into();
+ let payment_details = PaymentDetails::try_from(item.request.payment_method_data.clone())?;
let authorization_indicator_type =
item.request.capture_method.map(|c| AuthorizationIndicator {
authorization_indicator: c.into(),
diff --git a/crates/router/src/connector/checkout/transformers.rs b/crates/router/src/connector/checkout/transformers.rs
index a2d144bcc0d..a9d5eef4fa3 100644
--- a/crates/router/src/connector/checkout/transformers.rs
+++ b/crates/router/src/connector/checkout/transformers.rs
@@ -72,7 +72,8 @@ impl TryFrom<&types::PaymentsAuthorizeRouterData> for PaymentsRequest {
api::PaymentMethodData::Card(ref ccard) => Some(ccard),
api::PaymentMethodData::Wallet(_)
| api::PaymentMethodData::PayLater(_)
- | api::PaymentMethodData::BankRedirect(_) => None,
+ | api::PaymentMethodData::BankRedirect(_)
+ | api::PaymentMethodData::Crypto(_) => None,
};
let three_ds = match item.auth_type {
diff --git a/crates/router/src/connector/coinbase.rs b/crates/router/src/connector/coinbase.rs
new file mode 100644
index 00000000000..56aa415c628
--- /dev/null
+++ b/crates/router/src/connector/coinbase.rs
@@ -0,0 +1,570 @@
+mod transformers;
+
+use std::fmt::Debug;
+
+use common_utils::{crypto, ext_traits::ByteSliceExt};
+use error_stack::{IntoReport, ResultExt};
+use transformers as coinbase;
+
+use self::coinbase::CoinbaseWebhookDetails;
+use super::utils;
+use crate::{
+ configs::settings,
+ core::errors::{self, CustomResult},
+ db, headers,
+ services::{self, ConnectorIntegration},
+ types::{
+ self,
+ api::{self, ConnectorCommon, ConnectorCommonExt},
+ ErrorResponse, Response,
+ },
+ utils::{BytesExt, Encode},
+};
+
+#[derive(Debug, Clone)]
+pub struct Coinbase;
+
+impl api::Payment for Coinbase {}
+impl api::PaymentSession for Coinbase {}
+impl api::ConnectorAccessToken for Coinbase {}
+impl api::PreVerify for Coinbase {}
+impl api::PaymentAuthorize for Coinbase {}
+impl api::PaymentSync for Coinbase {}
+impl api::PaymentCapture for Coinbase {}
+impl api::PaymentVoid for Coinbase {}
+impl api::Refund for Coinbase {}
+impl api::RefundExecute for Coinbase {}
+impl api::RefundSync for Coinbase {}
+
+impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Coinbase
+where
+ Self: ConnectorIntegration<Flow, Request, Response>,
+{
+ fn build_headers(
+ &self,
+ req: &types::RouterData<Flow, Request, Response>,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ let mut header = vec![
+ (
+ headers::CONTENT_TYPE.to_string(),
+ self.common_get_content_type().to_string(),
+ ),
+ (headers::X_CC_VERSION.to_string(), "2018-03-22".to_string()),
+ ];
+ let mut api_key = self.get_auth_header(&req.connector_auth_type)?;
+ header.append(&mut api_key);
+ Ok(header)
+ }
+}
+
+impl ConnectorCommon for Coinbase {
+ fn id(&self) -> &'static str {
+ "coinbase"
+ }
+
+ fn common_get_content_type(&self) -> &'static str {
+ "application/json"
+ }
+
+ fn base_url<'a>(&self, connectors: &'a settings::Connectors) -> &'a str {
+ connectors.coinbase.base_url.as_ref()
+ }
+
+ fn get_auth_header(
+ &self,
+ auth_type: &types::ConnectorAuthType,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ let auth: coinbase::CoinbaseAuthType = coinbase::CoinbaseAuthType::try_from(auth_type)
+ .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+ Ok(vec![(headers::X_CC_API_KEY.to_string(), auth.api_key)])
+ }
+
+ fn build_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ let response: coinbase::CoinbaseErrorResponse = res
+ .response
+ .parse_struct("CoinbaseErrorResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+
+ Ok(ErrorResponse {
+ status_code: res.status_code,
+ code: response.code,
+ message: response.message,
+ reason: response.reason,
+ })
+ }
+}
+
+impl ConnectorIntegration<api::Session, types::PaymentsSessionData, types::PaymentsResponseData>
+ for Coinbase
+{
+ //TODO: implement sessions flow
+}
+
+impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, types::AccessToken>
+ for Coinbase
+{
+}
+
+impl ConnectorIntegration<api::Verify, types::VerifyRequestData, types::PaymentsResponseData>
+ for Coinbase
+{
+}
+
+impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::PaymentsResponseData>
+ for Coinbase
+{
+ fn get_headers(
+ &self,
+ req: &types::PaymentsAuthorizeRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::PaymentsAuthorizeRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Ok(format!("{}/charges", self.base_url(_connectors)))
+ }
+
+ fn get_request_body(
+ &self,
+ req: &types::PaymentsAuthorizeRouterData,
+ ) -> CustomResult<Option<String>, errors::ConnectorError> {
+ let req_obj = coinbase::CoinbasePaymentsRequest::try_from(req)?;
+ let coinbase_req =
+ Encode::<coinbase::CoinbasePaymentsRequest>::encode_to_string_of_json(&req_obj)
+ .change_context(errors::ConnectorError::RequestEncodingFailed)?;
+ Ok(Some(coinbase_req))
+ }
+
+ fn build_request(
+ &self,
+ req: &types::PaymentsAuthorizeRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Post)
+ .url(&types::PaymentsAuthorizeType::get_url(
+ self, req, connectors,
+ )?)
+ .headers(types::PaymentsAuthorizeType::get_headers(
+ self, req, connectors,
+ )?)
+ .body(types::PaymentsAuthorizeType::get_request_body(self, req)?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::PaymentsAuthorizeRouterData,
+ res: Response,
+ ) -> CustomResult<types::PaymentsAuthorizeRouterData, errors::ConnectorError> {
+ let response: coinbase::CoinbasePaymentsResponse = res
+ .response
+ .parse_struct("Coinbase PaymentsAuthorizeResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsResponseData>
+ for Coinbase
+{
+ fn get_headers(
+ &self,
+ req: &types::PaymentsSyncRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::PaymentsSyncRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ let connector_id = _req
+ .request
+ .connector_transaction_id
+ .get_connector_transaction_id()
+ .change_context(errors::ConnectorError::MissingConnectorTransactionID)?;
+ Ok(format!(
+ "{}/charges/{}",
+ self.base_url(_connectors),
+ connector_id
+ ))
+ }
+
+ fn build_request(
+ &self,
+ req: &types::PaymentsSyncRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Get)
+ .url(&types::PaymentsSyncType::get_url(self, req, connectors)?)
+ .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::PaymentsSyncRouterData,
+ res: Response,
+ ) -> CustomResult<types::PaymentsSyncRouterData, errors::ConnectorError> {
+ let response: coinbase::CoinbasePaymentsResponse = res
+ .response
+ .parse_struct("coinbase PaymentsSyncResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::PaymentsResponseData>
+ for Coinbase
+{
+ fn get_headers(
+ &self,
+ req: &types::PaymentsCaptureRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::PaymentsCaptureRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn get_request_body(
+ &self,
+ _req: &types::PaymentsCaptureRouterData,
+ ) -> CustomResult<Option<String>, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into())
+ }
+
+ fn build_request(
+ &self,
+ req: &types::PaymentsCaptureRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Post)
+ .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?)
+ .headers(types::PaymentsCaptureType::get_headers(
+ self, req, connectors,
+ )?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::PaymentsCaptureRouterData,
+ res: Response,
+ ) -> CustomResult<types::PaymentsCaptureRouterData, errors::ConnectorError> {
+ let response: coinbase::CoinbasePaymentsResponse = res
+ .response
+ .parse_struct("Coinbase PaymentsCaptureResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+impl ConnectorIntegration<api::Void, types::PaymentsCancelData, types::PaymentsResponseData>
+ for Coinbase
+{
+}
+
+impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsResponseData>
+ for Coinbase
+{
+ fn get_headers(
+ &self,
+ req: &types::RefundsRouterData<api::Execute>,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::RefundsRouterData<api::Execute>,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn get_request_body(
+ &self,
+ req: &types::RefundsRouterData<api::Execute>,
+ ) -> CustomResult<Option<String>, errors::ConnectorError> {
+ let req_obj = coinbase::CoinbaseRefundRequest::try_from(req)?;
+ let coinbase_req =
+ Encode::<coinbase::CoinbaseRefundRequest>::encode_to_string_of_json(&req_obj)
+ .change_context(errors::ConnectorError::RequestEncodingFailed)?;
+ Ok(Some(coinbase_req))
+ }
+
+ fn build_request(
+ &self,
+ req: &types::RefundsRouterData<api::Execute>,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ let request = services::RequestBuilder::new()
+ .method(services::Method::Post)
+ .url(&types::RefundExecuteType::get_url(self, req, connectors)?)
+ .headers(types::RefundExecuteType::get_headers(
+ self, req, connectors,
+ )?)
+ .body(types::RefundExecuteType::get_request_body(self, req)?)
+ .build();
+ Ok(Some(request))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::RefundsRouterData<api::Execute>,
+ res: Response,
+ ) -> CustomResult<types::RefundsRouterData<api::Execute>, errors::ConnectorError> {
+ let response: coinbase::RefundResponse = res
+ .response
+ .parse_struct("coinbase RefundResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponseData> for Coinbase {
+ fn get_headers(
+ &self,
+ req: &types::RefundSyncRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::RefundSyncRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn build_request(
+ &self,
+ req: &types::RefundSyncRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Get)
+ .url(&types::RefundSyncType::get_url(self, req, connectors)?)
+ .headers(types::RefundSyncType::get_headers(self, req, connectors)?)
+ .body(types::RefundSyncType::get_request_body(self, req)?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::RefundSyncRouterData,
+ res: Response,
+ ) -> CustomResult<types::RefundSyncRouterData, errors::ConnectorError> {
+ let response: coinbase::RefundResponse = res
+ .response
+ .parse_struct("coinbase RefundSyncResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+#[async_trait::async_trait]
+impl api::IncomingWebhook for Coinbase {
+ fn get_webhook_source_verification_algorithm(
+ &self,
+ _request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<Box<dyn crypto::VerifySignature + Send>, errors::ConnectorError> {
+ Ok(Box::new(crypto::HmacSha256))
+ }
+
+ fn get_webhook_source_verification_signature(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<Vec<u8>, errors::ConnectorError> {
+ let base64_signature =
+ utils::get_header_key_value("X-CC-Webhook-Signature", request.headers)?;
+ hex::decode(base64_signature)
+ .into_report()
+ .change_context(errors::ConnectorError::WebhookSourceVerificationFailed)
+ }
+
+ fn get_webhook_source_verification_message(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ _merchant_id: &str,
+ _secret: &[u8],
+ ) -> CustomResult<Vec<u8>, errors::ConnectorError> {
+ let message = std::str::from_utf8(request.body)
+ .into_report()
+ .change_context(errors::ConnectorError::WebhookSourceVerificationFailed)?;
+ Ok(message.to_string().into_bytes())
+ }
+
+ async fn get_webhook_source_verification_merchant_secret(
+ &self,
+ db: &dyn db::StorageInterface,
+ merchant_id: &str,
+ ) -> CustomResult<Vec<u8>, errors::ConnectorError> {
+ let key = format!("whsec_verification_{}_{}", self.id(), merchant_id);
+ let secret = db
+ .get_key(&key)
+ .await
+ .change_context(errors::ConnectorError::WebhookVerificationSecretNotFound)?;
+
+ Ok(secret)
+ }
+
+ fn get_webhook_object_reference_id(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> {
+ let notif: CoinbaseWebhookDetails = request
+ .body
+ .parse_struct("CoinbaseWebhookDetails")
+ .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?;
+ Ok(api_models::webhooks::ObjectReferenceId::PaymentId(
+ api_models::payments::PaymentIdType::ConnectorTransactionId(notif.event.data.id),
+ ))
+ }
+
+ fn get_webhook_event_type(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<api::IncomingWebhookEvent, errors::ConnectorError> {
+ let notif: CoinbaseWebhookDetails = request
+ .body
+ .parse_struct("CoinbaseWebhookDetails")
+ .change_context(errors::ConnectorError::WebhookEventTypeNotFound)?;
+ match notif.event.event_type {
+ coinbase::WebhookEventType::Confirmed | coinbase::WebhookEventType::Resolved => {
+ Ok(api::IncomingWebhookEvent::PaymentIntentSuccess)
+ }
+ coinbase::WebhookEventType::Failed => {
+ Ok(api::IncomingWebhookEvent::PaymentActionRequired)
+ }
+ coinbase::WebhookEventType::Pending => {
+ Ok(api::IncomingWebhookEvent::PaymentIntentProcessing)
+ }
+ _ => Ok(api::IncomingWebhookEvent::EventNotSupported),
+ }
+ }
+
+ fn get_webhook_resource_object(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<serde_json::Value, errors::ConnectorError> {
+ let notif: CoinbaseWebhookDetails = request
+ .body
+ .parse_struct("CoinbaseWebhookDetails")
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
+ Encode::<CoinbaseWebhookDetails>::encode_to_value(¬if.event)
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)
+ }
+}
diff --git a/crates/router/src/connector/coinbase/transformers.rs b/crates/router/src/connector/coinbase/transformers.rs
new file mode 100644
index 00000000000..f97edf50ae6
--- /dev/null
+++ b/crates/router/src/connector/coinbase/transformers.rs
@@ -0,0 +1,405 @@
+use std::collections::HashMap;
+
+use serde::{Deserialize, Serialize};
+
+use crate::{
+ connector::utils::{self, AddressDetailsData, PaymentsAuthorizeRequestData, RouterData},
+ core::errors,
+ pii::Secret,
+ services,
+ types::{self, api, storage::enums},
+};
+
+#[derive(Debug, Default, Eq, PartialEq, Serialize)]
+pub struct LocalPrice {
+ pub amount: String,
+ pub currency: String,
+}
+
+#[derive(Debug, Default, Eq, PartialEq, Serialize, Deserialize)]
+pub struct Metadata {
+ pub customer_id: String,
+ pub customer_name: String,
+}
+
+#[derive(Default, Debug, Serialize, Eq, PartialEq)]
+pub struct CoinbasePaymentsRequest {
+ pub name: Secret<String>,
+ pub description: String,
+ pub pricing_type: String,
+ pub local_price: LocalPrice,
+ pub redirect_url: String,
+ pub cancel_url: String,
+}
+
+impl TryFrom<&types::PaymentsAuthorizeRouterData> for CoinbasePaymentsRequest {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(item: &types::PaymentsAuthorizeRouterData) -> Result<Self, Self::Error> {
+ get_crypto_specific_payment_data(item)
+ }
+}
+
+// Auth Struct
+pub struct CoinbaseAuthType {
+ pub(super) api_key: String,
+}
+
+impl TryFrom<&types::ConnectorAuthType> for CoinbaseAuthType {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(_auth_type: &types::ConnectorAuthType) -> Result<Self, Self::Error> {
+ if let types::ConnectorAuthType::HeaderKey { api_key } = _auth_type {
+ Ok(Self {
+ api_key: api_key.to_string(),
+ })
+ } else {
+ Err(errors::ConnectorError::FailedToObtainAuthType.into())
+ }
+ }
+}
+// PaymentsResponse
+#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "UPPERCASE")]
+pub enum CoinbasePaymentStatus {
+ New,
+ #[default]
+ Pending,
+ Completed,
+ Expired,
+ Unresolved,
+ Resolved,
+ Cancelled,
+ #[serde(rename = "PENDING REFUND")]
+ PendingRefund,
+ Refunded,
+}
+
+impl From<CoinbasePaymentStatus> for enums::AttemptStatus {
+ fn from(item: CoinbasePaymentStatus) -> Self {
+ match item {
+ CoinbasePaymentStatus::Completed | CoinbasePaymentStatus::Resolved => Self::Charged,
+ CoinbasePaymentStatus::Expired => Self::Failure,
+ CoinbasePaymentStatus::New => Self::AuthenticationPending,
+ CoinbasePaymentStatus::Unresolved => Self::Unresolved,
+ _ => Self::Pending,
+ }
+ }
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, strum::Display)]
+#[serde(rename_all = "UPPERCASE")]
+#[strum(serialize_all = "UPPERCASE")]
+pub enum UnResolvedContext {
+ Underpaid,
+ Overpaid,
+ Delayed,
+}
+
+#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
+pub struct Timeline {
+ status: CoinbasePaymentStatus,
+ context: Option<UnResolvedContext>,
+ time: String,
+ pub payment: Option<TimelinePayment>,
+}
+
+#[derive(Default, Debug, Serialize, Deserialize)]
+pub struct CoinbasePaymentsResponse {
+ // status: CoinbasePaymentStatus,
+ // id: String,
+ data: CoinbasePaymentResponseData,
+}
+
+impl<F, T>
+ TryFrom<types::ResponseRouterData<F, CoinbasePaymentsResponse, T, types::PaymentsResponseData>>
+ for types::RouterData<F, T, types::PaymentsResponseData>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: types::ResponseRouterData<
+ F,
+ CoinbasePaymentsResponse,
+ T,
+ types::PaymentsResponseData,
+ >,
+ ) -> Result<Self, Self::Error> {
+ let form_fields = HashMap::new();
+ let redirection_data = services::RedirectForm {
+ endpoint: item.response.data.hosted_url.to_string(),
+ method: services::Method::Get,
+ form_fields,
+ };
+ let timeline = item
+ .response
+ .data
+ .timeline
+ .last()
+ .ok_or_else(|| errors::ConnectorError::ResponseHandlingFailed)?
+ .clone();
+ let connector_id = types::ResponseId::ConnectorTransactionId(item.response.data.id);
+ let attempt_status = timeline.status.clone();
+ let response_data = timeline.context.map_or(
+ Ok(types::PaymentsResponseData::TransactionResponse {
+ resource_id: connector_id.clone(),
+ redirection_data: Some(redirection_data),
+ mandate_reference: None,
+ connector_metadata: None,
+ }),
+ |context| {
+ Ok(types::PaymentsResponseData::TransactionUnresolvedResponse{
+ resource_id: connector_id,
+ reason: Some(api::enums::UnresolvedResponseReason {
+ code: context.to_string(),
+ message: "Please check the transaction in coinbase dashboard and resolve manually"
+ .to_string(),
+ })
+ })
+ },
+ );
+ Ok(Self {
+ status: enums::AttemptStatus::from(attempt_status),
+ response: response_data,
+ ..item.data
+ })
+ }
+}
+
+// REFUND :
+// Type definition for RefundRequest
+#[derive(Default, Debug, Serialize)]
+pub struct CoinbaseRefundRequest {}
+
+impl<F> TryFrom<&types::RefundsRouterData<F>> for CoinbaseRefundRequest {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(_item: &types::RefundsRouterData<F>) -> Result<Self, Self::Error> {
+ Err(errors::ConnectorError::NotImplemented("try_from RefundsRouterData".to_string()).into())
+ }
+}
+
+// Type definition for Refund Response
+
+#[allow(dead_code)]
+#[derive(Debug, Serialize, Default, Deserialize, Clone)]
+pub enum RefundStatus {
+ Succeeded,
+ Failed,
+ #[default]
+ Processing,
+}
+
+impl From<RefundStatus> for enums::RefundStatus {
+ fn from(item: RefundStatus) -> Self {
+ match item {
+ RefundStatus::Succeeded => Self::Success,
+ RefundStatus::Failed => Self::Failure,
+ RefundStatus::Processing => Self::Pending,
+ }
+ }
+}
+
+#[derive(Default, Debug, Clone, Serialize, Deserialize)]
+pub struct RefundResponse {}
+
+impl TryFrom<types::RefundsResponseRouterData<api::Execute, RefundResponse>>
+ for types::RefundsRouterData<api::Execute>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ _item: types::RefundsResponseRouterData<api::Execute, RefundResponse>,
+ ) -> Result<Self, Self::Error> {
+ Err(errors::ConnectorError::NotImplemented(
+ "try_from RefundsResponseRouterData".to_string(),
+ )
+ .into())
+ }
+}
+
+impl TryFrom<types::RefundsResponseRouterData<api::RSync, RefundResponse>>
+ for types::RefundsRouterData<api::RSync>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ _item: types::RefundsResponseRouterData<api::RSync, RefundResponse>,
+ ) -> Result<Self, Self::Error> {
+ Err(errors::ConnectorError::NotImplemented(
+ "try_from RefundsResponseRouterData".to_string(),
+ )
+ .into())
+ }
+}
+
+#[derive(Default, Debug, Serialize, Deserialize, PartialEq)]
+pub struct CoinbaseErrorResponse {
+ pub code: String,
+ pub message: String,
+ pub reason: Option<String>,
+}
+
+#[derive(Default, Debug, Deserialize, PartialEq)]
+pub struct CoinbaseConnectorMeta {
+ pub pricing_type: String,
+}
+
+fn get_crypto_specific_payment_data(
+ item: &types::PaymentsAuthorizeRouterData,
+) -> Result<CoinbasePaymentsRequest, error_stack::Report<errors::ConnectorError>> {
+ let billing_address = item
+ .get_billing()?
+ .address
+ .as_ref()
+ .ok_or_else(utils::missing_field_err("billing.address"))?;
+ let name = billing_address.get_first_name()?.to_owned();
+ let description = item.get_description()?;
+ let connector_meta: CoinbaseConnectorMeta =
+ utils::to_connector_meta_from_secret(item.connector_meta_data.clone())?;
+ let pricing_type = connector_meta.pricing_type;
+ let local_price = get_local_price(item);
+ let redirect_url = item.request.get_return_url()?;
+ let cancel_url = item.request.get_return_url()?;
+
+ Ok(CoinbasePaymentsRequest {
+ name,
+ description,
+ pricing_type,
+ local_price,
+ redirect_url,
+ cancel_url,
+ })
+}
+
+fn get_local_price(item: &types::PaymentsAuthorizeRouterData) -> LocalPrice {
+ LocalPrice {
+ amount: format!("{:?}", item.request.amount),
+ currency: item.request.currency.to_string(),
+ }
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct CoinbaseWebhookDetails {
+ pub attempt_number: i64,
+ pub event: Event,
+ pub id: String,
+ pub scheduled_for: String,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct Event {
+ pub api_version: String,
+ pub created_at: String,
+ pub data: CoinbasePaymentResponseData,
+ pub id: String,
+ pub resource: String,
+ #[serde(rename = "type")]
+ pub event_type: WebhookEventType,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub enum WebhookEventType {
+ #[serde(rename = "charge:confirmed")]
+ Confirmed,
+ #[serde(rename = "charge:created")]
+ Created,
+ #[serde(rename = "charge:pending")]
+ Pending,
+ #[serde(rename = "charge:failed")]
+ Failed,
+ #[serde(rename = "charge:resolved")]
+ Resolved,
+}
+
+#[derive(Debug, Default, Serialize, Deserialize)]
+pub struct CoinbasePaymentResponseData {
+ pub id: String,
+ pub code: String,
+ pub name: String,
+ pub utxo: bool,
+ pub pricing: HashMap<String, OverpaymentAbsoluteThreshold>,
+ pub fee_rate: f64,
+ pub logo_url: String,
+ pub metadata: Metadata,
+ pub payments: Vec<PaymentElement>,
+ pub resource: String,
+ pub timeline: Vec<Timeline>,
+ pub pwcb_only: bool,
+ pub cancel_url: String,
+ pub created_at: String,
+ pub expires_at: String,
+ pub hosted_url: String,
+ pub brand_color: String,
+ pub description: String,
+ pub confirmed_at: Option<String>,
+ pub fees_settled: bool,
+ pub pricing_type: String,
+ pub redirect_url: String,
+ pub support_email: String,
+ pub brand_logo_url: String,
+ pub offchain_eligible: bool,
+ pub organization_name: String,
+ pub payment_threshold: PaymentThreshold,
+ pub coinbase_managed_merchant: bool,
+}
+
+#[derive(Debug, Serialize, Default, Deserialize)]
+pub struct PaymentThreshold {
+ pub overpayment_absolute_threshold: OverpaymentAbsoluteThreshold,
+ pub overpayment_relative_threshold: String,
+ pub underpayment_absolute_threshold: OverpaymentAbsoluteThreshold,
+ pub underpayment_relative_threshold: String,
+}
+
+#[derive(Debug, Clone, Serialize, Default, Deserialize, PartialEq, Eq)]
+pub struct OverpaymentAbsoluteThreshold {
+ pub amount: String,
+ pub currency: String,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct PaymentElement {
+ pub net: CoinbaseProcessingFee,
+ pub block: Block,
+ pub value: CoinbaseProcessingFee,
+ pub status: String,
+ pub network: String,
+ pub deposited: Deposited,
+ pub payment_id: String,
+ pub detected_at: String,
+ pub transaction_id: String,
+ pub coinbase_processing_fee: CoinbaseProcessingFee,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct Block {
+ pub hash: Option<String>,
+ pub height: Option<i64>,
+ pub confirmations: Option<i64>,
+ pub confirmations_required: Option<i64>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct CoinbaseProcessingFee {
+ pub local: Option<OverpaymentAbsoluteThreshold>,
+ pub crypto: OverpaymentAbsoluteThreshold,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct Deposited {
+ pub amount: Amount,
+ pub status: String,
+ pub destination: String,
+ pub exchange_rate: Option<serde_json::Value>,
+ pub autoconversion_status: String,
+ pub autoconversion_enabled: bool,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct Amount {
+ pub net: CoinbaseProcessingFee,
+ pub gross: CoinbaseProcessingFee,
+ pub coinbase_fee: CoinbaseProcessingFee,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
+pub struct TimelinePayment {
+ pub value: OverpaymentAbsoluteThreshold,
+ pub network: String,
+ pub transaction_id: String,
+}
diff --git a/crates/router/src/connector/opennode.rs b/crates/router/src/connector/opennode.rs
new file mode 100644
index 00000000000..6458f4413e5
--- /dev/null
+++ b/crates/router/src/connector/opennode.rs
@@ -0,0 +1,575 @@
+mod transformers;
+
+use std::fmt::Debug;
+
+use common_utils::crypto;
+use error_stack::{IntoReport, ResultExt};
+use transformers as opennode;
+
+use self::opennode::OpennodeWebhookDetails;
+use crate::{
+ configs::settings,
+ core::errors::{self, CustomResult},
+ db, headers,
+ services::{self, ConnectorIntegration},
+ types::{
+ self,
+ api::{self, ConnectorCommon, ConnectorCommonExt},
+ ErrorResponse, Response,
+ },
+ utils::{BytesExt, Encode},
+};
+
+#[derive(Debug, Clone)]
+pub struct Opennode;
+
+impl api::Payment for Opennode {}
+impl api::PaymentSession for Opennode {}
+impl api::ConnectorAccessToken for Opennode {}
+impl api::PreVerify for Opennode {}
+impl api::PaymentAuthorize for Opennode {}
+impl api::PaymentSync for Opennode {}
+impl api::PaymentCapture for Opennode {}
+impl api::PaymentVoid for Opennode {}
+impl api::Refund for Opennode {}
+impl api::RefundExecute for Opennode {}
+impl api::RefundSync for Opennode {}
+
+impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Opennode
+where
+ Self: ConnectorIntegration<Flow, Request, Response>,
+{
+ fn build_headers(
+ &self,
+ req: &types::RouterData<Flow, Request, Response>,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ let mut header = vec![
+ (
+ headers::CONTENT_TYPE.to_string(),
+ self.common_get_content_type().to_string(),
+ ),
+ (
+ headers::ACCEPT.to_string(),
+ self.common_get_content_type().to_string(),
+ ),
+ ];
+ let mut api_key = self.get_auth_header(&req.connector_auth_type)?;
+ header.append(&mut api_key);
+ Ok(header)
+ }
+}
+
+impl ConnectorCommon for Opennode {
+ fn id(&self) -> &'static str {
+ "opennode"
+ }
+
+ fn common_get_content_type(&self) -> &'static str {
+ "application/json"
+ }
+
+ fn base_url<'a>(&self, connectors: &'a settings::Connectors) -> &'a str {
+ connectors.opennode.base_url.as_ref()
+ }
+
+ fn get_auth_header(
+ &self,
+ auth_type: &types::ConnectorAuthType,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ let auth = opennode::OpennodeAuthType::try_from(auth_type)
+ .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+ Ok(vec![(headers::AUTHORIZATION.to_string(), auth.api_key)])
+ }
+
+ fn build_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ let response: opennode::OpennodeErrorResponse = res
+ .response
+ .parse_struct("OpennodeErrorResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+
+ Ok(ErrorResponse {
+ status_code: res.status_code,
+ code: response.code,
+ message: response.message,
+ reason: response.reason,
+ })
+ }
+}
+
+impl ConnectorIntegration<api::Session, types::PaymentsSessionData, types::PaymentsResponseData>
+ for Opennode
+{
+ //TODO: implement sessions flow
+}
+
+impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, types::AccessToken>
+ for Opennode
+{
+}
+
+impl ConnectorIntegration<api::Verify, types::VerifyRequestData, types::PaymentsResponseData>
+ for Opennode
+{
+}
+
+impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::PaymentsResponseData>
+ for Opennode
+{
+ fn get_headers(
+ &self,
+ req: &types::PaymentsAuthorizeRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::PaymentsAuthorizeRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Ok(format!("{}/v1/charges", self.base_url(_connectors)))
+ }
+
+ fn get_request_body(
+ &self,
+ req: &types::PaymentsAuthorizeRouterData,
+ ) -> CustomResult<Option<String>, errors::ConnectorError> {
+ let req_obj = opennode::OpennodePaymentsRequest::try_from(req)?;
+ let opennode_req =
+ Encode::<opennode::OpennodePaymentsRequest>::encode_to_string_of_json(&req_obj)
+ .change_context(errors::ConnectorError::RequestEncodingFailed)?;
+ Ok(Some(opennode_req))
+ }
+
+ fn build_request(
+ &self,
+ req: &types::PaymentsAuthorizeRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Post)
+ .url(&types::PaymentsAuthorizeType::get_url(
+ self, req, connectors,
+ )?)
+ .headers(types::PaymentsAuthorizeType::get_headers(
+ self, req, connectors,
+ )?)
+ .body(types::PaymentsAuthorizeType::get_request_body(self, req)?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::PaymentsAuthorizeRouterData,
+ res: Response,
+ ) -> CustomResult<types::PaymentsAuthorizeRouterData, errors::ConnectorError> {
+ let response: opennode::OpennodePaymentsResponse = res
+ .response
+ .parse_struct("Opennode PaymentsAuthorizeResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+impl ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsResponseData>
+ for Opennode
+{
+ fn get_headers(
+ &self,
+ req: &types::PaymentsSyncRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::PaymentsSyncRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ let connector_id = _req
+ .request
+ .connector_transaction_id
+ .get_connector_transaction_id()
+ .change_context(errors::ConnectorError::MissingConnectorTransactionID)?;
+ Ok(format!(
+ "{}/v2/charge/{}",
+ self.base_url(_connectors),
+ connector_id
+ ))
+ }
+
+ fn build_request(
+ &self,
+ req: &types::PaymentsSyncRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Get)
+ .url(&types::PaymentsSyncType::get_url(self, req, connectors)?)
+ .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::PaymentsSyncRouterData,
+ res: Response,
+ ) -> CustomResult<types::PaymentsSyncRouterData, errors::ConnectorError> {
+ let response: opennode::OpennodePaymentsResponse = res
+ .response
+ .parse_struct("opennode PaymentsSyncResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::PaymentsResponseData>
+ for Opennode
+{
+ fn get_headers(
+ &self,
+ req: &types::PaymentsCaptureRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::PaymentsCaptureRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn get_request_body(
+ &self,
+ _req: &types::PaymentsCaptureRouterData,
+ ) -> CustomResult<Option<String>, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into())
+ }
+
+ fn build_request(
+ &self,
+ req: &types::PaymentsCaptureRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Post)
+ .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?)
+ .headers(types::PaymentsCaptureType::get_headers(
+ self, req, connectors,
+ )?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::PaymentsCaptureRouterData,
+ res: Response,
+ ) -> CustomResult<types::PaymentsCaptureRouterData, errors::ConnectorError> {
+ let response: opennode::OpennodePaymentsResponse = res
+ .response
+ .parse_struct("Opennode PaymentsCaptureResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+impl ConnectorIntegration<api::Void, types::PaymentsCancelData, types::PaymentsResponseData>
+ for Opennode
+{
+}
+
+impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsResponseData>
+ for Opennode
+{
+ fn get_headers(
+ &self,
+ req: &types::RefundsRouterData<api::Execute>,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::RefundsRouterData<api::Execute>,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn get_request_body(
+ &self,
+ req: &types::RefundsRouterData<api::Execute>,
+ ) -> CustomResult<Option<String>, errors::ConnectorError> {
+ let req_obj = opennode::OpennodeRefundRequest::try_from(req)?;
+ let opennode_req =
+ Encode::<opennode::OpennodeRefundRequest>::encode_to_string_of_json(&req_obj)
+ .change_context(errors::ConnectorError::RequestEncodingFailed)?;
+ Ok(Some(opennode_req))
+ }
+
+ fn build_request(
+ &self,
+ req: &types::RefundsRouterData<api::Execute>,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ let request = services::RequestBuilder::new()
+ .method(services::Method::Post)
+ .url(&types::RefundExecuteType::get_url(self, req, connectors)?)
+ .headers(types::RefundExecuteType::get_headers(
+ self, req, connectors,
+ )?)
+ .body(types::RefundExecuteType::get_request_body(self, req)?)
+ .build();
+ Ok(Some(request))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::RefundsRouterData<api::Execute>,
+ res: Response,
+ ) -> CustomResult<types::RefundsRouterData<api::Execute>, errors::ConnectorError> {
+ let response: opennode::RefundResponse = res
+ .response
+ .parse_struct("opennode RefundResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+impl ConnectorIntegration<api::RSync, types::RefundsData, types::RefundsResponseData> for Opennode {
+ fn get_headers(
+ &self,
+ req: &types::RefundSyncRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Vec<(String, String)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &types::RefundSyncRouterData,
+ _connectors: &settings::Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn build_request(
+ &self,
+ req: &types::RefundSyncRouterData,
+ connectors: &settings::Connectors,
+ ) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
+ Ok(Some(
+ services::RequestBuilder::new()
+ .method(services::Method::Get)
+ .url(&types::RefundSyncType::get_url(self, req, connectors)?)
+ .headers(types::RefundSyncType::get_headers(self, req, connectors)?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &types::RefundSyncRouterData,
+ res: Response,
+ ) -> CustomResult<types::RefundSyncRouterData, errors::ConnectorError> {
+ let response: opennode::RefundResponse = res
+ .response
+ .parse_struct("opennode RefundSyncResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res)
+ }
+}
+
+#[async_trait::async_trait]
+impl api::IncomingWebhook for Opennode {
+ fn get_webhook_source_verification_algorithm(
+ &self,
+ _request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<Box<dyn crypto::VerifySignature + Send>, errors::ConnectorError> {
+ Ok(Box::new(crypto::HmacSha256))
+ }
+
+ fn get_webhook_source_verification_signature(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<Vec<u8>, errors::ConnectorError> {
+ let notif = serde_urlencoded::from_bytes::<OpennodeWebhookDetails>(request.body)
+ .into_report()
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
+ let base64_signature = notif.hashed_order;
+ hex::decode(base64_signature)
+ .into_report()
+ .change_context(errors::ConnectorError::WebhookSourceVerificationFailed)
+ }
+
+ fn get_webhook_source_verification_message(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ _merchant_id: &str,
+ _secret: &[u8],
+ ) -> CustomResult<Vec<u8>, errors::ConnectorError> {
+ let message = std::str::from_utf8(request.body)
+ .into_report()
+ .change_context(errors::ConnectorError::ParsingFailed)?;
+ Ok(message.to_string().into_bytes())
+ }
+
+ async fn get_webhook_source_verification_merchant_secret(
+ &self,
+ db: &dyn db::StorageInterface,
+ merchant_id: &str,
+ ) -> CustomResult<Vec<u8>, errors::ConnectorError> {
+ let key = format!("whsec_verification_{}_{}", self.id(), merchant_id);
+ let secret = db
+ .get_key(&key)
+ .await
+ .change_context(errors::ConnectorError::WebhookVerificationSecretNotFound)?;
+
+ Ok(secret)
+ }
+
+ fn get_webhook_object_reference_id(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> {
+ let notif = serde_urlencoded::from_bytes::<OpennodeWebhookDetails>(request.body)
+ .into_report()
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
+ Ok(api_models::webhooks::ObjectReferenceId::PaymentId(
+ api_models::payments::PaymentIdType::ConnectorTransactionId(notif.id),
+ ))
+ }
+
+ fn get_webhook_event_type(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<api::IncomingWebhookEvent, errors::ConnectorError> {
+ let notif = serde_urlencoded::from_bytes::<OpennodeWebhookDetails>(request.body)
+ .into_report()
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
+
+ match notif.status {
+ opennode::OpennodePaymentStatus::Paid => {
+ Ok(api::IncomingWebhookEvent::PaymentIntentSuccess)
+ }
+ opennode::OpennodePaymentStatus::Underpaid
+ | opennode::OpennodePaymentStatus::Expired => {
+ Ok(api::IncomingWebhookEvent::PaymentActionRequired)
+ }
+ opennode::OpennodePaymentStatus::Processing => {
+ Ok(api::IncomingWebhookEvent::PaymentIntentProcessing)
+ }
+ opennode::OpennodePaymentStatus::Refunded => {
+ Ok(api::IncomingWebhookEvent::RefundSuccess)
+ }
+ _ => Ok(api::IncomingWebhookEvent::EventNotSupported),
+ }
+ }
+
+ fn get_webhook_resource_object(
+ &self,
+ request: &api::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<serde_json::Value, errors::ConnectorError> {
+ let notif = serde_urlencoded::from_bytes::<OpennodeWebhookDetails>(request.body)
+ .into_report()
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
+ Encode::<OpennodeWebhookDetails>::encode_to_value(¬if.status)
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)
+ }
+}
diff --git a/crates/router/src/connector/opennode/transformers.rs b/crates/router/src/connector/opennode/transformers.rs
new file mode 100644
index 00000000000..f951b8eb92c
--- /dev/null
+++ b/crates/router/src/connector/opennode/transformers.rs
@@ -0,0 +1,256 @@
+use std::collections::HashMap;
+
+use serde::{Deserialize, Serialize};
+
+use crate::{
+ connector::utils::{PaymentsAuthorizeRequestData, RouterData},
+ core::errors,
+ services,
+ types::{self, api, storage::enums},
+};
+
+//TODO: Fill the struct with respective fields
+#[derive(Default, Debug, Serialize, Eq, PartialEq)]
+pub struct OpennodePaymentsRequest {
+ amount: i64,
+ currency: String,
+ description: String,
+ auto_settle: bool,
+ success_url: String,
+ callback_url: String,
+}
+
+impl TryFrom<&types::PaymentsAuthorizeRouterData> for OpennodePaymentsRequest {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(item: &types::PaymentsAuthorizeRouterData) -> Result<Self, Self::Error> {
+ get_crypto_specific_payment_data(item)
+ }
+}
+
+//TODO: Fill the struct with respective fields
+// Auth Struct
+pub struct OpennodeAuthType {
+ pub(super) api_key: String,
+}
+
+impl TryFrom<&types::ConnectorAuthType> for OpennodeAuthType {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(auth_type: &types::ConnectorAuthType) -> Result<Self, Self::Error> {
+ match auth_type {
+ types::ConnectorAuthType::HeaderKey { api_key } => Ok(Self {
+ api_key: api_key.to_string(),
+ }),
+ _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()),
+ }
+ }
+}
+// PaymentsResponse
+//TODO: Append the remaining status flags
+#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "lowercase")]
+pub enum OpennodePaymentStatus {
+ Unpaid,
+ Paid,
+ Expired,
+ #[default]
+ Processing,
+ Underpaid,
+ Refunded,
+}
+
+impl From<OpennodePaymentStatus> for enums::AttemptStatus {
+ fn from(item: OpennodePaymentStatus) -> Self {
+ match item {
+ OpennodePaymentStatus::Unpaid => Self::AuthenticationPending,
+ OpennodePaymentStatus::Paid => Self::Charged,
+ OpennodePaymentStatus::Expired => Self::Failure,
+ OpennodePaymentStatus::Underpaid => Self::Unresolved,
+ _ => Self::Pending,
+ }
+ }
+}
+
+#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
+pub struct OpennodePaymentsResponseData {
+ id: String,
+ hosted_checkout_url: String,
+ status: OpennodePaymentStatus,
+}
+
+//TODO: Fill the struct with respective fields
+#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
+pub struct OpennodePaymentsResponse {
+ data: OpennodePaymentsResponseData,
+}
+
+impl<F, T>
+ TryFrom<types::ResponseRouterData<F, OpennodePaymentsResponse, T, types::PaymentsResponseData>>
+ for types::RouterData<F, T, types::PaymentsResponseData>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: types::ResponseRouterData<
+ F,
+ OpennodePaymentsResponse,
+ T,
+ types::PaymentsResponseData,
+ >,
+ ) -> Result<Self, Self::Error> {
+ let form_fields = HashMap::new();
+ let redirection_data = services::RedirectForm {
+ endpoint: item.response.data.hosted_checkout_url.to_string(),
+ method: services::Method::Get,
+ form_fields,
+ };
+ let connector_id = types::ResponseId::ConnectorTransactionId(item.response.data.id);
+ let attempt_status = item.response.data.status;
+ let response_data = if attempt_status != OpennodePaymentStatus::Underpaid {
+ Ok(types::PaymentsResponseData::TransactionResponse {
+ resource_id: connector_id,
+ redirection_data: Some(redirection_data),
+ mandate_reference: None,
+ connector_metadata: None,
+ })
+ } else {
+ Ok(types::PaymentsResponseData::TransactionUnresolvedResponse {
+ resource_id: connector_id,
+ reason: Some(api::enums::UnresolvedResponseReason {
+ code: "UNDERPAID".to_string(),
+ message:
+ "Please check the transaction in opennode dashboard and resolve manually"
+ .to_string(),
+ }),
+ })
+ };
+ Ok(Self {
+ status: enums::AttemptStatus::from(attempt_status),
+ response: response_data,
+ ..item.data
+ })
+ }
+}
+
+//TODO: Fill the struct with respective fields
+// REFUND :
+// Type definition for RefundRequest
+#[derive(Default, Debug, Serialize)]
+pub struct OpennodeRefundRequest {
+ pub amount: i64,
+}
+
+impl<F> TryFrom<&types::RefundsRouterData<F>> for OpennodeRefundRequest {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(item: &types::RefundsRouterData<F>) -> Result<Self, Self::Error> {
+ Ok(Self {
+ amount: item.request.amount,
+ })
+ }
+}
+
+// Type definition for Refund Response
+
+#[allow(dead_code)]
+#[derive(Debug, Serialize, Default, Deserialize, Clone)]
+pub enum RefundStatus {
+ Refunded,
+ #[default]
+ Processing,
+}
+
+impl From<RefundStatus> for enums::RefundStatus {
+ fn from(item: RefundStatus) -> Self {
+ match item {
+ RefundStatus::Refunded => Self::Success,
+ RefundStatus::Processing => Self::Pending,
+ }
+ }
+}
+
+//TODO: Fill the struct with respective fields
+#[derive(Default, Debug, Clone, Serialize, Deserialize)]
+pub struct RefundResponse {
+ id: String,
+ status: RefundStatus,
+}
+
+impl TryFrom<types::RefundsResponseRouterData<api::Execute, RefundResponse>>
+ for types::RefundsRouterData<api::Execute>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: types::RefundsResponseRouterData<api::Execute, RefundResponse>,
+ ) -> Result<Self, Self::Error> {
+ Ok(Self {
+ response: Ok(types::RefundsResponseData {
+ connector_refund_id: item.response.id.to_string(),
+ refund_status: enums::RefundStatus::from(item.response.status),
+ }),
+ ..item.data
+ })
+ }
+}
+
+impl TryFrom<types::RefundsResponseRouterData<api::RSync, RefundResponse>>
+ for types::RefundsRouterData<api::RSync>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: types::RefundsResponseRouterData<api::RSync, RefundResponse>,
+ ) -> Result<Self, Self::Error> {
+ Ok(Self {
+ response: Ok(types::RefundsResponseData {
+ connector_refund_id: item.response.id.to_string(),
+ refund_status: enums::RefundStatus::from(item.response.status),
+ }),
+ ..item.data
+ })
+ }
+}
+
+//TODO: Fill the struct with respective fields
+#[derive(Default, Debug, Serialize, Deserialize, PartialEq)]
+pub struct OpennodeErrorResponse {
+ pub status_code: u16,
+ pub code: String,
+ pub message: String,
+ pub reason: Option<String>,
+}
+
+fn get_crypto_specific_payment_data(
+ item: &types::PaymentsAuthorizeRouterData,
+) -> Result<OpennodePaymentsRequest, error_stack::Report<errors::ConnectorError>> {
+ let amount = item.request.amount;
+ let currency = item.request.currency.to_string();
+ let description = item.get_description()?;
+ let auto_settle = true;
+ let success_url = item.get_return_url()?;
+ let callback_url = item.request.get_webhook_url()?;
+
+ Ok(OpennodePaymentsRequest {
+ amount,
+ currency,
+ description,
+ auto_settle,
+ success_url,
+ callback_url,
+ })
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct OpennodeWebhookDetails {
+ pub id: String,
+ pub callback_url: String,
+ pub success_url: String,
+ pub status: OpennodePaymentStatus,
+ pub payment_method: String,
+ pub missing_amt: String,
+ pub order_id: String,
+ pub description: String,
+ pub price: String,
+ pub fee: String,
+ pub auto_settle: String,
+ pub fiat_value: String,
+ pub net_fiat_value: String,
+ pub overpaid_by: String,
+ pub hashed_order: String,
+}
diff --git a/crates/router/src/connector/stripe/transformers.rs b/crates/router/src/connector/stripe/transformers.rs
index 95c99d0ecd9..612ee873755 100644
--- a/crates/router/src/connector/stripe/transformers.rs
+++ b/crates/router/src/connector/stripe/transformers.rs
@@ -1297,6 +1297,11 @@ impl
}))
}
api::PaymentMethodData::Wallet(_) => Ok(Self::Wallet),
+ api::PaymentMethodData::Crypto(_) => Err(errors::ConnectorError::NotSupported {
+ payment_method: format!("{pm_type:?}"),
+ connector: "Stripe",
+ payment_experience: api_models::enums::PaymentExperience::RedirectToUrl.to_string(),
+ })?,
}
}
}
diff --git a/crates/router/src/connector/utils.rs b/crates/router/src/connector/utils.rs
index f7eda87d089..cd694ca894c 100644
--- a/crates/router/src/connector/utils.rs
+++ b/crates/router/src/connector/utils.rs
@@ -50,6 +50,7 @@ pub trait RouterData {
fn get_billing_country(&self) -> Result<api_models::enums::CountryCode, Error>;
fn get_billing_phone(&self) -> Result<&api::PhoneDetails, Error>;
fn get_description(&self) -> Result<String, Error>;
+ fn get_return_url(&self) -> Result<String, Error>;
fn get_billing_address(&self) -> Result<&api::AddressDetails, Error>;
fn get_shipping_address(&self) -> Result<&api::AddressDetails, Error>;
fn get_connector_meta(&self) -> Result<pii::SecretSerdeValue, Error>;
@@ -89,6 +90,11 @@ impl<Flow, Request, Response> RouterData for types::RouterData<Flow, Request, Re
.clone()
.ok_or_else(missing_field_err("description"))
}
+ fn get_return_url(&self) -> Result<String, Error> {
+ self.return_url
+ .clone()
+ .ok_or_else(missing_field_err("return_url"))
+ }
fn get_billing_address(&self) -> Result<&api::AddressDetails, Error> {
self.address
.billing
@@ -139,6 +145,7 @@ pub trait PaymentsAuthorizeRequestData {
fn get_browser_info(&self) -> Result<types::BrowserInformation, Error>;
fn get_card(&self) -> Result<api::Card, Error>;
fn get_return_url(&self) -> Result<String, Error>;
+ fn get_webhook_url(&self) -> Result<String, Error>;
}
impl PaymentsAuthorizeRequestData for types::PaymentsAuthorizeData {
@@ -164,6 +171,11 @@ impl PaymentsAuthorizeRequestData for types::PaymentsAuthorizeData {
.clone()
.ok_or_else(missing_field_err("return_url"))
}
+ fn get_webhook_url(&self) -> Result<String, Error> {
+ self.router_return_url
+ .clone()
+ .ok_or_else(missing_field_err("webhook_url"))
+ }
}
pub trait PaymentsSyncRequestData {
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index 3ad6ad84abd..7a4c5621492 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -616,6 +616,7 @@ pub fn should_call_connector<Op: Debug, F: Clone>(
| storage_enums::IntentStatus::Processing
| storage_enums::IntentStatus::Succeeded
| storage_enums::IntentStatus::RequiresCustomerAction
+ | storage_enums::IntentStatus::RequiresMerchantAction
) && payment_data.force_sync.unwrap_or(false)
}
"PaymentCancel" => matches!(
diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs
index 1fba3783b0d..beece551fd8 100644
--- a/crates/router/src/core/payments/flows.rs
+++ b/crates/router/src/core/payments/flows.rs
@@ -81,11 +81,13 @@ default_imp_for_complete_authorize!(
connector::Bluesnap,
connector::Braintree,
connector::Checkout,
+ connector::Coinbase,
connector::Cybersource,
connector::Dlocal,
connector::Fiserv,
connector::Klarna,
connector::Multisafepay,
+ connector::Opennode,
connector::Payu,
connector::Rapyd,
connector::Shift4,
@@ -121,12 +123,14 @@ default_imp_for_connector_redirect_response!(
connector::Bambora,
connector::Bluesnap,
connector::Braintree,
+ connector::Coinbase,
connector::Cybersource,
connector::Dlocal,
connector::Fiserv,
connector::Globalpay,
connector::Klarna,
connector::Multisafepay,
+ connector::Opennode,
connector::Payu,
connector::Rapyd,
connector::Shift4,
@@ -152,6 +156,7 @@ default_imp_for_connector_request_id!(
connector::Bluesnap,
connector::Braintree,
connector::Checkout,
+ connector::Coinbase,
connector::Cybersource,
connector::Dlocal,
connector::Fiserv,
@@ -160,6 +165,7 @@ default_imp_for_connector_request_id!(
connector::Mollie,
connector::Multisafepay,
connector::Nuvei,
+ connector::Opennode,
connector::Payu,
connector::Rapyd,
connector::Shift4,
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index 78a8ab744e7..ba5855122ff 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -379,6 +379,7 @@ pub fn create_complete_authorize_url(
router_base_url, payment_attempt.payment_id, payment_attempt.merchant_id, connector_name
)
}
+
fn validate_recurring_mandate(req: api::MandateValidationFields) -> RouterResult<()> {
req.mandate_id.check_value_present("mandate_id")?;
@@ -805,6 +806,7 @@ pub async fn make_pm_data<'a, F: Clone, R>(
}
(pm @ Some(api::PaymentMethodData::PayLater(_)), _) => Ok(pm.to_owned()),
(pm @ Some(api::PaymentMethodData::BankRedirect(_)), _) => Ok(pm.to_owned()),
+ (pm @ Some(api::PaymentMethodData::Crypto(_)), _) => Ok(pm.to_owned()),
(pm_opt @ Some(pm @ api::PaymentMethodData::Wallet(_)), _) => {
let token = vault::Vault::store_payment_method_data_in_locker(
state,
diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs
index d75b35aefda..f58e6b2f104 100644
--- a/crates/router/src/core/payments/operations/payment_response.rs
+++ b/crates/router/src/core/payments/operations/payment_response.rs
@@ -295,8 +295,8 @@ async fn payment_response_update_tracker<F: Clone, T>(
Some(storage::PaymentAttemptUpdate::ErrorUpdate {
connector: None,
status: storage::enums::AttemptStatus::Failure,
- error_message: Some(err.message),
- error_code: Some(err.code),
+ error_message: Some(Some(err.message)),
+ error_code: Some(Some(err.code)),
}),
Some(storage::ConnectorResponseUpdate::ErrorUpdate {
connector_name: Some(router_data.connector.clone()),
@@ -324,6 +324,13 @@ async fn payment_response_update_tracker<F: Clone, T>(
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Could not parse the connector response")?;
+ // incase of success, update error code and error message
+ let error_status = if router_data.status == enums::AttemptStatus::Charged {
+ Some(None)
+ } else {
+ None
+ };
+
if router_data.status == enums::AttemptStatus::Charged {
metrics::SUCCESSFUL_PAYMENT.add(&metrics::CONTEXT, 1, &[]);
}
@@ -339,6 +346,8 @@ async fn payment_response_update_tracker<F: Clone, T>(
.clone()
.map(|mandate| mandate.mandate_id),
connector_metadata,
+ error_code: error_status.clone(),
+ error_message: error_status,
};
let connector_response_update = storage::ConnectorResponseUpdate::ResponseUpdate {
@@ -353,7 +362,27 @@ async fn payment_response_update_tracker<F: Clone, T>(
Some(connector_response_update),
)
}
-
+ types::PaymentsResponseData::TransactionUnresolvedResponse {
+ resource_id,
+ reason,
+ } => {
+ let connector_transaction_id = match resource_id {
+ types::ResponseId::NoResponseId => None,
+ types::ResponseId::ConnectorTransactionId(id)
+ | types::ResponseId::EncodedData(id) => Some(id),
+ };
+ (
+ Some(storage::PaymentAttemptUpdate::UnresolvedResponseUpdate {
+ status: router_data.status,
+ connector: None,
+ connector_transaction_id,
+ payment_method_id: Some(router_data.payment_method_id),
+ error_code: Some(reason.clone().map(|cd| cd.code)),
+ error_message: Some(reason.map(|cd| cd.message)),
+ }),
+ None,
+ )
+ }
types::PaymentsResponseData::SessionResponse { .. } => (None, None),
types::PaymentsResponseData::SessionTokenResponse { .. } => (None, None),
},
diff --git a/crates/router/src/core/webhooks.rs b/crates/router/src/core/webhooks.rs
index 36fd535cd53..38ec9374e1c 100644
--- a/crates/router/src/core/webhooks.rs
+++ b/crates/router/src/core/webhooks.rs
@@ -522,10 +522,18 @@ pub async fn webhooks_core<W: api::OutgoingWebhookType>(
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Could not find event type in incoming webhook body")?;
- if !matches!(
- event_type,
- api_models::webhooks::IncomingWebhookEvent::EndpointVerification
- ) {
+ let process_webhook_further = utils::lookup_webhook_event(
+ &*state.store,
+ connector_name,
+ &merchant_account.merchant_id,
+ &event_type,
+ )
+ .await;
+
+ logger::info!(process_webhook=?process_webhook_further);
+ logger::info!(event_type=?event_type);
+
+ if process_webhook_further {
let source_verified = connector
.verify_webhook_source(
&*state.store,
@@ -536,77 +544,67 @@ pub async fn webhooks_core<W: api::OutgoingWebhookType>(
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("There was an issue in incoming webhook source verification")?;
- let process_webhook_further = utils::lookup_webhook_event(
- &*state.store,
- connector_name,
- &merchant_account.merchant_id,
- &event_type,
- )
- .await;
+ let object_ref_id = connector
+ .get_webhook_object_reference_id(&request_details)
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Could not find object reference id in incoming webhook body")?;
- if process_webhook_further {
- let object_ref_id = connector
- .get_webhook_object_reference_id(&request_details)
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Could not find object reference id in incoming webhook body")?;
+ let event_object = connector
+ .get_webhook_resource_object(&request_details)
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Could not find resource object in incoming webhook body")?;
- let event_object = connector
- .get_webhook_resource_object(&request_details)
+ let webhook_details = api::IncomingWebhookDetails {
+ object_reference_id: object_ref_id,
+ resource_object: Encode::<serde_json::Value>::encode_to_vec(&event_object)
.change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Could not find resource object in incoming webhook body")?;
-
- let webhook_details = api::IncomingWebhookDetails {
- object_reference_id: object_ref_id,
- resource_object: Encode::<serde_json::Value>::encode_to_vec(&event_object)
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable(
- "There was an issue when encoding the incoming webhook body to bytes",
- )?,
- };
+ .attach_printable(
+ "There was an issue when encoding the incoming webhook body to bytes",
+ )?,
+ };
- let flow_type: api::WebhookFlow = event_type.to_owned().into();
- match flow_type {
- api::WebhookFlow::Payment => payments_incoming_webhook_flow::<W>(
- state.clone(),
- merchant_account,
- webhook_details,
- source_verified,
- )
- .await
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Incoming webhook flow for payments failed")?,
-
- api::WebhookFlow::Refund => refunds_incoming_webhook_flow::<W>(
- state.clone(),
- merchant_account,
- webhook_details,
- connector_name,
- source_verified,
- event_type,
- )
- .await
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Incoming webhook flow for refunds failed")?,
-
- api::WebhookFlow::Dispute => disputes_incoming_webhook_flow::<W>(
- state.clone(),
- merchant_account,
- webhook_details,
- source_verified,
- *connector,
- &request_details,
- event_type,
- )
- .await
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Incoming webhook flow for disputes failed")?,
+ let flow_type: api::WebhookFlow = event_type.to_owned().into();
+ match flow_type {
+ api::WebhookFlow::Payment => payments_incoming_webhook_flow::<W>(
+ state.clone(),
+ merchant_account,
+ webhook_details,
+ source_verified,
+ )
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Incoming webhook flow for payments failed")?,
+
+ api::WebhookFlow::Refund => refunds_incoming_webhook_flow::<W>(
+ state.clone(),
+ merchant_account,
+ webhook_details,
+ connector_name,
+ source_verified,
+ event_type,
+ )
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Incoming webhook flow for refunds failed")?,
- api::WebhookFlow::ReturnResponse => {}
+ api::WebhookFlow::Dispute => disputes_incoming_webhook_flow::<W>(
+ state.clone(),
+ merchant_account,
+ webhook_details,
+ source_verified,
+ *connector,
+ &request_details,
+ event_type,
+ )
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Incoming webhook flow for disputes failed")?,
- _ => Err(errors::ApiErrorResponse::InternalServerError)
- .into_report()
- .attach_printable("Unsupported Flow Type received in incoming webhooks")?,
- }
+ api::WebhookFlow::ReturnResponse => {}
+
+ _ => Err(errors::ApiErrorResponse::InternalServerError)
+ .into_report()
+ .attach_printable("Unsupported Flow Type received in incoming webhooks")?,
}
}
diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs
index e43598414d9..b41055dcc56 100644
--- a/crates/router/src/core/webhooks/utils.rs
+++ b/crates/router/src/core/webhooks/utils.rs
@@ -4,7 +4,13 @@ use crate::{
};
fn default_webhook_config() -> api::MerchantWebhookConfig {
- std::collections::HashSet::from([api::IncomingWebhookEvent::PaymentIntentSuccess])
+ std::collections::HashSet::from([
+ api::IncomingWebhookEvent::PaymentIntentSuccess,
+ api::IncomingWebhookEvent::PaymentIntentFailure,
+ api::IncomingWebhookEvent::PaymentIntentProcessing,
+ api::IncomingWebhookEvent::PaymentActionRequired,
+ api::IncomingWebhookEvent::RefundSuccess,
+ ])
}
pub async fn lookup_webhook_event(
diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs
index 42941ee0ffb..b38a7c23f12 100644
--- a/crates/router/src/lib.rs
+++ b/crates/router/src/lib.rs
@@ -45,6 +45,7 @@ static ALLOC: mimalloc::MiMalloc = mimalloc::MiMalloc;
pub mod headers {
pub const ACCEPT: &str = "Accept";
pub const API_KEY: &str = "API-KEY";
+ pub const X_CC_API_KEY: &str = "X-CC-Api-Key";
pub const AUTHORIZATION: &str = "Authorization";
pub const CONTENT_TYPE: &str = "Content-Type";
pub const DATE: &str = "Date";
@@ -55,6 +56,7 @@ pub mod headers {
pub const X_LOGIN: &str = "X-Login";
pub const X_TRANS_KEY: &str = "X-Trans-Key";
pub const X_VERSION: &str = "X-Version";
+ pub const X_CC_VERSION: &str = "X-CC-Version";
pub const X_DATE: &str = "X-Date";
}
diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs
index 6c4b26f039c..ffa5b651906 100644
--- a/crates/router/src/types.rs
+++ b/crates/router/src/types.rs
@@ -254,6 +254,11 @@ pub enum PaymentsResponseData {
SessionTokenResponse {
session_token: String,
},
+ TransactionUnresolvedResponse {
+ resource_id: ResponseId,
+ //to add more info on cypto response, like `unresolved` reason(overpaid, underpaid, delayed)
+ reason: Option<api::enums::UnresolvedResponseReason>,
+ },
}
#[derive(Debug, Clone, Default)]
diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs
index 0eea03f2a7e..7f3edef5fe0 100644
--- a/crates/router/src/types/api.rs
+++ b/crates/router/src/types/api.rs
@@ -192,6 +192,7 @@ impl ConnectorData {
"bluesnap" => Ok(Box::new(&connector::Bluesnap)),
"braintree" => Ok(Box::new(&connector::Braintree)),
"checkout" => Ok(Box::new(&connector::Checkout)),
+ "coinbase" => Ok(Box::new(&connector::Coinbase)),
"cybersource" => Ok(Box::new(&connector::Cybersource)),
"dlocal" => Ok(Box::new(&connector::Dlocal)),
"fiserv" => Ok(Box::new(&connector::Fiserv)),
@@ -199,6 +200,7 @@ impl ConnectorData {
"klarna" => Ok(Box::new(&connector::Klarna)),
"mollie" => Ok(Box::new(&connector::Mollie)),
"nuvei" => Ok(Box::new(&connector::Nuvei)),
+ "opennode" => Ok(Box::new(&connector::Opennode)),
"payu" => Ok(Box::new(&connector::Payu)),
"rapyd" => Ok(Box::new(&connector::Rapyd)),
"shift4" => Ok(Box::new(&connector::Shift4)),
diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs
index bcc29fd3fe0..87ef993880e 100644
--- a/crates/router/src/types/transformers.rs
+++ b/crates/router/src/types/transformers.rs
@@ -129,6 +129,7 @@ impl ForeignFrom<storage_enums::AttemptStatus> for storage_enums::IntentStatus {
storage_enums::AttemptStatus::Authorized => Self::RequiresCapture,
storage_enums::AttemptStatus::AuthenticationPending => Self::RequiresCustomerAction,
+ storage_enums::AttemptStatus::Unresolved => Self::RequiresMerchantAction,
storage_enums::AttemptStatus::PartialCharged
| storage_enums::AttemptStatus::Started
@@ -156,6 +157,8 @@ impl ForeignTryFrom<api_enums::IntentStatus> for storage_enums::EventType {
fn foreign_try_from(value: api_enums::IntentStatus) -> Result<Self, Self::Error> {
match value {
api_enums::IntentStatus::Succeeded => Ok(Self::PaymentSucceeded),
+ api_enums::IntentStatus::Processing => Ok(Self::PaymentProcessing),
+ api_enums::IntentStatus::RequiresMerchantAction => Ok(Self::ActionRequired),
_ => Err(errors::ValidationError::IncorrectValueProvided {
field_name: "intent_status",
}),
diff --git a/crates/router/tests/connectors/coinbase.rs b/crates/router/tests/connectors/coinbase.rs
new file mode 100644
index 00000000000..2ce5efae67f
--- /dev/null
+++ b/crates/router/tests/connectors/coinbase.rs
@@ -0,0 +1,465 @@
+use masking::Secret;
+use router::types::{self, api, storage::enums};
+
+use crate::{
+ connector_auth,
+ utils::{self, ConnectorActions},
+};
+
+#[derive(Clone, Copy)]
+struct CoinbaseTest;
+impl ConnectorActions for CoinbaseTest {}
+impl utils::Connector for CoinbaseTest {
+ fn get_data(&self) -> types::api::ConnectorData {
+ use router::connector::Coinbase;
+ types::api::ConnectorData {
+ connector: Box::new(&Coinbase),
+ connector_name: types::Connector::Coinbase,
+ get_token: types::api::GetToken::Connector,
+ }
+ }
+
+ fn get_auth_token(&self) -> types::ConnectorAuthType {
+ types::ConnectorAuthType::from(
+ connector_auth::ConnectorAuthentication::new()
+ .coinbase
+ .expect("Missing connector authentication configuration"),
+ )
+ }
+
+ fn get_name(&self) -> String {
+ "coinbase".to_string()
+ }
+}
+
+static CONNECTOR: CoinbaseTest = CoinbaseTest {};
+
+fn get_default_payment_info() -> Option<utils::PaymentInfo> {
+ None
+}
+
+fn payment_method_details() -> Option<types::PaymentsAuthorizeData> {
+ None
+}
+
+// Cards Positive Tests
+// Creates a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_only_authorize_payment() {
+ let response = CONNECTOR
+ .authorize_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .expect("Authorize payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Authorized);
+}
+
+// Captures a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_capture_authorized_payment() {
+ let response = CONNECTOR
+ .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info())
+ .await
+ .expect("Capture payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Charged);
+}
+
+// Partially captures a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_partially_capture_authorized_payment() {
+ let response = CONNECTOR
+ .authorize_and_capture_payment(
+ payment_method_details(),
+ Some(types::PaymentsCaptureData {
+ amount_to_capture: 50,
+ ..utils::PaymentCaptureType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .expect("Capture payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Charged);
+}
+
+// Synchronizes a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_authorized_payment() {
+ let authorize_response = CONNECTOR
+ .authorize_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .expect("Authorize payment response");
+ let txn_id = utils::get_connector_transaction_id(authorize_response.response);
+ let response = CONNECTOR
+ .psync_retry_till_status_matches(
+ enums::AttemptStatus::Authorized,
+ Some(types::PaymentsSyncData {
+ connector_transaction_id: router::types::ResponseId::ConnectorTransactionId(
+ txn_id.unwrap(),
+ ),
+ ..Default::default()
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .expect("PSync response");
+ assert_eq!(response.status, enums::AttemptStatus::Authorized,);
+}
+
+// Voids a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_void_authorized_payment() {
+ let response = CONNECTOR
+ .authorize_and_void_payment(
+ payment_method_details(),
+ Some(types::PaymentsCancelData {
+ connector_transaction_id: String::from(""),
+ cancellation_reason: Some("requested_by_customer".to_string()),
+ ..Default::default()
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .expect("Void payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Voided);
+}
+
+// Refunds a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_refund_manually_captured_payment() {
+ let response = CONNECTOR
+ .capture_payment_and_refund(
+ payment_method_details(),
+ None,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Partially refunds a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_partially_refund_manually_captured_payment() {
+ let response = CONNECTOR
+ .capture_payment_and_refund(
+ payment_method_details(),
+ None,
+ Some(types::RefundsData {
+ refund_amount: 50,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Synchronizes a refund using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_manually_captured_refund() {
+ let refund_response = CONNECTOR
+ .capture_payment_and_refund(
+ payment_method_details(),
+ None,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ let response = CONNECTOR
+ .rsync_retry_till_status_matches(
+ enums::RefundStatus::Success,
+ refund_response.response.unwrap().connector_refund_id,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Creates a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_make_payment() {
+ let authorize_response = CONNECTOR
+ .make_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(authorize_response.status, enums::AttemptStatus::Charged);
+}
+
+// Synchronizes a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_auto_captured_payment() {
+ let authorize_response = CONNECTOR
+ .make_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(authorize_response.status, enums::AttemptStatus::Charged);
+ let txn_id = utils::get_connector_transaction_id(authorize_response.response);
+ assert_ne!(txn_id, None, "Empty connector transaction id");
+ let response = CONNECTOR
+ .psync_retry_till_status_matches(
+ enums::AttemptStatus::Charged,
+ Some(types::PaymentsSyncData {
+ connector_transaction_id: router::types::ResponseId::ConnectorTransactionId(
+ txn_id.unwrap(),
+ ),
+ capture_method: Some(enums::CaptureMethod::Automatic),
+ ..Default::default()
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(response.status, enums::AttemptStatus::Charged,);
+}
+
+// Refunds a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_refund_auto_captured_payment() {
+ let response = CONNECTOR
+ .make_payment_and_refund(payment_method_details(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Partially refunds a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_partially_refund_succeeded_payment() {
+ let refund_response = CONNECTOR
+ .make_payment_and_refund(
+ payment_method_details(),
+ Some(types::RefundsData {
+ refund_amount: 50,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ refund_response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_refund_succeeded_payment_multiple_times() {
+ CONNECTOR
+ .make_payment_and_multiple_refund(
+ payment_method_details(),
+ Some(types::RefundsData {
+ refund_amount: 50,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await;
+}
+
+// Synchronizes a refund using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_refund() {
+ let refund_response = CONNECTOR
+ .make_payment_and_refund(payment_method_details(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ let response = CONNECTOR
+ .rsync_retry_till_status_matches(
+ enums::RefundStatus::Success,
+ refund_response.response.unwrap().connector_refund_id,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Cards Negative scenerios
+// Creates a payment with incorrect card number.
+#[actix_web::test]
+async fn should_fail_payment_for_incorrect_card_number() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_number: Secret::new("1234567891011".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card number is incorrect.".to_string(),
+ );
+}
+
+// Creates a payment with empty card number.
+#[actix_web::test]
+async fn should_fail_payment_for_empty_card_number() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_number: Secret::new(String::from("")),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ let x = response.response.unwrap_err();
+ assert_eq!(
+ x.message,
+ "You passed an empty string for 'payment_method_data[card][number]'.",
+ );
+}
+
+// Creates a payment with incorrect CVC.
+#[actix_web::test]
+async fn should_fail_payment_for_incorrect_cvc() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_cvc: Secret::new("12345".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card's security code is invalid.".to_string(),
+ );
+}
+
+// Creates a payment with incorrect expiry month.
+#[actix_web::test]
+async fn should_fail_payment_for_invalid_exp_month() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_exp_month: Secret::new("20".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card's expiration month is invalid.".to_string(),
+ );
+}
+
+// Creates a payment with incorrect expiry year.
+#[actix_web::test]
+async fn should_fail_payment_for_incorrect_expiry_year() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_exp_year: Secret::new("2000".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card's expiration year is invalid.".to_string(),
+ );
+}
+
+// Voids a payment using automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_fail_void_payment_for_auto_capture() {
+ let authorize_response = CONNECTOR
+ .make_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(authorize_response.status, enums::AttemptStatus::Charged);
+ let txn_id = utils::get_connector_transaction_id(authorize_response.response);
+ assert_ne!(txn_id, None, "Empty connector transaction id");
+ let void_response = CONNECTOR
+ .void_payment(txn_id.unwrap(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(
+ void_response.response.unwrap_err().message,
+ "You cannot cancel this PaymentIntent because it has a status of succeeded."
+ );
+}
+
+// Captures a payment using invalid connector payment id.
+#[actix_web::test]
+async fn should_fail_capture_for_invalid_payment() {
+ let capture_response = CONNECTOR
+ .capture_payment("123456789".to_string(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(
+ capture_response.response.unwrap_err().message,
+ String::from("No such payment_intent: '123456789'")
+ );
+}
+
+// Refunds a payment with refund amount higher than payment amount.
+#[actix_web::test]
+async fn should_fail_for_refund_amount_higher_than_payment_amount() {
+ let response = CONNECTOR
+ .make_payment_and_refund(
+ payment_method_details(),
+ Some(types::RefundsData {
+ refund_amount: 150,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Refund amount (₹1.50) is greater than charge amount (₹1.00)",
+ );
+}
+
+// Connector dependent test cases goes here
+
+// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests
diff --git a/crates/router/tests/connectors/connector_auth.rs b/crates/router/tests/connectors/connector_auth.rs
index daa17722986..b636de0a65a 100644
--- a/crates/router/tests/connectors/connector_auth.rs
+++ b/crates/router/tests/connectors/connector_auth.rs
@@ -12,6 +12,7 @@ pub(crate) struct ConnectorAuthentication {
pub bambora: Option<BodyKey>,
pub bluesnap: Option<BodyKey>,
pub checkout: Option<BodyKey>,
+ pub coinbase: Option<HeaderKey>,
pub cybersource: Option<SignatureKey>,
pub dlocal: Option<SignatureKey>,
pub fiserv: Option<SignatureKey>,
@@ -19,6 +20,7 @@ pub(crate) struct ConnectorAuthentication {
pub mollie: Option<HeaderKey>,
pub multisafepay: Option<HeaderKey>,
pub nuvei: Option<SignatureKey>,
+ pub opennode: Option<HeaderKey>,
pub paypal: Option<BodyKey>,
pub payu: Option<BodyKey>,
pub rapyd: Option<BodyKey>,
diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs
index e314408125f..91306502ec2 100644
--- a/crates/router/tests/connectors/main.rs
+++ b/crates/router/tests/connectors/main.rs
@@ -7,6 +7,7 @@ mod authorizedotnet;
mod bambora;
mod bluesnap;
mod checkout;
+mod coinbase;
mod connector_auth;
mod cybersource;
mod dlocal;
@@ -15,6 +16,7 @@ mod globalpay;
mod mollie;
mod multisafepay;
mod nuvei;
+mod opennode;
mod paypal;
mod payu;
mod rapyd;
diff --git a/crates/router/tests/connectors/opennode.rs b/crates/router/tests/connectors/opennode.rs
new file mode 100644
index 00000000000..4ae979ce285
--- /dev/null
+++ b/crates/router/tests/connectors/opennode.rs
@@ -0,0 +1,465 @@
+use masking::Secret;
+use router::types::{self, api, storage::enums};
+
+use crate::{
+ connector_auth,
+ utils::{self, ConnectorActions},
+};
+
+#[derive(Clone, Copy)]
+struct OpennodeTest;
+impl ConnectorActions for OpennodeTest {}
+impl utils::Connector for OpennodeTest {
+ fn get_data(&self) -> types::api::ConnectorData {
+ use router::connector::Opennode;
+ types::api::ConnectorData {
+ connector: Box::new(&Opennode),
+ connector_name: types::Connector::Opennode,
+ get_token: types::api::GetToken::Connector,
+ }
+ }
+
+ fn get_auth_token(&self) -> types::ConnectorAuthType {
+ types::ConnectorAuthType::from(
+ connector_auth::ConnectorAuthentication::new()
+ .opennode
+ .expect("Missing connector authentication configuration"),
+ )
+ }
+
+ fn get_name(&self) -> String {
+ "opennode".to_string()
+ }
+}
+
+static CONNECTOR: OpennodeTest = OpennodeTest {};
+
+fn get_default_payment_info() -> Option<utils::PaymentInfo> {
+ None
+}
+
+fn payment_method_details() -> Option<types::PaymentsAuthorizeData> {
+ None
+}
+
+// Cards Positive Tests
+// Creates a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_only_authorize_payment() {
+ let response = CONNECTOR
+ .authorize_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .expect("Authorize payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Authorized);
+}
+
+// Captures a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_capture_authorized_payment() {
+ let response = CONNECTOR
+ .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info())
+ .await
+ .expect("Capture payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Charged);
+}
+
+// Partially captures a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_partially_capture_authorized_payment() {
+ let response = CONNECTOR
+ .authorize_and_capture_payment(
+ payment_method_details(),
+ Some(types::PaymentsCaptureData {
+ amount_to_capture: 50,
+ ..utils::PaymentCaptureType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .expect("Capture payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Charged);
+}
+
+// Synchronizes a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_authorized_payment() {
+ let authorize_response = CONNECTOR
+ .authorize_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .expect("Authorize payment response");
+ let txn_id = utils::get_connector_transaction_id(authorize_response.response);
+ let response = CONNECTOR
+ .psync_retry_till_status_matches(
+ enums::AttemptStatus::Authorized,
+ Some(types::PaymentsSyncData {
+ connector_transaction_id: router::types::ResponseId::ConnectorTransactionId(
+ txn_id.unwrap(),
+ ),
+ ..Default::default()
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .expect("PSync response");
+ assert_eq!(response.status, enums::AttemptStatus::Authorized,);
+}
+
+// Voids a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_void_authorized_payment() {
+ let response = CONNECTOR
+ .authorize_and_void_payment(
+ payment_method_details(),
+ Some(types::PaymentsCancelData {
+ connector_transaction_id: String::from(""),
+ cancellation_reason: Some("requested_by_customer".to_string()),
+ ..Default::default()
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .expect("Void payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Voided);
+}
+
+// Refunds a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_refund_manually_captured_payment() {
+ let response = CONNECTOR
+ .capture_payment_and_refund(
+ payment_method_details(),
+ None,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Partially refunds a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_partially_refund_manually_captured_payment() {
+ let response = CONNECTOR
+ .capture_payment_and_refund(
+ payment_method_details(),
+ None,
+ Some(types::RefundsData {
+ refund_amount: 50,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Synchronizes a refund using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_manually_captured_refund() {
+ let refund_response = CONNECTOR
+ .capture_payment_and_refund(
+ payment_method_details(),
+ None,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ let response = CONNECTOR
+ .rsync_retry_till_status_matches(
+ enums::RefundStatus::Success,
+ refund_response.response.unwrap().connector_refund_id,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Creates a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_make_payment() {
+ let authorize_response = CONNECTOR
+ .make_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(authorize_response.status, enums::AttemptStatus::Charged);
+}
+
+// Synchronizes a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_auto_captured_payment() {
+ let authorize_response = CONNECTOR
+ .make_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(authorize_response.status, enums::AttemptStatus::Charged);
+ let txn_id = utils::get_connector_transaction_id(authorize_response.response);
+ assert_ne!(txn_id, None, "Empty connector transaction id");
+ let response = CONNECTOR
+ .psync_retry_till_status_matches(
+ enums::AttemptStatus::Charged,
+ Some(types::PaymentsSyncData {
+ connector_transaction_id: router::types::ResponseId::ConnectorTransactionId(
+ txn_id.unwrap(),
+ ),
+ capture_method: Some(enums::CaptureMethod::Automatic),
+ ..Default::default()
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(response.status, enums::AttemptStatus::Charged,);
+}
+
+// Refunds a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_refund_auto_captured_payment() {
+ let response = CONNECTOR
+ .make_payment_and_refund(payment_method_details(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Partially refunds a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_partially_refund_succeeded_payment() {
+ let refund_response = CONNECTOR
+ .make_payment_and_refund(
+ payment_method_details(),
+ Some(types::RefundsData {
+ refund_amount: 50,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ refund_response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_refund_succeeded_payment_multiple_times() {
+ CONNECTOR
+ .make_payment_and_multiple_refund(
+ payment_method_details(),
+ Some(types::RefundsData {
+ refund_amount: 50,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await;
+}
+
+// Synchronizes a refund using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_refund() {
+ let refund_response = CONNECTOR
+ .make_payment_and_refund(payment_method_details(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ let response = CONNECTOR
+ .rsync_retry_till_status_matches(
+ enums::RefundStatus::Success,
+ refund_response.response.unwrap().connector_refund_id,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Cards Negative scenerios
+// Creates a payment with incorrect card number.
+#[actix_web::test]
+async fn should_fail_payment_for_incorrect_card_number() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_number: Secret::new("1234567891011".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card number is incorrect.".to_string(),
+ );
+}
+
+// Creates a payment with empty card number.
+#[actix_web::test]
+async fn should_fail_payment_for_empty_card_number() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_number: Secret::new(String::from("")),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ let x = response.response.unwrap_err();
+ assert_eq!(
+ x.message,
+ "You passed an empty string for 'payment_method_data[card][number]'.",
+ );
+}
+
+// Creates a payment with incorrect CVC.
+#[actix_web::test]
+async fn should_fail_payment_for_incorrect_cvc() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_cvc: Secret::new("12345".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card's security code is invalid.".to_string(),
+ );
+}
+
+// Creates a payment with incorrect expiry month.
+#[actix_web::test]
+async fn should_fail_payment_for_invalid_exp_month() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_exp_month: Secret::new("20".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card's expiration month is invalid.".to_string(),
+ );
+}
+
+// Creates a payment with incorrect expiry year.
+#[actix_web::test]
+async fn should_fail_payment_for_incorrect_expiry_year() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: types::api::PaymentMethodData::Card(api::Card {
+ card_exp_year: Secret::new("2000".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card's expiration year is invalid.".to_string(),
+ );
+}
+
+// Voids a payment using automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_fail_void_payment_for_auto_capture() {
+ let authorize_response = CONNECTOR
+ .make_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(authorize_response.status, enums::AttemptStatus::Charged);
+ let txn_id = utils::get_connector_transaction_id(authorize_response.response);
+ assert_ne!(txn_id, None, "Empty connector transaction id");
+ let void_response = CONNECTOR
+ .void_payment(txn_id.unwrap(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(
+ void_response.response.unwrap_err().message,
+ "You cannot cancel this PaymentIntent because it has a status of succeeded."
+ );
+}
+
+// Captures a payment using invalid connector payment id.
+#[actix_web::test]
+async fn should_fail_capture_for_invalid_payment() {
+ let capture_response = CONNECTOR
+ .capture_payment("123456789".to_string(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(
+ capture_response.response.unwrap_err().message,
+ String::from("No such payment_intent: '123456789'")
+ );
+}
+
+// Refunds a payment with refund amount higher than payment amount.
+#[actix_web::test]
+async fn should_fail_for_refund_amount_higher_than_payment_amount() {
+ let response = CONNECTOR
+ .make_payment_and_refund(
+ payment_method_details(),
+ Some(types::RefundsData {
+ refund_amount: 150,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Refund amount (₹1.50) is greater than charge amount (₹1.00)",
+ );
+}
+
+// Connector dependent test cases goes here
+
+// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests
diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml
index 2a2ad2d8ed5..214b6ba246c 100644
--- a/crates/router/tests/connectors/sample_auth.toml
+++ b/crates/router/tests/connectors/sample_auth.toml
@@ -72,4 +72,10 @@ api_key = "api_key"
key1 = "key1"
[mollie]
-api_key = "API Key"
\ No newline at end of file
+api_key = "API Key"
+
+[coinbase]
+api_key="API Key"
+
+[opennode]
+api_key="API Key"
diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs
index db92f2ead26..8f7f9e1bf7b 100644
--- a/crates/router/tests/connectors/utils.rs
+++ b/crates/router/tests/connectors/utils.rs
@@ -397,6 +397,7 @@ pub trait ConnectorActions: Connector {
}
Ok(types::PaymentsResponseData::SessionResponse { .. }) => None,
Ok(types::PaymentsResponseData::SessionTokenResponse { .. }) => None,
+ Ok(types::PaymentsResponseData::TransactionUnresolvedResponse { .. }) => None,
Err(_) => None,
}
}
@@ -576,6 +577,7 @@ pub fn get_connector_transaction_id(
}
Ok(types::PaymentsResponseData::SessionResponse { .. }) => None,
Ok(types::PaymentsResponseData::SessionTokenResponse { .. }) => None,
+ Ok(types::PaymentsResponseData::TransactionUnresolvedResponse { .. }) => None,
Err(_) => None,
}
}
diff --git a/crates/storage_models/src/enums.rs b/crates/storage_models/src/enums.rs
index ac5f25dc8fe..c54ef1a138d 100644
--- a/crates/storage_models/src/enums.rs
+++ b/crates/storage_models/src/enums.rs
@@ -51,6 +51,7 @@ pub enum AttemptStatus {
VoidFailed,
AutoRefunded,
PartialCharged,
+ Unresolved,
#[default]
Pending,
Failure,
@@ -317,6 +318,8 @@ pub enum EventObjectType {
#[strum(serialize_all = "snake_case")]
pub enum EventType {
PaymentSucceeded,
+ PaymentProcessing,
+ ActionRequired,
RefundSucceeded,
RefundFailed,
DisputeOpened,
@@ -350,6 +353,7 @@ pub enum IntentStatus {
Cancelled,
Processing,
RequiresCustomerAction,
+ RequiresMerchantAction,
RequiresPaymentMethod,
#[default]
RequiresConfirmation,
@@ -450,6 +454,7 @@ pub enum PaymentMethod {
PayLater,
Wallet,
BankRedirect,
+ Crypto,
}
#[derive(
@@ -618,6 +623,7 @@ pub enum PaymentMethodType {
GooglePay,
ApplePay,
Paypal,
+ CryptoCurrency,
}
#[derive(
diff --git a/crates/storage_models/src/payment_attempt.rs b/crates/storage_models/src/payment_attempt.rs
index fe9ac04c212..b911863d412 100644
--- a/crates/storage_models/src/payment_attempt.rs
+++ b/crates/storage_models/src/payment_attempt.rs
@@ -135,6 +135,16 @@ pub enum PaymentAttemptUpdate {
payment_method_id: Option<Option<String>>,
mandate_id: Option<String>,
connector_metadata: Option<serde_json::Value>,
+ error_code: Option<Option<String>>,
+ error_message: Option<Option<String>>,
+ },
+ UnresolvedResponseUpdate {
+ status: storage_enums::AttemptStatus,
+ connector: Option<serde_json::Value>,
+ connector_transaction_id: Option<String>,
+ payment_method_id: Option<Option<String>>,
+ error_code: Option<Option<String>>,
+ error_message: Option<Option<String>>,
},
StatusUpdate {
status: storage_enums::AttemptStatus,
@@ -142,8 +152,8 @@ pub enum PaymentAttemptUpdate {
ErrorUpdate {
connector: Option<serde_json::Value>,
status: storage_enums::AttemptStatus,
- error_code: Option<String>,
- error_message: Option<String>,
+ error_code: Option<Option<String>>,
+ error_message: Option<Option<String>>,
},
}
@@ -157,14 +167,14 @@ pub struct PaymentAttemptUpdateInternal {
connector: Option<serde_json::Value>,
authentication_type: Option<storage_enums::AuthenticationType>,
payment_method: Option<storage_enums::PaymentMethod>,
- error_message: Option<String>,
+ error_message: Option<Option<String>>,
payment_method_id: Option<Option<String>>,
cancellation_reason: Option<String>,
modified_at: Option<PrimitiveDateTime>,
mandate_id: Option<String>,
browser_info: Option<serde_json::Value>,
payment_token: Option<String>,
- error_code: Option<String>,
+ error_code: Option<Option<String>>,
connector_metadata: Option<serde_json::Value>,
payment_method_data: Option<serde_json::Value>,
payment_method_type: Option<storage_enums::PaymentMethodType>,
@@ -184,7 +194,7 @@ impl PaymentAttemptUpdate {
.or(pa_update.connector_transaction_id),
authentication_type: pa_update.authentication_type.or(source.authentication_type),
payment_method: pa_update.payment_method.or(source.payment_method),
- error_message: pa_update.error_message.or(source.error_message),
+ error_message: pa_update.error_message.unwrap_or(source.error_message),
payment_method_id: pa_update
.payment_method_id
.unwrap_or(source.payment_method_id),
@@ -274,6 +284,8 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal {
payment_method_id,
mandate_id,
connector_metadata,
+ error_code,
+ error_message,
} => Self {
status: Some(status),
connector,
@@ -283,6 +295,8 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal {
modified_at: Some(common_utils::date_time::now()),
mandate_id,
connector_metadata,
+ error_code,
+ error_message,
..Default::default()
},
PaymentAttemptUpdate::ErrorUpdate {
@@ -310,6 +324,23 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal {
connector,
..Default::default()
},
+ PaymentAttemptUpdate::UnresolvedResponseUpdate {
+ status,
+ connector,
+ connector_transaction_id,
+ payment_method_id,
+ error_code,
+ error_message,
+ } => Self {
+ status: Some(status),
+ connector,
+ connector_transaction_id,
+ payment_method_id,
+ modified_at: Some(common_utils::date_time::now()),
+ error_code,
+ error_message,
+ ..Default::default()
+ },
}
}
}
diff --git a/crates/storage_models/src/payment_intent.rs b/crates/storage_models/src/payment_intent.rs
index 9a02bc20485..b2198b86d18 100644
--- a/crates/storage_models/src/payment_intent.rs
+++ b/crates/storage_models/src/payment_intent.rs
@@ -265,6 +265,7 @@ fn make_client_secret_null_based_on_status(
| storage_enums::IntentStatus::Cancelled => Some(None),
storage_enums::IntentStatus::Processing
| storage_enums::IntentStatus::RequiresCustomerAction
+ | storage_enums::IntentStatus::RequiresMerchantAction
| storage_enums::IntentStatus::RequiresPaymentMethod
| storage_enums::IntentStatus::RequiresConfirmation
| storage_enums::IntentStatus::RequiresCapture => None,
diff --git a/loadtest/config/Development.toml b/loadtest/config/Development.toml
index 7406f43639b..96a1563e23f 100644
--- a/loadtest/config/Development.toml
+++ b/loadtest/config/Development.toml
@@ -64,6 +64,7 @@ bambora.base_url = "https://api.na.bambora.com"
bluesnap.base_url = "https://sandbox.bluesnap.com/"
braintree.base_url = "https://api.sandbox.braintreegateway.com/"
checkout.base_url = "https://api.sandbox.checkout.com/"
+coinbase.base_url = "https://api.commerce.coinbase.com"
cybersource.base_url = "https://apitest.cybersource.com/"
dlocal.base_url = "https://sandbox.dlocal.com/"
fiserv.base_url = "https://cert.api.fiservapps.com/"
@@ -72,6 +73,7 @@ klarna.base_url = "https://api-na.playground.klarna.com/"
mollie.base_url = "https://api.mollie.com/v2/"
multisafepay.base_url = "https://testapi.multisafepay.com/"
nuvei.base_url = "https://ppp-test.nuvei.com/"
+opennode.base_url = "https://dev-api.opennode.com"
paypal.base_url = "https://www.sandbox.paypal.com/"
payu.base_url = "https://secure.snd.payu.com/"
rapyd.base_url = "https://sandboxapi.rapyd.net"
@@ -93,6 +95,7 @@ cards = [
"bluesnap",
"braintree",
"checkout",
+ "coinbase",
"cybersource",
"dlocal",
"fiserv",
@@ -100,6 +103,7 @@ cards = [
"mollie",
"multisafepay",
"nuvei",
+ "opennode",
"paypal",
"payu",
"shift4",
diff --git a/migrations/2023-03-26-163105_add_unresolved_status/down.sql b/migrations/2023-03-26-163105_add_unresolved_status/down.sql
new file mode 100644
index 00000000000..c7be58db8e2
--- /dev/null
+++ b/migrations/2023-03-26-163105_add_unresolved_status/down.sql
@@ -0,0 +1,20 @@
+DELETE FROM pg_enum
+WHERE enumlabel = 'unresolved'
+AND enumtypid = (
+ SELECT oid FROM pg_type WHERE typname = 'AttemptStatus'
+);
+DELETE FROM pg_enum
+WHERE enumlabel = 'requires_merchant_action'
+AND enumtypid = (
+ SELECT oid FROM pg_type WHERE typname = 'IntentStatus'
+);
+DELETE FROM pg_enum
+WHERE enumlabel = 'action_required'
+AND enumtypid = (
+ SELECT oid FROM pg_type WHERE typname = 'EventType'
+);
+DELETE FROM pg_enum
+WHERE enumlabel = 'payment_processing'
+AND enumtypid = (
+ SELECT oid FROM pg_type WHERE typname = 'EventType'
+);
\ No newline at end of file
diff --git a/migrations/2023-03-26-163105_add_unresolved_status/up.sql b/migrations/2023-03-26-163105_add_unresolved_status/up.sql
new file mode 100644
index 00000000000..121dc441cb1
--- /dev/null
+++ b/migrations/2023-03-26-163105_add_unresolved_status/up.sql
@@ -0,0 +1,4 @@
+ALTER TYPE "AttemptStatus" ADD VALUE IF NOT EXISTS 'unresolved';
+ALTER TYPE "IntentStatus" ADD VALUE IF NOT EXISTS 'requires_merchant_action' after 'requires_customer_action';
+ALTER TYPE "EventType" ADD VALUE IF NOT EXISTS 'action_required';
+ALTER TYPE "EventType" ADD VALUE IF NOT EXISTS 'payment_processing';
diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh
index ff87ccc9239..feeac2b8578 100755
--- a/scripts/add_connector.sh
+++ b/scripts/add_connector.sh
@@ -4,7 +4,7 @@ function find_prev_connector() {
git checkout $self
cp $self $self.tmp
# add new connector to existing list and sort it
- connectors=(aci adyen airwallex applepay authorizedotnet bambora bluesnap braintree checkout cybersource dlocal fiserv globalpay klarna mollie multisafepay nuvei payu rapyd shift4 stripe trustpay worldline worldpay "$1")
+ connectors=(aci adyen airwallex applepay authorizedotnet bambora bluesnap braintree checkout coinbase cybersource dlocal fiserv globalpay klarna mollie multisafepay nuvei opennode payu rapyd shift4 stripe trustpay worldline worldpay "$1")
IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS
res=`echo ${sorted[@]}`
sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp
|
feat
|
[Coinbase] [Opennode] Add support for crypto payments via PG redirection (#834)
|
76c34595ef612ca1a3b750653e6460b980163d63
|
2025-02-10 17:06:21
|
Anurag
|
fix(connector): fix incorrect mapping of attempt status in NMI connector (#7200)
| false
|
diff --git a/crates/router/src/connector/nmi/transformers.rs b/crates/router/src/connector/nmi/transformers.rs
index e99549893b6..e70813216d2 100644
--- a/crates/router/src/connector/nmi/transformers.rs
+++ b/crates/router/src/connector/nmi/transformers.rs
@@ -910,7 +910,7 @@ impl TryFrom<types::PaymentsResponseRouterData<StandardResponse>>
{
enums::AttemptStatus::CaptureInitiated
} else {
- enums::AttemptStatus::Authorizing
+ enums::AttemptStatus::Authorized
},
),
Response::Declined | Response::Error => (
|
fix
|
fix incorrect mapping of attempt status in NMI connector (#7200)
|
0eca55f75392f8091a1cf8f378e8cbee9afd3eac
|
2025-01-21 15:21:03
|
Mrudul Vajpayee
|
refactor: check allowed payment method types in enabled options (#7019)
| false
|
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index 1b31fdf46c0..93769c71e6c 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -1,4 +1,4 @@
-use std::{borrow::Cow, str::FromStr};
+use std::{borrow::Cow, collections::HashSet, str::FromStr};
#[cfg(feature = "v2")]
use api_models::ephemeral_key::EphemeralKeyResponse;
@@ -6301,3 +6301,91 @@ pub async fn is_merchant_eligible_authentication_service(
Ok(auth_eligible_array.contains(&merchant_id.get_string_repr().to_owned()))
}
+
+#[cfg(feature = "v1")]
+pub async fn validate_allowed_payment_method_types_request(
+ state: &SessionState,
+ profile_id: &id_type::ProfileId,
+ merchant_account: &domain::MerchantAccount,
+ merchant_key_store: &domain::MerchantKeyStore,
+ allowed_payment_method_types: Option<Vec<common_enums::PaymentMethodType>>,
+) -> CustomResult<(), errors::ApiErrorResponse> {
+ if let Some(allowed_payment_method_types) = allowed_payment_method_types {
+ let db = &*state.store;
+ let all_connector_accounts = db
+ .find_merchant_connector_account_by_merchant_id_and_disabled_list(
+ &state.into(),
+ merchant_account.get_id(),
+ false,
+ merchant_key_store,
+ )
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed to fetch merchant connector account for given merchant id")?;
+
+ let filtered_connector_accounts = filter_mca_based_on_profile_and_connector_type(
+ all_connector_accounts,
+ profile_id,
+ ConnectorType::PaymentProcessor,
+ );
+
+ let supporting_payment_method_types: HashSet<_> = filtered_connector_accounts
+ .iter()
+ .flat_map(|connector_account| {
+ connector_account
+ .payment_methods_enabled
+ .clone()
+ .unwrap_or_default()
+ .into_iter()
+ .map(|payment_methods_enabled| {
+ payment_methods_enabled
+ .parse_value::<api_models::admin::PaymentMethodsEnabled>(
+ "payment_methods_enabled",
+ )
+ })
+ .filter_map(|parsed_payment_method_result| {
+ parsed_payment_method_result
+ .inspect_err(|err| {
+ logger::error!(
+ "Unable to deserialize payment methods enabled: {:?}",
+ err
+ );
+ })
+ .ok()
+ })
+ .flat_map(|parsed_payment_methods_enabled| {
+ parsed_payment_methods_enabled
+ .payment_method_types
+ .unwrap_or_default()
+ .into_iter()
+ .map(|payment_method_type| payment_method_type.payment_method_type)
+ })
+ })
+ .collect();
+
+ let unsupported_payment_methods: Vec<_> = allowed_payment_method_types
+ .iter()
+ .filter(|allowed_pmt| !supporting_payment_method_types.contains(allowed_pmt))
+ .collect();
+
+ if !unsupported_payment_methods.is_empty() {
+ metrics::PAYMENT_METHOD_TYPES_MISCONFIGURATION_METRIC.add(
+ 1,
+ router_env::metric_attributes!(("merchant_id", merchant_account.get_id().clone())),
+ );
+ }
+
+ fp_utils::when(
+ unsupported_payment_methods.len() == allowed_payment_method_types.len(),
+ || {
+ Err(errors::ApiErrorResponse::IncorrectPaymentMethodConfiguration)
+ .attach_printable(format!(
+ "None of the allowed payment method types {:?} are configured for this merchant connector account.",
+ allowed_payment_method_types
+ ))
+ },
+ )?;
+ }
+
+ Ok(())
+}
diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs
index ed7b84e8329..2bb751d4e14 100644
--- a/crates/router/src/core/payments/operations/payment_create.rs
+++ b/crates/router/src/core/payments/operations/payment_create.rs
@@ -181,6 +181,15 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest>
)
.await?;
+ helpers::validate_allowed_payment_method_types_request(
+ state,
+ &profile_id,
+ merchant_account,
+ merchant_key_store,
+ request.allowed_payment_method_types.clone(),
+ )
+ .await?;
+
let customer_details = helpers::get_customer_details_from_request(request);
let shipping_address = helpers::create_or_find_address_for_payment_by_request(
diff --git a/crates/router/src/routes/metrics.rs b/crates/router/src/routes/metrics.rs
index 5920c001d3f..edb33f48762 100644
--- a/crates/router/src/routes/metrics.rs
+++ b/crates/router/src/routes/metrics.rs
@@ -141,3 +141,6 @@ histogram_metric_f64!(GENERATE_NETWORK_TOKEN_TIME, GLOBAL_METER);
histogram_metric_f64!(FETCH_NETWORK_TOKEN_TIME, GLOBAL_METER);
histogram_metric_f64!(DELETE_NETWORK_TOKEN_TIME, GLOBAL_METER);
histogram_metric_f64!(CHECK_NETWORK_TOKEN_STATUS_TIME, GLOBAL_METER);
+
+// A counter to indicate allowed payment method types mismatch
+counter_metric!(PAYMENT_METHOD_TYPES_MISCONFIGURATION_METRIC, GLOBAL_METER);
|
refactor
|
check allowed payment method types in enabled options (#7019)
|
92d76a361a8babaa3433ead589f83268cb3d722f
|
2024-08-09 20:30:59
|
Sai Harsha Vardhan
|
refactor(openapi): add openapi support for generating v2 api-reference (#5580)
| false
|
diff --git a/.github/workflows/pr-convention-checks.yml b/.github/workflows/pr-convention-checks.yml
index bceb49fd903..fb48d6e3844 100644
--- a/.github/workflows/pr-convention-checks.yml
+++ b/.github/workflows/pr-convention-checks.yml
@@ -153,11 +153,11 @@ jobs:
files_changed="$(gh api --header "Accept: application/vnd.github+json" --header "X-GitHub-Api-Version: 2022-11-28" --paginate https://api.github.com/repos/juspay/hyperswitch/pulls/${{ github.event.pull_request.number }}/files --jq '.[] | .filename')"
- if echo "${files_changed}" | grep --quiet --extended-regexp '(^migrations/.*/(up|down)\.sql$|^crates/diesel_models/src/schema.rs$)' ; then
+ if echo "${files_changed}" | grep --quiet --extended-regexp '(^(migrations|v2_migrations)/.*/(up|down)\.sql$|^crates/diesel_models/src/(schema|schema_v2).rs$)' ; then
migration_and_schema_changes='true'
fi
- if echo "${files_changed}" | grep --quiet --extended-regexp '^(api-reference/openapi_spec.json)$'; then
+ if echo "${files_changed}" | grep --quiet --extended-regexp '^api-reference/(openapi_spec.json|openapi_spec_v2.json)$'; then
openapi_changes='true'
fi
diff --git a/.github/workflows/validate-openapi-spec.yml b/.github/workflows/validate-openapi-spec.yml
index 04acc87acdd..942d5144e41 100644
--- a/.github/workflows/validate-openapi-spec.yml
+++ b/.github/workflows/validate-openapi-spec.yml
@@ -54,6 +54,10 @@ jobs:
shell: bash
run: cargo run -p openapi
+ - name: Generate the OpenAPI spec file for V2
+ shell: bash
+ run: cargo r -p openapi --no-default-features --features v2
+
- name: Install `swagger-cli`
shell: bash
run: npm install -g @apidevtools/swagger-cli
@@ -62,15 +66,19 @@ jobs:
shell: bash
run: swagger-cli validate ./api-reference/openapi_spec.json
+ - name: Validate the JSON file for V2
+ shell: bash
+ run: swagger-cli validate ./api-reference/openapi_spec_v2.json
+
- name: Commit the JSON file if it is not up-to-date
# PR originated from same repository
if: ${{ (github.event_name == 'pull_request') && (github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name) }}
shell: bash
run: |
- if ! git diff --quiet --exit-code -- api-reference/openapi_spec.json ; then
+ if ! git diff --quiet --exit-code -- api-reference/openapi_spec.json api-reference/openapi_spec_v2.json ; then
git config --local user.name 'hyperswitch-bot[bot]'
git config --local user.email '148525504+hyperswitch-bot[bot]@users.noreply.github.com'
- git add api-reference/openapi_spec.json
+ git add api-reference/openapi_spec.json api-reference/openapi_spec_v2.json
git commit --message 'docs(openapi): re-generate OpenAPI specification'
git push
fi
diff --git a/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--create.mdx b/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--create.mdx
new file mode 100644
index 00000000000..a6ba2bbef8f
--- /dev/null
+++ b/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--create.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /connector_accounts
+---
\ No newline at end of file
diff --git a/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--delete.mdx b/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--delete.mdx
new file mode 100644
index 00000000000..c95826b6917
--- /dev/null
+++ b/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--delete.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /connector_accounts/{id}
+---
\ No newline at end of file
diff --git a/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--retrieve.mdx b/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--retrieve.mdx
new file mode 100644
index 00000000000..eeae4e44002
--- /dev/null
+++ b/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--retrieve.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /connector_accounts/{id}
+---
\ No newline at end of file
diff --git a/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--update.mdx b/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--update.mdx
new file mode 100644
index 00000000000..143d457c8fd
--- /dev/null
+++ b/api-reference/api-reference-v2/merchant-connector-account/merchant-connector--update.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /connector_accounts/{id}
+---
\ No newline at end of file
diff --git a/api-reference/mint_v2.json b/api-reference/mint_v2.json
new file mode 100644
index 00000000000..862b4a259c0
--- /dev/null
+++ b/api-reference/mint_v2.json
@@ -0,0 +1,59 @@
+{
+ "$schema": "https://mintlify.com/schema.json",
+ "name": "Hyperswitch",
+ "logo": {
+ "dark": "/logo/dark.svg",
+ "light": "/logo/light.svg"
+ },
+ "favicon": "/favicon.png",
+ "colors": {
+ "primary": "#006DF9",
+ "light": "#006DF9",
+ "dark": "#006DF9",
+ "background": {
+ "dark": "#242F48"
+ }
+ },
+ "tabs": [
+ {
+ "name": "API Reference",
+ "url": "api-reference"
+ },
+ {
+ "name": "Locker API Reference",
+ "url": "locker-api-reference"
+ }
+ ],
+ "navigation": [
+ {
+ "group": "Get Started",
+ "pages": ["introduction"]
+ },
+ {
+ "group": "Essentials",
+ "pages": [
+ "essentials/webhooks",
+ "essentials/error_codes",
+ "essentials/rate_limit",
+ "essentials/go-live"
+ ]
+ },
+ {
+ "group": "Merchant Connector Account",
+ "pages": [
+ "api-reference-v2/merchant-connector-account/merchant-connector--create",
+ "api-reference-v2/merchant-connector-account/merchant-connector--retrieve",
+ "api-reference-v2/merchant-connector-account/merchant-connector--update",
+ "api-reference-v2/merchant-connector-account/merchant-connector--delete"
+ ]
+ }
+ ],
+ "footerSocials": {
+ "github": "https://github.com/juspay/hyperswitch",
+ "linkedin": "https://www.linkedin.com/company/hyperswitch"
+ },
+ "openapi": ["openapi_spec_v2.json", "rust_locker_open_api_spec.yml"],
+ "api": {
+ "maintainOrder": true
+ }
+ }
\ No newline at end of file
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
index b801adab76d..e1634359565 100644
--- a/api-reference/openapi_spec.json
+++ b/api-reference/openapi_spec.json
@@ -1516,7 +1516,7 @@
},
"connector_label": "EU_adyen",
"connector_name": "adyen",
- "connector_type": "fiz_operations"
+ "connector_type": "payment_processor"
}
},
"Create a merchant connector account under a specific business profile": {
@@ -1527,7 +1527,7 @@
"key1": "{{adyen_merchant_account}}"
},
"connector_name": "adyen",
- "connector_type": "fiz_operations",
+ "connector_type": "payment_processor",
"profile_id": "{{profile_id}}"
}
},
@@ -1539,7 +1539,7 @@
"key1": "{{adyen_merchant_account}}"
},
"connector_name": "adyen",
- "connector_type": "fiz_operations"
+ "connector_type": "payment_processor"
}
}
}
@@ -1704,7 +1704,7 @@
"examples": {
"Enable card payment method": {
"value": {
- "connector_type": "fiz_operations",
+ "connector_type": "payment_processor",
"payment_methods_enabled": [
{
"payment_method": "card"
diff --git a/api-reference/openapi_spec_v2.json b/api-reference/openapi_spec_v2.json
new file mode 100644
index 00000000000..80a6189ee5b
--- /dev/null
+++ b/api-reference/openapi_spec_v2.json
@@ -0,0 +1,17099 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "title": "Hyperswitch - API Documentation",
+ "description": "\n## Get started\n\nHyperswitch provides a collection of APIs that enable you to process and manage payments.\nOur APIs accept and return JSON in the HTTP body, and return standard HTTP response codes.\n\nYou can consume the APIs directly using your favorite HTTP/REST library.\n\nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without\naffecting production data.\nCurrently, our sandbox environment is live while our production environment is under development\nand will be available soon.\nYou can sign up on our Dashboard to get API keys to access Hyperswitch API.\n\n### Environment\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n|---------------|------------------------------------|\n| Sandbox | <https://sandbox.hyperswitch.io> |\n| Production | <https://api.hyperswitch.io> |\n\n## Authentication\n\nWhen you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant\naccount, you are given a secret key (also referred as api-key) and a publishable key.\nYou may authenticate all API requests with Hyperswitch server by providing the appropriate key in\nthe request Authorization header.\n\n| Key | Description |\n|-----------------|-----------------------------------------------------------------------------------------------|\n| api-key | Private key. Used to authenticate all API requests from your merchant server |\n| publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client |\n\nNever share your secret api keys. Keep them guarded and secure.\n",
+ "contact": {
+ "name": "Hyperswitch Support",
+ "url": "https://hyperswitch.io",
+ "email": "[email protected]"
+ },
+ "license": {
+ "name": "Apache-2.0"
+ },
+ "version": "0.1.0"
+ },
+ "servers": [
+ {
+ "url": "https://sandbox.hyperswitch.io",
+ "description": "Sandbox Environment"
+ }
+ ],
+ "paths": {
+ "/connector_accounts": {
+ "post": {
+ "tags": [
+ "Merchant Connector Account"
+ ],
+ "operationId": "Create a Merchant Connector",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MerchantConnectorCreate"
+ },
+ "examples": {
+ "Create a merchant account with custom connector label": {
+ "value": {
+ "connector_account_details": {
+ "api_key": "{{adyen-api-key}}",
+ "auth_type": "BodyKey",
+ "key1": "{{adyen_merchant_account}}"
+ },
+ "connector_label": "EU_adyen",
+ "connector_name": "adyen",
+ "connector_type": "payment_processor"
+ }
+ },
+ "Create a merchant connector account under a specific business profile": {
+ "value": {
+ "connector_account_details": {
+ "api_key": "{{adyen-api-key}}",
+ "auth_type": "BodyKey",
+ "key1": "{{adyen_merchant_account}}"
+ },
+ "connector_name": "adyen",
+ "connector_type": "payment_processor",
+ "profile_id": "{{profile_id}}"
+ }
+ },
+ "Create a merchant connector account with minimal fields": {
+ "value": {
+ "connector_account_details": {
+ "api_key": "{{adyen-api-key}}",
+ "auth_type": "BodyKey",
+ "key1": "{{adyen_merchant_account}}"
+ },
+ "connector_name": "adyen",
+ "connector_type": "payment_processor"
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Merchant Connector Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MerchantConnectorResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Missing Mandatory fields"
+ }
+ },
+ "security": [
+ {
+ "admin_api_key": []
+ }
+ ]
+ }
+ },
+ "/connector_accounts/{id}": {
+ "get": {
+ "tags": [
+ "Merchant Connector Account"
+ ],
+ "operationId": "Retrieve a Merchant Connector",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "The unique identifier for the Merchant Connector",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Merchant Connector retrieved successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MerchantConnectorResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized request"
+ },
+ "404": {
+ "description": "Merchant Connector does not exist in records"
+ }
+ },
+ "security": [
+ {
+ "admin_api_key": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Merchant Connector Account"
+ ],
+ "operationId": "Update a Merchant Connector",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "The unique identifier for the Merchant Connector",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MerchantConnectorUpdate"
+ },
+ "examples": {
+ "Enable card payment method": {
+ "value": {
+ "connector_type": "payment_processor",
+ "payment_methods_enabled": [
+ {
+ "payment_method": "card"
+ }
+ ]
+ }
+ },
+ "Update webhook secret": {
+ "value": {
+ "connector_webhook_details": {
+ "merchant_secret": "{{webhook_secret}}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "Merchant Connector Updated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MerchantConnectorResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized request"
+ },
+ "404": {
+ "description": "Merchant Connector does not exist in records"
+ }
+ },
+ "security": [
+ {
+ "admin_api_key": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Merchant Connector Account"
+ ],
+ "operationId": "Delete a Merchant Connector",
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "The unique identifier for the Merchant Connector",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Merchant Connector Deleted",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MerchantConnectorDeleteResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized request"
+ },
+ "404": {
+ "description": "Merchant Connector does not exist in records"
+ }
+ },
+ "security": [
+ {
+ "admin_api_key": []
+ }
+ ]
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "AcceptanceType": {
+ "type": "string",
+ "description": "This is used to indicate if the mandate was accepted online or offline",
+ "enum": [
+ "online",
+ "offline"
+ ]
+ },
+ "AcceptedCountries": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "list"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "enable_only"
+ ]
+ },
+ "list": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "list"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "disable_only"
+ ]
+ },
+ "list": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "all_accepted"
+ ]
+ }
+ }
+ }
+ ],
+ "description": "Object to filter the customer countries for which the payment method is displayed",
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "AcceptedCurrencies": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "list"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "enable_only"
+ ]
+ },
+ "list": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Currency"
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "list"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "disable_only"
+ ]
+ },
+ "list": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Currency"
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "all_accepted"
+ ]
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "AchBankTransfer": {
+ "type": "object",
+ "required": [
+ "bank_account_number",
+ "bank_routing_number"
+ ],
+ "properties": {
+ "bank_name": {
+ "type": "string",
+ "description": "Bank name",
+ "example": "Deutsche Bank",
+ "nullable": true
+ },
+ "bank_country_code": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ },
+ "bank_city": {
+ "type": "string",
+ "description": "Bank city",
+ "example": "California",
+ "nullable": true
+ },
+ "bank_account_number": {
+ "type": "string",
+ "description": "Bank account number is an unique identifier assigned by a bank to a customer.",
+ "example": "000123456"
+ },
+ "bank_routing_number": {
+ "type": "string",
+ "description": "[9 digits] Routing number - used in USA for identifying a specific bank.",
+ "example": "110000000"
+ }
+ }
+ },
+ "AchBillingDetails": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "The Email ID for ACH billing",
+ "example": "[email protected]",
+ "nullable": true
+ }
+ }
+ },
+ "AchTransfer": {
+ "type": "object",
+ "required": [
+ "account_number",
+ "bank_name",
+ "routing_number",
+ "swift_code"
+ ],
+ "properties": {
+ "account_number": {
+ "type": "string",
+ "example": "122385736258"
+ },
+ "bank_name": {
+ "type": "string"
+ },
+ "routing_number": {
+ "type": "string",
+ "example": "012"
+ },
+ "swift_code": {
+ "type": "string",
+ "example": "234"
+ }
+ }
+ },
+ "AdditionalMerchantData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "open_banking_recipient_data"
+ ],
+ "properties": {
+ "open_banking_recipient_data": {
+ "$ref": "#/components/schemas/MerchantRecipientData"
+ }
+ }
+ }
+ ]
+ },
+ "Address": {
+ "type": "object",
+ "properties": {
+ "address": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AddressDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "phone": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PhoneDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "AddressDetails": {
+ "type": "object",
+ "description": "Address details",
+ "properties": {
+ "city": {
+ "type": "string",
+ "description": "The address city",
+ "example": "New York",
+ "nullable": true,
+ "maxLength": 50
+ },
+ "country": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ },
+ "line1": {
+ "type": "string",
+ "description": "The first line of the address",
+ "example": "123, King Street",
+ "nullable": true,
+ "maxLength": 200
+ },
+ "line2": {
+ "type": "string",
+ "description": "The second line of the address",
+ "example": "Powelson Avenue",
+ "nullable": true,
+ "maxLength": 50
+ },
+ "line3": {
+ "type": "string",
+ "description": "The third line of the address",
+ "example": "Bridgewater",
+ "nullable": true,
+ "maxLength": 50
+ },
+ "zip": {
+ "type": "string",
+ "description": "The zip/postal code for the address",
+ "example": "08807",
+ "nullable": true,
+ "maxLength": 50
+ },
+ "state": {
+ "type": "string",
+ "description": "The address state",
+ "example": "New York",
+ "nullable": true
+ },
+ "first_name": {
+ "type": "string",
+ "description": "The first name for the address",
+ "example": "John",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "last_name": {
+ "type": "string",
+ "description": "The last name for the address",
+ "example": "Doe",
+ "nullable": true,
+ "maxLength": 255
+ }
+ },
+ "additionalProperties": false
+ },
+ "AirwallexData": {
+ "type": "object",
+ "properties": {
+ "payload": {
+ "type": "string",
+ "description": "payload required by airwallex",
+ "nullable": true
+ }
+ }
+ },
+ "AlfamartVoucherData": {
+ "type": "object",
+ "properties": {
+ "first_name": {
+ "type": "string",
+ "description": "The billing first name for Alfamart",
+ "example": "Jane",
+ "nullable": true
+ },
+ "last_name": {
+ "type": "string",
+ "description": "The billing second name for Alfamart",
+ "example": "Doe",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "The Email ID for Alfamart",
+ "example": "[email protected]",
+ "nullable": true
+ }
+ }
+ },
+ "AliPayHkRedirection": {
+ "type": "object"
+ },
+ "AliPayQr": {
+ "type": "object"
+ },
+ "AliPayRedirection": {
+ "type": "object"
+ },
+ "AmountFilter": {
+ "type": "object",
+ "properties": {
+ "start_amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The start amount to filter list of transactions which are greater than or equal to the start amount",
+ "nullable": true
+ },
+ "end_amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The end amount to filter list of transactions which are less than or equal to the end amount",
+ "nullable": true
+ }
+ }
+ },
+ "AmountInfo": {
+ "type": "object",
+ "required": [
+ "label",
+ "amount"
+ ],
+ "properties": {
+ "label": {
+ "type": "string",
+ "description": "The label must be the name of the merchant."
+ },
+ "type": {
+ "type": "string",
+ "description": "A value that indicates whether the line item(Ex: total, tax, discount, or grand total) is final or pending.",
+ "nullable": true
+ },
+ "amount": {
+ "type": "string",
+ "description": "The total amount for the payment in majot unit string (Ex: 38.02)",
+ "example": "38.02"
+ }
+ }
+ },
+ "ApiKeyExpiration": {
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "never"
+ ]
+ },
+ {
+ "type": "string",
+ "format": "date-time"
+ }
+ ]
+ },
+ "ApplePayAddressParameters": {
+ "type": "string",
+ "enum": [
+ "postalAddress",
+ "phone",
+ "email"
+ ]
+ },
+ "ApplePayBillingContactFields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApplePayAddressParameters"
+ }
+ },
+ "ApplePayPaymentRequest": {
+ "type": "object",
+ "required": [
+ "country_code",
+ "currency_code",
+ "total"
+ ],
+ "properties": {
+ "country_code": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ },
+ "currency_code": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "total": {
+ "$ref": "#/components/schemas/AmountInfo"
+ },
+ "merchant_capabilities": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of merchant capabilities(ex: whether capable of 3ds or no-3ds)",
+ "nullable": true
+ },
+ "supported_networks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of supported networks",
+ "nullable": true
+ },
+ "merchant_identifier": {
+ "type": "string",
+ "nullable": true
+ },
+ "required_billing_contact_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ApplePayBillingContactFields"
+ }
+ ],
+ "nullable": true
+ },
+ "required_shipping_contact_fields": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ApplePayShippingContactFields"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "ApplePayRedirectData": {
+ "type": "object"
+ },
+ "ApplePaySessionResponse": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/ThirdPartySdkSessionResponse"
+ },
+ {
+ "$ref": "#/components/schemas/NoThirdPartySdkSessionResponse"
+ },
+ {
+ "type": "object",
+ "default": null,
+ "nullable": true
+ }
+ ]
+ },
+ "ApplePayShippingContactFields": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApplePayAddressParameters"
+ }
+ },
+ "ApplePayThirdPartySdkData": {
+ "type": "object"
+ },
+ "ApplePayWalletData": {
+ "type": "object",
+ "required": [
+ "payment_data",
+ "payment_method",
+ "transaction_identifier"
+ ],
+ "properties": {
+ "payment_data": {
+ "type": "string",
+ "description": "The payment data of Apple pay"
+ },
+ "payment_method": {
+ "$ref": "#/components/schemas/ApplepayPaymentMethod"
+ },
+ "transaction_identifier": {
+ "type": "string",
+ "description": "The unique identifier for the transaction"
+ }
+ }
+ },
+ "ApplepayConnectorMetadataRequest": {
+ "type": "object",
+ "properties": {
+ "session_token_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SessionTokenInfo"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "ApplepayInitiative": {
+ "type": "string",
+ "enum": [
+ "web",
+ "ios"
+ ]
+ },
+ "ApplepayPaymentMethod": {
+ "type": "object",
+ "required": [
+ "display_name",
+ "network",
+ "type"
+ ],
+ "properties": {
+ "display_name": {
+ "type": "string",
+ "description": "The name to be displayed on Apple Pay button"
+ },
+ "network": {
+ "type": "string",
+ "description": "The network of the Apple pay payment method"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the payment method"
+ }
+ }
+ },
+ "ApplepaySessionTokenResponse": {
+ "type": "object",
+ "required": [
+ "connector",
+ "delayed_session_token",
+ "sdk_next_action"
+ ],
+ "properties": {
+ "session_token_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ApplePaySessionResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_request_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ApplePayPaymentRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "string",
+ "description": "The session token is w.r.t this connector"
+ },
+ "delayed_session_token": {
+ "type": "boolean",
+ "description": "Identifier for the delayed session response"
+ },
+ "sdk_next_action": {
+ "$ref": "#/components/schemas/SdkNextAction"
+ },
+ "connector_reference_id": {
+ "type": "string",
+ "description": "The connector transaction id",
+ "nullable": true
+ },
+ "connector_sdk_public_key": {
+ "type": "string",
+ "description": "The public key id is to invoke third party sdk",
+ "nullable": true
+ },
+ "connector_merchant_id": {
+ "type": "string",
+ "description": "The connector merchant id",
+ "nullable": true
+ }
+ }
+ },
+ "AttemptStatus": {
+ "type": "string",
+ "description": "The status of the attempt",
+ "enum": [
+ "started",
+ "authentication_failed",
+ "router_declined",
+ "authentication_pending",
+ "authentication_successful",
+ "authorized",
+ "authorization_failed",
+ "charged",
+ "authorizing",
+ "cod_initiated",
+ "voided",
+ "void_initiated",
+ "capture_initiated",
+ "capture_failed",
+ "void_failed",
+ "auto_refunded",
+ "partial_charged",
+ "partial_charged_and_chargeable",
+ "unresolved",
+ "pending",
+ "failure",
+ "payment_method_awaited",
+ "confirmation_awaited",
+ "device_data_collection_pending"
+ ]
+ },
+ "AuthenticationConnectorDetails": {
+ "type": "object",
+ "required": [
+ "authentication_connectors",
+ "three_ds_requestor_url"
+ ],
+ "properties": {
+ "authentication_connectors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AuthenticationConnectors"
+ },
+ "description": "List of authentication connectors"
+ },
+ "three_ds_requestor_url": {
+ "type": "string",
+ "description": "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process."
+ }
+ }
+ },
+ "AuthenticationConnectors": {
+ "type": "string",
+ "enum": [
+ "threedsecureio",
+ "netcetera",
+ "gpayments"
+ ]
+ },
+ "AuthenticationStatus": {
+ "type": "string",
+ "enum": [
+ "started",
+ "pending",
+ "success",
+ "failed"
+ ]
+ },
+ "AuthenticationType": {
+ "type": "string",
+ "description": "Pass this parameter to force 3DS or non 3DS auth for this payment. Some connectors will still force 3DS auth even in case of passing 'no_three_ds' here and vice versa. Default value is 'no_three_ds' if not set",
+ "enum": [
+ "three_ds",
+ "no_three_ds"
+ ]
+ },
+ "AuthorizationStatus": {
+ "type": "string",
+ "enum": [
+ "success",
+ "failure",
+ "processing",
+ "unresolved"
+ ]
+ },
+ "BacsBankTransfer": {
+ "type": "object",
+ "required": [
+ "bank_account_number",
+ "bank_sort_code"
+ ],
+ "properties": {
+ "bank_name": {
+ "type": "string",
+ "description": "Bank name",
+ "example": "Deutsche Bank",
+ "nullable": true
+ },
+ "bank_country_code": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ },
+ "bank_city": {
+ "type": "string",
+ "description": "Bank city",
+ "example": "California",
+ "nullable": true
+ },
+ "bank_account_number": {
+ "type": "string",
+ "description": "Bank account number is an unique identifier assigned by a bank to a customer.",
+ "example": "000123456"
+ },
+ "bank_sort_code": {
+ "type": "string",
+ "description": "[6 digits] Sort Code - used in UK and Ireland for identifying a bank and it's branches.",
+ "example": "98-76-54"
+ }
+ }
+ },
+ "BacsBankTransferInstructions": {
+ "type": "object",
+ "required": [
+ "account_holder_name",
+ "account_number",
+ "sort_code"
+ ],
+ "properties": {
+ "account_holder_name": {
+ "type": "string",
+ "example": "Jane Doe"
+ },
+ "account_number": {
+ "type": "string",
+ "example": "10244123908"
+ },
+ "sort_code": {
+ "type": "string",
+ "example": "012"
+ }
+ }
+ },
+ "Bank": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AchBankTransfer"
+ },
+ {
+ "$ref": "#/components/schemas/BacsBankTransfer"
+ },
+ {
+ "$ref": "#/components/schemas/SepaBankTransfer"
+ },
+ {
+ "$ref": "#/components/schemas/PixBankTransfer"
+ }
+ ]
+ },
+ "BankDebitBilling": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The billing name for bank debits",
+ "example": "John Doe",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "The billing email for bank debits",
+ "example": "[email protected]",
+ "nullable": true
+ },
+ "address": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AddressDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "BankDebitData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "ach_bank_debit"
+ ],
+ "properties": {
+ "ach_bank_debit": {
+ "type": "object",
+ "description": "Payment Method data for Ach bank debit",
+ "required": [
+ "account_number",
+ "routing_number",
+ "card_holder_name",
+ "bank_account_holder_name",
+ "bank_name",
+ "bank_type",
+ "bank_holder_type"
+ ],
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankDebitBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "account_number": {
+ "type": "string",
+ "description": "Account number for ach bank debit payment",
+ "example": "000123456789"
+ },
+ "routing_number": {
+ "type": "string",
+ "description": "Routing number for ach bank debit payment",
+ "example": "110000000"
+ },
+ "card_holder_name": {
+ "type": "string",
+ "example": "John Test"
+ },
+ "bank_account_holder_name": {
+ "type": "string",
+ "example": "John Doe"
+ },
+ "bank_name": {
+ "type": "string",
+ "example": "ACH"
+ },
+ "bank_type": {
+ "type": "string",
+ "example": "Checking"
+ },
+ "bank_holder_type": {
+ "type": "string",
+ "example": "Personal"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "sepa_bank_debit"
+ ],
+ "properties": {
+ "sepa_bank_debit": {
+ "type": "object",
+ "required": [
+ "iban",
+ "bank_account_holder_name"
+ ],
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankDebitBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "iban": {
+ "type": "string",
+ "description": "International bank account number (iban) for SEPA",
+ "example": "DE89370400440532013000"
+ },
+ "bank_account_holder_name": {
+ "type": "string",
+ "description": "Owner name for bank debit",
+ "example": "A. Schneider"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "becs_bank_debit"
+ ],
+ "properties": {
+ "becs_bank_debit": {
+ "type": "object",
+ "required": [
+ "account_number",
+ "bsb_number"
+ ],
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankDebitBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "account_number": {
+ "type": "string",
+ "description": "Account number for Becs payment method",
+ "example": "000123456"
+ },
+ "bsb_number": {
+ "type": "string",
+ "description": "Bank-State-Branch (bsb) number",
+ "example": "000000"
+ },
+ "bank_account_holder_name": {
+ "type": "string",
+ "description": "Owner name for bank debit",
+ "example": "A. Schneider",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bacs_bank_debit"
+ ],
+ "properties": {
+ "bacs_bank_debit": {
+ "type": "object",
+ "required": [
+ "account_number",
+ "sort_code",
+ "bank_account_holder_name"
+ ],
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankDebitBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "account_number": {
+ "type": "string",
+ "description": "Account number for Bacs payment method",
+ "example": "00012345"
+ },
+ "sort_code": {
+ "type": "string",
+ "description": "Sort code for Bacs payment method",
+ "example": "108800"
+ },
+ "bank_account_holder_name": {
+ "type": "string",
+ "description": "holder name for bank debit",
+ "example": "A. Schneider"
+ }
+ }
+ }
+ }
+ }
+ ]
+ },
+ "BankNames": {
+ "type": "string",
+ "description": "Name of banks supported by Hyperswitch",
+ "enum": [
+ "american_express",
+ "affin_bank",
+ "agro_bank",
+ "alliance_bank",
+ "am_bank",
+ "bank_of_america",
+ "bank_islam",
+ "bank_muamalat",
+ "bank_rakyat",
+ "bank_simpanan_nasional",
+ "barclays",
+ "blik_p_s_p",
+ "capital_one",
+ "chase",
+ "citi",
+ "cimb_bank",
+ "discover",
+ "navy_federal_credit_union",
+ "pentagon_federal_credit_union",
+ "synchrony_bank",
+ "wells_fargo",
+ "abn_amro",
+ "asn_bank",
+ "bunq",
+ "handelsbanken",
+ "hong_leong_bank",
+ "hsbc_bank",
+ "ing",
+ "knab",
+ "kuwait_finance_house",
+ "moneyou",
+ "rabobank",
+ "regiobank",
+ "revolut",
+ "sns_bank",
+ "triodos_bank",
+ "van_lanschot",
+ "arzte_und_apotheker_bank",
+ "austrian_anadi_bank_ag",
+ "bank_austria",
+ "bank99_ag",
+ "bankhaus_carl_spangler",
+ "bankhaus_schelhammer_und_schattera_ag",
+ "bank_millennium",
+ "bank_p_e_k_a_o_s_a",
+ "bawag_psk_ag",
+ "bks_bank_ag",
+ "brull_kallmus_bank_ag",
+ "btv_vier_lander_bank",
+ "capital_bank_grawe_gruppe_ag",
+ "ceska_sporitelna",
+ "dolomitenbank",
+ "easybank_ag",
+ "e_platby_v_u_b",
+ "erste_bank_und_sparkassen",
+ "friesland_bank",
+ "hypo_alpeadriabank_international_ag",
+ "hypo_noe_lb_fur_niederosterreich_u_wien",
+ "hypo_oberosterreich_salzburg_steiermark",
+ "hypo_tirol_bank_ag",
+ "hypo_vorarlberg_bank_ag",
+ "hypo_bank_burgenland_aktiengesellschaft",
+ "komercni_banka",
+ "m_bank",
+ "marchfelder_bank",
+ "maybank",
+ "oberbank_ag",
+ "osterreichische_arzte_und_apothekerbank",
+ "ocbc_bank",
+ "pay_with_i_n_g",
+ "place_z_i_p_k_o",
+ "platnosc_online_karta_platnicza",
+ "posojilnica_bank_e_gen",
+ "postova_banka",
+ "public_bank",
+ "raiffeisen_bankengruppe_osterreich",
+ "rhb_bank",
+ "schelhammer_capital_bank_ag",
+ "standard_chartered_bank",
+ "schoellerbank_ag",
+ "sparda_bank_wien",
+ "sporo_pay",
+ "santander_przelew24",
+ "tatra_pay",
+ "viamo",
+ "volksbank_gruppe",
+ "volkskreditbank_ag",
+ "vr_bank_braunau",
+ "uob_bank",
+ "pay_with_alior_bank",
+ "banki_spoldzielcze",
+ "pay_with_inteligo",
+ "b_n_p_paribas_poland",
+ "bank_nowy_s_a",
+ "credit_agricole",
+ "pay_with_b_o_s",
+ "pay_with_citi_handlowy",
+ "pay_with_plus_bank",
+ "toyota_bank",
+ "velo_bank",
+ "e_transfer_pocztowy24",
+ "plus_bank",
+ "etransfer_pocztowy24",
+ "banki_spbdzielcze",
+ "bank_nowy_bfg_sa",
+ "getin_bank",
+ "blik",
+ "noble_pay",
+ "idea_bank",
+ "envelo_bank",
+ "nest_przelew",
+ "mbank_mtransfer",
+ "inteligo",
+ "pbac_z_ipko",
+ "bnp_paribas",
+ "bank_pekao_sa",
+ "volkswagen_bank",
+ "alior_bank",
+ "boz",
+ "bangkok_bank",
+ "krungsri_bank",
+ "krung_thai_bank",
+ "the_siam_commercial_bank",
+ "kasikorn_bank",
+ "open_bank_success",
+ "open_bank_failure",
+ "open_bank_cancelled",
+ "aib",
+ "bank_of_scotland",
+ "danske_bank",
+ "first_direct",
+ "first_trust",
+ "halifax",
+ "lloyds",
+ "monzo",
+ "nat_west",
+ "nationwide_bank",
+ "royal_bank_of_scotland",
+ "starling",
+ "tsb_bank",
+ "tesco_bank",
+ "ulster_bank",
+ "yoursafe",
+ "n26",
+ "nationale_nederlanden"
+ ]
+ },
+ "BankRedirectBilling": {
+ "type": "object",
+ "required": [
+ "billing_name",
+ "email"
+ ],
+ "properties": {
+ "billing_name": {
+ "type": "string",
+ "description": "The name for which billing is issued",
+ "example": "John Doe"
+ },
+ "email": {
+ "type": "string",
+ "description": "The billing email for bank redirect",
+ "example": "[email protected]"
+ }
+ }
+ },
+ "BankRedirectData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "bancontact_card"
+ ],
+ "properties": {
+ "bancontact_card": {
+ "type": "object",
+ "required": [
+ "card_number",
+ "card_exp_month",
+ "card_exp_year",
+ "card_holder_name"
+ ],
+ "properties": {
+ "card_number": {
+ "type": "string",
+ "description": "The card number",
+ "example": "4242424242424242"
+ },
+ "card_exp_month": {
+ "type": "string",
+ "description": "The card's expiry month",
+ "example": "24"
+ },
+ "card_exp_year": {
+ "type": "string",
+ "description": "The card's expiry year",
+ "example": "24"
+ },
+ "card_holder_name": {
+ "type": "string",
+ "description": "The card holder's name",
+ "example": "John Test"
+ },
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankRedirectBilling"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bizum"
+ ],
+ "properties": {
+ "bizum": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "blik"
+ ],
+ "properties": {
+ "blik": {
+ "type": "object",
+ "properties": {
+ "blik_code": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "eps"
+ ],
+ "properties": {
+ "eps": {
+ "type": "object",
+ "required": [
+ "bank_name",
+ "country"
+ ],
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankRedirectBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "bank_name": {
+ "$ref": "#/components/schemas/BankNames"
+ },
+ "country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "giropay"
+ ],
+ "properties": {
+ "giropay": {
+ "type": "object",
+ "required": [
+ "country"
+ ],
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankRedirectBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "bank_account_bic": {
+ "type": "string",
+ "description": "Bank account details for Giropay\nBank account bic code",
+ "nullable": true
+ },
+ "bank_account_iban": {
+ "type": "string",
+ "description": "Bank account iban",
+ "nullable": true
+ },
+ "country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "ideal"
+ ],
+ "properties": {
+ "ideal": {
+ "type": "object",
+ "required": [
+ "bank_name",
+ "country"
+ ],
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankRedirectBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "bank_name": {
+ "$ref": "#/components/schemas/BankNames"
+ },
+ "country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "interac"
+ ],
+ "properties": {
+ "interac": {
+ "type": "object",
+ "properties": {
+ "country": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "example": "[email protected]",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "online_banking_czech_republic"
+ ],
+ "properties": {
+ "online_banking_czech_republic": {
+ "type": "object",
+ "required": [
+ "issuer"
+ ],
+ "properties": {
+ "issuer": {
+ "$ref": "#/components/schemas/BankNames"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "online_banking_finland"
+ ],
+ "properties": {
+ "online_banking_finland": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "online_banking_poland"
+ ],
+ "properties": {
+ "online_banking_poland": {
+ "type": "object",
+ "required": [
+ "issuer"
+ ],
+ "properties": {
+ "issuer": {
+ "$ref": "#/components/schemas/BankNames"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "online_banking_slovakia"
+ ],
+ "properties": {
+ "online_banking_slovakia": {
+ "type": "object",
+ "required": [
+ "issuer"
+ ],
+ "properties": {
+ "issuer": {
+ "$ref": "#/components/schemas/BankNames"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "open_banking_uk"
+ ],
+ "properties": {
+ "open_banking_uk": {
+ "type": "object",
+ "required": [
+ "issuer",
+ "country"
+ ],
+ "properties": {
+ "issuer": {
+ "$ref": "#/components/schemas/BankNames"
+ },
+ "country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "przelewy24"
+ ],
+ "properties": {
+ "przelewy24": {
+ "type": "object",
+ "required": [
+ "billing_details"
+ ],
+ "properties": {
+ "bank_name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankNames"
+ }
+ ],
+ "nullable": true
+ },
+ "billing_details": {
+ "$ref": "#/components/schemas/BankRedirectBilling"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "sofort"
+ ],
+ "properties": {
+ "sofort": {
+ "type": "object",
+ "required": [
+ "country"
+ ],
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankRedirectBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ },
+ "preferred_language": {
+ "type": "string",
+ "description": "The preferred language",
+ "example": "en",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "trustly"
+ ],
+ "properties": {
+ "trustly": {
+ "type": "object",
+ "required": [
+ "country"
+ ],
+ "properties": {
+ "country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "online_banking_fpx"
+ ],
+ "properties": {
+ "online_banking_fpx": {
+ "type": "object",
+ "required": [
+ "issuer"
+ ],
+ "properties": {
+ "issuer": {
+ "$ref": "#/components/schemas/BankNames"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "online_banking_thailand"
+ ],
+ "properties": {
+ "online_banking_thailand": {
+ "type": "object",
+ "required": [
+ "issuer"
+ ],
+ "properties": {
+ "issuer": {
+ "$ref": "#/components/schemas/BankNames"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "local_bank_redirect"
+ ],
+ "properties": {
+ "local_bank_redirect": {
+ "type": "object"
+ }
+ }
+ }
+ ]
+ },
+ "BankTransferData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "ach_bank_transfer"
+ ],
+ "properties": {
+ "ach_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AchBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "sepa_bank_transfer"
+ ],
+ "properties": {
+ "sepa_bank_transfer": {
+ "type": "object",
+ "required": [
+ "country"
+ ],
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SepaAndBacsBillingDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bacs_bank_transfer"
+ ],
+ "properties": {
+ "bacs_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SepaAndBacsBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "multibanco_bank_transfer"
+ ],
+ "properties": {
+ "multibanco_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MultibancoBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "permata_bank_transfer"
+ ],
+ "properties": {
+ "permata_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/DokuBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bca_bank_transfer"
+ ],
+ "properties": {
+ "bca_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/DokuBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bni_va_bank_transfer"
+ ],
+ "properties": {
+ "bni_va_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/DokuBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bri_va_bank_transfer"
+ ],
+ "properties": {
+ "bri_va_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/DokuBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "cimb_va_bank_transfer"
+ ],
+ "properties": {
+ "cimb_va_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/DokuBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "danamon_va_bank_transfer"
+ ],
+ "properties": {
+ "danamon_va_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/DokuBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "mandiri_va_bank_transfer"
+ ],
+ "properties": {
+ "mandiri_va_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "billing_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/DokuBillingDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "pix"
+ ],
+ "properties": {
+ "pix": {
+ "type": "object",
+ "properties": {
+ "pix_key": {
+ "type": "string",
+ "description": "Unique key for pix transfer",
+ "example": "a1f4102e-a446-4a57-bcce-6fa48899c1d1",
+ "nullable": true
+ },
+ "cpf": {
+ "type": "string",
+ "description": "CPF is a Brazilian tax identification number",
+ "example": "10599054689",
+ "nullable": true
+ },
+ "cnpj": {
+ "type": "string",
+ "description": "CNPJ is a Brazilian company tax identification number",
+ "example": "74469027417312",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "pse"
+ ],
+ "properties": {
+ "pse": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "local_bank_transfer"
+ ],
+ "properties": {
+ "local_bank_transfer": {
+ "type": "object",
+ "properties": {
+ "bank_code": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ ]
+ },
+ "BankTransferInstructions": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "doku_bank_transfer_instructions"
+ ],
+ "properties": {
+ "doku_bank_transfer_instructions": {
+ "$ref": "#/components/schemas/DokuBankTransferInstructions"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "ach_credit_transfer"
+ ],
+ "properties": {
+ "ach_credit_transfer": {
+ "$ref": "#/components/schemas/AchTransfer"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "sepa_bank_instructions"
+ ],
+ "properties": {
+ "sepa_bank_instructions": {
+ "$ref": "#/components/schemas/SepaBankTransferInstructions"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bacs_bank_instructions"
+ ],
+ "properties": {
+ "bacs_bank_instructions": {
+ "$ref": "#/components/schemas/BacsBankTransferInstructions"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "multibanco"
+ ],
+ "properties": {
+ "multibanco": {
+ "$ref": "#/components/schemas/MultibancoTransferInstructions"
+ }
+ }
+ }
+ ]
+ },
+ "BankTransferNextStepsData": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BankTransferInstructions"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "receiver": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ReceiverDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ ]
+ },
+ "BlocklistDataKind": {
+ "type": "string",
+ "enum": [
+ "payment_method",
+ "card_bin",
+ "extended_card_bin"
+ ]
+ },
+ "BlocklistRequest": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "card_bin"
+ ]
+ },
+ "data": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "fingerprint"
+ ]
+ },
+ "data": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "extended_card_bin"
+ ]
+ },
+ "data": {
+ "type": "string"
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "BlocklistResponse": {
+ "type": "object",
+ "required": [
+ "fingerprint_id",
+ "data_kind",
+ "created_at"
+ ],
+ "properties": {
+ "fingerprint_id": {
+ "type": "string"
+ },
+ "data_kind": {
+ "$ref": "#/components/schemas/BlocklistDataKind"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "BoletoVoucherData": {
+ "type": "object",
+ "properties": {
+ "social_security_number": {
+ "type": "string",
+ "description": "The shopper's social security number",
+ "nullable": true
+ }
+ }
+ },
+ "BrowserInformation": {
+ "type": "object",
+ "description": "Browser information to be used for 3DS 2.0",
+ "properties": {
+ "color_depth": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Color depth supported by the browser",
+ "nullable": true,
+ "minimum": 0
+ },
+ "java_enabled": {
+ "type": "boolean",
+ "description": "Whether java is enabled in the browser",
+ "nullable": true
+ },
+ "java_script_enabled": {
+ "type": "boolean",
+ "description": "Whether javascript is enabled in the browser",
+ "nullable": true
+ },
+ "language": {
+ "type": "string",
+ "description": "Language supported",
+ "nullable": true
+ },
+ "screen_height": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The screen height in pixels",
+ "nullable": true,
+ "minimum": 0
+ },
+ "screen_width": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The screen width in pixels",
+ "nullable": true,
+ "minimum": 0
+ },
+ "time_zone": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Time zone of the client",
+ "nullable": true
+ },
+ "ip_address": {
+ "type": "string",
+ "description": "Ip address of the client",
+ "nullable": true
+ },
+ "accept_header": {
+ "type": "string",
+ "description": "List of headers that are accepted",
+ "example": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
+ "nullable": true
+ },
+ "user_agent": {
+ "type": "string",
+ "description": "User-agent of the browser",
+ "nullable": true
+ }
+ }
+ },
+ "BusinessCollectLinkConfig": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BusinessGenericLinkConfig"
+ },
+ {
+ "type": "object",
+ "required": [
+ "enabled_payment_methods"
+ ],
+ "properties": {
+ "enabled_payment_methods": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EnabledPaymentMethod"
+ },
+ "description": "List of payment methods shown on collect UI",
+ "example": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\", \"sepa\"]}]"
+ }
+ }
+ }
+ ]
+ },
+ "BusinessGenericLinkConfig": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GenericLinkUiConfig"
+ },
+ {
+ "type": "object",
+ "required": [
+ "allowed_domains"
+ ],
+ "properties": {
+ "domain_name": {
+ "type": "string",
+ "description": "Custom domain name to be used for hosting the link",
+ "nullable": true
+ },
+ "allowed_domains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of allowed domains (glob patterns) where this link can be embedded / opened from",
+ "uniqueItems": true
+ }
+ }
+ }
+ ]
+ },
+ "BusinessPaymentLinkConfig": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentLinkConfigRequest"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "domain_name": {
+ "type": "string",
+ "description": "Custom domain name to be used for hosting the link in your own domain",
+ "nullable": true
+ },
+ "business_specific_configs": {
+ "type": "object",
+ "description": "list of configs for multi theme setup",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/PaymentLinkConfigRequest"
+ },
+ "nullable": true
+ },
+ "allowed_domains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of allowed domains (glob patterns) where this link can be embedded / opened from",
+ "uniqueItems": true,
+ "nullable": true
+ }
+ }
+ }
+ ]
+ },
+ "BusinessPayoutLinkConfig": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BusinessGenericLinkConfig"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "BusinessProfileCreate": {
+ "type": "object",
+ "properties": {
+ "profile_name": {
+ "type": "string",
+ "description": "The name of business profile",
+ "nullable": true,
+ "maxLength": 64
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to redirect after the completion of the operation",
+ "example": "https://www.example.com/success",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "enable_payment_response_hash": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if payment response hash needs to be enabled",
+ "default": true,
+ "example": true,
+ "nullable": true
+ },
+ "payment_response_hash_key": {
+ "type": "string",
+ "description": "Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a default value is used.",
+ "nullable": true
+ },
+ "redirect_to_merchant_with_http_post": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if redirect to merchant with http post needs to be enabled",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "webhook_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/WebhookDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Metadata is useful for storing additional, unstructured information on an object.",
+ "nullable": true
+ },
+ "routing_algorithm": {
+ "type": "object",
+ "description": "The routing algorithm to be used for routing payments to desired connectors",
+ "nullable": true
+ },
+ "intent_fulfillment_time": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Will be used to determine the time till which your payment will be active once the payment session starts",
+ "example": 900,
+ "nullable": true,
+ "minimum": 0
+ },
+ "frm_routing_algorithm": {
+ "type": "object",
+ "description": "The frm routing algorithm to be used for routing payments to desired FRM's",
+ "nullable": true
+ },
+ "payout_routing_algorithm": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RoutingAlgorithm"
+ }
+ ],
+ "nullable": true
+ },
+ "applepay_verified_domains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Verified applepay domains for a particular profile",
+ "nullable": true
+ },
+ "session_expiry": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Client Secret Default expiry for all payments created under this business profile",
+ "example": 900,
+ "nullable": true,
+ "minimum": 0
+ },
+ "payment_link_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BusinessPaymentLinkConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "authentication_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AuthenticationConnectorDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "use_billing_as_payment_method_billing": {
+ "type": "boolean",
+ "description": "Whether to use the billing details passed when creating the intent as payment method billing",
+ "nullable": true
+ },
+ "collect_shipping_details_from_wallet_connector": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if customer shipping details needs to be collected from wallet connector (Eg. Apple pay, Google pay etc)",
+ "default": false,
+ "example": false,
+ "nullable": true
+ },
+ "collect_billing_details_from_wallet_connector": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if customer billing details needs to be collected from wallet connector (Eg. Apple pay, Google pay etc)",
+ "default": false,
+ "example": false,
+ "nullable": true
+ },
+ "is_connector_agnostic_mit_enabled": {
+ "type": "boolean",
+ "description": "Indicates if the MIT (merchant initiated transaction) payments can be made connector\nagnostic, i.e., MITs may be processed through different connector than CIT (customer\ninitiated transaction) based on the routing rules.\nIf set to `false`, MIT will go through the same connector as the CIT.",
+ "nullable": true
+ },
+ "payout_link_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BusinessPayoutLinkConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "outgoing_webhook_custom_http_headers": {
+ "type": "object",
+ "description": "These key-value pairs are sent as additional custom headers in the outgoing webhook request. It is recommended not to use more than four key-value pairs.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "BusinessProfileResponse": {
+ "type": "object",
+ "required": [
+ "merchant_id",
+ "profile_id",
+ "profile_name",
+ "enable_payment_response_hash",
+ "redirect_to_merchant_with_http_post"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for Merchant Account",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The default business profile that must be used for creating merchant accounts and payments",
+ "example": "pro_abcdefghijklmnopqrstuvwxyz",
+ "maxLength": 64
+ },
+ "profile_name": {
+ "type": "string",
+ "description": "Name of the business profile",
+ "maxLength": 64
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to redirect after the completion of the operation",
+ "example": "https://www.example.com/success",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "enable_payment_response_hash": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if payment response hash needs to be enabled",
+ "default": true,
+ "example": true
+ },
+ "payment_response_hash_key": {
+ "type": "string",
+ "description": "Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a default value is used.",
+ "nullable": true
+ },
+ "redirect_to_merchant_with_http_post": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if redirect to merchant with http post needs to be enabled",
+ "default": false,
+ "example": true
+ },
+ "webhook_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/WebhookDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Metadata is useful for storing additional, unstructured information on an object.",
+ "nullable": true
+ },
+ "routing_algorithm": {
+ "type": "object",
+ "description": "The routing algorithm to be used for routing payments to desired connectors",
+ "nullable": true
+ },
+ "intent_fulfillment_time": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Will be used to determine the time till which your payment will be active once the payment session starts",
+ "example": 900,
+ "nullable": true
+ },
+ "frm_routing_algorithm": {
+ "type": "object",
+ "description": "The routing algorithm to be used to process the incoming request from merchant to outgoing payment processor or payment method. The default is 'Custom'",
+ "nullable": true
+ },
+ "payout_routing_algorithm": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RoutingAlgorithm"
+ }
+ ],
+ "nullable": true
+ },
+ "applepay_verified_domains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Verified applepay domains for a particular profile",
+ "nullable": true
+ },
+ "session_expiry": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Client Secret Default expiry for all payments created under this business profile",
+ "example": 900,
+ "nullable": true
+ },
+ "payment_link_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BusinessPaymentLinkConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "authentication_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AuthenticationConnectorDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "use_billing_as_payment_method_billing": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "extended_card_info_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ExtendedCardInfoConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "collect_shipping_details_from_wallet_connector": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if customer shipping details needs to be collected from wallet connector (Eg. Apple pay, Google pay etc)",
+ "default": false,
+ "example": false,
+ "nullable": true
+ },
+ "collect_billing_details_from_wallet_connector": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if customer billing details needs to be collected from wallet connector (Eg. Apple pay, Google pay etc)",
+ "default": false,
+ "example": false,
+ "nullable": true
+ },
+ "is_connector_agnostic_mit_enabled": {
+ "type": "boolean",
+ "description": "Indicates if the MIT (merchant initiated transaction) payments can be made connector\nagnostic, i.e., MITs may be processed through different connector than CIT (customer\ninitiated transaction) based on the routing rules.\nIf set to `false`, MIT will go through the same connector as the CIT.",
+ "nullable": true
+ },
+ "payout_link_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BusinessPayoutLinkConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "outgoing_webhook_custom_http_headers": {
+ "type": "object",
+ "description": "These key-value pairs are sent as additional custom headers in the outgoing webhook request.",
+ "nullable": true
+ }
+ }
+ },
+ "CaptureMethod": {
+ "type": "string",
+ "description": "Default value if not passed is set to 'automatic' which results in Auth and Capture in one single API request. Pass 'manual' or 'manual_multiple' in case you want do a separate Auth and Capture by first authorizing and placing a hold on your customer's funds so that you can use the Payments/Capture endpoint later to capture the authorized amount. Pass 'manual' if you want to only capture the amount later once or 'manual_multiple' if you want to capture the funds multiple times later. Both 'manual' and 'manual_multiple' are only supported by a specific list of processors",
+ "enum": [
+ "automatic",
+ "manual",
+ "manual_multiple",
+ "scheduled"
+ ]
+ },
+ "CaptureResponse": {
+ "type": "object",
+ "required": [
+ "capture_id",
+ "status",
+ "amount",
+ "connector",
+ "authorized_attempt_id",
+ "capture_sequence"
+ ],
+ "properties": {
+ "capture_id": {
+ "type": "string",
+ "description": "Unique identifier for the capture"
+ },
+ "status": {
+ "$ref": "#/components/schemas/CaptureStatus"
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The capture amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,",
+ "example": 6540
+ },
+ "currency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Currency"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "string",
+ "description": "The connector used for the payment"
+ },
+ "authorized_attempt_id": {
+ "type": "string",
+ "description": "Unique identifier for the parent attempt on which this capture is made"
+ },
+ "connector_capture_id": {
+ "type": "string",
+ "description": "A unique identifier for this capture provided by the connector",
+ "nullable": true
+ },
+ "capture_sequence": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Sequence number of this capture, in the series of captures made for the parent attempt"
+ },
+ "error_message": {
+ "type": "string",
+ "description": "If there was an error while calling the connector the error message is received here",
+ "nullable": true
+ },
+ "error_code": {
+ "type": "string",
+ "description": "If there was an error while calling the connectors the code is received here",
+ "nullable": true
+ },
+ "error_reason": {
+ "type": "string",
+ "description": "If there was an error while calling the connectors the reason is received here",
+ "nullable": true
+ },
+ "reference_id": {
+ "type": "string",
+ "description": "Reference to the capture at connector side",
+ "nullable": true
+ }
+ }
+ },
+ "CaptureStatus": {
+ "type": "string",
+ "enum": [
+ "started",
+ "charged",
+ "pending",
+ "failed"
+ ]
+ },
+ "Card": {
+ "type": "object",
+ "required": [
+ "card_number",
+ "card_exp_month",
+ "card_exp_year",
+ "card_holder_name",
+ "card_cvc"
+ ],
+ "properties": {
+ "card_number": {
+ "type": "string",
+ "description": "The card number",
+ "example": "4242424242424242"
+ },
+ "card_exp_month": {
+ "type": "string",
+ "description": "The card's expiry month",
+ "example": "24"
+ },
+ "card_exp_year": {
+ "type": "string",
+ "description": "The card's expiry year",
+ "example": "24"
+ },
+ "card_holder_name": {
+ "type": "string",
+ "description": "The card holder's name",
+ "example": "John Test"
+ },
+ "card_cvc": {
+ "type": "string",
+ "description": "The CVC number for the card",
+ "example": "242"
+ },
+ "card_issuer": {
+ "type": "string",
+ "description": "The name of the issuer of card",
+ "example": "chase",
+ "nullable": true
+ },
+ "card_network": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardNetwork"
+ }
+ ],
+ "nullable": true
+ },
+ "card_type": {
+ "type": "string",
+ "example": "CREDIT",
+ "nullable": true
+ },
+ "card_issuing_country": {
+ "type": "string",
+ "example": "INDIA",
+ "nullable": true
+ },
+ "bank_code": {
+ "type": "string",
+ "example": "JP_AMEX",
+ "nullable": true
+ },
+ "nick_name": {
+ "type": "string",
+ "description": "The card holder's nick name",
+ "example": "John Test",
+ "nullable": true
+ }
+ }
+ },
+ "CardDetail": {
+ "type": "object",
+ "required": [
+ "card_number",
+ "card_exp_month",
+ "card_exp_year",
+ "card_holder_name"
+ ],
+ "properties": {
+ "card_number": {
+ "type": "string",
+ "description": "Card Number",
+ "example": "4111111145551142"
+ },
+ "card_exp_month": {
+ "type": "string",
+ "description": "Card Expiry Month",
+ "example": "10"
+ },
+ "card_exp_year": {
+ "type": "string",
+ "description": "Card Expiry Year",
+ "example": "25"
+ },
+ "card_holder_name": {
+ "type": "string",
+ "description": "Card Holder Name",
+ "example": "John Doe"
+ },
+ "nick_name": {
+ "type": "string",
+ "description": "Card Holder's Nick Name",
+ "example": "John Doe",
+ "nullable": true
+ },
+ "card_issuing_country": {
+ "type": "string",
+ "description": "Card Issuing Country",
+ "nullable": true
+ },
+ "card_network": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardNetwork"
+ }
+ ],
+ "nullable": true
+ },
+ "card_issuer": {
+ "type": "string",
+ "description": "Issuer Bank for Card",
+ "nullable": true
+ },
+ "card_type": {
+ "type": "string",
+ "description": "Card Type",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "CardDetailFromLocker": {
+ "type": "object",
+ "required": [
+ "saved_to_locker"
+ ],
+ "properties": {
+ "scheme": {
+ "type": "string",
+ "nullable": true
+ },
+ "issuer_country": {
+ "type": "string",
+ "nullable": true
+ },
+ "last4_digits": {
+ "type": "string",
+ "nullable": true
+ },
+ "expiry_month": {
+ "type": "string",
+ "nullable": true
+ },
+ "expiry_year": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_token": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_holder_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_fingerprint": {
+ "type": "string",
+ "nullable": true
+ },
+ "nick_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_network": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardNetwork"
+ }
+ ],
+ "nullable": true
+ },
+ "card_isin": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_issuer": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_type": {
+ "type": "string",
+ "nullable": true
+ },
+ "saved_to_locker": {
+ "type": "boolean"
+ }
+ }
+ },
+ "CardDetailUpdate": {
+ "type": "object",
+ "required": [
+ "card_exp_month",
+ "card_exp_year",
+ "card_holder_name"
+ ],
+ "properties": {
+ "card_exp_month": {
+ "type": "string",
+ "description": "Card Expiry Month",
+ "example": "10"
+ },
+ "card_exp_year": {
+ "type": "string",
+ "description": "Card Expiry Year",
+ "example": "25"
+ },
+ "card_holder_name": {
+ "type": "string",
+ "description": "Card Holder Name",
+ "example": "John Doe"
+ },
+ "nick_name": {
+ "type": "string",
+ "description": "Card Holder's Nick Name",
+ "example": "John Doe",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "CardNetwork": {
+ "type": "string",
+ "description": "Indicates the card network.",
+ "enum": [
+ "Visa",
+ "Mastercard",
+ "AmericanExpress",
+ "JCB",
+ "DinersClub",
+ "Discover",
+ "CartesBancaires",
+ "UnionPay",
+ "Interac",
+ "RuPay",
+ "Maestro"
+ ]
+ },
+ "CardPayout": {
+ "type": "object",
+ "required": [
+ "card_number",
+ "expiry_month",
+ "expiry_year",
+ "card_holder_name"
+ ],
+ "properties": {
+ "card_number": {
+ "type": "string",
+ "description": "The card number",
+ "example": "4242424242424242"
+ },
+ "expiry_month": {
+ "type": "string",
+ "description": "The card's expiry month"
+ },
+ "expiry_year": {
+ "type": "string",
+ "description": "The card's expiry year"
+ },
+ "card_holder_name": {
+ "type": "string",
+ "description": "The card holder's name",
+ "example": "John Doe"
+ }
+ }
+ },
+ "CardRedirectData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "knet"
+ ],
+ "properties": {
+ "knet": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "benefit"
+ ],
+ "properties": {
+ "benefit": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "momo_atm"
+ ],
+ "properties": {
+ "momo_atm": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "card_redirect"
+ ],
+ "properties": {
+ "card_redirect": {
+ "type": "object"
+ }
+ }
+ }
+ ]
+ },
+ "CardResponse": {
+ "type": "object",
+ "properties": {
+ "last4": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_type": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_network": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardNetwork"
+ }
+ ],
+ "nullable": true
+ },
+ "card_issuer": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_issuing_country": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_isin": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_extended_bin": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_exp_month": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_exp_year": {
+ "type": "string",
+ "nullable": true
+ },
+ "card_holder_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "payment_checks": {
+ "nullable": true
+ },
+ "authentication_data": {
+ "nullable": true
+ }
+ }
+ },
+ "CardToken": {
+ "type": "object",
+ "required": [
+ "card_holder_name"
+ ],
+ "properties": {
+ "card_holder_name": {
+ "type": "string",
+ "description": "The card holder's name",
+ "example": "John Test"
+ },
+ "card_cvc": {
+ "type": "string",
+ "description": "The CVC number for the card",
+ "nullable": true
+ }
+ }
+ },
+ "CashappQr": {
+ "type": "object"
+ },
+ "ChargeRefunds": {
+ "type": "object",
+ "description": "Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.",
+ "required": [
+ "charge_id"
+ ],
+ "properties": {
+ "charge_id": {
+ "type": "string",
+ "description": "Identifier for charge created for the payment"
+ },
+ "revert_platform_fee": {
+ "type": "boolean",
+ "description": "Toggle for reverting the application fee that was collected for the payment.\nIf set to false, the funds are pulled from the destination account.",
+ "nullable": true
+ },
+ "revert_transfer": {
+ "type": "boolean",
+ "description": "Toggle for reverting the transfer that was made during the charge.\nIf set to false, the funds are pulled from the main platform's account.",
+ "nullable": true
+ }
+ }
+ },
+ "Comparison": {
+ "type": "object",
+ "description": "Represents a single comparison condition.",
+ "required": [
+ "lhs",
+ "comparison",
+ "value",
+ "metadata"
+ ],
+ "properties": {
+ "lhs": {
+ "type": "string",
+ "description": "The left hand side which will always be a domain input identifier like \"payment.method.cardtype\""
+ },
+ "comparison": {
+ "$ref": "#/components/schemas/ComparisonType"
+ },
+ "value": {
+ "$ref": "#/components/schemas/ValueType"
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Additional metadata that the Static Analyzer and Backend does not touch.\nThis can be used to store useful information for the frontend and is required for communication\nbetween the static analyzer and the frontend.",
+ "additionalProperties": {}
+ }
+ }
+ },
+ "ComparisonType": {
+ "type": "string",
+ "description": "Conditional comparison type",
+ "enum": [
+ "equal",
+ "not_equal",
+ "less_than",
+ "less_than_equal",
+ "greater_than",
+ "greater_than_equal"
+ ]
+ },
+ "Connector": {
+ "type": "string",
+ "description": "A connector is an integration to fulfill payments",
+ "enum": [
+ "adyenplatform",
+ "phonypay",
+ "fauxpay",
+ "pretendpay",
+ "stripe_test",
+ "adyen_test",
+ "checkout_test",
+ "paypal_test",
+ "aci",
+ "adyen",
+ "airwallex",
+ "authorizedotnet",
+ "bambora",
+ "bamboraapac",
+ "bankofamerica",
+ "billwerk",
+ "bitpay",
+ "bluesnap",
+ "boku",
+ "braintree",
+ "cashtocode",
+ "checkout",
+ "coinbase",
+ "cryptopay",
+ "cybersource",
+ "datatrans",
+ "dlocal",
+ "ebanx",
+ "fiserv",
+ "forte",
+ "globalpay",
+ "globepay",
+ "gocardless",
+ "gpayments",
+ "helcim",
+ "iatapay",
+ "itaubank",
+ "klarna",
+ "mifinity",
+ "mollie",
+ "multisafepay",
+ "netcetera",
+ "nexinets",
+ "nmi",
+ "noon",
+ "nuvei",
+ "opennode",
+ "payme",
+ "payone",
+ "paypal",
+ "payu",
+ "placetopay",
+ "powertranz",
+ "prophetpay",
+ "rapyd",
+ "razorpay",
+ "shift4",
+ "square",
+ "stax",
+ "stripe",
+ "threedsecureio",
+ "trustpay",
+ "tsys",
+ "volt",
+ "wellsfargo",
+ "wise",
+ "worldline",
+ "worldpay",
+ "signifyd",
+ "plaid",
+ "riskified",
+ "zen",
+ "zsl"
+ ]
+ },
+ "ConnectorMetadata": {
+ "type": "object",
+ "description": "Some connectors like Apple Pay, Airwallex and Noon might require some additional information, find specific details in the child attributes below.",
+ "properties": {
+ "apple_pay": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ApplepayConnectorMetadataRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "airwallex": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AirwallexData"
+ }
+ ],
+ "nullable": true
+ },
+ "noon": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/NoonData"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "ConnectorSelection": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "priority"
+ ]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RoutableConnectorChoice"
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "volume_split"
+ ]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ConnectorVolumeSplit"
+ }
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "ConnectorStatus": {
+ "type": "string",
+ "enum": [
+ "inactive",
+ "active"
+ ]
+ },
+ "ConnectorType": {
+ "type": "string",
+ "description": "Type of the Connector for the financial use case. Could range from Payments to Accounting to Banking.",
+ "enum": [
+ "payment_processor",
+ "payment_vas",
+ "fin_operations",
+ "fiz_operations",
+ "networks",
+ "banking_entities",
+ "non_banking_finance",
+ "payout_processor",
+ "payment_method_auth",
+ "authentication_processor"
+ ]
+ },
+ "ConnectorVolumeSplit": {
+ "type": "object",
+ "required": [
+ "connector",
+ "split"
+ ],
+ "properties": {
+ "connector": {
+ "$ref": "#/components/schemas/RoutableConnectorChoice"
+ },
+ "split": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0
+ }
+ }
+ },
+ "CountryAlpha2": {
+ "type": "string",
+ "enum": [
+ "AF",
+ "AX",
+ "AL",
+ "DZ",
+ "AS",
+ "AD",
+ "AO",
+ "AI",
+ "AQ",
+ "AG",
+ "AR",
+ "AM",
+ "AW",
+ "AU",
+ "AT",
+ "AZ",
+ "BS",
+ "BH",
+ "BD",
+ "BB",
+ "BY",
+ "BE",
+ "BZ",
+ "BJ",
+ "BM",
+ "BT",
+ "BO",
+ "BQ",
+ "BA",
+ "BW",
+ "BV",
+ "BR",
+ "IO",
+ "BN",
+ "BG",
+ "BF",
+ "BI",
+ "KH",
+ "CM",
+ "CA",
+ "CV",
+ "KY",
+ "CF",
+ "TD",
+ "CL",
+ "CN",
+ "CX",
+ "CC",
+ "CO",
+ "KM",
+ "CG",
+ "CD",
+ "CK",
+ "CR",
+ "CI",
+ "HR",
+ "CU",
+ "CW",
+ "CY",
+ "CZ",
+ "DK",
+ "DJ",
+ "DM",
+ "DO",
+ "EC",
+ "EG",
+ "SV",
+ "GQ",
+ "ER",
+ "EE",
+ "ET",
+ "FK",
+ "FO",
+ "FJ",
+ "FI",
+ "FR",
+ "GF",
+ "PF",
+ "TF",
+ "GA",
+ "GM",
+ "GE",
+ "DE",
+ "GH",
+ "GI",
+ "GR",
+ "GL",
+ "GD",
+ "GP",
+ "GU",
+ "GT",
+ "GG",
+ "GN",
+ "GW",
+ "GY",
+ "HT",
+ "HM",
+ "VA",
+ "HN",
+ "HK",
+ "HU",
+ "IS",
+ "IN",
+ "ID",
+ "IR",
+ "IQ",
+ "IE",
+ "IM",
+ "IL",
+ "IT",
+ "JM",
+ "JP",
+ "JE",
+ "JO",
+ "KZ",
+ "KE",
+ "KI",
+ "KP",
+ "KR",
+ "KW",
+ "KG",
+ "LA",
+ "LV",
+ "LB",
+ "LS",
+ "LR",
+ "LY",
+ "LI",
+ "LT",
+ "LU",
+ "MO",
+ "MK",
+ "MG",
+ "MW",
+ "MY",
+ "MV",
+ "ML",
+ "MT",
+ "MH",
+ "MQ",
+ "MR",
+ "MU",
+ "YT",
+ "MX",
+ "FM",
+ "MD",
+ "MC",
+ "MN",
+ "ME",
+ "MS",
+ "MA",
+ "MZ",
+ "MM",
+ "NA",
+ "NR",
+ "NP",
+ "NL",
+ "NC",
+ "NZ",
+ "NI",
+ "NE",
+ "NG",
+ "NU",
+ "NF",
+ "MP",
+ "NO",
+ "OM",
+ "PK",
+ "PW",
+ "PS",
+ "PA",
+ "PG",
+ "PY",
+ "PE",
+ "PH",
+ "PN",
+ "PL",
+ "PT",
+ "PR",
+ "QA",
+ "RE",
+ "RO",
+ "RU",
+ "RW",
+ "BL",
+ "SH",
+ "KN",
+ "LC",
+ "MF",
+ "PM",
+ "VC",
+ "WS",
+ "SM",
+ "ST",
+ "SA",
+ "SN",
+ "RS",
+ "SC",
+ "SL",
+ "SG",
+ "SX",
+ "SK",
+ "SI",
+ "SB",
+ "SO",
+ "ZA",
+ "GS",
+ "SS",
+ "ES",
+ "LK",
+ "SD",
+ "SR",
+ "SJ",
+ "SZ",
+ "SE",
+ "CH",
+ "SY",
+ "TW",
+ "TJ",
+ "TZ",
+ "TH",
+ "TL",
+ "TG",
+ "TK",
+ "TO",
+ "TT",
+ "TN",
+ "TR",
+ "TM",
+ "TC",
+ "TV",
+ "UG",
+ "UA",
+ "AE",
+ "GB",
+ "UM",
+ "UY",
+ "UZ",
+ "VU",
+ "VE",
+ "VN",
+ "VG",
+ "VI",
+ "WF",
+ "EH",
+ "YE",
+ "ZM",
+ "ZW",
+ "US"
+ ]
+ },
+ "CreateApiKeyRequest": {
+ "type": "object",
+ "description": "The request body for creating an API Key.",
+ "required": [
+ "name",
+ "expiration"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "A unique name for the API Key to help you identify it.",
+ "example": "Sandbox integration key",
+ "maxLength": 64
+ },
+ "description": {
+ "type": "string",
+ "description": "A description to provide more context about the API Key.",
+ "example": "Key used by our developers to integrate with the sandbox environment",
+ "nullable": true,
+ "maxLength": 256
+ },
+ "expiration": {
+ "$ref": "#/components/schemas/ApiKeyExpiration"
+ }
+ },
+ "additionalProperties": false
+ },
+ "CreateApiKeyResponse": {
+ "type": "object",
+ "description": "The response body for creating an API Key.",
+ "required": [
+ "key_id",
+ "merchant_id",
+ "name",
+ "api_key",
+ "created",
+ "expiration"
+ ],
+ "properties": {
+ "key_id": {
+ "type": "string",
+ "description": "The identifier for the API Key.",
+ "example": "5hEEqkgJUyuxgSKGArHA4mWSnX",
+ "maxLength": 64
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account.",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64
+ },
+ "name": {
+ "type": "string",
+ "description": "The unique name for the API Key to help you identify it.",
+ "example": "Sandbox integration key",
+ "maxLength": 64
+ },
+ "description": {
+ "type": "string",
+ "description": "The description to provide more context about the API Key.",
+ "example": "Key used by our developers to integrate with the sandbox environment",
+ "nullable": true,
+ "maxLength": 256
+ },
+ "api_key": {
+ "type": "string",
+ "description": "The plaintext API Key used for server-side API access. Ensure you store the API Key\nsecurely as you will not be able to see it again.",
+ "maxLength": 128
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time at which the API Key was created.",
+ "example": "2022-09-10T10:11:12Z"
+ },
+ "expiration": {
+ "$ref": "#/components/schemas/ApiKeyExpiration"
+ }
+ }
+ },
+ "CryptoData": {
+ "type": "object",
+ "properties": {
+ "pay_currency": {
+ "type": "string",
+ "nullable": true
+ },
+ "network": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "Currency": {
+ "type": "string",
+ "description": "The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.",
+ "enum": [
+ "AED",
+ "ALL",
+ "AMD",
+ "ANG",
+ "AOA",
+ "ARS",
+ "AUD",
+ "AWG",
+ "AZN",
+ "BAM",
+ "BBD",
+ "BDT",
+ "BGN",
+ "BHD",
+ "BIF",
+ "BMD",
+ "BND",
+ "BOB",
+ "BRL",
+ "BSD",
+ "BWP",
+ "BYN",
+ "BZD",
+ "CAD",
+ "CHF",
+ "CLP",
+ "CNY",
+ "COP",
+ "CRC",
+ "CUP",
+ "CVE",
+ "CZK",
+ "DJF",
+ "DKK",
+ "DOP",
+ "DZD",
+ "EGP",
+ "ETB",
+ "EUR",
+ "FJD",
+ "FKP",
+ "GBP",
+ "GEL",
+ "GHS",
+ "GIP",
+ "GMD",
+ "GNF",
+ "GTQ",
+ "GYD",
+ "HKD",
+ "HNL",
+ "HRK",
+ "HTG",
+ "HUF",
+ "IDR",
+ "ILS",
+ "INR",
+ "IQD",
+ "JMD",
+ "JOD",
+ "JPY",
+ "KES",
+ "KGS",
+ "KHR",
+ "KMF",
+ "KRW",
+ "KWD",
+ "KYD",
+ "KZT",
+ "LAK",
+ "LBP",
+ "LKR",
+ "LRD",
+ "LSL",
+ "LYD",
+ "MAD",
+ "MDL",
+ "MGA",
+ "MKD",
+ "MMK",
+ "MNT",
+ "MOP",
+ "MRU",
+ "MUR",
+ "MVR",
+ "MWK",
+ "MXN",
+ "MYR",
+ "MZN",
+ "NAD",
+ "NGN",
+ "NIO",
+ "NOK",
+ "NPR",
+ "NZD",
+ "OMR",
+ "PAB",
+ "PEN",
+ "PGK",
+ "PHP",
+ "PKR",
+ "PLN",
+ "PYG",
+ "QAR",
+ "RON",
+ "RSD",
+ "RUB",
+ "RWF",
+ "SAR",
+ "SBD",
+ "SCR",
+ "SEK",
+ "SGD",
+ "SHP",
+ "SLE",
+ "SLL",
+ "SOS",
+ "SRD",
+ "SSP",
+ "STN",
+ "SVC",
+ "SZL",
+ "THB",
+ "TND",
+ "TOP",
+ "TRY",
+ "TTD",
+ "TWD",
+ "TZS",
+ "UAH",
+ "UGX",
+ "USD",
+ "UYU",
+ "UZS",
+ "VES",
+ "VND",
+ "VUV",
+ "WST",
+ "XAF",
+ "XCD",
+ "XOF",
+ "XPF",
+ "YER",
+ "ZAR",
+ "ZMW"
+ ]
+ },
+ "CustomerAcceptance": {
+ "type": "object",
+ "description": "This \"CustomerAcceptance\" object is passed during Payments-Confirm request, it enlists the type, time, and mode of acceptance properties related to an acceptance done by the customer. The customer_acceptance sub object is usually passed by the SDK or client.",
+ "required": [
+ "acceptance_type"
+ ],
+ "properties": {
+ "acceptance_type": {
+ "$ref": "#/components/schemas/AcceptanceType"
+ },
+ "accepted_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Specifying when the customer acceptance was provided",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "online": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OnlineMandate"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "CustomerDefaultPaymentMethodResponse": {
+ "type": "object",
+ "required": [
+ "customer_id",
+ "payment_method"
+ ],
+ "properties": {
+ "default_payment_method_id": {
+ "type": "string",
+ "description": "The unique identifier of the Payment method",
+ "example": "card_rGK4Vi5iSW70MY7J2mIg",
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The unique identifier of the customer.",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "CustomerDeleteResponse": {
+ "type": "object",
+ "required": [
+ "customer_id",
+ "customer_deleted",
+ "address_deleted",
+ "payment_methods_deleted"
+ ],
+ "properties": {
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for the customer object",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 255
+ },
+ "customer_deleted": {
+ "type": "boolean",
+ "description": "Whether customer was deleted or not",
+ "example": false
+ },
+ "address_deleted": {
+ "type": "boolean",
+ "description": "Whether address was deleted or not",
+ "example": false
+ },
+ "payment_methods_deleted": {
+ "type": "boolean",
+ "description": "Whether payment methods deleted or not",
+ "example": false
+ }
+ }
+ },
+ "CustomerDetails": {
+ "type": "object",
+ "description": "Passing this object creates a new customer or attaches an existing customer to the payment",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier for the customer.",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "name": {
+ "type": "string",
+ "description": "The customer's name",
+ "example": "John Doe",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "email": {
+ "type": "string",
+ "description": "The customer's email address",
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone": {
+ "type": "string",
+ "description": "The customer's phone number",
+ "example": "9123456789",
+ "nullable": true,
+ "maxLength": 10
+ },
+ "phone_country_code": {
+ "type": "string",
+ "description": "The country code for the customer's phone number",
+ "example": "+1",
+ "nullable": true,
+ "maxLength": 2
+ }
+ }
+ },
+ "CustomerDetailsResponse": {
+ "type": "object",
+ "description": "Details of customer attached to this payment",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier for the customer.",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "name": {
+ "type": "string",
+ "description": "The customer's name",
+ "example": "John Doe",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "email": {
+ "type": "string",
+ "description": "The customer's email address",
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone": {
+ "type": "string",
+ "description": "The customer's phone number",
+ "example": "9123456789",
+ "nullable": true,
+ "maxLength": 10
+ },
+ "phone_country_code": {
+ "type": "string",
+ "description": "The country code for the customer's phone number",
+ "example": "+1",
+ "nullable": true,
+ "maxLength": 2
+ }
+ }
+ },
+ "CustomerPaymentMethod": {
+ "type": "object",
+ "required": [
+ "payment_token",
+ "payment_method_id",
+ "customer_id",
+ "payment_method",
+ "recurring_enabled",
+ "installment_payment_enabled",
+ "requires_cvv",
+ "default_payment_method_set"
+ ],
+ "properties": {
+ "payment_token": {
+ "type": "string",
+ "description": "Token for payment method in temporary card locker which gets refreshed often",
+ "example": "7ebf443f-a050-4067-84e5-e6f6d4800aef"
+ },
+ "payment_method_id": {
+ "type": "string",
+ "description": "The unique identifier of the customer.",
+ "example": "pm_iouuy468iyuowqs"
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The unique identifier of the customer.",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_issuer": {
+ "type": "string",
+ "description": "The name of the bank/ provider issuing the payment method to the end user",
+ "example": "Citibank",
+ "nullable": true
+ },
+ "payment_method_issuer_code": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodIssuerCode"
+ }
+ ],
+ "nullable": true
+ },
+ "recurring_enabled": {
+ "type": "boolean",
+ "description": "Indicates whether the payment method is eligible for recurring payments",
+ "example": true
+ },
+ "installment_payment_enabled": {
+ "type": "boolean",
+ "description": "Indicates whether the payment method is eligible for installment payments",
+ "example": true
+ },
+ "payment_experience": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentExperience"
+ },
+ "description": "Type of payment experience enabled with the connector",
+ "example": [
+ "redirect_to_url"
+ ],
+ "nullable": true
+ },
+ "card": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardDetailFromLocker"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "A timestamp (ISO 8601 code) that determines when the customer was created",
+ "example": "2023-01-18T11:04:09.922Z",
+ "nullable": true
+ },
+ "bank_transfer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Bank"
+ }
+ ],
+ "nullable": true
+ },
+ "bank": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MaskedBankDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "surcharge_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SurchargeDetailsResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "requires_cvv": {
+ "type": "boolean",
+ "description": "Whether this payment method requires CVV to be collected",
+ "example": true
+ },
+ "last_used_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "A timestamp (ISO 8601 code) that determines when the payment method was last used",
+ "example": "2024-02-24T11:04:09.922Z",
+ "nullable": true
+ },
+ "default_payment_method_set": {
+ "type": "boolean",
+ "description": "Indicates if the payment method has been set to default or not",
+ "example": true
+ },
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "CustomerPaymentMethodsListResponse": {
+ "type": "object",
+ "required": [
+ "customer_payment_methods"
+ ],
+ "properties": {
+ "customer_payment_methods": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CustomerPaymentMethod"
+ },
+ "description": "List of payment methods for customer"
+ },
+ "is_guest_customer": {
+ "type": "boolean",
+ "description": "Returns whether a customer id is not tied to a payment intent (only when the request is made against a client secret)",
+ "nullable": true
+ }
+ }
+ },
+ "CustomerRequest": {
+ "type": "object",
+ "description": "The customer details",
+ "required": [
+ "name",
+ "email"
+ ],
+ "properties": {
+ "merchant_reference_id": {
+ "type": "string",
+ "description": "The merchant identifier for the customer object.",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "name": {
+ "type": "string",
+ "description": "The customer's name",
+ "example": "Jon Test",
+ "maxLength": 255
+ },
+ "email": {
+ "type": "string",
+ "description": "The customer's email address",
+ "example": "[email protected]",
+ "maxLength": 255
+ },
+ "phone": {
+ "type": "string",
+ "description": "The customer's phone number",
+ "example": "9123456789",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "description": {
+ "type": "string",
+ "description": "An arbitrary string that you can attach to a customer object.",
+ "example": "First Customer",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone_country_code": {
+ "type": "string",
+ "description": "The country code for the customer phone number",
+ "example": "+65",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "default_billing_address": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AddressDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "default_shipping_address": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AddressDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500\ncharacters long. Metadata is useful for storing additional, structured information on an\nobject.",
+ "nullable": true
+ }
+ }
+ },
+ "CustomerResponse": {
+ "type": "object",
+ "required": [
+ "merchant_reference_id",
+ "created_at"
+ ],
+ "properties": {
+ "merchant_reference_id": {
+ "type": "string",
+ "description": "The identifier for the customer object",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "name": {
+ "type": "string",
+ "description": "The customer's name",
+ "example": "Jon Test",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "email": {
+ "type": "string",
+ "description": "The customer's email address",
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone": {
+ "type": "string",
+ "description": "The customer's phone number",
+ "example": "9123456789",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone_country_code": {
+ "type": "string",
+ "description": "The country code for the customer phone number",
+ "example": "+65",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "description": {
+ "type": "string",
+ "description": "An arbitrary string that you can attach to a customer object.",
+ "example": "First Customer",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "default_billing_address": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AddressDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "default_shipping_address": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AddressDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "A timestamp (ISO 8601 code) that determines when the customer was created",
+ "example": "2023-01-18T11:04:09.922Z"
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500\ncharacters long. Metadata is useful for storing additional, structured information on an\nobject.",
+ "nullable": true
+ },
+ "default_payment_method_id": {
+ "type": "string",
+ "description": "The identifier for the default payment method.",
+ "example": "pm_djh2837dwduh890123",
+ "nullable": true,
+ "maxLength": 64
+ }
+ }
+ },
+ "DecoupledAuthenticationType": {
+ "type": "string",
+ "enum": [
+ "challenge",
+ "frictionless"
+ ]
+ },
+ "DefaultPaymentMethod": {
+ "type": "object",
+ "required": [
+ "customer_id",
+ "payment_method_id"
+ ],
+ "properties": {
+ "customer_id": {
+ "type": "string",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "payment_method_id": {
+ "type": "string"
+ }
+ }
+ },
+ "DeviceChannel": {
+ "type": "string",
+ "description": "Device Channel indicating whether request is coming from App or Browser",
+ "enum": [
+ "APP",
+ "BRW"
+ ]
+ },
+ "DisputeResponse": {
+ "type": "object",
+ "required": [
+ "dispute_id",
+ "payment_id",
+ "attempt_id",
+ "amount",
+ "currency",
+ "dispute_stage",
+ "dispute_status",
+ "connector",
+ "connector_status",
+ "connector_dispute_id",
+ "created_at"
+ ],
+ "properties": {
+ "dispute_id": {
+ "type": "string",
+ "description": "The identifier for dispute"
+ },
+ "payment_id": {
+ "type": "string",
+ "description": "The identifier for payment_intent"
+ },
+ "attempt_id": {
+ "type": "string",
+ "description": "The identifier for payment_attempt"
+ },
+ "amount": {
+ "type": "string",
+ "description": "The dispute amount"
+ },
+ "currency": {
+ "type": "string",
+ "description": "The three-letter ISO currency code"
+ },
+ "dispute_stage": {
+ "$ref": "#/components/schemas/DisputeStage"
+ },
+ "dispute_status": {
+ "$ref": "#/components/schemas/DisputeStatus"
+ },
+ "connector": {
+ "type": "string",
+ "description": "connector to which dispute is associated with"
+ },
+ "connector_status": {
+ "type": "string",
+ "description": "Status of the dispute sent by connector"
+ },
+ "connector_dispute_id": {
+ "type": "string",
+ "description": "Dispute id sent by connector"
+ },
+ "connector_reason": {
+ "type": "string",
+ "description": "Reason of dispute sent by connector",
+ "nullable": true
+ },
+ "connector_reason_code": {
+ "type": "string",
+ "description": "Reason code of dispute sent by connector",
+ "nullable": true
+ },
+ "challenge_required_by": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Evidence deadline of dispute sent by connector",
+ "nullable": true
+ },
+ "connector_created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Dispute created time sent by connector",
+ "nullable": true
+ },
+ "connector_updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Dispute updated time sent by connector",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time at which dispute is received"
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The `profile_id` associated with the dispute",
+ "nullable": true
+ },
+ "merchant_connector_id": {
+ "type": "string",
+ "description": "The `merchant_connector_id` of the connector / processor through which the dispute was processed",
+ "nullable": true
+ }
+ }
+ },
+ "DisputeResponsePaymentsRetrieve": {
+ "type": "object",
+ "required": [
+ "dispute_id",
+ "dispute_stage",
+ "dispute_status",
+ "connector_status",
+ "connector_dispute_id",
+ "created_at"
+ ],
+ "properties": {
+ "dispute_id": {
+ "type": "string",
+ "description": "The identifier for dispute"
+ },
+ "dispute_stage": {
+ "$ref": "#/components/schemas/DisputeStage"
+ },
+ "dispute_status": {
+ "$ref": "#/components/schemas/DisputeStatus"
+ },
+ "connector_status": {
+ "type": "string",
+ "description": "Status of the dispute sent by connector"
+ },
+ "connector_dispute_id": {
+ "type": "string",
+ "description": "Dispute id sent by connector"
+ },
+ "connector_reason": {
+ "type": "string",
+ "description": "Reason of dispute sent by connector",
+ "nullable": true
+ },
+ "connector_reason_code": {
+ "type": "string",
+ "description": "Reason code of dispute sent by connector",
+ "nullable": true
+ },
+ "challenge_required_by": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Evidence deadline of dispute sent by connector",
+ "nullable": true
+ },
+ "connector_created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Dispute created time sent by connector",
+ "nullable": true
+ },
+ "connector_updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Dispute updated time sent by connector",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time at which dispute is received"
+ }
+ }
+ },
+ "DisputeStage": {
+ "type": "string",
+ "description": "Stage of the dispute",
+ "enum": [
+ "pre_dispute",
+ "dispute",
+ "pre_arbitration"
+ ]
+ },
+ "DisputeStatus": {
+ "type": "string",
+ "description": "Status of the dispute",
+ "enum": [
+ "dispute_opened",
+ "dispute_expired",
+ "dispute_accepted",
+ "dispute_cancelled",
+ "dispute_challenged",
+ "dispute_won",
+ "dispute_lost"
+ ]
+ },
+ "DokuBankTransferInstructions": {
+ "type": "object",
+ "required": [
+ "expires_at",
+ "reference",
+ "instructions_url"
+ ],
+ "properties": {
+ "expires_at": {
+ "type": "string",
+ "example": "1707091200000"
+ },
+ "reference": {
+ "type": "string",
+ "example": "122385736258"
+ },
+ "instructions_url": {
+ "type": "string"
+ }
+ }
+ },
+ "DokuBillingDetails": {
+ "type": "object",
+ "properties": {
+ "first_name": {
+ "type": "string",
+ "description": "The billing first name for Doku",
+ "example": "Jane",
+ "nullable": true
+ },
+ "last_name": {
+ "type": "string",
+ "description": "The billing second name for Doku",
+ "example": "Doe",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "The Email ID for Doku billing",
+ "example": "[email protected]",
+ "nullable": true
+ }
+ }
+ },
+ "EnabledPaymentMethod": {
+ "type": "object",
+ "description": "Object for EnabledPaymentMethod",
+ "required": [
+ "payment_method",
+ "payment_method_types"
+ ],
+ "properties": {
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "description": "An array of associated payment method types",
+ "uniqueItems": true
+ }
+ }
+ },
+ "EphemeralKeyCreateResponse": {
+ "type": "object",
+ "description": "ephemeral_key for the customer_id mentioned",
+ "required": [
+ "customer_id",
+ "created_at",
+ "expires",
+ "secret"
+ ],
+ "properties": {
+ "customer_id": {
+ "type": "string",
+ "description": "customer_id to which this ephemeral key belongs to",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int64",
+ "description": "time at which this ephemeral key was created"
+ },
+ "expires": {
+ "type": "integer",
+ "format": "int64",
+ "description": "time at which this ephemeral key would expire"
+ },
+ "secret": {
+ "type": "string",
+ "description": "ephemeral key"
+ }
+ }
+ },
+ "EventClass": {
+ "type": "string",
+ "enum": [
+ "payments",
+ "refunds",
+ "disputes",
+ "mandates",
+ "payouts"
+ ]
+ },
+ "EventListItemResponse": {
+ "type": "object",
+ "description": "The response body for each item when listing events.",
+ "required": [
+ "event_id",
+ "merchant_id",
+ "profile_id",
+ "object_id",
+ "event_type",
+ "event_class",
+ "is_delivery_successful",
+ "initial_attempt_id",
+ "created"
+ ],
+ "properties": {
+ "event_id": {
+ "type": "string",
+ "description": "The identifier for the Event.",
+ "example": "evt_018e31720d1b7a2b82677d3032cab959",
+ "maxLength": 64
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account.",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The identifier for the Business Profile.",
+ "example": "SqB0zwDGR5wHppWf0bx7GKr1f2",
+ "maxLength": 64
+ },
+ "object_id": {
+ "type": "string",
+ "description": "The identifier for the object (Payment Intent ID, Refund ID, etc.)",
+ "example": "QHrfd5LUDdZaKtAjdJmMu0dMa1",
+ "maxLength": 64
+ },
+ "event_type": {
+ "$ref": "#/components/schemas/EventType"
+ },
+ "event_class": {
+ "$ref": "#/components/schemas/EventClass"
+ },
+ "is_delivery_successful": {
+ "type": "boolean",
+ "description": "Indicates whether the webhook delivery attempt was successful."
+ },
+ "initial_attempt_id": {
+ "type": "string",
+ "description": "The identifier for the initial delivery attempt. This will be the same as `event_id` for\nthe initial delivery attempt.",
+ "example": "evt_018e31720d1b7a2b82677d3032cab959",
+ "maxLength": 64
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time at which the event was created.",
+ "example": "2022-09-10T10:11:12Z"
+ }
+ }
+ },
+ "EventRetrieveResponse": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/EventListItemResponse"
+ },
+ {
+ "type": "object",
+ "required": [
+ "request",
+ "response"
+ ],
+ "properties": {
+ "request": {
+ "$ref": "#/components/schemas/OutgoingWebhookRequestContent"
+ },
+ "response": {
+ "$ref": "#/components/schemas/OutgoingWebhookResponseContent"
+ },
+ "delivery_attempt": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/WebhookDeliveryAttempt"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "description": "The response body for retrieving an event."
+ },
+ "EventType": {
+ "type": "string",
+ "enum": [
+ "payment_succeeded",
+ "payment_failed",
+ "payment_processing",
+ "payment_cancelled",
+ "payment_authorized",
+ "payment_captured",
+ "action_required",
+ "refund_succeeded",
+ "refund_failed",
+ "dispute_opened",
+ "dispute_expired",
+ "dispute_accepted",
+ "dispute_cancelled",
+ "dispute_challenged",
+ "dispute_won",
+ "dispute_lost",
+ "mandate_active",
+ "mandate_revoked",
+ "payout_success",
+ "payout_failed",
+ "payout_initiated",
+ "payout_processing",
+ "payout_cancelled",
+ "payout_expired",
+ "payout_reversed"
+ ]
+ },
+ "ExtendedCardInfo": {
+ "type": "object",
+ "required": [
+ "card_number",
+ "card_exp_month",
+ "card_exp_year",
+ "card_holder_name",
+ "card_cvc"
+ ],
+ "properties": {
+ "card_number": {
+ "type": "string",
+ "description": "The card number",
+ "example": "4242424242424242"
+ },
+ "card_exp_month": {
+ "type": "string",
+ "description": "The card's expiry month",
+ "example": "24"
+ },
+ "card_exp_year": {
+ "type": "string",
+ "description": "The card's expiry year",
+ "example": "24"
+ },
+ "card_holder_name": {
+ "type": "string",
+ "description": "The card holder's name",
+ "example": "John Test"
+ },
+ "card_cvc": {
+ "type": "string",
+ "description": "The CVC number for the card",
+ "example": "242"
+ },
+ "card_issuer": {
+ "type": "string",
+ "description": "The name of the issuer of card",
+ "example": "chase",
+ "nullable": true
+ },
+ "card_network": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardNetwork"
+ }
+ ],
+ "nullable": true
+ },
+ "card_type": {
+ "type": "string",
+ "example": "CREDIT",
+ "nullable": true
+ },
+ "card_issuing_country": {
+ "type": "string",
+ "example": "INDIA",
+ "nullable": true
+ },
+ "bank_code": {
+ "type": "string",
+ "example": "JP_AMEX",
+ "nullable": true
+ }
+ }
+ },
+ "ExtendedCardInfoConfig": {
+ "type": "object",
+ "required": [
+ "public_key"
+ ],
+ "properties": {
+ "public_key": {
+ "type": "string",
+ "description": "Merchant public key"
+ },
+ "ttl_in_secs": {
+ "type": "integer",
+ "format": "int32",
+ "description": "TTL for extended card info",
+ "default": 900,
+ "maximum": 7200,
+ "minimum": 0
+ }
+ }
+ },
+ "ExtendedCardInfoResponse": {
+ "type": "object",
+ "required": [
+ "payload"
+ ],
+ "properties": {
+ "payload": {
+ "type": "string"
+ }
+ }
+ },
+ "ExternalAuthenticationDetailsResponse": {
+ "type": "object",
+ "description": "Details of external authentication",
+ "required": [
+ "status"
+ ],
+ "properties": {
+ "authentication_flow": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/DecoupledAuthenticationType"
+ }
+ ],
+ "nullable": true
+ },
+ "electronic_commerce_indicator": {
+ "type": "string",
+ "description": "Electronic Commerce Indicator (eci)",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/AuthenticationStatus"
+ },
+ "ds_transaction_id": {
+ "type": "string",
+ "description": "DS Transaction ID",
+ "nullable": true
+ },
+ "version": {
+ "type": "string",
+ "description": "Message Version",
+ "nullable": true
+ },
+ "error_code": {
+ "type": "string",
+ "description": "Error Code",
+ "nullable": true
+ },
+ "error_message": {
+ "type": "string",
+ "description": "Error Message",
+ "nullable": true
+ }
+ }
+ },
+ "FeatureMetadata": {
+ "type": "object",
+ "description": "additional data that might be required by hyperswitch",
+ "properties": {
+ "redirect_response": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RedirectResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "search_tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Additional tags to be used for global search",
+ "nullable": true
+ }
+ }
+ },
+ "FieldType": {
+ "oneOf": [
+ {
+ "type": "string",
+ "enum": [
+ "user_card_number"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_card_expiry_month"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_card_expiry_year"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_card_cvc"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_full_name"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_email_address"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_phone_number"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_phone_number_country_code"
+ ]
+ },
+ {
+ "type": "object",
+ "required": [
+ "user_country"
+ ],
+ "properties": {
+ "user_country": {
+ "type": "object",
+ "required": [
+ "options"
+ ],
+ "properties": {
+ "options": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "user_currency"
+ ],
+ "properties": {
+ "user_currency": {
+ "type": "object",
+ "required": [
+ "options"
+ ],
+ "properties": {
+ "options": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_crypto_currency_network"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_billing_name"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_address_line1"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_address_line2"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_address_city"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_address_pincode"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_address_state"
+ ]
+ },
+ {
+ "type": "object",
+ "required": [
+ "user_address_country"
+ ],
+ "properties": {
+ "user_address_country": {
+ "type": "object",
+ "required": [
+ "options"
+ ],
+ "properties": {
+ "options": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_shipping_name"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_shipping_address_line1"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_shipping_address_line2"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_shipping_address_city"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_shipping_address_pincode"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_shipping_address_state"
+ ]
+ },
+ {
+ "type": "object",
+ "required": [
+ "user_shipping_address_country"
+ ],
+ "properties": {
+ "user_shipping_address_country": {
+ "type": "object",
+ "required": [
+ "options"
+ ],
+ "properties": {
+ "options": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_blik_code"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_bank"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "text"
+ ]
+ },
+ {
+ "type": "object",
+ "required": [
+ "drop_down"
+ ],
+ "properties": {
+ "drop_down": {
+ "type": "object",
+ "required": [
+ "options"
+ ],
+ "properties": {
+ "options": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_date_of_birth"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_vpa_id"
+ ]
+ },
+ {
+ "type": "object",
+ "required": [
+ "language_preference"
+ ],
+ "properties": {
+ "language_preference": {
+ "type": "object",
+ "required": [
+ "options"
+ ],
+ "properties": {
+ "options": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_pix_key"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_cpf"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "user_cnpj"
+ ]
+ }
+ ],
+ "description": "Possible field type of required fields in payment_method_data"
+ },
+ "FrmAction": {
+ "type": "string",
+ "enum": [
+ "cancel_txn",
+ "auto_refund",
+ "manual_review"
+ ]
+ },
+ "FrmConfigs": {
+ "type": "object",
+ "description": "Details of FrmConfigs are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table",
+ "required": [
+ "gateway",
+ "payment_methods"
+ ],
+ "properties": {
+ "gateway": {
+ "$ref": "#/components/schemas/ConnectorType"
+ },
+ "payment_methods": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FrmPaymentMethod"
+ },
+ "description": "payment methods that can be used in the payment"
+ }
+ },
+ "additionalProperties": false
+ },
+ "FrmMessage": {
+ "type": "object",
+ "description": "frm message is an object sent inside the payments response...when frm is invoked, its value is Some(...), else its None",
+ "required": [
+ "frm_name"
+ ],
+ "properties": {
+ "frm_name": {
+ "type": "string"
+ },
+ "frm_transaction_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "frm_transaction_type": {
+ "type": "string",
+ "nullable": true
+ },
+ "frm_status": {
+ "type": "string",
+ "nullable": true
+ },
+ "frm_score": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ },
+ "frm_reason": {
+ "nullable": true
+ },
+ "frm_error": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "FrmPaymentMethod": {
+ "type": "object",
+ "description": "Details of FrmPaymentMethod are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table",
+ "required": [
+ "payment_method"
+ ],
+ "properties": {
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FrmPaymentMethodType"
+ },
+ "description": "payment method types(credit, debit) that can be used in the payment. This field is deprecated. It has not been removed to provide backward compatibility.",
+ "nullable": true
+ },
+ "flow": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FrmPreferredFlowTypes"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "FrmPaymentMethodType": {
+ "type": "object",
+ "description": "Details of FrmPaymentMethodType are mentioned here... it should be passed in payment connector create api call, and stored in merchant_connector_table",
+ "required": [
+ "payment_method_type",
+ "card_networks",
+ "flow",
+ "action"
+ ],
+ "properties": {
+ "payment_method_type": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "card_networks": {
+ "$ref": "#/components/schemas/CardNetwork"
+ },
+ "flow": {
+ "$ref": "#/components/schemas/FrmPreferredFlowTypes"
+ },
+ "action": {
+ "$ref": "#/components/schemas/FrmAction"
+ }
+ },
+ "additionalProperties": false
+ },
+ "FrmPreferredFlowTypes": {
+ "type": "string",
+ "enum": [
+ "pre",
+ "post"
+ ]
+ },
+ "FutureUsage": {
+ "type": "string",
+ "description": "Indicates that you intend to make future payments with the payment methods used for this Payment. Providing this parameter will attach the payment method to the Customer, if present, after the Payment is confirmed and any required actions from the user are complete.",
+ "enum": [
+ "off_session",
+ "on_session"
+ ]
+ },
+ "GcashRedirection": {
+ "type": "object"
+ },
+ "GenericLinkUiConfig": {
+ "type": "object",
+ "description": "Object for GenericLinkUiConfig",
+ "properties": {
+ "logo": {
+ "type": "string",
+ "description": "Merchant's display logo",
+ "example": "https://hyperswitch.io/favicon.ico",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "merchant_name": {
+ "type": "string",
+ "description": "Custom merchant name for the link",
+ "example": "Hyperswitch",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "theme": {
+ "type": "string",
+ "description": "Primary color to be used in the form represented in hex format",
+ "example": "#4285F4",
+ "nullable": true,
+ "maxLength": 255
+ }
+ }
+ },
+ "GiftCardData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "givex"
+ ],
+ "properties": {
+ "givex": {
+ "$ref": "#/components/schemas/GiftCardDetails"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "pay_safe_card"
+ ],
+ "properties": {
+ "pay_safe_card": {
+ "type": "object"
+ }
+ }
+ }
+ ]
+ },
+ "GiftCardDetails": {
+ "type": "object",
+ "required": [
+ "number",
+ "cvc"
+ ],
+ "properties": {
+ "number": {
+ "type": "string",
+ "description": "The gift card number"
+ },
+ "cvc": {
+ "type": "string",
+ "description": "The card verification code."
+ }
+ }
+ },
+ "GoPayRedirection": {
+ "type": "object"
+ },
+ "GooglePayAssuranceDetails": {
+ "type": "object",
+ "required": [
+ "card_holder_authenticated",
+ "account_verified"
+ ],
+ "properties": {
+ "card_holder_authenticated": {
+ "type": "boolean",
+ "description": "indicates that Cardholder possession validation has been performed"
+ },
+ "account_verified": {
+ "type": "boolean",
+ "description": "indicates that identification and verifications (ID&V) was performed"
+ }
+ }
+ },
+ "GooglePayPaymentMethodInfo": {
+ "type": "object",
+ "required": [
+ "card_network",
+ "card_details"
+ ],
+ "properties": {
+ "card_network": {
+ "type": "string",
+ "description": "The name of the card network"
+ },
+ "card_details": {
+ "type": "string",
+ "description": "The details of the card"
+ },
+ "assurance_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GooglePayAssuranceDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "GooglePayRedirectData": {
+ "type": "object"
+ },
+ "GooglePaySessionResponse": {
+ "type": "object",
+ "required": [
+ "merchant_info",
+ "shipping_address_required",
+ "email_required",
+ "shipping_address_parameters",
+ "allowed_payment_methods",
+ "transaction_info",
+ "delayed_session_token",
+ "connector",
+ "sdk_next_action"
+ ],
+ "properties": {
+ "merchant_info": {
+ "$ref": "#/components/schemas/GpayMerchantInfo"
+ },
+ "shipping_address_required": {
+ "type": "boolean",
+ "description": "Is shipping address required"
+ },
+ "email_required": {
+ "type": "boolean",
+ "description": "Is email required"
+ },
+ "shipping_address_parameters": {
+ "$ref": "#/components/schemas/GpayShippingAddressParameters"
+ },
+ "allowed_payment_methods": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GpayAllowedPaymentMethods"
+ },
+ "description": "List of the allowed payment meythods"
+ },
+ "transaction_info": {
+ "$ref": "#/components/schemas/GpayTransactionInfo"
+ },
+ "delayed_session_token": {
+ "type": "boolean",
+ "description": "Identifier for the delayed session response"
+ },
+ "connector": {
+ "type": "string",
+ "description": "The name of the connector"
+ },
+ "sdk_next_action": {
+ "$ref": "#/components/schemas/SdkNextAction"
+ },
+ "secrets": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SecretInfoToInitiateSdk"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "GooglePayThirdPartySdk": {
+ "type": "object",
+ "required": [
+ "delayed_session_token",
+ "connector",
+ "sdk_next_action"
+ ],
+ "properties": {
+ "delayed_session_token": {
+ "type": "boolean",
+ "description": "Identifier for the delayed session response"
+ },
+ "connector": {
+ "type": "string",
+ "description": "The name of the connector"
+ },
+ "sdk_next_action": {
+ "$ref": "#/components/schemas/SdkNextAction"
+ }
+ }
+ },
+ "GooglePayThirdPartySdkData": {
+ "type": "object"
+ },
+ "GooglePayWalletData": {
+ "type": "object",
+ "required": [
+ "type",
+ "description",
+ "info",
+ "tokenization_data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of payment method"
+ },
+ "description": {
+ "type": "string",
+ "description": "User-facing message to describe the payment method that funds this transaction."
+ },
+ "info": {
+ "$ref": "#/components/schemas/GooglePayPaymentMethodInfo"
+ },
+ "tokenization_data": {
+ "$ref": "#/components/schemas/GpayTokenizationData"
+ }
+ }
+ },
+ "GpayAllowedMethodsParameters": {
+ "type": "object",
+ "required": [
+ "allowed_auth_methods",
+ "allowed_card_networks"
+ ],
+ "properties": {
+ "allowed_auth_methods": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of allowed auth methods (ex: 3DS, No3DS, PAN_ONLY etc)"
+ },
+ "allowed_card_networks": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of allowed card networks (ex: AMEX,JCB etc)"
+ },
+ "billing_address_required": {
+ "type": "boolean",
+ "description": "Is billing address required",
+ "nullable": true
+ },
+ "billing_address_parameters": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GpayBillingAddressParameters"
+ }
+ ],
+ "nullable": true
+ },
+ "assurance_details_required": {
+ "type": "boolean",
+ "description": "Whether assurance details are required",
+ "nullable": true
+ }
+ }
+ },
+ "GpayAllowedPaymentMethods": {
+ "type": "object",
+ "required": [
+ "type",
+ "parameters",
+ "tokenization_specification"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of payment method"
+ },
+ "parameters": {
+ "$ref": "#/components/schemas/GpayAllowedMethodsParameters"
+ },
+ "tokenization_specification": {
+ "$ref": "#/components/schemas/GpayTokenizationSpecification"
+ }
+ }
+ },
+ "GpayBillingAddressFormat": {
+ "type": "string",
+ "enum": [
+ "FULL",
+ "MIN"
+ ]
+ },
+ "GpayBillingAddressParameters": {
+ "type": "object",
+ "required": [
+ "phone_number_required",
+ "format"
+ ],
+ "properties": {
+ "phone_number_required": {
+ "type": "boolean",
+ "description": "Is billing phone number required"
+ },
+ "format": {
+ "$ref": "#/components/schemas/GpayBillingAddressFormat"
+ }
+ }
+ },
+ "GpayMerchantInfo": {
+ "type": "object",
+ "required": [
+ "merchant_name"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The merchant Identifier that needs to be passed while invoking Gpay SDK",
+ "nullable": true
+ },
+ "merchant_name": {
+ "type": "string",
+ "description": "The name of the merchant that needs to be displayed on Gpay PopUp"
+ }
+ }
+ },
+ "GpaySessionTokenResponse": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/GooglePayThirdPartySdk"
+ },
+ {
+ "$ref": "#/components/schemas/GooglePaySessionResponse"
+ }
+ ]
+ },
+ "GpayShippingAddressParameters": {
+ "type": "object",
+ "required": [
+ "phone_number_required"
+ ],
+ "properties": {
+ "phone_number_required": {
+ "type": "boolean",
+ "description": "Is shipping phone number required"
+ }
+ }
+ },
+ "GpayTokenParameters": {
+ "type": "object",
+ "required": [
+ "gateway"
+ ],
+ "properties": {
+ "gateway": {
+ "type": "string",
+ "description": "The name of the connector"
+ },
+ "gateway_merchant_id": {
+ "type": "string",
+ "description": "The merchant ID registered in the connector associated",
+ "nullable": true
+ },
+ "stripe:version": {
+ "type": "string",
+ "nullable": true
+ },
+ "stripe:publishableKey": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "GpayTokenizationData": {
+ "type": "object",
+ "required": [
+ "type",
+ "token"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of the token"
+ },
+ "token": {
+ "type": "string",
+ "description": "Token generated for the wallet"
+ }
+ }
+ },
+ "GpayTokenizationSpecification": {
+ "type": "object",
+ "required": [
+ "type",
+ "parameters"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The token specification type(ex: PAYMENT_GATEWAY)"
+ },
+ "parameters": {
+ "$ref": "#/components/schemas/GpayTokenParameters"
+ }
+ }
+ },
+ "GpayTransactionInfo": {
+ "type": "object",
+ "required": [
+ "country_code",
+ "currency_code",
+ "total_price_status",
+ "total_price"
+ ],
+ "properties": {
+ "country_code": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ },
+ "currency_code": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "total_price_status": {
+ "type": "string",
+ "description": "The total price status (ex: 'FINAL')"
+ },
+ "total_price": {
+ "type": "string",
+ "description": "The total price",
+ "example": "38.02"
+ }
+ }
+ },
+ "GsmCreateRequest": {
+ "type": "object",
+ "required": [
+ "connector",
+ "flow",
+ "sub_flow",
+ "code",
+ "message",
+ "status",
+ "decision",
+ "step_up_possible"
+ ],
+ "properties": {
+ "connector": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "flow": {
+ "type": "string",
+ "description": "The flow in which the code and message occurred for a connector"
+ },
+ "sub_flow": {
+ "type": "string",
+ "description": "The sub_flow in which the code and message occurred for a connector"
+ },
+ "code": {
+ "type": "string",
+ "description": "code received from the connector"
+ },
+ "message": {
+ "type": "string",
+ "description": "message received from the connector"
+ },
+ "status": {
+ "type": "string",
+ "description": "status provided by the router"
+ },
+ "router_error": {
+ "type": "string",
+ "description": "optional error provided by the router",
+ "nullable": true
+ },
+ "decision": {
+ "$ref": "#/components/schemas/GsmDecision"
+ },
+ "step_up_possible": {
+ "type": "boolean",
+ "description": "indicates if step_up retry is possible"
+ },
+ "unified_code": {
+ "type": "string",
+ "description": "error code unified across the connectors",
+ "nullable": true
+ },
+ "unified_message": {
+ "type": "string",
+ "description": "error message unified across the connectors",
+ "nullable": true
+ }
+ }
+ },
+ "GsmDecision": {
+ "type": "string",
+ "enum": [
+ "retry",
+ "requeue",
+ "do_default"
+ ]
+ },
+ "GsmDeleteRequest": {
+ "type": "object",
+ "required": [
+ "connector",
+ "flow",
+ "sub_flow",
+ "code",
+ "message"
+ ],
+ "properties": {
+ "connector": {
+ "type": "string",
+ "description": "The connector through which payment has gone through"
+ },
+ "flow": {
+ "type": "string",
+ "description": "The flow in which the code and message occurred for a connector"
+ },
+ "sub_flow": {
+ "type": "string",
+ "description": "The sub_flow in which the code and message occurred for a connector"
+ },
+ "code": {
+ "type": "string",
+ "description": "code received from the connector"
+ },
+ "message": {
+ "type": "string",
+ "description": "message received from the connector"
+ }
+ }
+ },
+ "GsmDeleteResponse": {
+ "type": "object",
+ "required": [
+ "gsm_rule_delete",
+ "connector",
+ "flow",
+ "sub_flow",
+ "code"
+ ],
+ "properties": {
+ "gsm_rule_delete": {
+ "type": "boolean"
+ },
+ "connector": {
+ "type": "string",
+ "description": "The connector through which payment has gone through"
+ },
+ "flow": {
+ "type": "string",
+ "description": "The flow in which the code and message occurred for a connector"
+ },
+ "sub_flow": {
+ "type": "string",
+ "description": "The sub_flow in which the code and message occurred for a connector"
+ },
+ "code": {
+ "type": "string",
+ "description": "code received from the connector"
+ }
+ }
+ },
+ "GsmResponse": {
+ "type": "object",
+ "required": [
+ "connector",
+ "flow",
+ "sub_flow",
+ "code",
+ "message",
+ "status",
+ "decision",
+ "step_up_possible"
+ ],
+ "properties": {
+ "connector": {
+ "type": "string",
+ "description": "The connector through which payment has gone through"
+ },
+ "flow": {
+ "type": "string",
+ "description": "The flow in which the code and message occurred for a connector"
+ },
+ "sub_flow": {
+ "type": "string",
+ "description": "The sub_flow in which the code and message occurred for a connector"
+ },
+ "code": {
+ "type": "string",
+ "description": "code received from the connector"
+ },
+ "message": {
+ "type": "string",
+ "description": "message received from the connector"
+ },
+ "status": {
+ "type": "string",
+ "description": "status provided by the router"
+ },
+ "router_error": {
+ "type": "string",
+ "description": "optional error provided by the router",
+ "nullable": true
+ },
+ "decision": {
+ "type": "string",
+ "description": "decision to be taken for auto retries flow"
+ },
+ "step_up_possible": {
+ "type": "boolean",
+ "description": "indicates if step_up retry is possible"
+ },
+ "unified_code": {
+ "type": "string",
+ "description": "error code unified across the connectors",
+ "nullable": true
+ },
+ "unified_message": {
+ "type": "string",
+ "description": "error message unified across the connectors",
+ "nullable": true
+ }
+ }
+ },
+ "GsmRetrieveRequest": {
+ "type": "object",
+ "required": [
+ "connector",
+ "flow",
+ "sub_flow",
+ "code",
+ "message"
+ ],
+ "properties": {
+ "connector": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "flow": {
+ "type": "string",
+ "description": "The flow in which the code and message occurred for a connector"
+ },
+ "sub_flow": {
+ "type": "string",
+ "description": "The sub_flow in which the code and message occurred for a connector"
+ },
+ "code": {
+ "type": "string",
+ "description": "code received from the connector"
+ },
+ "message": {
+ "type": "string",
+ "description": "message received from the connector"
+ }
+ }
+ },
+ "GsmUpdateRequest": {
+ "type": "object",
+ "required": [
+ "connector",
+ "flow",
+ "sub_flow",
+ "code",
+ "message"
+ ],
+ "properties": {
+ "connector": {
+ "type": "string",
+ "description": "The connector through which payment has gone through"
+ },
+ "flow": {
+ "type": "string",
+ "description": "The flow in which the code and message occurred for a connector"
+ },
+ "sub_flow": {
+ "type": "string",
+ "description": "The sub_flow in which the code and message occurred for a connector"
+ },
+ "code": {
+ "type": "string",
+ "description": "code received from the connector"
+ },
+ "message": {
+ "type": "string",
+ "description": "message received from the connector"
+ },
+ "status": {
+ "type": "string",
+ "description": "status provided by the router",
+ "nullable": true
+ },
+ "router_error": {
+ "type": "string",
+ "description": "optional error provided by the router",
+ "nullable": true
+ },
+ "decision": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GsmDecision"
+ }
+ ],
+ "nullable": true
+ },
+ "step_up_possible": {
+ "type": "boolean",
+ "description": "indicates if step_up retry is possible",
+ "nullable": true
+ },
+ "unified_code": {
+ "type": "string",
+ "description": "error code unified across the connectors",
+ "nullable": true
+ },
+ "unified_message": {
+ "type": "string",
+ "description": "error message unified across the connectors",
+ "nullable": true
+ }
+ }
+ },
+ "IfStatement": {
+ "type": "object",
+ "description": "Represents an IF statement with conditions and optional nested IF statements\n\n```text\npayment.method = card {\npayment.method.cardtype = (credit, debit) {\npayment.method.network = (amex, rupay, diners)\n}\n}\n```",
+ "required": [
+ "condition"
+ ],
+ "properties": {
+ "condition": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Comparison"
+ }
+ },
+ "nested": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IfStatement"
+ },
+ "nullable": true
+ }
+ }
+ },
+ "IncrementalAuthorizationResponse": {
+ "type": "object",
+ "required": [
+ "authorization_id",
+ "amount",
+ "status",
+ "previously_authorized_amount"
+ ],
+ "properties": {
+ "authorization_id": {
+ "type": "string",
+ "description": "The unique identifier of authorization"
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Amount the authorization has been made for",
+ "example": 6540
+ },
+ "status": {
+ "$ref": "#/components/schemas/AuthorizationStatus"
+ },
+ "error_code": {
+ "type": "string",
+ "description": "Error code sent by the connector for authorization",
+ "nullable": true
+ },
+ "error_message": {
+ "type": "string",
+ "description": "Error message sent by the connector for authorization",
+ "nullable": true
+ },
+ "previously_authorized_amount": {
+ "$ref": "#/components/schemas/MinorUnit"
+ }
+ }
+ },
+ "IndomaretVoucherData": {
+ "type": "object",
+ "properties": {
+ "first_name": {
+ "type": "string",
+ "description": "The billing first name for Alfamart",
+ "example": "Jane",
+ "nullable": true
+ },
+ "last_name": {
+ "type": "string",
+ "description": "The billing second name for Alfamart",
+ "example": "Doe",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "The Email ID for Alfamart",
+ "example": "[email protected]",
+ "nullable": true
+ }
+ }
+ },
+ "IntentStatus": {
+ "type": "string",
+ "description": "The status of the current payment that was made",
+ "enum": [
+ "succeeded",
+ "failed",
+ "cancelled",
+ "processing",
+ "requires_customer_action",
+ "requires_merchant_action",
+ "requires_payment_method",
+ "requires_confirmation",
+ "requires_capture",
+ "partially_captured",
+ "partially_captured_and_capturable"
+ ]
+ },
+ "JCSVoucherData": {
+ "type": "object",
+ "properties": {
+ "first_name": {
+ "type": "string",
+ "description": "The billing first name for Japanese convenience stores",
+ "example": "Jane",
+ "nullable": true
+ },
+ "last_name": {
+ "type": "string",
+ "description": "The billing second name Japanese convenience stores",
+ "example": "Doe",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "The Email ID for Japanese convenience stores",
+ "example": "[email protected]",
+ "nullable": true
+ },
+ "phone_number": {
+ "type": "string",
+ "description": "The telephone number for Japanese convenience stores",
+ "example": "9123456789",
+ "nullable": true
+ }
+ }
+ },
+ "KakaoPayRedirection": {
+ "type": "object"
+ },
+ "KlarnaSdkPaymentMethodResponse": {
+ "type": "object",
+ "properties": {
+ "payment_type": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "KlarnaSessionTokenResponse": {
+ "type": "object",
+ "required": [
+ "session_token",
+ "session_id"
+ ],
+ "properties": {
+ "session_token": {
+ "type": "string",
+ "description": "The session token for Klarna"
+ },
+ "session_id": {
+ "type": "string",
+ "description": "The identifier for the session"
+ }
+ }
+ },
+ "LinkedRoutingConfigRetrieveResponse": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/RoutingRetrieveResponse"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RoutingDictionaryRecord"
+ }
+ }
+ ]
+ },
+ "ListBlocklistQuery": {
+ "type": "object",
+ "required": [
+ "data_kind"
+ ],
+ "properties": {
+ "data_kind": {
+ "$ref": "#/components/schemas/BlocklistDataKind"
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0
+ },
+ "offset": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0
+ }
+ }
+ },
+ "MandateAmountData": {
+ "type": "object",
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "properties": {
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum amount to be debited for the mandate transaction",
+ "example": 6540
+ },
+ "currency": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "start_date": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Specifying start date of the mandate",
+ "example": "2022-09-10T00:00:00Z",
+ "nullable": true
+ },
+ "end_date": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Specifying end date of the mandate",
+ "example": "2023-09-10T23:59:59Z",
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Additional details required by mandate",
+ "nullable": true
+ }
+ }
+ },
+ "MandateCardDetails": {
+ "type": "object",
+ "properties": {
+ "last4_digits": {
+ "type": "string",
+ "description": "The last 4 digits of card",
+ "nullable": true
+ },
+ "card_exp_month": {
+ "type": "string",
+ "description": "The expiry month of card",
+ "nullable": true
+ },
+ "card_exp_year": {
+ "type": "string",
+ "description": "The expiry year of card",
+ "nullable": true
+ },
+ "card_holder_name": {
+ "type": "string",
+ "description": "The card holder name",
+ "nullable": true
+ },
+ "card_token": {
+ "type": "string",
+ "description": "The token from card locker",
+ "nullable": true
+ },
+ "scheme": {
+ "type": "string",
+ "description": "The card scheme network for the particular card",
+ "nullable": true
+ },
+ "issuer_country": {
+ "type": "string",
+ "description": "The country code in in which the card was issued",
+ "nullable": true
+ },
+ "card_fingerprint": {
+ "type": "string",
+ "description": "A unique identifier alias to identify a particular card",
+ "nullable": true
+ },
+ "card_isin": {
+ "type": "string",
+ "description": "The first 6 digits of card",
+ "nullable": true
+ },
+ "card_issuer": {
+ "type": "string",
+ "description": "The bank that issued the card",
+ "nullable": true
+ },
+ "card_network": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardNetwork"
+ }
+ ],
+ "nullable": true
+ },
+ "card_type": {
+ "type": "string",
+ "description": "The type of the payment card",
+ "nullable": true
+ },
+ "nick_name": {
+ "type": "string",
+ "description": "The nick_name of the card holder",
+ "nullable": true
+ }
+ }
+ },
+ "MandateData": {
+ "type": "object",
+ "description": "Passing this object during payments creates a mandate. The mandate_type sub object is passed by the server.",
+ "properties": {
+ "update_mandate_id": {
+ "type": "string",
+ "description": "A way to update the mandate's payment method details",
+ "nullable": true
+ },
+ "customer_acceptance": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerAcceptance"
+ }
+ ],
+ "nullable": true
+ },
+ "mandate_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MandateType"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "MandateResponse": {
+ "type": "object",
+ "required": [
+ "mandate_id",
+ "status",
+ "payment_method_id",
+ "payment_method"
+ ],
+ "properties": {
+ "mandate_id": {
+ "type": "string",
+ "description": "The identifier for mandate"
+ },
+ "status": {
+ "$ref": "#/components/schemas/MandateStatus"
+ },
+ "payment_method_id": {
+ "type": "string",
+ "description": "The identifier for payment method"
+ },
+ "payment_method": {
+ "type": "string",
+ "description": "The payment method"
+ },
+ "payment_method_type": {
+ "type": "string",
+ "description": "The payment method type",
+ "nullable": true
+ },
+ "card": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MandateCardDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "customer_acceptance": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerAcceptance"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "MandateRevokedResponse": {
+ "type": "object",
+ "required": [
+ "mandate_id",
+ "status"
+ ],
+ "properties": {
+ "mandate_id": {
+ "type": "string",
+ "description": "The identifier for mandate"
+ },
+ "status": {
+ "$ref": "#/components/schemas/MandateStatus"
+ },
+ "error_code": {
+ "type": "string",
+ "description": "If there was an error while calling the connectors the code is received here",
+ "example": "E0001",
+ "nullable": true
+ },
+ "error_message": {
+ "type": "string",
+ "description": "If there was an error while calling the connector the error message is received here",
+ "example": "Failed while verifying the card",
+ "nullable": true
+ }
+ }
+ },
+ "MandateStatus": {
+ "type": "string",
+ "description": "The status of the mandate, which indicates whether it can be used to initiate a payment.",
+ "enum": [
+ "active",
+ "inactive",
+ "pending",
+ "revoked"
+ ]
+ },
+ "MandateType": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "single_use"
+ ],
+ "properties": {
+ "single_use": {
+ "$ref": "#/components/schemas/MandateAmountData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "multi_use"
+ ],
+ "properties": {
+ "multi_use": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MandateAmountData"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ ]
+ },
+ "MaskedBankDetails": {
+ "type": "object",
+ "required": [
+ "mask"
+ ],
+ "properties": {
+ "mask": {
+ "type": "string"
+ }
+ }
+ },
+ "MbWayRedirection": {
+ "type": "object",
+ "required": [
+ "telephone_number"
+ ],
+ "properties": {
+ "telephone_number": {
+ "type": "string",
+ "description": "Telephone number of the shopper. Should be Portuguese phone number."
+ }
+ }
+ },
+ "MerchantAccountCreate": {
+ "type": "object",
+ "required": [
+ "merchant_name",
+ "organization_id"
+ ],
+ "properties": {
+ "merchant_name": {
+ "type": "string",
+ "description": "Name of the Merchant Account, This will be used as a prefix to generate the id",
+ "example": "NewAge Retailer",
+ "maxLength": 64
+ },
+ "merchant_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Metadata is useful for storing additional, unstructured information about the merchant account.",
+ "nullable": true
+ },
+ "organization_id": {
+ "type": "string",
+ "description": "The id of the organization to which the merchant belongs to. Please use the organization endpoint to create an organization",
+ "example": "org_q98uSGAYbjEwqs0mJwnz",
+ "maxLength": 64,
+ "minLength": 1
+ }
+ },
+ "additionalProperties": false
+ },
+ "MerchantAccountData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "iban"
+ ],
+ "properties": {
+ "iban": {
+ "type": "object",
+ "required": [
+ "iban",
+ "name"
+ ],
+ "properties": {
+ "iban": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "connector_recipient_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bacs"
+ ],
+ "properties": {
+ "bacs": {
+ "type": "object",
+ "required": [
+ "account_number",
+ "sort_code",
+ "name"
+ ],
+ "properties": {
+ "account_number": {
+ "type": "string"
+ },
+ "sort_code": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "connector_recipient_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ ]
+ },
+ "MerchantAccountDeleteResponse": {
+ "type": "object",
+ "required": [
+ "merchant_id",
+ "deleted"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 255
+ },
+ "deleted": {
+ "type": "boolean",
+ "description": "If the connector is deleted or not",
+ "example": false
+ }
+ }
+ },
+ "MerchantAccountResponse": {
+ "type": "object",
+ "required": [
+ "id",
+ "merchant_name",
+ "publishable_key",
+ "organization_id",
+ "recon_status"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64
+ },
+ "merchant_name": {
+ "type": "string",
+ "description": "Name of the Merchant Account",
+ "example": "NewAge Retailer"
+ },
+ "merchant_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "publishable_key": {
+ "type": "string",
+ "description": "API key that will be used for server side API access",
+ "example": "AH3423bkjbkjdsfbkj"
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Metadata is useful for storing additional, unstructured information on an object.",
+ "nullable": true
+ },
+ "organization_id": {
+ "type": "string",
+ "description": "The id of the organization which the merchant is associated with",
+ "example": "org_q98uSGAYbjEwqs0mJwnz",
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "recon_status": {
+ "$ref": "#/components/schemas/ReconStatus"
+ }
+ }
+ },
+ "MerchantAccountUpdate": {
+ "type": "object",
+ "properties": {
+ "merchant_name": {
+ "type": "string",
+ "description": "Name of the Merchant Account",
+ "example": "NewAge Retailer",
+ "nullable": true
+ },
+ "merchant_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Metadata is useful for storing additional, unstructured information on an object.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "MerchantConnectorCreate": {
+ "type": "object",
+ "description": "Create a new Merchant Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialized services like Fraud / Accounting etc.\"",
+ "required": [
+ "connector_type",
+ "connector_name",
+ "merchant_id"
+ ],
+ "properties": {
+ "connector_type": {
+ "$ref": "#/components/schemas/ConnectorType"
+ },
+ "connector_name": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "connector_label": {
+ "type": "string",
+ "description": "This is an unique label you can generate and pass in order to identify this connector account on your Hyperswitch dashboard and reports. Eg: if your profile label is `default`, connector label can be `stripe_default`",
+ "example": "stripe_US_travel",
+ "nullable": true
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "Identifier for the business profile, if not provided default will be chosen from merchant account",
+ "nullable": true
+ },
+ "connector_account_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_methods_enabled": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodsEnabled"
+ },
+ "description": "An object containing the details about the payment methods that need to be enabled under this merchant connector account",
+ "example": [
+ {
+ "accepted_countries": {
+ "list": [
+ "FR",
+ "DE",
+ "IN"
+ ],
+ "type": "disable_only"
+ },
+ "accepted_currencies": {
+ "list": [
+ "USD",
+ "EUR"
+ ],
+ "type": "enable_only"
+ },
+ "installment_payment_enabled": true,
+ "maximum_amount": 68607706,
+ "minimum_amount": 1,
+ "payment_method": "wallet",
+ "payment_method_issuers": [
+ "labore magna ipsum",
+ "aute"
+ ],
+ "payment_method_types": [
+ "upi_collect",
+ "upi_intent"
+ ],
+ "payment_schemes": [
+ "Discover",
+ "Discover"
+ ],
+ "recurring_enabled": true
+ }
+ ],
+ "nullable": true
+ },
+ "connector_webhook_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorWebhookDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Metadata is useful for storing additional, unstructured information on an object.",
+ "nullable": true
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if the connector is disabled. By default, its value is false.",
+ "default": false,
+ "example": false,
+ "nullable": true
+ },
+ "frm_configs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FrmConfigs"
+ },
+ "description": "Contains the frm configs for the merchant connector",
+ "example": "\n[{\"gateway\":\"stripe\",\"payment_methods\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\",\"action\":\"cancel_txn\"},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\"}]}]}]\n",
+ "nullable": true
+ },
+ "merchant_connector_id": {
+ "type": "string",
+ "description": "Unique ID of the connector",
+ "example": "mca_5apGeP94tMts6rg3U3kR",
+ "nullable": true
+ },
+ "pm_auth_config": {
+ "type": "object",
+ "description": "pm_auth_config will relate MCA records to their respective chosen auth services, based on payment_method and pmt",
+ "nullable": true
+ },
+ "status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ConnectorStatus"
+ }
+ ],
+ "nullable": true
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "additional_merchant_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AdditionalMerchantData"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "MerchantConnectorDeleteResponse": {
+ "type": "object",
+ "required": [
+ "merchant_id",
+ "id",
+ "deleted"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 255
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique ID of the connector",
+ "example": "mca_5apGeP94tMts6rg3U3kR"
+ },
+ "deleted": {
+ "type": "boolean",
+ "description": "If the connector is deleted or not",
+ "example": false
+ }
+ }
+ },
+ "MerchantConnectorDetails": {
+ "type": "object",
+ "properties": {
+ "connector_account_details": {
+ "type": "object",
+ "description": "Account details of the Connector. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Metadata is useful for storing additional, unstructured information on an object.",
+ "nullable": true
+ }
+ }
+ },
+ "MerchantConnectorDetailsWrap": {
+ "type": "object",
+ "description": "Merchant connector details used to make payments.",
+ "required": [
+ "creds_identifier"
+ ],
+ "properties": {
+ "creds_identifier": {
+ "type": "string",
+ "description": "Creds Identifier is to uniquely identify the credentials. Do not send any sensitive info, like encoded_data in this field. And do not send the string \"null\"."
+ },
+ "encoded_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetails"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "MerchantConnectorId": {
+ "type": "object",
+ "required": [
+ "id"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ }
+ }
+ },
+ "MerchantConnectorListResponse": {
+ "type": "object",
+ "required": [
+ "connector_type",
+ "connector_name",
+ "id",
+ "status"
+ ],
+ "properties": {
+ "connector_type": {
+ "$ref": "#/components/schemas/ConnectorType"
+ },
+ "connector_name": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "connector_label": {
+ "type": "string",
+ "description": "A unique label to identify the connector account created under a business profile",
+ "example": "stripe_US_travel",
+ "nullable": true
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique ID of the merchant connector account",
+ "example": "mca_5apGeP94tMts6rg3U3kR"
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "Identifier for the business profile, if not provided default will be chosen from merchant account",
+ "nullable": true,
+ "maxLength": 64
+ },
+ "payment_methods_enabled": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodsEnabled"
+ },
+ "description": "An object containing the details about the payment methods that need to be enabled under this merchant connector account",
+ "example": [
+ {
+ "accepted_countries": {
+ "list": [
+ "FR",
+ "DE",
+ "IN"
+ ],
+ "type": "disable_only"
+ },
+ "accepted_currencies": {
+ "list": [
+ "USD",
+ "EUR"
+ ],
+ "type": "enable_only"
+ },
+ "installment_payment_enabled": true,
+ "maximum_amount": 68607706,
+ "minimum_amount": 1,
+ "payment_method": "wallet",
+ "payment_method_issuers": [
+ "labore magna ipsum",
+ "aute"
+ ],
+ "payment_method_types": [
+ "upi_collect",
+ "upi_intent"
+ ],
+ "payment_schemes": [
+ "Discover",
+ "Discover"
+ ],
+ "recurring_enabled": true
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Metadata is useful for storing additional, unstructured information on an object.",
+ "nullable": true
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if the connector is disabled. By default, its value is false.",
+ "default": false,
+ "example": false,
+ "nullable": true
+ },
+ "frm_configs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FrmConfigs"
+ },
+ "description": "Contains the frm configs for the merchant connector",
+ "example": "\n[{\"gateway\":\"stripe\",\"payment_methods\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\",\"action\":\"cancel_txn\"},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\"}]}]}]\n",
+ "nullable": true
+ },
+ "applepay_verified_domains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "identifier for the verified domains of a particular connector account",
+ "nullable": true
+ },
+ "pm_auth_config": {
+ "type": "object",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/ConnectorStatus"
+ },
+ "additional_merchant_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AdditionalMerchantData"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "MerchantConnectorResponse": {
+ "type": "object",
+ "description": "Response of creating a new Merchant Connector for the merchant account.\"",
+ "required": [
+ "connector_type",
+ "connector_name",
+ "id",
+ "status"
+ ],
+ "properties": {
+ "connector_type": {
+ "$ref": "#/components/schemas/ConnectorType"
+ },
+ "connector_name": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "connector_label": {
+ "type": "string",
+ "description": "A unique label to identify the connector account created under a business profile",
+ "example": "stripe_US_travel",
+ "nullable": true
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique ID of the merchant connector account",
+ "example": "mca_5apGeP94tMts6rg3U3kR"
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "Identifier for the business profile, if not provided default will be chosen from merchant account",
+ "nullable": true,
+ "maxLength": 64
+ },
+ "connector_account_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_methods_enabled": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodsEnabled"
+ },
+ "description": "An object containing the details about the payment methods that need to be enabled under this merchant connector account",
+ "example": [
+ {
+ "accepted_countries": {
+ "list": [
+ "FR",
+ "DE",
+ "IN"
+ ],
+ "type": "disable_only"
+ },
+ "accepted_currencies": {
+ "list": [
+ "USD",
+ "EUR"
+ ],
+ "type": "enable_only"
+ },
+ "installment_payment_enabled": true,
+ "maximum_amount": 68607706,
+ "minimum_amount": 1,
+ "payment_method": "wallet",
+ "payment_method_issuers": [
+ "labore magna ipsum",
+ "aute"
+ ],
+ "payment_method_types": [
+ "upi_collect",
+ "upi_intent"
+ ],
+ "payment_schemes": [
+ "Discover",
+ "Discover"
+ ],
+ "recurring_enabled": true
+ }
+ ],
+ "nullable": true
+ },
+ "connector_webhook_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorWebhookDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "Metadata is useful for storing additional, unstructured information on an object.",
+ "nullable": true
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if the connector is disabled. By default, its value is false.",
+ "default": false,
+ "example": false,
+ "nullable": true
+ },
+ "frm_configs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FrmConfigs"
+ },
+ "description": "Contains the frm configs for the merchant connector",
+ "example": "\n[{\"gateway\":\"stripe\",\"payment_methods\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\",\"action\":\"cancel_txn\"},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\"}]}]}]\n",
+ "nullable": true
+ },
+ "applepay_verified_domains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "identifier for the verified domains of a particular connector account",
+ "nullable": true
+ },
+ "pm_auth_config": {
+ "type": "object",
+ "description": "pm_auth_config will relate MCA records to their respective chosen auth services, based on payment_method and pmt",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/ConnectorStatus"
+ },
+ "additional_merchant_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AdditionalMerchantData"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "MerchantConnectorUpdate": {
+ "type": "object",
+ "description": "Create a new Merchant Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialized services like Fraud / Accounting etc.\"",
+ "required": [
+ "connector_type",
+ "status",
+ "merchant_id"
+ ],
+ "properties": {
+ "connector_type": {
+ "$ref": "#/components/schemas/ConnectorType"
+ },
+ "connector_label": {
+ "type": "string",
+ "description": "This is an unique label you can generate and pass in order to identify this connector account on your Hyperswitch dashboard and reports. Eg: if your profile label is `default`, connector label can be `stripe_default`",
+ "example": "stripe_US_travel",
+ "nullable": true
+ },
+ "connector_account_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_methods_enabled": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodsEnabled"
+ },
+ "description": "An object containing the details about the payment methods that need to be enabled under this merchant connector account",
+ "example": [
+ {
+ "accepted_countries": {
+ "list": [
+ "FR",
+ "DE",
+ "IN"
+ ],
+ "type": "disable_only"
+ },
+ "accepted_currencies": {
+ "list": [
+ "USD",
+ "EUR"
+ ],
+ "type": "enable_only"
+ },
+ "installment_payment_enabled": true,
+ "maximum_amount": 68607706,
+ "minimum_amount": 1,
+ "payment_method": "wallet",
+ "payment_method_issuers": [
+ "labore magna ipsum",
+ "aute"
+ ],
+ "payment_method_types": [
+ "upi_collect",
+ "upi_intent"
+ ],
+ "payment_schemes": [
+ "Discover",
+ "Discover"
+ ],
+ "recurring_enabled": true
+ }
+ ],
+ "nullable": true
+ },
+ "connector_webhook_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorWebhookDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "disabled": {
+ "type": "boolean",
+ "description": "A boolean value to indicate if the connector is disabled. By default, its value is false.",
+ "default": false,
+ "example": false,
+ "nullable": true
+ },
+ "frm_configs": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/FrmConfigs"
+ },
+ "description": "Contains the frm configs for the merchant connector",
+ "example": "\n[{\"gateway\":\"stripe\",\"payment_methods\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\",\"action\":\"cancel_txn\"},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\"],\"flow\":\"pre\"}]}]}]\n",
+ "nullable": true
+ },
+ "pm_auth_config": {
+ "type": "object",
+ "description": "pm_auth_config will relate MCA records to their respective chosen auth services, based on payment_method and pmt",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/ConnectorStatus"
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64,
+ "minLength": 1
+ }
+ },
+ "additionalProperties": false
+ },
+ "MerchantConnectorWebhookDetails": {
+ "type": "object",
+ "required": [
+ "merchant_secret",
+ "additional_secret"
+ ],
+ "properties": {
+ "merchant_secret": {
+ "type": "string",
+ "example": "12345678900987654321"
+ },
+ "additional_secret": {
+ "type": "string",
+ "example": "12345678900987654321"
+ }
+ },
+ "additionalProperties": false
+ },
+ "MerchantDetails": {
+ "type": "object",
+ "properties": {
+ "primary_contact_person": {
+ "type": "string",
+ "description": "The merchant's primary contact name",
+ "example": "John Doe",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "primary_phone": {
+ "type": "string",
+ "description": "The merchant's primary phone number",
+ "example": "999999999",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "primary_email": {
+ "type": "string",
+ "description": "The merchant's primary email address",
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "secondary_contact_person": {
+ "type": "string",
+ "description": "The merchant's secondary contact name",
+ "example": "John Doe2",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "secondary_phone": {
+ "type": "string",
+ "description": "The merchant's secondary phone number",
+ "example": "999999988",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "secondary_email": {
+ "type": "string",
+ "description": "The merchant's secondary email address",
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "website": {
+ "type": "string",
+ "description": "The business website of the merchant",
+ "example": "www.example.com",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "about_business": {
+ "type": "string",
+ "description": "A brief description about merchant's business",
+ "example": "Online Retail with a wide selection of organic products for North America",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "address": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AddressDetails"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "MerchantRecipientData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "connector_recipient_id"
+ ],
+ "properties": {
+ "connector_recipient_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "wallet_id"
+ ],
+ "properties": {
+ "wallet_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "account_data"
+ ],
+ "properties": {
+ "account_data": {
+ "$ref": "#/components/schemas/MerchantAccountData"
+ }
+ }
+ }
+ ]
+ },
+ "MerchantRoutingAlgorithm": {
+ "type": "object",
+ "description": "Routing Algorithm specific to merchants",
+ "required": [
+ "id",
+ "profile_id",
+ "name",
+ "description",
+ "algorithm",
+ "created_at",
+ "modified_at",
+ "algorithm_for"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "profile_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "algorithm": {
+ "$ref": "#/components/schemas/RoutingAlgorithm"
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "modified_at": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "algorithm_for": {
+ "$ref": "#/components/schemas/TransactionType"
+ }
+ }
+ },
+ "MetadataValue": {
+ "type": "object",
+ "required": [
+ "key",
+ "value"
+ ],
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ },
+ "MifinityData": {
+ "type": "object",
+ "required": [
+ "date_of_birth"
+ ],
+ "properties": {
+ "date_of_birth": {
+ "type": "string",
+ "format": "date"
+ },
+ "language_preference": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "MinorUnit": {
+ "type": "integer",
+ "format": "int64",
+ "description": "This Unit struct represents MinorUnit in which core amount works"
+ },
+ "MobilePayRedirection": {
+ "type": "object"
+ },
+ "MomoRedirection": {
+ "type": "object"
+ },
+ "MultibancoBillingDetails": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "example": "[email protected]",
+ "nullable": true
+ }
+ }
+ },
+ "MultibancoTransferInstructions": {
+ "type": "object",
+ "required": [
+ "reference",
+ "entity"
+ ],
+ "properties": {
+ "reference": {
+ "type": "string",
+ "example": "122385736258"
+ },
+ "entity": {
+ "type": "string",
+ "example": "12345"
+ }
+ }
+ },
+ "NextActionCall": {
+ "type": "string",
+ "enum": [
+ "confirm",
+ "sync",
+ "complete_authorize"
+ ]
+ },
+ "NextActionData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "description": "Contains the url for redirection flow",
+ "required": [
+ "redirect_to_url",
+ "type"
+ ],
+ "properties": {
+ "redirect_to_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "redirect_to_url"
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Informs the next steps for bank transfer and also contains the charges details (ex: amount received, amount charged etc)",
+ "required": [
+ "bank_transfer_steps_and_charges_details",
+ "type"
+ ],
+ "properties": {
+ "bank_transfer_steps_and_charges_details": {
+ "$ref": "#/components/schemas/BankTransferNextStepsData"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "display_bank_transfer_information"
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Contains third party sdk session token response",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "session_token": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SessionToken"
+ }
+ ],
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "third_party_sdk_session_token"
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Contains url for Qr code image, this qr code has to be shown in sdk",
+ "required": [
+ "image_data_url",
+ "qr_code_url",
+ "type"
+ ],
+ "properties": {
+ "image_data_url": {
+ "type": "string",
+ "description": "Hyperswitch generated image data source url"
+ },
+ "display_to_timestamp": {
+ "type": "integer",
+ "format": "int64",
+ "nullable": true
+ },
+ "qr_code_url": {
+ "type": "string",
+ "description": "The url for Qr code given by the connector"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "qr_code_information"
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Contains url to fetch Qr code data",
+ "required": [
+ "qr_code_fetch_url",
+ "type"
+ ],
+ "properties": {
+ "qr_code_fetch_url": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "fetch_qr_code_information"
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Contains the download url and the reference number for transaction",
+ "required": [
+ "voucher_details",
+ "type"
+ ],
+ "properties": {
+ "voucher_details": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "display_voucher_information"
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Contains duration for displaying a wait screen, wait screen with timer is displayed by sdk",
+ "required": [
+ "display_from_timestamp",
+ "type"
+ ],
+ "properties": {
+ "display_from_timestamp": {
+ "type": "integer"
+ },
+ "display_to_timestamp": {
+ "type": "integer",
+ "nullable": true
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "wait_screen_information"
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Contains the information regarding three_ds_method_data submission, three_ds authentication, and authorization flows",
+ "required": [
+ "three_ds_data",
+ "type"
+ ],
+ "properties": {
+ "three_ds_data": {
+ "$ref": "#/components/schemas/ThreeDsData"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "three_ds_invoke"
+ ]
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "next_action_data",
+ "type"
+ ],
+ "properties": {
+ "next_action_data": {
+ "$ref": "#/components/schemas/SdkNextActionData"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "invoke_sdk_client"
+ ]
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "NextActionType": {
+ "type": "string",
+ "enum": [
+ "redirect_to_url",
+ "display_qr_code",
+ "invoke_sdk_client",
+ "trigger_api",
+ "display_bank_transfer_information",
+ "display_wait_screen"
+ ]
+ },
+ "NoThirdPartySdkSessionResponse": {
+ "type": "object",
+ "required": [
+ "epoch_timestamp",
+ "expires_at",
+ "merchant_session_identifier",
+ "nonce",
+ "merchant_identifier",
+ "domain_name",
+ "display_name",
+ "signature",
+ "operational_analytics_identifier",
+ "retries",
+ "psp_id"
+ ],
+ "properties": {
+ "epoch_timestamp": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Timestamp at which session is requested",
+ "minimum": 0
+ },
+ "expires_at": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Timestamp at which session expires",
+ "minimum": 0
+ },
+ "merchant_session_identifier": {
+ "type": "string",
+ "description": "The identifier for the merchant session"
+ },
+ "nonce": {
+ "type": "string",
+ "description": "Apple pay generated unique ID (UUID) value"
+ },
+ "merchant_identifier": {
+ "type": "string",
+ "description": "The identifier for the merchant"
+ },
+ "domain_name": {
+ "type": "string",
+ "description": "The domain name of the merchant which is registered in Apple Pay"
+ },
+ "display_name": {
+ "type": "string",
+ "description": "The name to be displayed on Apple Pay button"
+ },
+ "signature": {
+ "type": "string",
+ "description": "A string which represents the properties of a payment"
+ },
+ "operational_analytics_identifier": {
+ "type": "string",
+ "description": "The identifier for the operational analytics"
+ },
+ "retries": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of retries to get the session response",
+ "minimum": 0
+ },
+ "psp_id": {
+ "type": "string",
+ "description": "The identifier for the connector transaction"
+ }
+ }
+ },
+ "NoonData": {
+ "type": "object",
+ "properties": {
+ "order_category": {
+ "type": "string",
+ "description": "Information about the order category that merchant wants to specify at connector level. (e.g. In Noon Payments it can take values like \"pay\", \"food\", or any other custom string set by the merchant in Noon's Dashboard)",
+ "nullable": true
+ }
+ }
+ },
+ "NumberComparison": {
+ "type": "object",
+ "description": "Represents a number comparison for \"NumberComparisonArrayValue\"",
+ "required": [
+ "comparisonType",
+ "number"
+ ],
+ "properties": {
+ "comparisonType": {
+ "$ref": "#/components/schemas/ComparisonType"
+ },
+ "number": {
+ "$ref": "#/components/schemas/MinorUnit"
+ }
+ }
+ },
+ "OnlineMandate": {
+ "type": "object",
+ "required": [
+ "ip_address",
+ "user_agent"
+ ],
+ "properties": {
+ "ip_address": {
+ "type": "string",
+ "description": "Ip address of the customer machine from which the mandate was created",
+ "example": "123.32.25.123"
+ },
+ "user_agent": {
+ "type": "string",
+ "description": "The user-agent of the customer's browser"
+ }
+ },
+ "additionalProperties": false
+ },
+ "OpenBankingData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "open_banking_pis"
+ ],
+ "properties": {
+ "open_banking_pis": {
+ "type": "object"
+ }
+ }
+ }
+ ]
+ },
+ "OpenBankingSessionToken": {
+ "type": "object",
+ "required": [
+ "open_banking_session_token"
+ ],
+ "properties": {
+ "open_banking_session_token": {
+ "type": "string",
+ "description": "The session token for OpenBanking Connectors"
+ }
+ }
+ },
+ "OrderDetails": {
+ "type": "object",
+ "required": [
+ "product_name",
+ "quantity"
+ ],
+ "properties": {
+ "product_name": {
+ "type": "string",
+ "description": "Name of the product that is being purchased",
+ "example": "shirt",
+ "maxLength": 255
+ },
+ "quantity": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The quantity of the product to be purchased",
+ "example": 1,
+ "minimum": 0
+ },
+ "requires_shipping": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "product_img_link": {
+ "type": "string",
+ "description": "The image URL of the product",
+ "nullable": true
+ },
+ "product_id": {
+ "type": "string",
+ "description": "ID of the product that is being purchased",
+ "nullable": true
+ },
+ "category": {
+ "type": "string",
+ "description": "Category of the product that is being purchased",
+ "nullable": true
+ },
+ "sub_category": {
+ "type": "string",
+ "description": "Sub category of the product that is being purchased",
+ "nullable": true
+ },
+ "brand": {
+ "type": "string",
+ "description": "Brand of the product that is being purchased",
+ "nullable": true
+ },
+ "product_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ProductType"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "OrderDetailsWithAmount": {
+ "type": "object",
+ "required": [
+ "product_name",
+ "quantity",
+ "amount"
+ ],
+ "properties": {
+ "product_name": {
+ "type": "string",
+ "description": "Name of the product that is being purchased",
+ "example": "shirt",
+ "maxLength": 255
+ },
+ "quantity": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The quantity of the product to be purchased",
+ "example": 1,
+ "minimum": 0
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "the amount per quantity of product"
+ },
+ "requires_shipping": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "product_img_link": {
+ "type": "string",
+ "description": "The image URL of the product",
+ "nullable": true
+ },
+ "product_id": {
+ "type": "string",
+ "description": "ID of the product that is being purchased",
+ "nullable": true
+ },
+ "category": {
+ "type": "string",
+ "description": "Category of the product that is being purchased",
+ "nullable": true
+ },
+ "sub_category": {
+ "type": "string",
+ "description": "Sub category of the product that is being purchased",
+ "nullable": true
+ },
+ "brand": {
+ "type": "string",
+ "description": "Brand of the product that is being purchased",
+ "nullable": true
+ },
+ "product_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ProductType"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "OrganizationRequest": {
+ "type": "object",
+ "properties": {
+ "organization_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "organization_details": {
+ "type": "object",
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ },
+ "OrganizationResponse": {
+ "type": "object",
+ "required": [
+ "organization_id",
+ "modified_at",
+ "created_at"
+ ],
+ "properties": {
+ "organization_id": {
+ "type": "string",
+ "example": "org_q98uSGAYbjEwqs0mJwnz",
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "organization_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "organization_details": {
+ "type": "object",
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "nullable": true
+ },
+ "modified_at": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "OutgoingWebhook": {
+ "type": "object",
+ "required": [
+ "merchant_id",
+ "event_id",
+ "event_type",
+ "content"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The merchant id of the merchant"
+ },
+ "event_id": {
+ "type": "string",
+ "description": "The unique event id for each webhook"
+ },
+ "event_type": {
+ "$ref": "#/components/schemas/EventType"
+ },
+ "content": {
+ "$ref": "#/components/schemas/OutgoingWebhookContent"
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time at which webhook was sent"
+ }
+ }
+ },
+ "OutgoingWebhookContent": {
+ "oneOf": [
+ {
+ "type": "object",
+ "title": "PaymentsResponse",
+ "required": [
+ "type",
+ "object"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "payment_details"
+ ]
+ },
+ "object": {
+ "$ref": "#/components/schemas/PaymentsResponse"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "RefundResponse",
+ "required": [
+ "type",
+ "object"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "refund_details"
+ ]
+ },
+ "object": {
+ "$ref": "#/components/schemas/RefundResponse"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "DisputeResponse",
+ "required": [
+ "type",
+ "object"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "dispute_details"
+ ]
+ },
+ "object": {
+ "$ref": "#/components/schemas/DisputeResponse"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "MandateResponse",
+ "required": [
+ "type",
+ "object"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "mandate_details"
+ ]
+ },
+ "object": {
+ "$ref": "#/components/schemas/MandateResponse"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "PayoutCreateResponse",
+ "required": [
+ "type",
+ "object"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "payout_details"
+ ]
+ },
+ "object": {
+ "$ref": "#/components/schemas/PayoutCreateResponse"
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "OutgoingWebhookRequestContent": {
+ "type": "object",
+ "description": "The request information (headers and body) sent in the webhook.",
+ "required": [
+ "body",
+ "headers"
+ ],
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The request body sent in the webhook."
+ },
+ "headers": {
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "allOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "description": "The request headers sent in the webhook.",
+ "example": [
+ [
+ "content-type",
+ "application/json"
+ ],
+ [
+ "content-length",
+ "1024"
+ ]
+ ]
+ }
+ }
+ },
+ "OutgoingWebhookResponseContent": {
+ "type": "object",
+ "description": "The response information (headers, body and status code) received for the webhook sent.",
+ "properties": {
+ "body": {
+ "type": "string",
+ "description": "The response body received for the webhook sent.",
+ "nullable": true
+ },
+ "headers": {
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "allOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "description": "The response headers received for the webhook sent.",
+ "example": [
+ [
+ "content-type",
+ "application/json"
+ ],
+ [
+ "content-length",
+ "1024"
+ ]
+ ],
+ "nullable": true
+ },
+ "status_code": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The HTTP status code for the webhook sent.",
+ "example": 200,
+ "nullable": true,
+ "minimum": 0
+ },
+ "error_message": {
+ "type": "string",
+ "description": "Error message in case any error occurred when trying to deliver the webhook.",
+ "example": 200,
+ "nullable": true
+ }
+ }
+ },
+ "PayLaterData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "klarna_redirect"
+ ],
+ "properties": {
+ "klarna_redirect": {
+ "type": "object",
+ "description": "For KlarnaRedirect as PayLater Option",
+ "properties": {
+ "billing_email": {
+ "type": "string",
+ "description": "The billing email",
+ "nullable": true
+ },
+ "billing_country": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "klarna_sdk"
+ ],
+ "properties": {
+ "klarna_sdk": {
+ "type": "object",
+ "description": "For Klarna Sdk as PayLater Option",
+ "required": [
+ "token"
+ ],
+ "properties": {
+ "token": {
+ "type": "string",
+ "description": "The token for the sdk workflow"
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "affirm_redirect"
+ ],
+ "properties": {
+ "affirm_redirect": {
+ "type": "object",
+ "description": "For Affirm redirect as PayLater Option"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "afterpay_clearpay_redirect"
+ ],
+ "properties": {
+ "afterpay_clearpay_redirect": {
+ "type": "object",
+ "description": "For AfterpayClearpay redirect as PayLater Option",
+ "properties": {
+ "billing_email": {
+ "type": "string",
+ "description": "The billing email",
+ "nullable": true
+ },
+ "billing_name": {
+ "type": "string",
+ "description": "The billing name",
+ "nullable": true
+ }
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "pay_bright_redirect"
+ ],
+ "properties": {
+ "pay_bright_redirect": {
+ "type": "object",
+ "description": "For PayBright Redirect as PayLater Option"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "walley_redirect"
+ ],
+ "properties": {
+ "walley_redirect": {
+ "type": "object",
+ "description": "For WalleyRedirect as PayLater Option"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "alma_redirect"
+ ],
+ "properties": {
+ "alma_redirect": {
+ "type": "object",
+ "description": "For Alma Redirection as PayLater Option"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "atome_redirect"
+ ],
+ "properties": {
+ "atome_redirect": {
+ "type": "object"
+ }
+ }
+ }
+ ]
+ },
+ "PayPalWalletData": {
+ "type": "object",
+ "required": [
+ "token"
+ ],
+ "properties": {
+ "token": {
+ "type": "string",
+ "description": "Token generated for the Apple pay"
+ }
+ }
+ },
+ "PaylaterResponse": {
+ "type": "object",
+ "properties": {
+ "klarna_sdk": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/KlarnaSdkPaymentMethodResponse"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "PaymentAttemptResponse": {
+ "type": "object",
+ "required": [
+ "attempt_id",
+ "status",
+ "amount",
+ "created_at",
+ "modified_at"
+ ],
+ "properties": {
+ "attempt_id": {
+ "type": "string",
+ "description": "Unique identifier for the attempt"
+ },
+ "status": {
+ "$ref": "#/components/schemas/AttemptStatus"
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment attempt amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,",
+ "example": 6540
+ },
+ "currency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Currency"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "string",
+ "description": "The connector used for the payment",
+ "nullable": true
+ },
+ "error_message": {
+ "type": "string",
+ "description": "If there was an error while calling the connector, the error message is received here",
+ "nullable": true
+ },
+ "payment_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "connector_transaction_id": {
+ "type": "string",
+ "description": "A unique identifier for a payment provided by the connector",
+ "nullable": true
+ },
+ "capture_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CaptureMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "authentication_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AuthenticationType"
+ }
+ ],
+ "default": "three_ds",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time at which the payment attempt was created",
+ "example": "2022-09-10T10:11:12Z"
+ },
+ "modified_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time at which the payment attempt was last modified",
+ "example": "2022-09-10T10:11:12Z"
+ },
+ "cancellation_reason": {
+ "type": "string",
+ "description": "If the payment was cancelled the reason will be provided here",
+ "nullable": true
+ },
+ "mandate_id": {
+ "type": "string",
+ "description": "A unique identifier to link the payment to a mandate, can be use instead of payment_method_data",
+ "nullable": true
+ },
+ "error_code": {
+ "type": "string",
+ "description": "If there was an error while calling the connectors the error code is received here",
+ "nullable": true
+ },
+ "payment_token": {
+ "type": "string",
+ "description": "Provide a reference to a stored payment method",
+ "nullable": true
+ },
+ "connector_metadata": {
+ "description": "Additional data related to some connectors",
+ "nullable": true
+ },
+ "payment_experience": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentExperience"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "reference_id": {
+ "type": "string",
+ "description": "Reference to the payment at connector side",
+ "example": "993672945374576J",
+ "nullable": true
+ },
+ "unified_code": {
+ "type": "string",
+ "description": "(This field is not live yet)Error code unified across the connectors is received here if there was an error while calling connector",
+ "nullable": true
+ },
+ "unified_message": {
+ "type": "string",
+ "description": "(This field is not live yet)Error message unified across the connectors is received here if there was an error while calling connector",
+ "nullable": true
+ },
+ "client_source": {
+ "type": "string",
+ "description": "Value passed in X-CLIENT-SOURCE header during payments confirm request by the client",
+ "nullable": true
+ },
+ "client_version": {
+ "type": "string",
+ "description": "Value passed in X-CLIENT-VERSION header during payments confirm request by the client",
+ "nullable": true
+ }
+ }
+ },
+ "PaymentChargeRequest": {
+ "type": "object",
+ "description": "Fee information to be charged on the payment being collected",
+ "required": [
+ "charge_type",
+ "fees",
+ "transfer_account_id"
+ ],
+ "properties": {
+ "charge_type": {
+ "$ref": "#/components/schemas/PaymentChargeType"
+ },
+ "fees": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Platform fees to be collected on the payment",
+ "example": 6540
+ },
+ "transfer_account_id": {
+ "type": "string",
+ "description": "Identifier for the reseller's account to send the funds to"
+ }
+ }
+ },
+ "PaymentChargeResponse": {
+ "type": "object",
+ "description": "Fee information to be charged on the payment being collected",
+ "required": [
+ "charge_type",
+ "application_fees",
+ "transfer_account_id"
+ ],
+ "properties": {
+ "charge_id": {
+ "type": "string",
+ "description": "Identifier for charge created for the payment",
+ "nullable": true
+ },
+ "charge_type": {
+ "$ref": "#/components/schemas/PaymentChargeType"
+ },
+ "application_fees": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Platform fees collected on the payment",
+ "example": 6540
+ },
+ "transfer_account_id": {
+ "type": "string",
+ "description": "Identifier for the reseller's account where the funds were transferred"
+ }
+ }
+ },
+ "PaymentChargeType": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "Stripe"
+ ],
+ "properties": {
+ "Stripe": {
+ "$ref": "#/components/schemas/StripeChargeType"
+ }
+ }
+ }
+ ]
+ },
+ "PaymentCreatePaymentLinkConfig": {
+ "allOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentLinkConfigRequest"
+ }
+ ],
+ "nullable": true
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "description": "Configure a custom payment link for the particular payment"
+ },
+ "PaymentExperience": {
+ "type": "string",
+ "description": "To indicate the type of payment experience that the customer would go through",
+ "enum": [
+ "redirect_to_url",
+ "invoke_sdk_client",
+ "display_qr_code",
+ "one_click",
+ "link_wallet",
+ "invoke_payment_app",
+ "display_wait_screen"
+ ]
+ },
+ "PaymentIdType": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "PaymentIntentId"
+ ],
+ "properties": {
+ "PaymentIntentId": {
+ "type": "string",
+ "description": "The identifier for payment intent"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "ConnectorTransactionId"
+ ],
+ "properties": {
+ "ConnectorTransactionId": {
+ "type": "string",
+ "description": "The identifier for connector transaction"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "PaymentAttemptId"
+ ],
+ "properties": {
+ "PaymentAttemptId": {
+ "type": "string",
+ "description": "The identifier for payment attempt"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "PreprocessingId"
+ ],
+ "properties": {
+ "PreprocessingId": {
+ "type": "string",
+ "description": "The identifier for preprocessing step"
+ }
+ }
+ }
+ ]
+ },
+ "PaymentLinkConfig": {
+ "type": "object",
+ "required": [
+ "theme",
+ "logo",
+ "seller_name",
+ "sdk_layout",
+ "display_sdk_only",
+ "enabled_saved_payment_method"
+ ],
+ "properties": {
+ "theme": {
+ "type": "string",
+ "description": "custom theme for the payment link"
+ },
+ "logo": {
+ "type": "string",
+ "description": "merchant display logo"
+ },
+ "seller_name": {
+ "type": "string",
+ "description": "Custom merchant name for payment link"
+ },
+ "sdk_layout": {
+ "type": "string",
+ "description": "Custom layout for sdk"
+ },
+ "display_sdk_only": {
+ "type": "boolean",
+ "description": "Display only the sdk for payment link"
+ },
+ "enabled_saved_payment_method": {
+ "type": "boolean",
+ "description": "Enable saved payment method option for payment link"
+ },
+ "allowed_domains": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of allowed domains (glob patterns) where this link can be embedded / opened from",
+ "uniqueItems": true,
+ "nullable": true
+ },
+ "transaction_details": {
+ "type": "string",
+ "description": "Dynamic details related to merchant to be rendered in payment link",
+ "nullable": true
+ }
+ }
+ },
+ "PaymentLinkConfigRequest": {
+ "type": "object",
+ "properties": {
+ "theme": {
+ "type": "string",
+ "description": "custom theme for the payment link",
+ "example": "#4E6ADD",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "logo": {
+ "type": "string",
+ "description": "merchant display logo",
+ "example": "https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "seller_name": {
+ "type": "string",
+ "description": "Custom merchant name for payment link",
+ "example": "hyperswitch",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "sdk_layout": {
+ "type": "string",
+ "description": "Custom layout for sdk",
+ "example": "accordion",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "display_sdk_only": {
+ "type": "boolean",
+ "description": "Display only the sdk for payment link",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "enabled_saved_payment_method": {
+ "type": "boolean",
+ "description": "Enable saved payment method option for payment link",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "transaction_details": {
+ "type": "object",
+ "description": "Dynamic details related to merchant to be rendered in payment link",
+ "nullable": true
+ }
+ }
+ },
+ "PaymentLinkInitiateRequest": {
+ "type": "object",
+ "required": [
+ "merchant_id",
+ "payment_id"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string"
+ },
+ "payment_id": {
+ "type": "string"
+ }
+ }
+ },
+ "PaymentLinkResponse": {
+ "type": "object",
+ "required": [
+ "link",
+ "payment_link_id"
+ ],
+ "properties": {
+ "link": {
+ "type": "string",
+ "description": "URL for rendering the open payment link"
+ },
+ "secure_link": {
+ "type": "string",
+ "description": "URL for rendering the secure payment link",
+ "nullable": true
+ },
+ "payment_link_id": {
+ "type": "string",
+ "description": "Identifier for the payment link"
+ }
+ }
+ },
+ "PaymentLinkStatus": {
+ "type": "string",
+ "description": "Status Of the Payment Link",
+ "enum": [
+ "active",
+ "expired"
+ ]
+ },
+ "PaymentListConstraints": {
+ "type": "object",
+ "properties": {
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for customer",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "starting_after": {
+ "type": "string",
+ "description": "A cursor for use in pagination, fetch the next list after some object",
+ "example": "pay_fafa124123",
+ "nullable": true
+ },
+ "ending_before": {
+ "type": "string",
+ "description": "A cursor for use in pagination, fetch the previous list before some object",
+ "example": "pay_fafa124123",
+ "nullable": true
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int32",
+ "description": "limit on the number of objects to return",
+ "default": 10,
+ "maximum": 100,
+ "minimum": 0
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time at which payment is created",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "created.lt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time less than the payment created time",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "created.gt": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time greater than the payment created time",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "created.lte": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time less than or equals to the payment created time",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "created.gte": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time greater than or equals to the payment created time",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "PaymentListResponse": {
+ "type": "object",
+ "required": [
+ "size",
+ "data"
+ ],
+ "properties": {
+ "size": {
+ "type": "integer",
+ "description": "The number of payments included in the list",
+ "minimum": 0
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentsResponse"
+ }
+ }
+ }
+ },
+ "PaymentMethod": {
+ "type": "string",
+ "description": "Indicates the type of payment method. Eg: 'card', 'wallet', etc.",
+ "enum": [
+ "card",
+ "card_redirect",
+ "pay_later",
+ "wallet",
+ "bank_redirect",
+ "bank_transfer",
+ "crypto",
+ "bank_debit",
+ "reward",
+ "real_time_payment",
+ "upi",
+ "voucher",
+ "gift_card",
+ "open_banking"
+ ]
+ },
+ "PaymentMethodCollectLinkRequest": {
+ "allOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GenericLinkUiConfig"
+ }
+ ],
+ "nullable": true
+ },
+ {
+ "type": "object",
+ "required": [
+ "customer_id"
+ ],
+ "properties": {
+ "pm_collect_link_id": {
+ "type": "string",
+ "description": "The unique identifier for the collect link.",
+ "example": "pm_collect_link_2bdacf398vwzq5n422S1",
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The unique identifier of the customer.",
+ "example": "cus_92dnwed8s32bV9D8Snbiasd8v"
+ },
+ "session_expiry": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Will be used to expire client secret after certain amount of time to be supplied in seconds\n(900) for 15 mins",
+ "example": 900,
+ "nullable": true,
+ "minimum": 0
+ },
+ "return_url": {
+ "type": "string",
+ "description": "Redirect to this URL post completion",
+ "example": "https://sandbox.hyperswitch.io/payment_method/collect/pm_collect_link_2bdacf398vwzq5n422S1/status",
+ "nullable": true
+ },
+ "enabled_payment_methods": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EnabledPaymentMethod"
+ },
+ "description": "List of payment methods shown on collect UI",
+ "example": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\"]}]",
+ "nullable": true
+ }
+ }
+ }
+ ]
+ },
+ "PaymentMethodCollectLinkResponse": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GenericLinkUiConfig"
+ },
+ {
+ "type": "object",
+ "required": [
+ "pm_collect_link_id",
+ "customer_id",
+ "expiry",
+ "link"
+ ],
+ "properties": {
+ "pm_collect_link_id": {
+ "type": "string",
+ "description": "The unique identifier for the collect link.",
+ "example": "pm_collect_link_2bdacf398vwzq5n422S1"
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The unique identifier of the customer.",
+ "example": "cus_92dnwed8s32bV9D8Snbiasd8v"
+ },
+ "expiry": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time when this link will be expired in ISO8601 format",
+ "example": "2025-01-18T11:04:09.922Z"
+ },
+ "link": {
+ "type": "string",
+ "description": "URL to the form's link generated for collecting payment method details.",
+ "example": "https://sandbox.hyperswitch.io/payment_method/collect/pm_collect_link_2bdacf398vwzq5n422S1"
+ },
+ "return_url": {
+ "type": "string",
+ "description": "Redirect to this URL post completion",
+ "example": "https://sandbox.hyperswitch.io/payment_method/collect/pm_collect_link_2bdacf398vwzq5n422S1/status",
+ "nullable": true
+ },
+ "enabled_payment_methods": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EnabledPaymentMethod"
+ },
+ "description": "List of payment methods shown on collect UI",
+ "example": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\"]}]",
+ "nullable": true
+ }
+ }
+ }
+ ]
+ },
+ "PaymentMethodCreate": {
+ "type": "object",
+ "required": [
+ "payment_method"
+ ],
+ "properties": {
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_issuer": {
+ "type": "string",
+ "description": "The name of the bank/ provider issuing the payment method to the end user",
+ "example": "Citibank",
+ "nullable": true
+ },
+ "payment_method_issuer_code": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodIssuerCode"
+ }
+ ],
+ "nullable": true
+ },
+ "card": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardDetail"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The unique identifier of the customer.",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "card_network": {
+ "type": "string",
+ "description": "The card network",
+ "example": "Visa",
+ "nullable": true
+ },
+ "bank_transfer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Bank"
+ }
+ ],
+ "nullable": true
+ },
+ "wallet": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Wallet"
+ }
+ ],
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "For Client based calls, SDK will use the client_secret\nin order to call /payment_methods\nClient secret will be generated whenever a new\npayment method is created",
+ "nullable": true
+ },
+ "payment_method_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodCreateData"
+ }
+ ],
+ "nullable": true
+ },
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "PaymentMethodCreateData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "card"
+ ],
+ "properties": {
+ "card": {
+ "$ref": "#/components/schemas/CardDetail"
+ }
+ }
+ }
+ ]
+ },
+ "PaymentMethodData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "title": "Card",
+ "required": [
+ "card"
+ ],
+ "properties": {
+ "card": {
+ "$ref": "#/components/schemas/Card"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "CardRedirect",
+ "required": [
+ "card_redirect"
+ ],
+ "properties": {
+ "card_redirect": {
+ "$ref": "#/components/schemas/CardRedirectData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "Wallet",
+ "required": [
+ "wallet"
+ ],
+ "properties": {
+ "wallet": {
+ "$ref": "#/components/schemas/WalletData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "PayLater",
+ "required": [
+ "pay_later"
+ ],
+ "properties": {
+ "pay_later": {
+ "$ref": "#/components/schemas/PayLaterData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "BankRedirect",
+ "required": [
+ "bank_redirect"
+ ],
+ "properties": {
+ "bank_redirect": {
+ "$ref": "#/components/schemas/BankRedirectData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "BankDebit",
+ "required": [
+ "bank_debit"
+ ],
+ "properties": {
+ "bank_debit": {
+ "$ref": "#/components/schemas/BankDebitData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "BankTransfer",
+ "required": [
+ "bank_transfer"
+ ],
+ "properties": {
+ "bank_transfer": {
+ "$ref": "#/components/schemas/BankTransferData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "RealTimePayment",
+ "required": [
+ "real_time_payment"
+ ],
+ "properties": {
+ "real_time_payment": {
+ "$ref": "#/components/schemas/RealTimePaymentData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "Crypto",
+ "required": [
+ "crypto"
+ ],
+ "properties": {
+ "crypto": {
+ "$ref": "#/components/schemas/CryptoData"
+ }
+ }
+ },
+ {
+ "type": "string",
+ "title": "MandatePayment",
+ "enum": [
+ "mandate_payment"
+ ]
+ },
+ {
+ "type": "string",
+ "title": "Reward",
+ "enum": [
+ "reward"
+ ]
+ },
+ {
+ "type": "object",
+ "title": "Upi",
+ "required": [
+ "upi"
+ ],
+ "properties": {
+ "upi": {
+ "$ref": "#/components/schemas/UpiData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "Voucher",
+ "required": [
+ "voucher"
+ ],
+ "properties": {
+ "voucher": {
+ "$ref": "#/components/schemas/VoucherData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "GiftCard",
+ "required": [
+ "gift_card"
+ ],
+ "properties": {
+ "gift_card": {
+ "$ref": "#/components/schemas/GiftCardData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "CardToken",
+ "required": [
+ "card_token"
+ ],
+ "properties": {
+ "card_token": {
+ "$ref": "#/components/schemas/CardToken"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "OpenBanking",
+ "required": [
+ "open_banking"
+ ],
+ "properties": {
+ "open_banking": {
+ "$ref": "#/components/schemas/OpenBankingData"
+ }
+ }
+ }
+ ]
+ },
+ "PaymentMethodDataRequest": {
+ "allOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodData"
+ }
+ ],
+ "nullable": true
+ },
+ {
+ "type": "object",
+ "properties": {
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "description": "The payment method information provided for making a payment"
+ },
+ "PaymentMethodDataResponse": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "card"
+ ],
+ "properties": {
+ "card": {
+ "$ref": "#/components/schemas/CardResponse"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bank_transfer"
+ ],
+ "properties": {
+ "bank_transfer": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "wallet"
+ ],
+ "properties": {
+ "wallet": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "pay_later"
+ ],
+ "properties": {
+ "pay_later": {
+ "$ref": "#/components/schemas/PaylaterResponse"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "paypal"
+ ],
+ "properties": {
+ "paypal": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bank_redirect"
+ ],
+ "properties": {
+ "bank_redirect": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "crypto"
+ ],
+ "properties": {
+ "crypto": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bank_debit"
+ ],
+ "properties": {
+ "bank_debit": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "mandate_payment"
+ ],
+ "properties": {
+ "mandate_payment": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "reward"
+ ],
+ "properties": {
+ "reward": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "real_time_payment"
+ ],
+ "properties": {
+ "real_time_payment": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "upi"
+ ],
+ "properties": {
+ "upi": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "voucher"
+ ],
+ "properties": {
+ "voucher": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "gift_card"
+ ],
+ "properties": {
+ "gift_card": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "card_redirect"
+ ],
+ "properties": {
+ "card_redirect": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "card_token"
+ ],
+ "properties": {
+ "card_token": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "open_banking"
+ ],
+ "properties": {
+ "open_banking": {
+ "type": "object"
+ }
+ }
+ }
+ ]
+ },
+ "PaymentMethodDataResponseWithBilling": {
+ "allOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodDataResponse"
+ }
+ ],
+ "nullable": true
+ },
+ {
+ "type": "object",
+ "properties": {
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ ]
+ },
+ "PaymentMethodDeleteResponse": {
+ "type": "object",
+ "required": [
+ "payment_method_id",
+ "deleted"
+ ],
+ "properties": {
+ "payment_method_id": {
+ "type": "string",
+ "description": "The unique identifier of the Payment method",
+ "example": "card_rGK4Vi5iSW70MY7J2mIg"
+ },
+ "deleted": {
+ "type": "boolean",
+ "description": "Whether payment method was deleted or not",
+ "example": true
+ }
+ }
+ },
+ "PaymentMethodIssuerCode": {
+ "type": "string",
+ "enum": [
+ "jp_hdfc",
+ "jp_icici",
+ "jp_googlepay",
+ "jp_applepay",
+ "jp_phonepay",
+ "jp_wechat",
+ "jp_sofort",
+ "jp_giropay",
+ "jp_sepa",
+ "jp_bacs"
+ ]
+ },
+ "PaymentMethodList": {
+ "type": "object",
+ "required": [
+ "payment_method"
+ ],
+ "properties": {
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "description": "This is a sub-category of payment method.",
+ "example": [
+ "credit"
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "PaymentMethodListResponse": {
+ "type": "object",
+ "required": [
+ "currency",
+ "payment_methods",
+ "mandate_payment",
+ "show_surcharge_breakup_screen",
+ "request_external_three_ds_authentication"
+ ],
+ "properties": {
+ "redirect_url": {
+ "type": "string",
+ "description": "Redirect URL of the merchant",
+ "example": "https://www.google.com",
+ "nullable": true
+ },
+ "currency": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "payment_methods": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodList"
+ },
+ "description": "Information about the payment method",
+ "example": [
+ {
+ "payment_experience": null,
+ "payment_method": "wallet",
+ "payment_method_issuers": [
+ "labore magna ipsum",
+ "aute"
+ ]
+ }
+ ]
+ },
+ "mandate_payment": {
+ "$ref": "#/components/schemas/MandateType"
+ },
+ "merchant_name": {
+ "type": "string",
+ "nullable": true
+ },
+ "show_surcharge_breakup_screen": {
+ "type": "boolean",
+ "description": "flag to indicate if surcharge and tax breakup screen should be shown or not"
+ },
+ "payment_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentType"
+ }
+ ],
+ "nullable": true
+ },
+ "request_external_three_ds_authentication": {
+ "type": "boolean",
+ "description": "flag to indicate whether to perform external 3ds authentication",
+ "example": true
+ },
+ "collect_shipping_details_from_wallets": {
+ "type": "boolean",
+ "description": "flag that indicates whether to collect shipping details from wallets or from the customer",
+ "nullable": true
+ },
+ "collect_billing_details_from_wallets": {
+ "type": "boolean",
+ "description": "flag that indicates whether to collect billing details from wallets or from the customer",
+ "nullable": true
+ }
+ }
+ },
+ "PaymentMethodResponse": {
+ "type": "object",
+ "required": [
+ "merchant_id",
+ "payment_method_id",
+ "payment_method",
+ "recurring_enabled",
+ "installment_payment_enabled"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "Unique identifier for a merchant",
+ "example": "merchant_1671528864"
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The unique identifier of the customer.",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "payment_method_id": {
+ "type": "string",
+ "description": "The unique identifier of the Payment method",
+ "example": "card_rGK4Vi5iSW70MY7J2mIg"
+ },
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "card": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardDetailFromLocker"
+ }
+ ],
+ "nullable": true
+ },
+ "recurring_enabled": {
+ "type": "boolean",
+ "description": "Indicates whether the payment method is eligible for recurring payments",
+ "example": true
+ },
+ "installment_payment_enabled": {
+ "type": "boolean",
+ "description": "Indicates whether the payment method is eligible for installment payments",
+ "example": true
+ },
+ "payment_experience": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentExperience"
+ },
+ "description": "Type of payment experience enabled with the connector",
+ "example": [
+ "redirect_to_url"
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "A timestamp (ISO 8601 code) that determines when the customer was created",
+ "example": "2023-01-18T11:04:09.922Z",
+ "nullable": true
+ },
+ "bank_transfer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Bank"
+ }
+ ],
+ "nullable": true
+ },
+ "last_used_at": {
+ "type": "string",
+ "format": "date-time",
+ "example": "2024-02-24T11:04:09.922Z",
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "For Client based calls",
+ "nullable": true
+ }
+ }
+ },
+ "PaymentMethodStatus": {
+ "type": "string",
+ "description": "Payment Method Status",
+ "enum": [
+ "active",
+ "inactive",
+ "processing",
+ "awaiting_data"
+ ]
+ },
+ "PaymentMethodType": {
+ "type": "string",
+ "description": "Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.",
+ "enum": [
+ "ach",
+ "affirm",
+ "afterpay_clearpay",
+ "alfamart",
+ "ali_pay",
+ "ali_pay_hk",
+ "alma",
+ "apple_pay",
+ "atome",
+ "bacs",
+ "bancontact_card",
+ "becs",
+ "benefit",
+ "bizum",
+ "blik",
+ "boleto",
+ "bca_bank_transfer",
+ "bni_va",
+ "bri_va",
+ "card_redirect",
+ "cimb_va",
+ "classic",
+ "credit",
+ "crypto_currency",
+ "cashapp",
+ "dana",
+ "danamon_va",
+ "debit",
+ "duit_now",
+ "efecty",
+ "eps",
+ "fps",
+ "evoucher",
+ "giropay",
+ "givex",
+ "google_pay",
+ "go_pay",
+ "gcash",
+ "ideal",
+ "interac",
+ "indomaret",
+ "klarna",
+ "kakao_pay",
+ "local_bank_redirect",
+ "mandiri_va",
+ "knet",
+ "mb_way",
+ "mobile_pay",
+ "momo",
+ "momo_atm",
+ "multibanco",
+ "online_banking_thailand",
+ "online_banking_czech_republic",
+ "online_banking_finland",
+ "online_banking_fpx",
+ "online_banking_poland",
+ "online_banking_slovakia",
+ "oxxo",
+ "pago_efectivo",
+ "permata_bank_transfer",
+ "open_banking_uk",
+ "pay_bright",
+ "paypal",
+ "pix",
+ "pay_safe_card",
+ "przelewy24",
+ "prompt_pay",
+ "pse",
+ "red_compra",
+ "red_pagos",
+ "samsung_pay",
+ "sepa",
+ "sofort",
+ "swish",
+ "touch_n_go",
+ "trustly",
+ "twint",
+ "upi_collect",
+ "upi_intent",
+ "vipps",
+ "viet_qr",
+ "venmo",
+ "walley",
+ "we_chat_pay",
+ "seven_eleven",
+ "lawson",
+ "mini_stop",
+ "family_mart",
+ "seicomart",
+ "pay_easy",
+ "local_bank_transfer",
+ "mifinity",
+ "open_banking_pis"
+ ]
+ },
+ "PaymentMethodUpdate": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CardDetailUpdate"
+ }
+ ],
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "This is a 15 minute expiry token which shall be used from the client to authenticate and perform sessions from the SDK",
+ "example": "secret_k2uj3he2893eiu2d",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ }
+ },
+ "additionalProperties": false
+ },
+ "PaymentMethodsEnabled": {
+ "type": "object",
+ "description": "Details of all the payment methods enabled for the connector for the given merchant account",
+ "required": [
+ "payment_method"
+ ],
+ "properties": {
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RequestPaymentMethodTypes"
+ },
+ "description": "Subtype of payment method",
+ "example": [
+ "credit"
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "PaymentProcessingDetails": {
+ "type": "object",
+ "required": [
+ "payment_processing_certificate",
+ "payment_processing_certificate_key"
+ ],
+ "properties": {
+ "payment_processing_certificate": {
+ "type": "string"
+ },
+ "payment_processing_certificate_key": {
+ "type": "string"
+ }
+ }
+ },
+ "PaymentProcessingDetailsAt": {
+ "oneOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentProcessingDetails"
+ },
+ {
+ "type": "object",
+ "required": [
+ "payment_processing_details_at"
+ ],
+ "properties": {
+ "payment_processing_details_at": {
+ "type": "string",
+ "enum": [
+ "Hyperswitch"
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "type": "object",
+ "required": [
+ "payment_processing_details_at"
+ ],
+ "properties": {
+ "payment_processing_details_at": {
+ "type": "string",
+ "enum": [
+ "Connector"
+ ]
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "payment_processing_details_at"
+ }
+ },
+ "PaymentRetrieveBody": {
+ "type": "object",
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account.",
+ "nullable": true
+ },
+ "force_sync": {
+ "type": "boolean",
+ "description": "Decider to enable or disable the connector call for retrieve request",
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK",
+ "nullable": true
+ },
+ "expand_captures": {
+ "type": "boolean",
+ "description": "If enabled provides list of captures linked to latest attempt",
+ "nullable": true
+ },
+ "expand_attempts": {
+ "type": "boolean",
+ "description": "If enabled provides list of attempts linked to payment intent",
+ "nullable": true
+ }
+ }
+ },
+ "PaymentType": {
+ "type": "string",
+ "description": "The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.",
+ "enum": [
+ "normal",
+ "new_mandate",
+ "setup_mandate",
+ "recurring_mandate"
+ ]
+ },
+ "PaymentsCancelRequest": {
+ "type": "object",
+ "properties": {
+ "cancellation_reason": {
+ "type": "string",
+ "description": "The reason for the payment cancel",
+ "nullable": true
+ },
+ "merchant_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "PaymentsCaptureRequest": {
+ "type": "object",
+ "required": [
+ "amount_to_capture"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The unique identifier for the merchant",
+ "nullable": true
+ },
+ "amount_to_capture": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The Amount to be captured/ debited from the user's payment method.",
+ "example": 6540
+ },
+ "refund_uncaptured_amount": {
+ "type": "boolean",
+ "description": "Decider to refund the uncaptured amount",
+ "nullable": true
+ },
+ "statement_descriptor_suffix": {
+ "type": "string",
+ "description": "Provides information about a card payment that customers see on their statements.",
+ "nullable": true
+ },
+ "statement_descriptor_prefix": {
+ "type": "string",
+ "description": "Concatenated with the statement descriptor suffix that’s set on the account to form the complete statement descriptor.",
+ "nullable": true
+ },
+ "merchant_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "PaymentsCompleteAuthorizeRequest": {
+ "type": "object",
+ "required": [
+ "client_secret"
+ ],
+ "properties": {
+ "shipping": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "Client Secret"
+ }
+ }
+ },
+ "PaymentsConfirmRequest": {
+ "type": "object",
+ "properties": {
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and ¥100 since ¥ is a zero-decimal currency",
+ "example": 6540,
+ "nullable": true,
+ "minimum": 0
+ },
+ "currency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Currency"
+ }
+ ],
+ "nullable": true
+ },
+ "amount_to_capture": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The Amount to be captured / debited from the users payment method. It shall be in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, the default amount_to_capture will be the payment amount. Also, it must be less than or equal to the original payment account.",
+ "example": 6540,
+ "nullable": true
+ },
+ "payment_id": {
+ "type": "string",
+ "description": "Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant. The value for this field can be specified in the request, it will be auto generated otherwise and returned in the API response.",
+ "example": "pay_mbabizu24mvu3mela5njyhpit4",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StraightThroughAlgorithm"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "description": "This allows to manually select a connector with which the payment can go through.",
+ "example": [
+ "stripe",
+ "adyen"
+ ],
+ "nullable": true
+ },
+ "capture_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CaptureMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "authentication_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AuthenticationType"
+ }
+ ],
+ "default": "three_ds",
+ "nullable": true
+ },
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "confirm": {
+ "type": "boolean",
+ "description": "Whether to confirm the payment (if applicable). It can be used to completely process a payment by attaching a payment method, setting `confirm=true` and `capture_method = automatic` in the *Payments/Create API* request itself.",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "customer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for the customer",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "off_session": {
+ "type": "boolean",
+ "description": "Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. When making a recurring payment by passing a mandate_id, this parameter is mandatory",
+ "example": true,
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "A description for the payment",
+ "example": "It's my first payment request",
+ "nullable": true
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to which you want the user to be redirected after the completion of the payment operation",
+ "example": "https://hyperswitch.io",
+ "nullable": true
+ },
+ "setup_future_usage": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FutureUsage"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodDataRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_token": {
+ "type": "string",
+ "description": "As Hyperswitch tokenises the sensitive details about the payments method, it provides the payment_token as a reference to a stored payment method, ensuring that the sensitive details are not exposed in any manner.",
+ "example": "187282ab-40ef-47a9-9206-5099ba31e432",
+ "nullable": true
+ },
+ "shipping": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "statement_descriptor_name": {
+ "type": "string",
+ "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
+ "example": "Hyperswitch Router",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "statement_descriptor_suffix": {
+ "type": "string",
+ "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
+ "example": "Payment for shoes purchase",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "order_details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OrderDetailsWithAmount"
+ },
+ "description": "Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount",
+ "example": "[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]",
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "It's a token used for client side verification.",
+ "example": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
+ "nullable": true
+ },
+ "mandate_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MandateData"
+ }
+ ],
+ "nullable": true
+ },
+ "customer_acceptance": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerAcceptance"
+ }
+ ],
+ "nullable": true
+ },
+ "mandate_id": {
+ "type": "string",
+ "description": "A unique identifier to link the payment to a mandate. To do Recurring payments after a mandate has been created, pass the mandate_id instead of payment_method_data",
+ "example": "mandate_iwer89rnjef349dni3",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "browser_info": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BrowserInformation"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_experience": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentExperience"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "merchant_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
+ }
+ ],
+ "nullable": true
+ },
+ "allowed_payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "description": "Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent",
+ "nullable": true
+ },
+ "retry_action": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RetryAction"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "connector_metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ConnectorMetadata"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_link": {
+ "type": "boolean",
+ "description": "Whether to generate the payment link for this payment or not (if applicable)",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "payment_link_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentCreatePaymentLinkConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_link_config_id": {
+ "type": "string",
+ "description": "Custom payment link config id set at business profile, send only if business_specific_configs is configured",
+ "nullable": true
+ },
+ "payment_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentType"
+ }
+ ],
+ "nullable": true
+ },
+ "request_incremental_authorization": {
+ "type": "boolean",
+ "description": "Request an incremental authorization, i.e., increase the authorized amount on a confirmed payment before you capture it.",
+ "nullable": true
+ },
+ "session_expiry": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Will be used to expire client secret after certain amount of time to be supplied in seconds\n(900) for 15 mins",
+ "example": 900,
+ "nullable": true,
+ "minimum": 0
+ },
+ "frm_metadata": {
+ "type": "object",
+ "description": "Additional data related to some frm(Fraud Risk Management) connectors",
+ "nullable": true
+ },
+ "request_external_three_ds_authentication": {
+ "type": "boolean",
+ "description": "Whether to perform external authentication (if applicable)",
+ "example": true,
+ "nullable": true
+ },
+ "recurring_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RecurringDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "charges": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentChargeRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "merchant_order_reference_id": {
+ "type": "string",
+ "description": "Merchant's identifier for the payment/invoice. This will be sent to the connector\nif the connector provides support to accept multiple reference ids.\nIn case the connector supports only one reference id, Hyperswitch's Payment ID will be sent as reference.",
+ "example": "Custom_Order_id_123",
+ "nullable": true,
+ "maxLength": 255
+ }
+ }
+ },
+ "PaymentsCreateRequest": {
+ "type": "object",
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "properties": {
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and ¥100 since ¥ is a zero-decimal currency",
+ "minimum": 0
+ },
+ "currency": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "amount_to_capture": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The Amount to be captured / debited from the users payment method. It shall be in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, the default amount_to_capture will be the payment amount. Also, it must be less than or equal to the original payment account.",
+ "example": 6540,
+ "nullable": true
+ },
+ "payment_id": {
+ "type": "string",
+ "description": "Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant. The value for this field can be specified in the request, it will be auto generated otherwise and returned in the API response.",
+ "example": "pay_mbabizu24mvu3mela5njyhpit4",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StraightThroughAlgorithm"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "description": "This allows to manually select a connector with which the payment can go through.",
+ "example": [
+ "stripe",
+ "adyen"
+ ],
+ "nullable": true
+ },
+ "capture_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CaptureMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "authentication_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AuthenticationType"
+ }
+ ],
+ "default": "three_ds",
+ "nullable": true
+ },
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "confirm": {
+ "type": "boolean",
+ "description": "Whether to confirm the payment (if applicable). It can be used to completely process a payment by attaching a payment method, setting `confirm=true` and `capture_method = automatic` in the *Payments/Create API* request itself.",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "customer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for the customer",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "off_session": {
+ "type": "boolean",
+ "description": "Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. When making a recurring payment by passing a mandate_id, this parameter is mandatory",
+ "example": true,
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "A description for the payment",
+ "example": "It's my first payment request",
+ "nullable": true
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to which you want the user to be redirected after the completion of the payment operation",
+ "example": "https://hyperswitch.io",
+ "nullable": true
+ },
+ "setup_future_usage": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FutureUsage"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodDataRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_token": {
+ "type": "string",
+ "description": "As Hyperswitch tokenises the sensitive details about the payments method, it provides the payment_token as a reference to a stored payment method, ensuring that the sensitive details are not exposed in any manner.",
+ "example": "187282ab-40ef-47a9-9206-5099ba31e432",
+ "nullable": true
+ },
+ "shipping": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "statement_descriptor_name": {
+ "type": "string",
+ "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
+ "example": "Hyperswitch Router",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "statement_descriptor_suffix": {
+ "type": "string",
+ "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
+ "example": "Payment for shoes purchase",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "order_details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OrderDetailsWithAmount"
+ },
+ "description": "Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount",
+ "example": "[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]",
+ "nullable": true
+ },
+ "mandate_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MandateData"
+ }
+ ],
+ "nullable": true
+ },
+ "customer_acceptance": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerAcceptance"
+ }
+ ],
+ "nullable": true
+ },
+ "mandate_id": {
+ "type": "string",
+ "description": "A unique identifier to link the payment to a mandate. To do Recurring payments after a mandate has been created, pass the mandate_id instead of payment_method_data",
+ "example": "mandate_iwer89rnjef349dni3",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "browser_info": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BrowserInformation"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_experience": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentExperience"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "business_country": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ },
+ "business_label": {
+ "type": "string",
+ "description": "Business label of the merchant for this payment.\nTo be deprecated soon. Pass the profile_id instead",
+ "example": "food",
+ "nullable": true
+ },
+ "merchant_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
+ }
+ ],
+ "nullable": true
+ },
+ "allowed_payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "description": "Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent",
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "connector_metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ConnectorMetadata"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_link": {
+ "type": "boolean",
+ "description": "Whether to generate the payment link for this payment or not (if applicable)",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "payment_link_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentCreatePaymentLinkConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_link_config_id": {
+ "type": "string",
+ "description": "Custom payment link config id set at business profile, send only if business_specific_configs is configured",
+ "nullable": true
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The business profile to be used for this payment, if not passed the default business profile associated with the merchant account will be used. It is mandatory in case multiple business profiles have been set up.",
+ "nullable": true
+ },
+ "surcharge_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RequestSurchargeDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentType"
+ }
+ ],
+ "nullable": true
+ },
+ "request_incremental_authorization": {
+ "type": "boolean",
+ "description": "Request an incremental authorization, i.e., increase the authorized amount on a confirmed payment before you capture it.",
+ "nullable": true
+ },
+ "session_expiry": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Will be used to expire client secret after certain amount of time to be supplied in seconds\n(900) for 15 mins",
+ "example": 900,
+ "nullable": true,
+ "minimum": 0
+ },
+ "frm_metadata": {
+ "type": "object",
+ "description": "Additional data related to some frm(Fraud Risk Management) connectors",
+ "nullable": true
+ },
+ "request_external_three_ds_authentication": {
+ "type": "boolean",
+ "description": "Whether to perform external authentication (if applicable)",
+ "example": true,
+ "nullable": true
+ },
+ "recurring_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RecurringDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "charges": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentChargeRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "merchant_order_reference_id": {
+ "type": "string",
+ "description": "Merchant's identifier for the payment/invoice. This will be sent to the connector\nif the connector provides support to accept multiple reference ids.\nIn case the connector supports only one reference id, Hyperswitch's Payment ID will be sent as reference.",
+ "example": "Custom_Order_id_123",
+ "nullable": true,
+ "maxLength": 255
+ }
+ }
+ },
+ "PaymentsCreateResponseOpenApi": {
+ "type": "object",
+ "required": [
+ "status",
+ "amount",
+ "net_amount",
+ "amount_capturable",
+ "amount_received",
+ "currency",
+ "payment_method",
+ "attempt_count"
+ ],
+ "properties": {
+ "payment_id": {
+ "type": "string",
+ "description": "Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant.",
+ "example": "pay_mbabizu24mvu3mela5njyhpit4",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "This is an identifier for the merchant account. This is inferred from the API key\nprovided during the request",
+ "example": "merchant_1668273825",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/IntentStatus"
+ }
+ ],
+ "default": "requires_confirmation"
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,",
+ "example": 6540
+ },
+ "net_amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment net amount. net_amount = amount + surcharge_details.surcharge_amount + surcharge_details.tax_amount,\nIf no surcharge_details, net_amount = amount",
+ "example": 6540
+ },
+ "amount_capturable": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum amount that could be captured from the payment",
+ "example": 6540,
+ "minimum": 100
+ },
+ "amount_received": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The amount which is already captured from the payment, this helps in the cases where merchants can't capture all capturable amount at once.",
+ "example": 6540
+ },
+ "connector": {
+ "type": "string",
+ "description": "The connector used for the payment",
+ "example": "stripe",
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "It's a token used for client side verification.",
+ "example": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
+ "nullable": true
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time when the payment was created",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "currency": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for the customer object. If not provided the customer ID will be autogenerated.\nThis field will be deprecated soon. Please refer to `customer.id`",
+ "deprecated": true,
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the payment",
+ "example": "It's my first payment request",
+ "nullable": true
+ },
+ "refunds": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RefundResponse"
+ },
+ "description": "List of refunds that happened on this intent, as same payment intent can have multiple refund requests depending on the nature of order",
+ "nullable": true
+ },
+ "disputes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DisputeResponsePaymentsRetrieve"
+ },
+ "description": "List of disputes that happened on this intent",
+ "nullable": true
+ },
+ "attempts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentAttemptResponse"
+ },
+ "description": "List of attempts that happened on this intent",
+ "nullable": true
+ },
+ "captures": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CaptureResponse"
+ },
+ "description": "List of captures done on latest attempt",
+ "nullable": true
+ },
+ "mandate_id": {
+ "type": "string",
+ "description": "A unique identifier to link the payment to a mandate, can be used instead of payment_method_data, in case of setting up recurring payments",
+ "example": "mandate_iwer89rnjef349dni3",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "mandate_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MandateData"
+ }
+ ],
+ "nullable": true
+ },
+ "setup_future_usage": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FutureUsage"
+ }
+ ],
+ "nullable": true
+ },
+ "off_session": {
+ "type": "boolean",
+ "description": "Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. This parameter can only be used with confirm=true.",
+ "example": true,
+ "nullable": true
+ },
+ "capture_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CaptureMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodDataResponseWithBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_token": {
+ "type": "string",
+ "description": "Provide a reference to a stored payment method",
+ "example": "187282ab-40ef-47a9-9206-5099ba31e432",
+ "nullable": true
+ },
+ "shipping": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "order_details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OrderDetailsWithAmount"
+ },
+ "description": "Information about the product , quantity and amount for connectors. (e.g. Klarna)",
+ "example": "[{\n \"product_name\": \"gillete creme\",\n \"quantity\": 15,\n \"amount\" : 900\n }]",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "description: The customer's email address\nThis field will be deprecated soon. Please refer to `customer.email` object",
+ "deprecated": true,
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "name": {
+ "type": "string",
+ "description": "description: The customer's name\nThis field will be deprecated soon. Please refer to `customer.name` object",
+ "deprecated": true,
+ "example": "John Test",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone": {
+ "type": "string",
+ "description": "The customer's phone number\nThis field will be deprecated soon. Please refer to `customer.phone` object",
+ "deprecated": true,
+ "example": "9123456789",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to redirect after the completion of the operation",
+ "example": "https://hyperswitch.io",
+ "nullable": true
+ },
+ "authentication_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AuthenticationType"
+ }
+ ],
+ "default": "three_ds",
+ "nullable": true
+ },
+ "statement_descriptor_name": {
+ "type": "string",
+ "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
+ "example": "Hyperswitch Router",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "statement_descriptor_suffix": {
+ "type": "string",
+ "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 255 characters for the concatenated descriptor.",
+ "example": "Payment for shoes purchase",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "next_action": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/NextActionData"
+ }
+ ],
+ "nullable": true
+ },
+ "cancellation_reason": {
+ "type": "string",
+ "description": "If the payment was cancelled the reason will be provided here",
+ "nullable": true
+ },
+ "error_code": {
+ "type": "string",
+ "description": "If there was an error while calling the connectors the code is received here",
+ "example": "E0001",
+ "nullable": true
+ },
+ "error_message": {
+ "type": "string",
+ "description": "If there was an error while calling the connector the error message is received here",
+ "example": "Failed while verifying the card",
+ "nullable": true
+ },
+ "payment_experience": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentExperience"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "connector_label": {
+ "type": "string",
+ "description": "The connector used for this payment along with the country and business details",
+ "example": "stripe_US_food",
+ "nullable": true
+ },
+ "business_country": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ },
+ "business_label": {
+ "type": "string",
+ "description": "The business label of merchant for this payment",
+ "nullable": true
+ },
+ "business_sub_label": {
+ "type": "string",
+ "description": "The business_sub_label for this payment",
+ "nullable": true
+ },
+ "allowed_payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "description": "Allowed Payment Method Types for a given PaymentIntent",
+ "nullable": true
+ },
+ "ephemeral_key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/EphemeralKeyCreateResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "manual_retry_allowed": {
+ "type": "boolean",
+ "description": "If true the payment can be retried with same or different payment method which means the confirm call can be made again.",
+ "nullable": true
+ },
+ "connector_transaction_id": {
+ "type": "string",
+ "description": "A unique identifier for a payment provided by the connector",
+ "example": "993672945374576J",
+ "nullable": true
+ },
+ "frm_message": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FrmMessage"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "connector_metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ConnectorMetadata"
+ }
+ ],
+ "nullable": true
+ },
+ "feature_metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FeatureMetadata"
+ }
+ ],
+ "nullable": true
+ },
+ "reference_id": {
+ "type": "string",
+ "description": "reference(Identifier) to the payment at connector side",
+ "example": "993672945374576J",
+ "nullable": true
+ },
+ "payment_link": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentLinkResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The business profile that is associated with this payment",
+ "nullable": true
+ },
+ "surcharge_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RequestSurchargeDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "attempt_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total number of attempts associated with this payment"
+ },
+ "merchant_decision": {
+ "type": "string",
+ "description": "Denotes the action(approve or reject) taken by merchant in case of manual review. Manual review can occur when the transaction is marked as risky by the frm_processor, payment processor or when there is underpayment/over payment incase of crypto payment",
+ "nullable": true
+ },
+ "merchant_connector_id": {
+ "type": "string",
+ "description": "Identifier of the connector ( merchant connector account ) which was chosen to make the payment",
+ "nullable": true
+ },
+ "incremental_authorization_allowed": {
+ "type": "boolean",
+ "description": "If true, incremental authorization can be performed on this payment, in case the funds authorized initially fall short.",
+ "nullable": true
+ },
+ "authorization_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total number of authorizations happened in an incremental_authorization payment",
+ "nullable": true
+ },
+ "incremental_authorizations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IncrementalAuthorizationResponse"
+ },
+ "description": "List of incremental authorizations happened to the payment",
+ "nullable": true
+ },
+ "external_authentication_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ExternalAuthenticationDetailsResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "external_3ds_authentication_attempted": {
+ "type": "boolean",
+ "description": "Flag indicating if external 3ds authentication is made or not",
+ "nullable": true
+ },
+ "expires_on": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date Time for expiry of the payment",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "fingerprint": {
+ "type": "string",
+ "description": "Payment Fingerprint, to identify a particular card.\nIt is a 20 character long alphanumeric code.",
+ "nullable": true
+ },
+ "browser_info": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BrowserInformation"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_id": {
+ "type": "string",
+ "description": "Identifier for Payment Method used for the payment",
+ "nullable": true
+ },
+ "payment_method_status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodStatus"
+ }
+ ],
+ "nullable": true
+ },
+ "updated": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date time at which payment was updated",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "charges": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentChargeResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "frm_metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. FRM Metadata is useful for storing additional, structured information on an object related to FRM.",
+ "nullable": true
+ },
+ "merchant_order_reference_id": {
+ "type": "string",
+ "description": "Merchant's identifier for the payment/invoice. This will be sent to the connector\nif the connector provides support to accept multiple reference ids.\nIn case the connector supports only one reference id, Hyperswitch's Payment ID will be sent as reference.",
+ "example": "Custom_Order_id_123",
+ "nullable": true,
+ "maxLength": 255
+ }
+ }
+ },
+ "PaymentsExternalAuthenticationRequest": {
+ "type": "object",
+ "required": [
+ "client_secret",
+ "device_channel",
+ "threeds_method_comp_ind"
+ ],
+ "properties": {
+ "client_secret": {
+ "type": "string",
+ "description": "Client Secret"
+ },
+ "sdk_information": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SdkInformation"
+ }
+ ],
+ "nullable": true
+ },
+ "device_channel": {
+ "$ref": "#/components/schemas/DeviceChannel"
+ },
+ "threeds_method_comp_ind": {
+ "$ref": "#/components/schemas/ThreeDsCompletionIndicator"
+ }
+ }
+ },
+ "PaymentsExternalAuthenticationResponse": {
+ "type": "object",
+ "required": [
+ "trans_status",
+ "three_ds_requestor_url"
+ ],
+ "properties": {
+ "trans_status": {
+ "$ref": "#/components/schemas/TransactionStatus"
+ },
+ "acs_url": {
+ "type": "string",
+ "description": "Access Server URL to be used for challenge submission",
+ "nullable": true
+ },
+ "challenge_request": {
+ "type": "string",
+ "description": "Challenge request which should be sent to acs_url",
+ "nullable": true
+ },
+ "acs_reference_number": {
+ "type": "string",
+ "description": "Unique identifier assigned by the EMVCo(Europay, Mastercard and Visa)",
+ "nullable": true
+ },
+ "acs_trans_id": {
+ "type": "string",
+ "description": "Unique identifier assigned by the ACS to identify a single transaction",
+ "nullable": true
+ },
+ "three_dsserver_trans_id": {
+ "type": "string",
+ "description": "Unique identifier assigned by the 3DS Server to identify a single transaction",
+ "nullable": true
+ },
+ "acs_signed_content": {
+ "type": "string",
+ "description": "Contains the JWS object created by the ACS for the ARes(Authentication Response) message",
+ "nullable": true
+ },
+ "three_ds_requestor_url": {
+ "type": "string",
+ "description": "Three DS Requestor URL"
+ }
+ }
+ },
+ "PaymentsIncrementalAuthorizationRequest": {
+ "type": "object",
+ "required": [
+ "amount"
+ ],
+ "properties": {
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The total amount including previously authorized amount and additional amount",
+ "example": 6540
+ },
+ "reason": {
+ "type": "string",
+ "description": "Reason for incremental authorization",
+ "nullable": true
+ }
+ }
+ },
+ "PaymentsRequest": {
+ "type": "object",
+ "properties": {
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and ¥100 since ¥ is a zero-decimal currency",
+ "example": 6540,
+ "nullable": true,
+ "minimum": 0
+ },
+ "currency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Currency"
+ }
+ ],
+ "nullable": true
+ },
+ "amount_to_capture": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The Amount to be captured / debited from the users payment method. It shall be in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, the default amount_to_capture will be the payment amount. Also, it must be less than or equal to the original payment account.",
+ "example": 6540,
+ "nullable": true
+ },
+ "payment_id": {
+ "type": "string",
+ "description": "Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant. The value for this field can be specified in the request, it will be auto generated otherwise and returned in the API response.",
+ "example": "pay_mbabizu24mvu3mela5njyhpit4",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "This is an identifier for the merchant account. This is inferred from the API key\nprovided during the request",
+ "example": "merchant_1668273825",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StraightThroughAlgorithm"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "description": "This allows to manually select a connector with which the payment can go through.",
+ "example": [
+ "stripe",
+ "adyen"
+ ],
+ "nullable": true
+ },
+ "capture_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CaptureMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "authentication_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AuthenticationType"
+ }
+ ],
+ "default": "three_ds",
+ "nullable": true
+ },
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "capture_on": {
+ "type": "string",
+ "format": "date-time",
+ "description": "A timestamp (ISO 8601 code) that determines when the payment should be captured.\nProviding this field will automatically set `capture` to true",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "confirm": {
+ "type": "boolean",
+ "description": "Whether to confirm the payment (if applicable). It can be used to completely process a payment by attaching a payment method, setting `confirm=true` and `capture_method = automatic` in the *Payments/Create API* request itself.",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "customer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for the customer",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "email": {
+ "type": "string",
+ "description": "The customer's email address.\nThis field will be deprecated soon, use the customer object instead",
+ "deprecated": true,
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "name": {
+ "type": "string",
+ "description": "The customer's name.\nThis field will be deprecated soon, use the customer object instead.",
+ "deprecated": true,
+ "example": "John Test",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone": {
+ "type": "string",
+ "description": "The customer's phone number\nThis field will be deprecated soon, use the customer object instead",
+ "deprecated": true,
+ "example": "9123456789",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone_country_code": {
+ "type": "string",
+ "description": "The country code for the customer phone number\nThis field will be deprecated soon, use the customer object instead",
+ "deprecated": true,
+ "example": "+1",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "off_session": {
+ "type": "boolean",
+ "description": "Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. When making a recurring payment by passing a mandate_id, this parameter is mandatory",
+ "example": true,
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "A description for the payment",
+ "example": "It's my first payment request",
+ "nullable": true
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to which you want the user to be redirected after the completion of the payment operation",
+ "example": "https://hyperswitch.io",
+ "nullable": true
+ },
+ "setup_future_usage": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FutureUsage"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodDataRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_token": {
+ "type": "string",
+ "description": "As Hyperswitch tokenises the sensitive details about the payments method, it provides the payment_token as a reference to a stored payment method, ensuring that the sensitive details are not exposed in any manner.",
+ "example": "187282ab-40ef-47a9-9206-5099ba31e432",
+ "nullable": true
+ },
+ "card_cvc": {
+ "type": "string",
+ "description": "This is used along with the payment_token field while collecting during saved card payments. This field will be deprecated soon, use the payment_method_data.card_token object instead",
+ "deprecated": true,
+ "nullable": true
+ },
+ "shipping": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "statement_descriptor_name": {
+ "type": "string",
+ "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
+ "example": "Hyperswitch Router",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "statement_descriptor_suffix": {
+ "type": "string",
+ "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
+ "example": "Payment for shoes purchase",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "order_details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OrderDetailsWithAmount"
+ },
+ "description": "Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount",
+ "example": "[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]",
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "It's a token used for client side verification.",
+ "example": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
+ "nullable": true
+ },
+ "mandate_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MandateData"
+ }
+ ],
+ "nullable": true
+ },
+ "customer_acceptance": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerAcceptance"
+ }
+ ],
+ "nullable": true
+ },
+ "mandate_id": {
+ "type": "string",
+ "description": "A unique identifier to link the payment to a mandate. To do Recurring payments after a mandate has been created, pass the mandate_id instead of payment_method_data",
+ "example": "mandate_iwer89rnjef349dni3",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "browser_info": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BrowserInformation"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_experience": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentExperience"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "business_country": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ },
+ "business_label": {
+ "type": "string",
+ "description": "Business label of the merchant for this payment.\nTo be deprecated soon. Pass the profile_id instead",
+ "example": "food",
+ "nullable": true
+ },
+ "merchant_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
+ }
+ ],
+ "nullable": true
+ },
+ "allowed_payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "description": "Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent",
+ "nullable": true
+ },
+ "business_sub_label": {
+ "type": "string",
+ "description": "Business sub label for the payment",
+ "nullable": true
+ },
+ "retry_action": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RetryAction"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "connector_metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ConnectorMetadata"
+ }
+ ],
+ "nullable": true
+ },
+ "feature_metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FeatureMetadata"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_link": {
+ "type": "boolean",
+ "description": "Whether to generate the payment link for this payment or not (if applicable)",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "payment_link_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentCreatePaymentLinkConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_link_config_id": {
+ "type": "string",
+ "description": "Custom payment link config id set at business profile, send only if business_specific_configs is configured",
+ "nullable": true
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The business profile to be used for this payment, if not passed the default business profile associated with the merchant account will be used. It is mandatory in case multiple business profiles have been set up.",
+ "nullable": true
+ },
+ "surcharge_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RequestSurchargeDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentType"
+ }
+ ],
+ "nullable": true
+ },
+ "request_incremental_authorization": {
+ "type": "boolean",
+ "description": "Request an incremental authorization, i.e., increase the authorized amount on a confirmed payment before you capture it.",
+ "nullable": true
+ },
+ "session_expiry": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Will be used to expire client secret after certain amount of time to be supplied in seconds\n(900) for 15 mins",
+ "example": 900,
+ "nullable": true,
+ "minimum": 0
+ },
+ "frm_metadata": {
+ "type": "object",
+ "description": "Additional data related to some frm(Fraud Risk Management) connectors",
+ "nullable": true
+ },
+ "request_external_three_ds_authentication": {
+ "type": "boolean",
+ "description": "Whether to perform external authentication (if applicable)",
+ "example": true,
+ "nullable": true
+ },
+ "recurring_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RecurringDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "charges": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentChargeRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "merchant_order_reference_id": {
+ "type": "string",
+ "description": "Merchant's identifier for the payment/invoice. This will be sent to the connector\nif the connector provides support to accept multiple reference ids.\nIn case the connector supports only one reference id, Hyperswitch's Payment ID will be sent as reference.",
+ "example": "Custom_Order_id_123",
+ "nullable": true,
+ "maxLength": 255
+ }
+ },
+ "additionalProperties": false
+ },
+ "PaymentsResponse": {
+ "type": "object",
+ "required": [
+ "status",
+ "amount",
+ "net_amount",
+ "amount_capturable",
+ "amount_received",
+ "currency",
+ "payment_method",
+ "attempt_count"
+ ],
+ "properties": {
+ "payment_id": {
+ "type": "string",
+ "description": "Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant.",
+ "example": "pay_mbabizu24mvu3mela5njyhpit4",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "This is an identifier for the merchant account. This is inferred from the API key\nprovided during the request",
+ "example": "merchant_1668273825",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/IntentStatus"
+ }
+ ],
+ "default": "requires_confirmation"
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,",
+ "example": 6540
+ },
+ "net_amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment net amount. net_amount = amount + surcharge_details.surcharge_amount + surcharge_details.tax_amount,\nIf no surcharge_details, net_amount = amount",
+ "example": 6540
+ },
+ "amount_capturable": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The maximum amount that could be captured from the payment",
+ "example": 6540,
+ "minimum": 100
+ },
+ "amount_received": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The amount which is already captured from the payment, this helps in the cases where merchants can't capture all capturable amount at once.",
+ "example": 6540
+ },
+ "connector": {
+ "type": "string",
+ "description": "The connector used for the payment",
+ "example": "stripe",
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "It's a token used for client side verification.",
+ "example": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
+ "nullable": true
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time when the payment was created",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "currency": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for the customer object. If not provided the customer ID will be autogenerated.\nThis field will be deprecated soon. Please refer to `customer.id`",
+ "deprecated": true,
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "customer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerDetailsResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the payment",
+ "example": "It's my first payment request",
+ "nullable": true
+ },
+ "refunds": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RefundResponse"
+ },
+ "description": "List of refunds that happened on this intent, as same payment intent can have multiple refund requests depending on the nature of order",
+ "nullable": true
+ },
+ "disputes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DisputeResponsePaymentsRetrieve"
+ },
+ "description": "List of disputes that happened on this intent",
+ "nullable": true
+ },
+ "attempts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentAttemptResponse"
+ },
+ "description": "List of attempts that happened on this intent",
+ "nullable": true
+ },
+ "captures": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CaptureResponse"
+ },
+ "description": "List of captures done on latest attempt",
+ "nullable": true
+ },
+ "mandate_id": {
+ "type": "string",
+ "description": "A unique identifier to link the payment to a mandate, can be used instead of payment_method_data, in case of setting up recurring payments",
+ "example": "mandate_iwer89rnjef349dni3",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "mandate_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MandateData"
+ }
+ ],
+ "nullable": true
+ },
+ "setup_future_usage": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FutureUsage"
+ }
+ ],
+ "nullable": true
+ },
+ "off_session": {
+ "type": "boolean",
+ "description": "Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. This parameter can only be used with confirm=true.",
+ "example": true,
+ "nullable": true
+ },
+ "capture_on": {
+ "type": "string",
+ "format": "date-time",
+ "description": "A timestamp (ISO 8601 code) that determines when the payment should be captured.\nProviding this field will automatically set `capture` to true",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "capture_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CaptureMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method": {
+ "$ref": "#/components/schemas/PaymentMethod"
+ },
+ "payment_method_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodDataResponseWithBilling"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_token": {
+ "type": "string",
+ "description": "Provide a reference to a stored payment method",
+ "example": "187282ab-40ef-47a9-9206-5099ba31e432",
+ "nullable": true
+ },
+ "shipping": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "order_details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OrderDetailsWithAmount"
+ },
+ "description": "Information about the product , quantity and amount for connectors. (e.g. Klarna)",
+ "example": "[{\n \"product_name\": \"gillete creme\",\n \"quantity\": 15,\n \"amount\" : 900\n }]",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "description: The customer's email address\nThis field will be deprecated soon. Please refer to `customer.email` object",
+ "deprecated": true,
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "name": {
+ "type": "string",
+ "description": "description: The customer's name\nThis field will be deprecated soon. Please refer to `customer.name` object",
+ "deprecated": true,
+ "example": "John Test",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone": {
+ "type": "string",
+ "description": "The customer's phone number\nThis field will be deprecated soon. Please refer to `customer.phone` object",
+ "deprecated": true,
+ "example": "9123456789",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to redirect after the completion of the operation",
+ "example": "https://hyperswitch.io",
+ "nullable": true
+ },
+ "authentication_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AuthenticationType"
+ }
+ ],
+ "default": "three_ds",
+ "nullable": true
+ },
+ "statement_descriptor_name": {
+ "type": "string",
+ "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
+ "example": "Hyperswitch Router",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "statement_descriptor_suffix": {
+ "type": "string",
+ "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 255 characters for the concatenated descriptor.",
+ "example": "Payment for shoes purchase",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "next_action": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/NextActionData"
+ }
+ ],
+ "nullable": true
+ },
+ "cancellation_reason": {
+ "type": "string",
+ "description": "If the payment was cancelled the reason will be provided here",
+ "nullable": true
+ },
+ "error_code": {
+ "type": "string",
+ "description": "If there was an error while calling the connectors the code is received here",
+ "example": "E0001",
+ "nullable": true
+ },
+ "error_message": {
+ "type": "string",
+ "description": "If there was an error while calling the connector the error message is received here",
+ "example": "Failed while verifying the card",
+ "nullable": true
+ },
+ "unified_code": {
+ "type": "string",
+ "description": "error code unified across the connectors is received here if there was an error while calling connector",
+ "nullable": true
+ },
+ "unified_message": {
+ "type": "string",
+ "description": "error message unified across the connectors is received here if there was an error while calling connector",
+ "nullable": true
+ },
+ "payment_experience": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentExperience"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "connector_label": {
+ "type": "string",
+ "description": "The connector used for this payment along with the country and business details",
+ "example": "stripe_US_food",
+ "nullable": true
+ },
+ "business_country": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ },
+ "business_label": {
+ "type": "string",
+ "description": "The business label of merchant for this payment",
+ "nullable": true
+ },
+ "business_sub_label": {
+ "type": "string",
+ "description": "The business_sub_label for this payment",
+ "nullable": true
+ },
+ "allowed_payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "description": "Allowed Payment Method Types for a given PaymentIntent",
+ "nullable": true
+ },
+ "ephemeral_key": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/EphemeralKeyCreateResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "manual_retry_allowed": {
+ "type": "boolean",
+ "description": "If true the payment can be retried with same or different payment method which means the confirm call can be made again.",
+ "nullable": true
+ },
+ "connector_transaction_id": {
+ "type": "string",
+ "description": "A unique identifier for a payment provided by the connector",
+ "example": "993672945374576J",
+ "nullable": true
+ },
+ "frm_message": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FrmMessage"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "connector_metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ConnectorMetadata"
+ }
+ ],
+ "nullable": true
+ },
+ "feature_metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FeatureMetadata"
+ }
+ ],
+ "nullable": true
+ },
+ "reference_id": {
+ "type": "string",
+ "description": "reference(Identifier) to the payment at connector side",
+ "example": "993672945374576J",
+ "nullable": true
+ },
+ "payment_link": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentLinkResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The business profile that is associated with this payment",
+ "nullable": true
+ },
+ "surcharge_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RequestSurchargeDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "attempt_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total number of attempts associated with this payment"
+ },
+ "merchant_decision": {
+ "type": "string",
+ "description": "Denotes the action(approve or reject) taken by merchant in case of manual review. Manual review can occur when the transaction is marked as risky by the frm_processor, payment processor or when there is underpayment/over payment incase of crypto payment",
+ "nullable": true
+ },
+ "merchant_connector_id": {
+ "type": "string",
+ "description": "Identifier of the connector ( merchant connector account ) which was chosen to make the payment",
+ "nullable": true
+ },
+ "incremental_authorization_allowed": {
+ "type": "boolean",
+ "description": "If true, incremental authorization can be performed on this payment, in case the funds authorized initially fall short.",
+ "nullable": true
+ },
+ "authorization_count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total number of authorizations happened in an incremental_authorization payment",
+ "nullable": true
+ },
+ "incremental_authorizations": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IncrementalAuthorizationResponse"
+ },
+ "description": "List of incremental authorizations happened to the payment",
+ "nullable": true
+ },
+ "external_authentication_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ExternalAuthenticationDetailsResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "external_3ds_authentication_attempted": {
+ "type": "boolean",
+ "description": "Flag indicating if external 3ds authentication is made or not",
+ "nullable": true
+ },
+ "expires_on": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date Time for expiry of the payment",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "fingerprint": {
+ "type": "string",
+ "description": "Payment Fingerprint, to identify a particular card.\nIt is a 20 character long alphanumeric code.",
+ "nullable": true
+ },
+ "browser_info": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BrowserInformation"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_id": {
+ "type": "string",
+ "description": "Identifier for Payment Method used for the payment",
+ "nullable": true
+ },
+ "payment_method_status": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodStatus"
+ }
+ ],
+ "nullable": true
+ },
+ "updated": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date time at which payment was updated",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "charges": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentChargeResponse"
+ }
+ ],
+ "nullable": true
+ },
+ "frm_metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. FRM Metadata is useful for storing additional, structured information on an object related to FRM.",
+ "nullable": true
+ },
+ "merchant_order_reference_id": {
+ "type": "string",
+ "description": "Merchant's identifier for the payment/invoice. This will be sent to the connector\nif the connector provides support to accept multiple reference ids.\nIn case the connector supports only one reference id, Hyperswitch's Payment ID will be sent as reference.",
+ "example": "Custom_Order_id_123",
+ "nullable": true,
+ "maxLength": 255
+ }
+ }
+ },
+ "PaymentsRetrieveRequest": {
+ "type": "object",
+ "required": [
+ "resource_id",
+ "force_sync"
+ ],
+ "properties": {
+ "resource_id": {
+ "$ref": "#/components/schemas/PaymentIdType"
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account.",
+ "nullable": true
+ },
+ "force_sync": {
+ "type": "boolean",
+ "description": "Decider to enable or disable the connector call for retrieve request"
+ },
+ "param": {
+ "type": "string",
+ "description": "The parameters passed to a retrieve request",
+ "nullable": true
+ },
+ "connector": {
+ "type": "string",
+ "description": "The name of the connector",
+ "nullable": true
+ },
+ "merchant_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
+ }
+ ],
+ "nullable": true
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK",
+ "nullable": true
+ },
+ "expand_captures": {
+ "type": "boolean",
+ "description": "If enabled provides list of captures linked to latest attempt",
+ "nullable": true
+ },
+ "expand_attempts": {
+ "type": "boolean",
+ "description": "If enabled provides list of attempts linked to payment intent",
+ "nullable": true
+ }
+ }
+ },
+ "PaymentsSessionRequest": {
+ "type": "object",
+ "required": [
+ "payment_id",
+ "client_secret",
+ "wallets"
+ ],
+ "properties": {
+ "payment_id": {
+ "type": "string",
+ "description": "The identifier for the payment"
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK"
+ },
+ "wallets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "description": "The list of the supported wallets"
+ },
+ "merchant_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "PaymentsSessionResponse": {
+ "type": "object",
+ "required": [
+ "payment_id",
+ "client_secret",
+ "session_token"
+ ],
+ "properties": {
+ "payment_id": {
+ "type": "string",
+ "description": "The identifier for the payment"
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK"
+ },
+ "session_token": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SessionToken"
+ },
+ "description": "The list of session token object"
+ }
+ }
+ },
+ "PaymentsStartRequest": {
+ "type": "object",
+ "required": [
+ "payment_id",
+ "merchant_id",
+ "attempt_id"
+ ],
+ "properties": {
+ "payment_id": {
+ "type": "string",
+ "description": "Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant. This field is auto generated and is returned in the API response."
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account."
+ },
+ "attempt_id": {
+ "type": "string",
+ "description": "The identifier for the payment transaction"
+ }
+ }
+ },
+ "PaymentsUpdateRequest": {
+ "type": "object",
+ "properties": {
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and ¥100 since ¥ is a zero-decimal currency",
+ "example": 6540,
+ "nullable": true,
+ "minimum": 0
+ },
+ "currency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Currency"
+ }
+ ],
+ "nullable": true
+ },
+ "amount_to_capture": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The Amount to be captured / debited from the users payment method. It shall be in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, the default amount_to_capture will be the payment amount. Also, it must be less than or equal to the original payment account.",
+ "example": 6540,
+ "nullable": true
+ },
+ "payment_id": {
+ "type": "string",
+ "description": "Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant. The value for this field can be specified in the request, it will be auto generated otherwise and returned in the API response.",
+ "example": "pay_mbabizu24mvu3mela5njyhpit4",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/StraightThroughAlgorithm"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "description": "This allows to manually select a connector with which the payment can go through.",
+ "example": [
+ "stripe",
+ "adyen"
+ ],
+ "nullable": true
+ },
+ "capture_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CaptureMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "authentication_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AuthenticationType"
+ }
+ ],
+ "default": "three_ds",
+ "nullable": true
+ },
+ "billing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "confirm": {
+ "type": "boolean",
+ "description": "Whether to confirm the payment (if applicable). It can be used to completely process a payment by attaching a payment method, setting `confirm=true` and `capture_method = automatic` in the *Payments/Create API* request itself.",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "customer": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for the customer",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 64,
+ "minLength": 1
+ },
+ "off_session": {
+ "type": "boolean",
+ "description": "Set to true to indicate that the customer is not in your checkout flow during this payment, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later. When making a recurring payment by passing a mandate_id, this parameter is mandatory",
+ "example": true,
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "A description for the payment",
+ "example": "It's my first payment request",
+ "nullable": true
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to which you want the user to be redirected after the completion of the payment operation",
+ "example": "https://hyperswitch.io",
+ "nullable": true
+ },
+ "setup_future_usage": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/FutureUsage"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodDataRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethod"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_token": {
+ "type": "string",
+ "description": "As Hyperswitch tokenises the sensitive details about the payments method, it provides the payment_token as a reference to a stored payment method, ensuring that the sensitive details are not exposed in any manner.",
+ "example": "187282ab-40ef-47a9-9206-5099ba31e432",
+ "nullable": true
+ },
+ "shipping": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Address"
+ }
+ ],
+ "nullable": true
+ },
+ "statement_descriptor_name": {
+ "type": "string",
+ "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
+ "example": "Hyperswitch Router",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "statement_descriptor_suffix": {
+ "type": "string",
+ "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
+ "example": "Payment for shoes purchase",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "order_details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/OrderDetailsWithAmount"
+ },
+ "description": "Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount",
+ "example": "[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]",
+ "nullable": true
+ },
+ "mandate_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MandateData"
+ }
+ ],
+ "nullable": true
+ },
+ "customer_acceptance": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CustomerAcceptance"
+ }
+ ],
+ "nullable": true
+ },
+ "browser_info": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/BrowserInformation"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_experience": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentExperience"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "merchant_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
+ }
+ ],
+ "nullable": true
+ },
+ "allowed_payment_method_types": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "description": "Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent",
+ "nullable": true
+ },
+ "retry_action": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RetryAction"
+ }
+ ],
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "connector_metadata": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ConnectorMetadata"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_link": {
+ "type": "boolean",
+ "description": "Whether to generate the payment link for this payment or not (if applicable)",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "payment_link_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentCreatePaymentLinkConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_link_config_id": {
+ "type": "string",
+ "description": "Custom payment link config id set at business profile, send only if business_specific_configs is configured",
+ "nullable": true
+ },
+ "surcharge_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RequestSurchargeDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "payment_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentType"
+ }
+ ],
+ "nullable": true
+ },
+ "request_incremental_authorization": {
+ "type": "boolean",
+ "description": "Request an incremental authorization, i.e., increase the authorized amount on a confirmed payment before you capture it.",
+ "nullable": true
+ },
+ "session_expiry": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Will be used to expire client secret after certain amount of time to be supplied in seconds\n(900) for 15 mins",
+ "example": 900,
+ "nullable": true,
+ "minimum": 0
+ },
+ "frm_metadata": {
+ "type": "object",
+ "description": "Additional data related to some frm(Fraud Risk Management) connectors",
+ "nullable": true
+ },
+ "request_external_three_ds_authentication": {
+ "type": "boolean",
+ "description": "Whether to perform external authentication (if applicable)",
+ "example": true,
+ "nullable": true
+ },
+ "recurring_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RecurringDetails"
+ }
+ ],
+ "nullable": true
+ },
+ "charges": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentChargeRequest"
+ }
+ ],
+ "nullable": true
+ },
+ "merchant_order_reference_id": {
+ "type": "string",
+ "description": "Merchant's identifier for the payment/invoice. This will be sent to the connector\nif the connector provides support to accept multiple reference ids.\nIn case the connector supports only one reference id, Hyperswitch's Payment ID will be sent as reference.",
+ "example": "Custom_Order_id_123",
+ "nullable": true,
+ "maxLength": 255
+ }
+ }
+ },
+ "PayoutActionRequest": {
+ "type": "object",
+ "required": [
+ "payout_id"
+ ],
+ "properties": {
+ "payout_id": {
+ "type": "string",
+ "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.",
+ "example": "payout_mbabizu24mvu3mela5njyhpit4",
+ "maxLength": 30,
+ "minLength": 30
+ }
+ }
+ },
+ "PayoutAttemptResponse": {
+ "type": "object",
+ "required": [
+ "attempt_id",
+ "status",
+ "amount"
+ ],
+ "properties": {
+ "attempt_id": {
+ "type": "string",
+ "description": "Unique identifier for the attempt"
+ },
+ "status": {
+ "$ref": "#/components/schemas/PayoutStatus"
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payout attempt amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,",
+ "example": 6583
+ },
+ "currency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Currency"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "string",
+ "description": "The connector used for the payout",
+ "nullable": true
+ },
+ "error_code": {
+ "type": "string",
+ "description": "Connector's error code in case of failures",
+ "nullable": true
+ },
+ "error_message": {
+ "type": "string",
+ "description": "Connector's error message in case of failures",
+ "nullable": true
+ },
+ "payment_method": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PayoutType"
+ }
+ ],
+ "nullable": true
+ },
+ "payout_method_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ }
+ ],
+ "nullable": true
+ },
+ "connector_transaction_id": {
+ "type": "string",
+ "description": "A unique identifier for a payout provided by the connector",
+ "nullable": true
+ },
+ "cancellation_reason": {
+ "type": "string",
+ "description": "If the payout was cancelled the reason provided here",
+ "nullable": true
+ },
+ "unified_code": {
+ "type": "string",
+ "description": "error code unified across the connectors is received here if there was an error while calling connector",
+ "nullable": true
+ },
+ "unified_message": {
+ "type": "string",
+ "description": "error message unified across the connectors is received here if there was an error while calling connector",
+ "nullable": true
+ }
+ }
+ },
+ "PayoutConnectors": {
+ "type": "string",
+ "enum": [
+ "adyen",
+ "adyenplatform",
+ "cybersource",
+ "ebanx",
+ "payone",
+ "paypal",
+ "stripe",
+ "wise"
+ ]
+ },
+ "PayoutCreatePayoutLinkConfig": {
+ "allOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GenericLinkUiConfig"
+ }
+ ],
+ "nullable": true
+ },
+ {
+ "type": "object",
+ "properties": {
+ "payout_link_id": {
+ "type": "string",
+ "description": "The unique identifier for the collect link.",
+ "example": "pm_collect_link_2bdacf398vwzq5n422S1",
+ "nullable": true
+ },
+ "enabled_payment_methods": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EnabledPaymentMethod"
+ },
+ "description": "List of payout methods shown on collect UI",
+ "example": "[{\"payment_method\": \"bank_transfer\", \"payment_method_types\": [\"ach\", \"bacs\"]}]",
+ "nullable": true
+ }
+ }
+ }
+ ],
+ "description": "Custom payout link config for the particular payout, if payout link is to be generated."
+ },
+ "PayoutCreateRequest": {
+ "type": "object",
+ "required": [
+ "currency",
+ "confirm",
+ "payout_type",
+ "auto_fulfill",
+ "client_secret",
+ "return_url",
+ "business_country",
+ "description",
+ "entity_type",
+ "priority"
+ ],
+ "properties": {
+ "payout_id": {
+ "type": "string",
+ "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts that have been done by a single merchant. This field is auto generated and is returned in the API response, **not required to be included in the Payout Create/Update Request.**",
+ "example": "payout_mbabizu24mvu3mela5njyhpit4",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "This is an identifier for the merchant account. This is inferred from the API key provided during the request, **not required to be included in the Payout Create/Update Request.**",
+ "example": "merchant_1668273825",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,",
+ "example": 1000
+ },
+ "currency": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "routing": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RoutingAlgorithm"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PayoutConnectors"
+ },
+ "description": "This field allows the merchant to manually select a connector with which the payout can go through.",
+ "example": [
+ "wise",
+ "adyen"
+ ],
+ "nullable": true
+ },
+ "confirm": {
+ "type": "boolean",
+ "description": "This field is used when merchant wants to confirm the payout, thus useful for the payout _Confirm_ request. Ideally merchants should _Create_ a payout, _Update_ it (if required), then _Confirm_ it.",
+ "default": false,
+ "example": true
+ },
+ "payout_type": {
+ "$ref": "#/components/schemas/PayoutType"
+ },
+ "payout_method_data": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PayoutMethodData"
+ }
+ ],
+ "nullable": true
+ },
+ "billing": {
+ "type": "object",
+ "description": "The billing address for the payout",
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for the customer object. If not provided the customer ID will be autogenerated.",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "auto_fulfill": {
+ "type": "boolean",
+ "description": "Set to true to confirm the payout without review, no further action required",
+ "default": false,
+ "example": true
+ },
+ "email": {
+ "type": "string",
+ "description": "description: The customer's email address",
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "name": {
+ "type": "string",
+ "description": "description: The customer's name",
+ "example": "John Test",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone": {
+ "type": "string",
+ "description": "The customer's phone number",
+ "example": "9123456789",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone_country_code": {
+ "type": "string",
+ "description": "The country code for the customer phone number",
+ "example": "+1",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "It's a token used for client side verification.",
+ "example": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo"
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to redirect after the completion of the operation",
+ "example": "https://hyperswitch.io"
+ },
+ "business_country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ },
+ "business_label": {
+ "type": "string",
+ "description": "Business label of the merchant for this payout",
+ "example": "food",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the payout",
+ "example": "It's my first payout request"
+ },
+ "entity_type": {
+ "$ref": "#/components/schemas/PayoutEntityType"
+ },
+ "recurring": {
+ "type": "boolean",
+ "description": "Specifies whether or not the payout request is recurring",
+ "default": false,
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "payout_token": {
+ "type": "string",
+ "description": "Provide a reference to a stored payout method, used to process the payout.",
+ "example": "187282ab-40ef-47a9-9206-5099ba31e432",
+ "nullable": true
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The business profile to use for this payout, especially if there are multiple business profiles associated with the account, otherwise default business profile associated with the merchant account will be used.",
+ "nullable": true
+ },
+ "priority": {
+ "$ref": "#/components/schemas/PayoutSendPriority"
+ },
+ "payout_link": {
+ "type": "boolean",
+ "description": "Whether to get the payout link (if applicable). Merchant need to specify this during the Payout _Create_, this field can not be updated during Payout _Update_.",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "payout_link_config": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PayoutCreatePayoutLinkConfig"
+ }
+ ],
+ "nullable": true
+ },
+ "session_expiry": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Will be used to expire client secret after certain amount of time to be supplied in seconds\n(900) for 15 mins",
+ "example": 900,
+ "nullable": true,
+ "minimum": 0
+ }
+ },
+ "additionalProperties": false
+ },
+ "PayoutCreateResponse": {
+ "type": "object",
+ "required": [
+ "payout_id",
+ "merchant_id",
+ "amount",
+ "currency",
+ "customer_id",
+ "auto_fulfill",
+ "client_secret",
+ "return_url",
+ "business_country",
+ "description",
+ "entity_type",
+ "status",
+ "error_message",
+ "error_code",
+ "profile_id"
+ ],
+ "properties": {
+ "payout_id": {
+ "type": "string",
+ "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.",
+ "example": "payout_mbabizu24mvu3mela5njyhpit4",
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "This is an identifier for the merchant account. This is inferred from the API key\nprovided during the request",
+ "example": "merchant_1668273825",
+ "maxLength": 255
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,",
+ "example": 1000
+ },
+ "currency": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "connector": {
+ "type": "string",
+ "description": "The connector used for the payout",
+ "example": "wise",
+ "nullable": true
+ },
+ "payout_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PayoutType"
+ }
+ ],
+ "nullable": true
+ },
+ "billing": {
+ "type": "object",
+ "description": "The billing address for the payout",
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for the customer object. If not provided the customer ID will be autogenerated.",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 255
+ },
+ "auto_fulfill": {
+ "type": "boolean",
+ "description": "Set to true to confirm the payout without review, no further action required",
+ "default": false,
+ "example": true
+ },
+ "email": {
+ "type": "string",
+ "description": "description: The customer's email address",
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "name": {
+ "type": "string",
+ "description": "description: The customer's name",
+ "example": "John Test",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone": {
+ "type": "string",
+ "description": "The customer's phone number",
+ "example": "9123456789",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "phone_country_code": {
+ "type": "string",
+ "description": "The country code for the customer phone number",
+ "example": "+1",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "It's a token used for client side verification.",
+ "example": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo"
+ },
+ "return_url": {
+ "type": "string",
+ "description": "The URL to redirect after the completion of the operation",
+ "example": "https://hyperswitch.io"
+ },
+ "business_country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ },
+ "business_label": {
+ "type": "string",
+ "description": "Business label of the merchant for this payout",
+ "example": "food",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the payout",
+ "example": "It's my first payout request"
+ },
+ "entity_type": {
+ "$ref": "#/components/schemas/PayoutEntityType"
+ },
+ "recurring": {
+ "type": "boolean",
+ "description": "Specifies whether or not the payout request is recurring",
+ "default": false,
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/PayoutStatus"
+ },
+ "error_message": {
+ "type": "string",
+ "description": "If there was an error while calling the connector the error message is received here",
+ "example": "Failed while verifying the card"
+ },
+ "error_code": {
+ "type": "string",
+ "description": "If there was an error while calling the connectors the code is received here",
+ "example": "E0001"
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The business profile that is associated with this payout"
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time when the payout was created",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ },
+ "connector_transaction_id": {
+ "type": "string",
+ "description": "Underlying processor's payout resource ID",
+ "example": "S3FC9G9M2MVFDXT5",
+ "nullable": true
+ },
+ "priority": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PayoutSendPriority"
+ }
+ ],
+ "nullable": true
+ },
+ "attempts": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PayoutAttemptResponse"
+ },
+ "description": "List of attempts",
+ "nullable": true
+ },
+ "payout_link": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PayoutLinkResponse"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "PayoutEntityType": {
+ "type": "string",
+ "description": "Type of entity to whom the payout is being carried out to, select from the given list of options",
+ "enum": [
+ "Individual",
+ "Company",
+ "NonProfit",
+ "PublicSector",
+ "NaturalPerson",
+ "lowercase",
+ "Personal"
+ ]
+ },
+ "PayoutLinkInitiateRequest": {
+ "type": "object",
+ "required": [
+ "merchant_id",
+ "payout_id"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string"
+ },
+ "payout_id": {
+ "type": "string"
+ }
+ }
+ },
+ "PayoutLinkResponse": {
+ "type": "object",
+ "required": [
+ "payout_link_id",
+ "link"
+ ],
+ "properties": {
+ "payout_link_id": {
+ "type": "string"
+ },
+ "link": {
+ "type": "string"
+ }
+ }
+ },
+ "PayoutListConstraints": {
+ "allOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/TimeRange"
+ }
+ ],
+ "nullable": true
+ },
+ {
+ "type": "object",
+ "properties": {
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for customer",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true
+ },
+ "starting_after": {
+ "type": "string",
+ "description": "A cursor for use in pagination, fetch the next list after some object",
+ "example": "pay_fafa124123",
+ "nullable": true
+ },
+ "ending_before": {
+ "type": "string",
+ "description": "A cursor for use in pagination, fetch the previous list before some object",
+ "example": "pay_fafa124123",
+ "nullable": true
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int32",
+ "description": "limit on the number of objects to return",
+ "default": 10,
+ "maximum": 100,
+ "minimum": 0
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time at which payout is created",
+ "example": "2022-09-10T10:11:12Z",
+ "nullable": true
+ }
+ }
+ }
+ ]
+ },
+ "PayoutListFilterConstraints": {
+ "allOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/TimeRange"
+ }
+ ],
+ "nullable": true
+ },
+ {
+ "type": "object",
+ "required": [
+ "currency",
+ "entity_type"
+ ],
+ "properties": {
+ "payout_id": {
+ "type": "string",
+ "description": "The identifier for payout",
+ "example": "payout_mbabizu24mvu3mela5njyhpit4",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The identifier for business profile",
+ "nullable": true
+ },
+ "customer_id": {
+ "type": "string",
+ "description": "The identifier for customer",
+ "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The limit on the number of objects. The default limit is 10 and max limit is 20",
+ "minimum": 0
+ },
+ "offset": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The starting point within a list of objects",
+ "nullable": true,
+ "minimum": 0
+ },
+ "connector": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PayoutConnectors"
+ },
+ "description": "The list of connectors to filter payouts list",
+ "example": [
+ "wise",
+ "adyen"
+ ],
+ "nullable": true
+ },
+ "currency": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "status": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PayoutStatus"
+ },
+ "description": "The list of payout status to filter payouts list",
+ "example": [
+ "pending",
+ "failed"
+ ],
+ "nullable": true
+ },
+ "payout_method": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PayoutType"
+ },
+ "description": "The list of payout methods to filter payouts list",
+ "example": [
+ "bank",
+ "card"
+ ],
+ "nullable": true
+ },
+ "entity_type": {
+ "$ref": "#/components/schemas/PayoutEntityType"
+ }
+ }
+ }
+ ]
+ },
+ "PayoutListResponse": {
+ "type": "object",
+ "required": [
+ "size",
+ "data"
+ ],
+ "properties": {
+ "size": {
+ "type": "integer",
+ "description": "The number of payouts included in the list",
+ "minimum": 0
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PayoutCreateResponse"
+ }
+ }
+ }
+ },
+ "PayoutMethodData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "card"
+ ],
+ "properties": {
+ "card": {
+ "$ref": "#/components/schemas/CardPayout"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "bank"
+ ],
+ "properties": {
+ "bank": {
+ "$ref": "#/components/schemas/Bank"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "wallet"
+ ],
+ "properties": {
+ "wallet": {
+ "$ref": "#/components/schemas/Wallet"
+ }
+ }
+ }
+ ],
+ "description": "The payout method information required for carrying out a payout"
+ },
+ "PayoutRequest": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "PayoutActionRequest"
+ ],
+ "properties": {
+ "PayoutActionRequest": {
+ "$ref": "#/components/schemas/PayoutActionRequest"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "PayoutCreateRequest"
+ ],
+ "properties": {
+ "PayoutCreateRequest": {
+ "$ref": "#/components/schemas/PayoutCreateRequest"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "PayoutRetrieveRequest"
+ ],
+ "properties": {
+ "PayoutRetrieveRequest": {
+ "$ref": "#/components/schemas/PayoutRetrieveRequest"
+ }
+ }
+ }
+ ]
+ },
+ "PayoutRetrieveBody": {
+ "type": "object",
+ "properties": {
+ "force_sync": {
+ "type": "boolean",
+ "nullable": true
+ },
+ "merchant_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "PayoutRetrieveRequest": {
+ "type": "object",
+ "required": [
+ "payout_id"
+ ],
+ "properties": {
+ "payout_id": {
+ "type": "string",
+ "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.",
+ "example": "payout_mbabizu24mvu3mela5njyhpit4",
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "force_sync": {
+ "type": "boolean",
+ "description": "`force_sync` with the connector to get payout details\n(defaults to false)",
+ "default": false,
+ "example": true,
+ "nullable": true
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account.",
+ "nullable": true
+ }
+ }
+ },
+ "PayoutSendPriority": {
+ "type": "string",
+ "description": "The send method which will be required for processing payouts, check options for better understanding.",
+ "enum": [
+ "instant",
+ "fast",
+ "regular",
+ "wire",
+ "cross_border",
+ "internal"
+ ]
+ },
+ "PayoutStatus": {
+ "type": "string",
+ "enum": [
+ "success",
+ "failed",
+ "cancelled",
+ "initiated",
+ "expired",
+ "reversed",
+ "pending",
+ "ineligible",
+ "requires_creation",
+ "requires_confirmation",
+ "requires_payout_method_data",
+ "requires_fulfillment",
+ "requires_vendor_account_creation"
+ ]
+ },
+ "PayoutType": {
+ "type": "string",
+ "description": "The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.",
+ "enum": [
+ "card",
+ "bank",
+ "wallet"
+ ]
+ },
+ "Paypal": {
+ "type": "object",
+ "required": [
+ "email",
+ "telephone_number",
+ "paypal_id"
+ ],
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "Email linked with paypal account",
+ "example": "[email protected]"
+ },
+ "telephone_number": {
+ "type": "string",
+ "description": "mobile number linked to paypal account",
+ "example": "16608213349"
+ },
+ "paypal_id": {
+ "type": "string",
+ "description": "id of the paypal account",
+ "example": "G83KXTJ5EHCQ2"
+ }
+ }
+ },
+ "PaypalRedirection": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "paypal's email address",
+ "example": "[email protected]",
+ "nullable": true,
+ "maxLength": 255
+ }
+ }
+ },
+ "PaypalSessionTokenResponse": {
+ "type": "object",
+ "required": [
+ "connector",
+ "session_token",
+ "sdk_next_action"
+ ],
+ "properties": {
+ "connector": {
+ "type": "string",
+ "description": "Name of the connector"
+ },
+ "session_token": {
+ "type": "string",
+ "description": "The session token for PayPal"
+ },
+ "sdk_next_action": {
+ "$ref": "#/components/schemas/SdkNextAction"
+ }
+ }
+ },
+ "PhoneDetails": {
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "string",
+ "description": "The contact number",
+ "example": "9123456789",
+ "nullable": true
+ },
+ "country_code": {
+ "type": "string",
+ "description": "The country code attached to the number",
+ "example": "+1",
+ "nullable": true
+ }
+ }
+ },
+ "PixBankTransfer": {
+ "type": "object",
+ "required": [
+ "bank_account_number",
+ "pix_key"
+ ],
+ "properties": {
+ "bank_name": {
+ "type": "string",
+ "description": "Bank name",
+ "example": "Deutsche Bank",
+ "nullable": true
+ },
+ "bank_branch": {
+ "type": "string",
+ "description": "Bank branch",
+ "example": "3707",
+ "nullable": true
+ },
+ "bank_account_number": {
+ "type": "string",
+ "description": "Bank account number is an unique identifier assigned by a bank to a customer.",
+ "example": "000123456"
+ },
+ "pix_key": {
+ "type": "string",
+ "description": "Unique key for pix customer",
+ "example": "000123456"
+ },
+ "tax_id": {
+ "type": "string",
+ "description": "Individual taxpayer identification number",
+ "example": "000123456",
+ "nullable": true
+ }
+ }
+ },
+ "PollConfigResponse": {
+ "type": "object",
+ "required": [
+ "poll_id",
+ "delay_in_secs",
+ "frequency"
+ ],
+ "properties": {
+ "poll_id": {
+ "type": "string",
+ "description": "Poll Id"
+ },
+ "delay_in_secs": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Interval of the poll"
+ },
+ "frequency": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Frequency of the poll"
+ }
+ }
+ },
+ "PollResponse": {
+ "type": "object",
+ "required": [
+ "poll_id",
+ "status"
+ ],
+ "properties": {
+ "poll_id": {
+ "type": "string",
+ "description": "The poll id"
+ },
+ "status": {
+ "$ref": "#/components/schemas/PollStatus"
+ }
+ }
+ },
+ "PollStatus": {
+ "type": "string",
+ "enum": [
+ "pending",
+ "completed",
+ "not_found"
+ ]
+ },
+ "PrimaryBusinessDetails": {
+ "type": "object",
+ "required": [
+ "country",
+ "business"
+ ],
+ "properties": {
+ "country": {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ },
+ "business": {
+ "type": "string",
+ "example": "food"
+ }
+ },
+ "additionalProperties": false
+ },
+ "ProcessorPaymentToken": {
+ "type": "object",
+ "description": "Processor payment token for MIT payments where payment_method_data is not available",
+ "required": [
+ "processor_payment_token",
+ "connector",
+ "merchant_connector_id"
+ ],
+ "properties": {
+ "processor_payment_token": {
+ "type": "string"
+ },
+ "connector": {
+ "$ref": "#/components/schemas/Connector"
+ },
+ "merchant_connector_id": {
+ "type": "string"
+ }
+ }
+ },
+ "ProductType": {
+ "type": "string",
+ "enum": [
+ "physical",
+ "digital",
+ "travel",
+ "ride",
+ "event",
+ "accommodation"
+ ]
+ },
+ "ProfileDefaultRoutingConfig": {
+ "type": "object",
+ "required": [
+ "profile_id",
+ "connectors"
+ ],
+ "properties": {
+ "profile_id": {
+ "type": "string"
+ },
+ "connectors": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RoutableConnectorChoice"
+ }
+ }
+ }
+ },
+ "ProgramConnectorSelection": {
+ "type": "object",
+ "description": "The program, having a default connector selection and\na bunch of rules. Also can hold arbitrary metadata.",
+ "required": [
+ "defaultSelection",
+ "rules",
+ "metadata"
+ ],
+ "properties": {
+ "defaultSelection": {
+ "$ref": "#/components/schemas/ConnectorSelection"
+ },
+ "rules": {
+ "$ref": "#/components/schemas/RuleConnectorSelection"
+ },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {}
+ }
+ }
+ },
+ "RealTimePaymentData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "fps"
+ ],
+ "properties": {
+ "fps": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "duit_now"
+ ],
+ "properties": {
+ "duit_now": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "prompt_pay"
+ ],
+ "properties": {
+ "prompt_pay": {
+ "type": "object"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "viet_qr"
+ ],
+ "properties": {
+ "viet_qr": {
+ "type": "object"
+ }
+ }
+ }
+ ]
+ },
+ "ReceiverDetails": {
+ "type": "object",
+ "required": [
+ "amount_received"
+ ],
+ "properties": {
+ "amount_received": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The amount received by receiver"
+ },
+ "amount_charged": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The amount charged by ACH",
+ "nullable": true
+ },
+ "amount_remaining": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The amount remaining to be sent via ACH",
+ "nullable": true
+ }
+ }
+ },
+ "ReconStatus": {
+ "type": "string",
+ "enum": [
+ "not_requested",
+ "requested",
+ "active",
+ "disabled"
+ ]
+ },
+ "RecurringDetails": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "mandate_id"
+ ]
+ },
+ "data": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "payment_method_id"
+ ]
+ },
+ "data": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "processor_payment_token"
+ ]
+ },
+ "data": {
+ "$ref": "#/components/schemas/ProcessorPaymentToken"
+ }
+ }
+ }
+ ],
+ "description": "Details required for recurring payment",
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "RedirectResponse": {
+ "type": "object",
+ "properties": {
+ "param": {
+ "type": "string",
+ "nullable": true
+ },
+ "json_payload": {
+ "type": "object",
+ "nullable": true
+ }
+ }
+ },
+ "RefundListRequest": {
+ "allOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/TimeRange"
+ }
+ ],
+ "nullable": true
+ },
+ {
+ "type": "object",
+ "properties": {
+ "payment_id": {
+ "type": "string",
+ "description": "The identifier for the payment",
+ "nullable": true
+ },
+ "refund_id": {
+ "type": "string",
+ "description": "The identifier for the refund",
+ "nullable": true
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The identifier for business profile",
+ "nullable": true
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Limit on the number of objects to return",
+ "nullable": true
+ },
+ "offset": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The starting point within a list of objects",
+ "nullable": true
+ },
+ "amount_filter": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AmountFilter"
+ }
+ ],
+ "nullable": true
+ },
+ "connector": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of connectors to filter refunds list",
+ "nullable": true
+ },
+ "merchant_connector_id": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of merchant connector ids to filter the refunds list for selected label",
+ "nullable": true
+ },
+ "currency": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Currency"
+ },
+ "description": "The list of currencies to filter refunds list",
+ "nullable": true
+ },
+ "refund_status": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RefundStatus"
+ },
+ "description": "The list of refund statuses to filter refunds list",
+ "nullable": true
+ }
+ }
+ }
+ ]
+ },
+ "RefundListResponse": {
+ "type": "object",
+ "required": [
+ "count",
+ "total_count",
+ "data"
+ ],
+ "properties": {
+ "count": {
+ "type": "integer",
+ "description": "The number of refunds included in the list",
+ "minimum": 0
+ },
+ "total_count": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The total number of refunds in the list"
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RefundResponse"
+ },
+ "description": "The List of refund response object"
+ }
+ }
+ },
+ "RefundRequest": {
+ "type": "object",
+ "required": [
+ "payment_id"
+ ],
+ "properties": {
+ "payment_id": {
+ "type": "string",
+ "description": "The payment id against which refund is to be initiated",
+ "example": "pay_mbabizu24mvu3mela5njyhpit4",
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "refund_id": {
+ "type": "string",
+ "description": "Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refunds initiated against the same payment. If this is not passed by the merchant, this field shall be auto generated and provided in the API response. It is recommended to generate uuid(v4) as the refund_id.",
+ "example": "ref_mbabizu24mvu3mela5njyhpit4",
+ "nullable": true,
+ "maxLength": 30,
+ "minLength": 30
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "Total amount for which the refund is to be initiated. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, this will default to the full payment amount",
+ "example": 6540,
+ "nullable": true,
+ "minimum": 100
+ },
+ "reason": {
+ "type": "string",
+ "description": "Reason for the refund. Often useful for displaying to users and your customer support executive. In case the payment went through Stripe, this field needs to be passed with one of these enums: `duplicate`, `fraudulent`, or `requested_by_customer`",
+ "example": "Customer returned the product",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "refund_type": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/RefundType"
+ }
+ ],
+ "default": "Instant",
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ },
+ "merchant_connector_details": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantConnectorDetailsWrap"
+ }
+ ],
+ "nullable": true
+ },
+ "charges": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChargeRefunds"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "RefundResponse": {
+ "type": "object",
+ "required": [
+ "refund_id",
+ "payment_id",
+ "amount",
+ "currency",
+ "status",
+ "connector"
+ ],
+ "properties": {
+ "refund_id": {
+ "type": "string",
+ "description": "Unique Identifier for the refund"
+ },
+ "payment_id": {
+ "type": "string",
+ "description": "The payment id against which refund is initiated"
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The refund amount, which should be less than or equal to the total payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc",
+ "example": 6540,
+ "minimum": 100
+ },
+ "currency": {
+ "type": "string",
+ "description": "The three-letter ISO currency code"
+ },
+ "status": {
+ "$ref": "#/components/schemas/RefundStatus"
+ },
+ "reason": {
+ "type": "string",
+ "description": "An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive",
+ "nullable": true
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object",
+ "nullable": true
+ },
+ "error_message": {
+ "type": "string",
+ "description": "The error message",
+ "nullable": true
+ },
+ "error_code": {
+ "type": "string",
+ "description": "The code for the error",
+ "nullable": true
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The timestamp at which refund is created",
+ "nullable": true
+ },
+ "updated_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The timestamp at which refund is updated",
+ "nullable": true
+ },
+ "connector": {
+ "type": "string",
+ "description": "The connector used for the refund and the corresponding payment",
+ "example": "stripe"
+ },
+ "profile_id": {
+ "type": "string",
+ "description": "The id of business profile for this refund",
+ "nullable": true
+ },
+ "merchant_connector_id": {
+ "type": "string",
+ "description": "The merchant_connector_id of the processor through which this payment went through",
+ "nullable": true
+ },
+ "charges": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ChargeRefunds"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "RefundStatus": {
+ "type": "string",
+ "description": "The status for refunds",
+ "enum": [
+ "succeeded",
+ "failed",
+ "pending",
+ "review"
+ ]
+ },
+ "RefundType": {
+ "type": "string",
+ "description": "To indicate whether to refund needs to be instant or scheduled",
+ "enum": [
+ "scheduled",
+ "instant"
+ ]
+ },
+ "RefundUpdateRequest": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive",
+ "example": "Customer returned the product",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "metadata": {
+ "type": "object",
+ "description": "You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.",
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "RequestPaymentMethodTypes": {
+ "type": "object",
+ "required": [
+ "payment_method_type",
+ "recurring_enabled",
+ "installment_payment_enabled"
+ ],
+ "properties": {
+ "payment_method_type": {
+ "$ref": "#/components/schemas/PaymentMethodType"
+ },
+ "payment_experience": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentExperience"
+ }
+ ],
+ "nullable": true
+ },
+ "card_networks": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CardNetwork"
+ },
+ "nullable": true
+ },
+ "accepted_currencies": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AcceptedCurrencies"
+ }
+ ],
+ "nullable": true
+ },
+ "accepted_countries": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/AcceptedCountries"
+ }
+ ],
+ "nullable": true
+ },
+ "minimum_amount": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MinorUnit"
+ }
+ ],
+ "nullable": true
+ },
+ "maximum_amount": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MinorUnit"
+ }
+ ],
+ "nullable": true
+ },
+ "recurring_enabled": {
+ "type": "boolean",
+ "description": "Boolean to enable recurring payments / mandates. Default is true.",
+ "default": true,
+ "example": false
+ },
+ "installment_payment_enabled": {
+ "type": "boolean",
+ "description": "Boolean to enable installment / EMI / BNPL payments. Default is true.",
+ "default": true,
+ "example": false
+ }
+ }
+ },
+ "RequestSurchargeDetails": {
+ "type": "object",
+ "description": "Details of surcharge applied on this payment, if applicable",
+ "required": [
+ "surcharge_amount"
+ ],
+ "properties": {
+ "surcharge_amount": {
+ "type": "integer",
+ "format": "int64",
+ "example": 6540
+ },
+ "tax_amount": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MinorUnit"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "RequiredFieldInfo": {
+ "type": "object",
+ "description": "Required fields info used while listing the payment_method_data",
+ "required": [
+ "required_field",
+ "display_name",
+ "field_type"
+ ],
+ "properties": {
+ "required_field": {
+ "type": "string",
+ "description": "Required field for a payment_method through a payment_method_type"
+ },
+ "display_name": {
+ "type": "string",
+ "description": "Display name of the required field in the front-end"
+ },
+ "field_type": {
+ "$ref": "#/components/schemas/FieldType"
+ },
+ "value": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "RetrieveApiKeyResponse": {
+ "type": "object",
+ "description": "The response body for retrieving an API Key.",
+ "required": [
+ "key_id",
+ "merchant_id",
+ "name",
+ "prefix",
+ "created",
+ "expiration"
+ ],
+ "properties": {
+ "key_id": {
+ "type": "string",
+ "description": "The identifier for the API Key.",
+ "example": "5hEEqkgJUyuxgSKGArHA4mWSnX",
+ "maxLength": 64
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account.",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64
+ },
+ "name": {
+ "type": "string",
+ "description": "The unique name for the API Key to help you identify it.",
+ "example": "Sandbox integration key",
+ "maxLength": 64
+ },
+ "description": {
+ "type": "string",
+ "description": "The description to provide more context about the API Key.",
+ "example": "Key used by our developers to integrate with the sandbox environment",
+ "nullable": true,
+ "maxLength": 256
+ },
+ "prefix": {
+ "type": "string",
+ "description": "The first few characters of the plaintext API Key to help you identify it.",
+ "maxLength": 64
+ },
+ "created": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The time at which the API Key was created.",
+ "example": "2022-09-10T10:11:12Z"
+ },
+ "expiration": {
+ "$ref": "#/components/schemas/ApiKeyExpiration"
+ }
+ }
+ },
+ "RetrievePaymentLinkRequest": {
+ "type": "object",
+ "properties": {
+ "client_secret": {
+ "type": "string",
+ "description": "It's a token used for client side verification.",
+ "nullable": true
+ }
+ }
+ },
+ "RetrievePaymentLinkResponse": {
+ "type": "object",
+ "required": [
+ "payment_link_id",
+ "merchant_id",
+ "link_to_pay",
+ "amount",
+ "created_at",
+ "status"
+ ],
+ "properties": {
+ "payment_link_id": {
+ "type": "string",
+ "description": "Identifier for Payment Link"
+ },
+ "merchant_id": {
+ "type": "string",
+ "description": "Identifier for Merchant"
+ },
+ "link_to_pay": {
+ "type": "string",
+ "description": "Open payment link (without any security checks and listing SPMs)"
+ },
+ "amount": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The payment amount. Amount for the payment in the lowest denomination of the currency",
+ "example": 6540
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date and time of Payment Link creation"
+ },
+ "expiry": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Date and time of Expiration for Payment Link",
+ "nullable": true
+ },
+ "description": {
+ "type": "string",
+ "description": "Description for Payment Link",
+ "nullable": true
+ },
+ "status": {
+ "$ref": "#/components/schemas/PaymentLinkStatus"
+ },
+ "currency": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Currency"
+ }
+ ],
+ "nullable": true
+ },
+ "secure_link": {
+ "type": "string",
+ "description": "Secure payment link (with security checks and listing saved payment methods)",
+ "nullable": true
+ }
+ }
+ },
+ "RetryAction": {
+ "type": "string",
+ "description": "Denotes the retry action",
+ "enum": [
+ "manual_retry",
+ "requeue"
+ ]
+ },
+ "RevokeApiKeyResponse": {
+ "type": "object",
+ "description": "The response body for revoking an API Key.",
+ "required": [
+ "merchant_id",
+ "key_id",
+ "revoked"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account.",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 64
+ },
+ "key_id": {
+ "type": "string",
+ "description": "The identifier for the API Key.",
+ "example": "5hEEqkgJUyuxgSKGArHA4mWSnX",
+ "maxLength": 64
+ },
+ "revoked": {
+ "type": "boolean",
+ "description": "Indicates whether the API key was revoked or not.",
+ "example": "true"
+ }
+ }
+ },
+ "RewardData": {
+ "type": "object",
+ "required": [
+ "merchant_id"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The merchant ID with which we have to call the connector"
+ }
+ }
+ },
+ "RoutableChoiceKind": {
+ "type": "string",
+ "enum": [
+ "OnlyConnector",
+ "FullStruct"
+ ]
+ },
+ "RoutableConnectorChoice": {
+ "type": "object",
+ "description": "Routable Connector chosen for a payment",
+ "required": [
+ "connector"
+ ],
+ "properties": {
+ "connector": {
+ "$ref": "#/components/schemas/RoutableConnectors"
+ },
+ "merchant_connector_id": {
+ "type": "string",
+ "nullable": true
+ }
+ }
+ },
+ "RoutableConnectors": {
+ "type": "string",
+ "description": "Connectors eligible for payments routing",
+ "enum": [
+ "adyenplatform",
+ "phonypay",
+ "fauxpay",
+ "pretendpay",
+ "stripe_test",
+ "adyen_test",
+ "checkout_test",
+ "paypal_test",
+ "aci",
+ "adyen",
+ "airwallex",
+ "authorizedotnet",
+ "bankofamerica",
+ "billwerk",
+ "bitpay",
+ "bambora",
+ "bamboraapac",
+ "bluesnap",
+ "boku",
+ "braintree",
+ "cashtocode",
+ "checkout",
+ "coinbase",
+ "cryptopay",
+ "cybersource",
+ "datatrans",
+ "dlocal",
+ "ebanx",
+ "fiserv",
+ "forte",
+ "globalpay",
+ "globepay",
+ "gocardless",
+ "helcim",
+ "iatapay",
+ "itaubank",
+ "klarna",
+ "mifinity",
+ "mollie",
+ "multisafepay",
+ "nexinets",
+ "nmi",
+ "noon",
+ "nuvei",
+ "opennode",
+ "payme",
+ "payone",
+ "paypal",
+ "payu",
+ "placetopay",
+ "powertranz",
+ "prophetpay",
+ "rapyd",
+ "razorpay",
+ "riskified",
+ "shift4",
+ "signifyd",
+ "square",
+ "stax",
+ "stripe",
+ "trustpay",
+ "tsys",
+ "volt",
+ "wellsfargo",
+ "wise",
+ "worldline",
+ "worldpay",
+ "zen",
+ "plaid",
+ "zsl"
+ ]
+ },
+ "RoutingAlgorithm": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "single"
+ ]
+ },
+ "data": {
+ "$ref": "#/components/schemas/RoutableConnectorChoice"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "priority"
+ ]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RoutableConnectorChoice"
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "volume_split"
+ ]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ConnectorVolumeSplit"
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "advanced"
+ ]
+ },
+ "data": {
+ "$ref": "#/components/schemas/ProgramConnectorSelection"
+ }
+ }
+ }
+ ],
+ "description": "Routing Algorithm kind",
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "RoutingAlgorithmKind": {
+ "type": "string",
+ "enum": [
+ "single",
+ "priority",
+ "volume_split",
+ "advanced"
+ ]
+ },
+ "RoutingConfigRequest": {
+ "type": "object",
+ "required": [
+ "name",
+ "description",
+ "algorithm",
+ "profile_id"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "algorithm": {
+ "$ref": "#/components/schemas/RoutingAlgorithm"
+ },
+ "profile_id": {
+ "type": "string"
+ }
+ }
+ },
+ "RoutingDictionary": {
+ "type": "object",
+ "required": [
+ "merchant_id",
+ "records"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string"
+ },
+ "active_id": {
+ "type": "string",
+ "nullable": true
+ },
+ "records": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RoutingDictionaryRecord"
+ }
+ }
+ }
+ },
+ "RoutingDictionaryRecord": {
+ "type": "object",
+ "required": [
+ "id",
+ "profile_id",
+ "name",
+ "kind",
+ "description",
+ "created_at",
+ "modified_at"
+ ],
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "profile_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "kind": {
+ "$ref": "#/components/schemas/RoutingAlgorithmKind"
+ },
+ "description": {
+ "type": "string"
+ },
+ "created_at": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "modified_at": {
+ "type": "integer",
+ "format": "int64"
+ },
+ "algorithm_for": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/TransactionType"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "RoutingKind": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/RoutingDictionary"
+ },
+ {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RoutingDictionaryRecord"
+ }
+ }
+ ]
+ },
+ "RoutingRetrieveResponse": {
+ "type": "object",
+ "description": "Response of the retrieved routing configs for a merchant account",
+ "properties": {
+ "algorithm": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MerchantRoutingAlgorithm"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ },
+ "RuleConnectorSelection": {
+ "type": "object",
+ "description": "Represents a rule\n\n```text\nrule_name: [stripe, adyen, checkout]\n{\npayment.method = card {\npayment.method.cardtype = (credit, debit) {\npayment.method.network = (amex, rupay, diners)\n}\n\npayment.method.cardtype = credit\n}\n}\n```",
+ "required": [
+ "name",
+ "connectorSelection",
+ "statements"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "connectorSelection": {
+ "$ref": "#/components/schemas/ConnectorSelection"
+ },
+ "statements": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/IfStatement"
+ }
+ }
+ }
+ },
+ "SamsungPayWalletData": {
+ "type": "object",
+ "required": [
+ "token"
+ ],
+ "properties": {
+ "token": {
+ "type": "string",
+ "description": "The encrypted payment token from Samsung"
+ }
+ }
+ },
+ "SdkInformation": {
+ "type": "object",
+ "description": "SDK Information if request is from SDK",
+ "required": [
+ "sdk_app_id",
+ "sdk_enc_data",
+ "sdk_ephem_pub_key",
+ "sdk_trans_id",
+ "sdk_reference_number",
+ "sdk_max_timeout"
+ ],
+ "properties": {
+ "sdk_app_id": {
+ "type": "string",
+ "description": "Unique ID created on installations of the 3DS Requestor App on a Consumer Device"
+ },
+ "sdk_enc_data": {
+ "type": "string",
+ "description": "JWE Object containing data encrypted by the SDK for the DS to decrypt"
+ },
+ "sdk_ephem_pub_key": {
+ "type": "object",
+ "description": "Public key component of the ephemeral key pair generated by the 3DS SDK",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "sdk_trans_id": {
+ "type": "string",
+ "description": "Unique transaction identifier assigned by the 3DS SDK"
+ },
+ "sdk_reference_number": {
+ "type": "string",
+ "description": "Identifies the vendor and version for the 3DS SDK that is integrated in a 3DS Requestor App"
+ },
+ "sdk_max_timeout": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Indicates maximum amount of time in minutes",
+ "minimum": 0
+ }
+ }
+ },
+ "SdkNextAction": {
+ "type": "object",
+ "required": [
+ "next_action"
+ ],
+ "properties": {
+ "next_action": {
+ "$ref": "#/components/schemas/NextActionCall"
+ }
+ }
+ },
+ "SdkNextActionData": {
+ "type": "object",
+ "required": [
+ "next_action"
+ ],
+ "properties": {
+ "next_action": {
+ "$ref": "#/components/schemas/NextActionCall"
+ }
+ }
+ },
+ "SecretInfoToInitiateSdk": {
+ "type": "object",
+ "required": [
+ "display",
+ "payment"
+ ],
+ "properties": {
+ "display": {
+ "type": "string"
+ },
+ "payment": {
+ "type": "string"
+ }
+ }
+ },
+ "SepaAndBacsBillingDetails": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "description": "The Email ID for SEPA and BACS billing",
+ "example": "[email protected]",
+ "nullable": true
+ },
+ "name": {
+ "type": "string",
+ "description": "The billing name for SEPA and BACS billing",
+ "example": "Jane Doe",
+ "nullable": true
+ }
+ }
+ },
+ "SepaBankTransfer": {
+ "type": "object",
+ "required": [
+ "iban",
+ "bic"
+ ],
+ "properties": {
+ "bank_name": {
+ "type": "string",
+ "description": "Bank name",
+ "example": "Deutsche Bank",
+ "nullable": true
+ },
+ "bank_country_code": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ },
+ "bank_city": {
+ "type": "string",
+ "description": "Bank city",
+ "example": "California",
+ "nullable": true
+ },
+ "iban": {
+ "type": "string",
+ "description": "International Bank Account Number (iban) - used in many countries for identifying a bank along with it's customer.",
+ "example": "DE89370400440532013000"
+ },
+ "bic": {
+ "type": "string",
+ "description": "[8 / 11 digits] Bank Identifier Code (bic) / Swift Code - used in many countries for identifying a bank and it's branches",
+ "example": "HSBCGB2LXXX"
+ }
+ }
+ },
+ "SepaBankTransferInstructions": {
+ "type": "object",
+ "required": [
+ "account_holder_name",
+ "bic",
+ "country",
+ "iban"
+ ],
+ "properties": {
+ "account_holder_name": {
+ "type": "string",
+ "example": "Jane Doe"
+ },
+ "bic": {
+ "type": "string",
+ "example": "9123456789"
+ },
+ "country": {
+ "type": "string"
+ },
+ "iban": {
+ "type": "string",
+ "example": "123456789"
+ }
+ }
+ },
+ "SessionToken": {
+ "oneOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/GpaySessionTokenResponse"
+ },
+ {
+ "type": "object",
+ "required": [
+ "wallet_name"
+ ],
+ "properties": {
+ "wallet_name": {
+ "type": "string",
+ "enum": [
+ "google_pay"
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/KlarnaSessionTokenResponse"
+ },
+ {
+ "type": "object",
+ "required": [
+ "wallet_name"
+ ],
+ "properties": {
+ "wallet_name": {
+ "type": "string",
+ "enum": [
+ "klarna"
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaypalSessionTokenResponse"
+ },
+ {
+ "type": "object",
+ "required": [
+ "wallet_name"
+ ],
+ "properties": {
+ "wallet_name": {
+ "type": "string",
+ "enum": [
+ "paypal"
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ApplepaySessionTokenResponse"
+ },
+ {
+ "type": "object",
+ "required": [
+ "wallet_name"
+ ],
+ "properties": {
+ "wallet_name": {
+ "type": "string",
+ "enum": [
+ "apple_pay"
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/OpenBankingSessionToken"
+ },
+ {
+ "type": "object",
+ "required": [
+ "wallet_name"
+ ],
+ "properties": {
+ "wallet_name": {
+ "type": "string",
+ "enum": [
+ "open_banking"
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "type": "object",
+ "required": [
+ "wallet_name"
+ ],
+ "properties": {
+ "wallet_name": {
+ "type": "string",
+ "enum": [
+ "no_session_token_received"
+ ]
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "wallet_name"
+ }
+ },
+ "SessionTokenInfo": {
+ "allOf": [
+ {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/PaymentProcessingDetailsAt"
+ }
+ ],
+ "nullable": true
+ },
+ {
+ "type": "object",
+ "required": [
+ "certificate",
+ "certificate_keys",
+ "merchant_identifier",
+ "display_name",
+ "initiative"
+ ],
+ "properties": {
+ "certificate": {
+ "type": "string"
+ },
+ "certificate_keys": {
+ "type": "string"
+ },
+ "merchant_identifier": {
+ "type": "string"
+ },
+ "display_name": {
+ "type": "string"
+ },
+ "initiative": {
+ "$ref": "#/components/schemas/ApplepayInitiative"
+ },
+ "initiative_context": {
+ "type": "string",
+ "nullable": true
+ },
+ "merchant_business_country": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/CountryAlpha2"
+ }
+ ],
+ "nullable": true
+ }
+ }
+ }
+ ]
+ },
+ "StraightThroughAlgorithm": {
+ "oneOf": [
+ {
+ "type": "object",
+ "title": "Single",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "single"
+ ]
+ },
+ "data": {
+ "$ref": "#/components/schemas/RoutableConnectorChoice"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "Priority",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "priority"
+ ]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RoutableConnectorChoice"
+ }
+ }
+ }
+ },
+ {
+ "type": "object",
+ "title": "VolumeSplit",
+ "required": [
+ "type",
+ "data"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "volume_split"
+ ]
+ },
+ "data": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ConnectorVolumeSplit"
+ }
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "StripeChargeType": {
+ "type": "string",
+ "enum": [
+ "direct",
+ "destination"
+ ]
+ },
+ "SurchargeDetailsResponse": {
+ "type": "object",
+ "required": [
+ "surcharge",
+ "display_surcharge_amount",
+ "display_tax_on_surcharge_amount",
+ "display_total_surcharge_amount",
+ "display_final_amount"
+ ],
+ "properties": {
+ "surcharge": {
+ "$ref": "#/components/schemas/SurchargeResponse"
+ },
+ "tax_on_surcharge": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/SurchargePercentage"
+ }
+ ],
+ "nullable": true
+ },
+ "display_surcharge_amount": {
+ "type": "number",
+ "format": "double",
+ "description": "surcharge amount for this payment"
+ },
+ "display_tax_on_surcharge_amount": {
+ "type": "number",
+ "format": "double",
+ "description": "tax on surcharge amount for this payment"
+ },
+ "display_total_surcharge_amount": {
+ "type": "number",
+ "format": "double",
+ "description": "sum of display_surcharge_amount and display_tax_on_surcharge_amount"
+ },
+ "display_final_amount": {
+ "type": "number",
+ "format": "double",
+ "description": "sum of original amount,"
+ }
+ }
+ },
+ "SurchargePercentage": {
+ "type": "object",
+ "required": [
+ "percentage"
+ ],
+ "properties": {
+ "percentage": {
+ "type": "number",
+ "format": "float"
+ }
+ }
+ },
+ "SurchargeResponse": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "value"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "fixed"
+ ]
+ },
+ "value": {
+ "$ref": "#/components/schemas/MinorUnit"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "value"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "rate"
+ ]
+ },
+ "value": {
+ "$ref": "#/components/schemas/SurchargePercentage"
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "SwishQrData": {
+ "type": "object"
+ },
+ "ThirdPartySdkSessionResponse": {
+ "type": "object",
+ "required": [
+ "secrets"
+ ],
+ "properties": {
+ "secrets": {
+ "$ref": "#/components/schemas/SecretInfoToInitiateSdk"
+ }
+ }
+ },
+ "ThreeDsCompletionIndicator": {
+ "type": "string",
+ "enum": [
+ "Y",
+ "N",
+ "U"
+ ]
+ },
+ "ThreeDsData": {
+ "type": "object",
+ "required": [
+ "three_ds_authentication_url",
+ "three_ds_authorize_url",
+ "three_ds_method_details",
+ "poll_config"
+ ],
+ "properties": {
+ "three_ds_authentication_url": {
+ "type": "string",
+ "description": "ThreeDS authentication url - to initiate authentication"
+ },
+ "three_ds_authorize_url": {
+ "type": "string",
+ "description": "ThreeDS authorize url - to complete the payment authorization after authentication"
+ },
+ "three_ds_method_details": {
+ "$ref": "#/components/schemas/ThreeDsMethodData"
+ },
+ "poll_config": {
+ "$ref": "#/components/schemas/PollConfigResponse"
+ },
+ "message_version": {
+ "type": "string",
+ "description": "Message Version",
+ "nullable": true
+ },
+ "directory_server_id": {
+ "type": "string",
+ "description": "Directory Server ID",
+ "nullable": true
+ }
+ }
+ },
+ "ThreeDsMethodData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "three_ds_method_data_submission",
+ "three_ds_method_key"
+ ],
+ "properties": {
+ "three_ds_method_data_submission": {
+ "type": "boolean",
+ "description": "Whether ThreeDS method data submission is required"
+ },
+ "three_ds_method_data": {
+ "type": "string",
+ "description": "ThreeDS method data",
+ "nullable": true
+ },
+ "three_ds_method_url": {
+ "type": "string",
+ "description": "ThreeDS method url",
+ "nullable": true
+ },
+ "three_ds_method_key": {
+ "type": "string",
+ "enum": [
+ "threeDSMethodData"
+ ]
+ }
+ }
+ }
+ ],
+ "discriminator": {
+ "propertyName": "three_ds_method_key"
+ }
+ },
+ "TimeRange": {
+ "type": "object",
+ "required": [
+ "start_time"
+ ],
+ "properties": {
+ "start_time": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The start time to filter payments list or to get list of filters. To get list of filters start time is needed to be passed"
+ },
+ "end_time": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The end time to filter payments list or to get list of filters. If not passed the default time is now",
+ "nullable": true
+ }
+ }
+ },
+ "ToggleBlocklistResponse": {
+ "type": "object",
+ "required": [
+ "blocklist_guard_status"
+ ],
+ "properties": {
+ "blocklist_guard_status": {
+ "type": "string"
+ }
+ }
+ },
+ "ToggleKVRequest": {
+ "type": "object",
+ "required": [
+ "kv_enabled"
+ ],
+ "properties": {
+ "kv_enabled": {
+ "type": "boolean",
+ "description": "Status of KV for the specific merchant",
+ "example": true
+ }
+ }
+ },
+ "ToggleKVResponse": {
+ "type": "object",
+ "required": [
+ "merchant_id",
+ "kv_enabled"
+ ],
+ "properties": {
+ "merchant_id": {
+ "type": "string",
+ "description": "The identifier for the Merchant Account",
+ "example": "y3oqhf46pyzuxjbcn2giaqnb44",
+ "maxLength": 255
+ },
+ "kv_enabled": {
+ "type": "boolean",
+ "description": "Status of KV for the specific merchant",
+ "example": true
+ }
+ }
+ },
+ "TouchNGoRedirection": {
+ "type": "object"
+ },
+ "TransactionStatus": {
+ "type": "string",
+ "description": "Indicates the transaction status",
+ "enum": [
+ "Y",
+ "N",
+ "U",
+ "A",
+ "R",
+ "C",
+ "D",
+ "I"
+ ]
+ },
+ "TransactionType": {
+ "type": "string",
+ "enum": [
+ "payment",
+ "payout"
+ ]
+ },
+ "UpdateApiKeyRequest": {
+ "type": "object",
+ "description": "The request body for updating an API Key.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "A unique name for the API Key to help you identify it.",
+ "example": "Sandbox integration key",
+ "nullable": true,
+ "maxLength": 64
+ },
+ "description": {
+ "type": "string",
+ "description": "A description to provide more context about the API Key.",
+ "example": "Key used by our developers to integrate with the sandbox environment",
+ "nullable": true,
+ "maxLength": 256
+ },
+ "expiration": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ApiKeyExpiration"
+ }
+ ],
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ },
+ "UpiCollectData": {
+ "type": "object",
+ "properties": {
+ "vpa_id": {
+ "type": "string",
+ "example": "successtest@iata",
+ "nullable": true
+ }
+ }
+ },
+ "UpiData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "upi_collect"
+ ],
+ "properties": {
+ "upi_collect": {
+ "$ref": "#/components/schemas/UpiCollectData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "upi_intent"
+ ],
+ "properties": {
+ "upi_intent": {
+ "$ref": "#/components/schemas/UpiIntentData"
+ }
+ }
+ }
+ ]
+ },
+ "UpiIntentData": {
+ "type": "object"
+ },
+ "ValueType": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "value"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "number"
+ ]
+ },
+ "value": {
+ "$ref": "#/components/schemas/MinorUnit"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "value"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "enum_variant"
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "Represents an enum variant"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "value"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "metadata_variant"
+ ]
+ },
+ "value": {
+ "$ref": "#/components/schemas/MetadataValue"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "value"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "str_value"
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "Represents a arbitrary String value"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "value"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "number_array"
+ ]
+ },
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MinorUnit"
+ },
+ "description": "Represents an array of numbers. This is basically used for\n\"one of the given numbers\" operations\neg: payment.method.amount = (1, 2, 3)"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "value"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "enum_variant_array"
+ ]
+ },
+ "value": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Similar to NumberArray but for enum variants\neg: payment.method.cardtype = (debit, credit)"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "type",
+ "value"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "number_comparison_array"
+ ]
+ },
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NumberComparison"
+ },
+ "description": "Like a number array but can include comparisons. Useful for\nconditions like \"500 < amount < 1000\"\neg: payment.amount = (> 500, < 1000)"
+ }
+ }
+ }
+ ],
+ "description": "Represents a value in the DSL",
+ "discriminator": {
+ "propertyName": "type"
+ }
+ },
+ "Venmo": {
+ "type": "object",
+ "required": [
+ "telephone_number"
+ ],
+ "properties": {
+ "telephone_number": {
+ "type": "string",
+ "description": "mobile number linked to venmo account",
+ "example": "16608213349"
+ }
+ }
+ },
+ "VoucherData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "boleto"
+ ],
+ "properties": {
+ "boleto": {
+ "$ref": "#/components/schemas/BoletoVoucherData"
+ }
+ }
+ },
+ {
+ "type": "string",
+ "enum": [
+ "efecty"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "pago_efectivo"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "red_compra"
+ ]
+ },
+ {
+ "type": "string",
+ "enum": [
+ "red_pagos"
+ ]
+ },
+ {
+ "type": "object",
+ "required": [
+ "alfamart"
+ ],
+ "properties": {
+ "alfamart": {
+ "$ref": "#/components/schemas/AlfamartVoucherData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "indomaret"
+ ],
+ "properties": {
+ "indomaret": {
+ "$ref": "#/components/schemas/IndomaretVoucherData"
+ }
+ }
+ },
+ {
+ "type": "string",
+ "enum": [
+ "oxxo"
+ ]
+ },
+ {
+ "type": "object",
+ "required": [
+ "seven_eleven"
+ ],
+ "properties": {
+ "seven_eleven": {
+ "$ref": "#/components/schemas/JCSVoucherData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "lawson"
+ ],
+ "properties": {
+ "lawson": {
+ "$ref": "#/components/schemas/JCSVoucherData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "mini_stop"
+ ],
+ "properties": {
+ "mini_stop": {
+ "$ref": "#/components/schemas/JCSVoucherData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "family_mart"
+ ],
+ "properties": {
+ "family_mart": {
+ "$ref": "#/components/schemas/JCSVoucherData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "seicomart"
+ ],
+ "properties": {
+ "seicomart": {
+ "$ref": "#/components/schemas/JCSVoucherData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "pay_easy"
+ ],
+ "properties": {
+ "pay_easy": {
+ "$ref": "#/components/schemas/JCSVoucherData"
+ }
+ }
+ }
+ ]
+ },
+ "Wallet": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "paypal"
+ ],
+ "properties": {
+ "paypal": {
+ "$ref": "#/components/schemas/Paypal"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "venmo"
+ ],
+ "properties": {
+ "venmo": {
+ "$ref": "#/components/schemas/Venmo"
+ }
+ }
+ }
+ ]
+ },
+ "WalletData": {
+ "oneOf": [
+ {
+ "type": "object",
+ "required": [
+ "ali_pay_qr"
+ ],
+ "properties": {
+ "ali_pay_qr": {
+ "$ref": "#/components/schemas/AliPayQr"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "ali_pay_redirect"
+ ],
+ "properties": {
+ "ali_pay_redirect": {
+ "$ref": "#/components/schemas/AliPayRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "ali_pay_hk_redirect"
+ ],
+ "properties": {
+ "ali_pay_hk_redirect": {
+ "$ref": "#/components/schemas/AliPayHkRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "momo_redirect"
+ ],
+ "properties": {
+ "momo_redirect": {
+ "$ref": "#/components/schemas/MomoRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "kakao_pay_redirect"
+ ],
+ "properties": {
+ "kakao_pay_redirect": {
+ "$ref": "#/components/schemas/KakaoPayRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "go_pay_redirect"
+ ],
+ "properties": {
+ "go_pay_redirect": {
+ "$ref": "#/components/schemas/GoPayRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "gcash_redirect"
+ ],
+ "properties": {
+ "gcash_redirect": {
+ "$ref": "#/components/schemas/GcashRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "apple_pay"
+ ],
+ "properties": {
+ "apple_pay": {
+ "$ref": "#/components/schemas/ApplePayWalletData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "apple_pay_redirect"
+ ],
+ "properties": {
+ "apple_pay_redirect": {
+ "$ref": "#/components/schemas/ApplePayRedirectData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "apple_pay_third_party_sdk"
+ ],
+ "properties": {
+ "apple_pay_third_party_sdk": {
+ "$ref": "#/components/schemas/ApplePayThirdPartySdkData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "dana_redirect"
+ ],
+ "properties": {
+ "dana_redirect": {
+ "type": "object",
+ "description": "Wallet data for DANA redirect flow"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "google_pay"
+ ],
+ "properties": {
+ "google_pay": {
+ "$ref": "#/components/schemas/GooglePayWalletData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "google_pay_redirect"
+ ],
+ "properties": {
+ "google_pay_redirect": {
+ "$ref": "#/components/schemas/GooglePayRedirectData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "google_pay_third_party_sdk"
+ ],
+ "properties": {
+ "google_pay_third_party_sdk": {
+ "$ref": "#/components/schemas/GooglePayThirdPartySdkData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "mb_way_redirect"
+ ],
+ "properties": {
+ "mb_way_redirect": {
+ "$ref": "#/components/schemas/MbWayRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "mobile_pay_redirect"
+ ],
+ "properties": {
+ "mobile_pay_redirect": {
+ "$ref": "#/components/schemas/MobilePayRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "paypal_redirect"
+ ],
+ "properties": {
+ "paypal_redirect": {
+ "$ref": "#/components/schemas/PaypalRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "paypal_sdk"
+ ],
+ "properties": {
+ "paypal_sdk": {
+ "$ref": "#/components/schemas/PayPalWalletData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "samsung_pay"
+ ],
+ "properties": {
+ "samsung_pay": {
+ "$ref": "#/components/schemas/SamsungPayWalletData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "twint_redirect"
+ ],
+ "properties": {
+ "twint_redirect": {
+ "type": "object",
+ "description": "Wallet data for Twint Redirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "vipps_redirect"
+ ],
+ "properties": {
+ "vipps_redirect": {
+ "type": "object",
+ "description": "Wallet data for Vipps Redirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "touch_n_go_redirect"
+ ],
+ "properties": {
+ "touch_n_go_redirect": {
+ "$ref": "#/components/schemas/TouchNGoRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "we_chat_pay_redirect"
+ ],
+ "properties": {
+ "we_chat_pay_redirect": {
+ "$ref": "#/components/schemas/WeChatPayRedirection"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "we_chat_pay_qr"
+ ],
+ "properties": {
+ "we_chat_pay_qr": {
+ "$ref": "#/components/schemas/WeChatPayQr"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "cashapp_qr"
+ ],
+ "properties": {
+ "cashapp_qr": {
+ "$ref": "#/components/schemas/CashappQr"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "swish_qr"
+ ],
+ "properties": {
+ "swish_qr": {
+ "$ref": "#/components/schemas/SwishQrData"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "required": [
+ "mifinity"
+ ],
+ "properties": {
+ "mifinity": {
+ "$ref": "#/components/schemas/MifinityData"
+ }
+ }
+ }
+ ]
+ },
+ "WeChatPay": {
+ "type": "object"
+ },
+ "WeChatPayQr": {
+ "type": "object"
+ },
+ "WeChatPayRedirection": {
+ "type": "object"
+ },
+ "WebhookDeliveryAttempt": {
+ "type": "string",
+ "enum": [
+ "initial_attempt",
+ "automatic_retry",
+ "manual_retry"
+ ]
+ },
+ "WebhookDetails": {
+ "type": "object",
+ "properties": {
+ "webhook_version": {
+ "type": "string",
+ "description": "The version for Webhook",
+ "example": "1.0.2",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "webhook_username": {
+ "type": "string",
+ "description": "The user name for Webhook login",
+ "example": "ekart_retail",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "webhook_password": {
+ "type": "string",
+ "description": "The password for Webhook login",
+ "example": "ekart@123",
+ "nullable": true,
+ "maxLength": 255
+ },
+ "webhook_url": {
+ "type": "string",
+ "description": "The url for the webhook endpoint",
+ "example": "www.ekart.com/webhooks",
+ "nullable": true
+ },
+ "payment_created_enabled": {
+ "type": "boolean",
+ "description": "If this property is true, a webhook message is posted whenever a new payment is created",
+ "example": true,
+ "nullable": true
+ },
+ "payment_succeeded_enabled": {
+ "type": "boolean",
+ "description": "If this property is true, a webhook message is posted whenever a payment is successful",
+ "example": true,
+ "nullable": true
+ },
+ "payment_failed_enabled": {
+ "type": "boolean",
+ "description": "If this property is true, a webhook message is posted whenever a payment fails",
+ "example": true,
+ "nullable": true
+ }
+ },
+ "additionalProperties": false
+ }
+ },
+ "securitySchemes": {
+ "admin_api_key": {
+ "type": "apiKey",
+ "in": "header",
+ "name": "api-key",
+ "description": "Admin API keys allow you to perform some privileged actions such as creating a merchant account and Merchant Connector account."
+ },
+ "api_key": {
+ "type": "apiKey",
+ "in": "header",
+ "name": "api-key",
+ "description": "Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application."
+ },
+ "ephemeral_key": {
+ "type": "apiKey",
+ "in": "header",
+ "name": "api-key",
+ "description": "Ephemeral keys provide temporary access to singular data, such as access to a single customer object for a short period of time."
+ },
+ "publishable_key": {
+ "type": "apiKey",
+ "in": "header",
+ "name": "api-key",
+ "description": "Publishable keys are a type of keys that can be public and have limited scope of usage."
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Merchant Account",
+ "description": "Create and manage merchant accounts"
+ },
+ {
+ "name": "Business Profile",
+ "description": "Create and manage business profiles"
+ },
+ {
+ "name": "Merchant Connector Account",
+ "description": "Create and manage merchant connector accounts"
+ },
+ {
+ "name": "Payments",
+ "description": "Create and manage one-time payments, recurring payments and mandates"
+ },
+ {
+ "name": "Refunds",
+ "description": "Create and manage refunds for successful payments"
+ },
+ {
+ "name": "Mandates",
+ "description": "Manage mandates"
+ },
+ {
+ "name": "Customers",
+ "description": "Create and manage customers"
+ },
+ {
+ "name": "Payment Methods",
+ "description": "Create and manage payment methods of customers"
+ },
+ {
+ "name": "Disputes",
+ "description": "Manage disputes"
+ },
+ {
+ "name": "API Key",
+ "description": "Create and manage API Keys"
+ },
+ {
+ "name": "Payouts",
+ "description": "Create and manage payouts"
+ },
+ {
+ "name": "payment link",
+ "description": "Create payment link"
+ },
+ {
+ "name": "Routing",
+ "description": "Create and manage routing configurations"
+ },
+ {
+ "name": "Event",
+ "description": "Manage events"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs
index 571dc493208..3ed77eb5111 100644
--- a/crates/api_models/src/admin.rs
+++ b/crates/api_models/src/admin.rs
@@ -539,7 +539,7 @@ pub struct MerchantAccountResponse {
#[derive(Clone, Debug, ToSchema, Serialize)]
pub struct MerchantAccountResponse {
/// The identifier for the Merchant Account
- #[schema(max_length = 64, example = "y3oqhf46pyzuxjbcn2giaqnb44")]
+ #[schema(max_length = 64, example = "y3oqhf46pyzuxjbcn2giaqnb44", value_type = String)]
pub id: id_type::MerchantId,
/// Name of the Merchant Account
diff --git a/crates/openapi/Cargo.toml b/crates/openapi/Cargo.toml
index d75714fd2ea..98d80ffe9cb 100644
--- a/crates/openapi/Cargo.toml
+++ b/crates/openapi/Cargo.toml
@@ -17,5 +17,5 @@ router_env = { version = "0.1.0", path = "../router_env" }
[features]
default = ["v1"]
-v2 = ["api_models/v2"]
-v1 = ["api_models/v1"]
+v2 = ["api_models/v2", "api_models/customer_v2", "api_models/merchant_account_v2", "api_models/routing_v2", "api_models/merchant_connector_account_v2"]
+v1 = ["api_models/v1"]
\ No newline at end of file
diff --git a/crates/openapi/src/main.rs b/crates/openapi/src/main.rs
index 3d69a6495cb..50782a81a7d 100644
--- a/crates/openapi/src/main.rs
+++ b/crates/openapi/src/main.rs
@@ -1,13 +1,23 @@
+#[cfg(feature = "v1")]
mod openapi;
+#[cfg(feature = "v2")]
+mod openapi_v2;
mod routes;
fn main() {
+ #[cfg(feature = "v1")]
let relative_file_path = "api-reference/openapi_spec.json";
+ #[cfg(feature = "v2")]
+ let relative_file_path = "api-reference/openapi_spec_v2.json";
+
let mut file_path = router_env::workspace_path();
file_path.push(relative_file_path);
+ #[cfg(feature = "v1")]
let openapi = <openapi::ApiDoc as utoipa::OpenApi>::openapi();
+ #[cfg(feature = "v2")]
+ let openapi = <openapi_v2::ApiDoc as utoipa::OpenApi>::openapi();
#[allow(clippy::expect_used)]
std::fs::write(
diff --git a/crates/openapi/src/openapi_v2.rs b/crates/openapi/src/openapi_v2.rs
new file mode 100644
index 00000000000..7a6e709e982
--- /dev/null
+++ b/crates/openapi/src/openapi_v2.rs
@@ -0,0 +1,506 @@
+use crate::routes;
+
+#[derive(utoipa::OpenApi)]
+#[openapi(
+ info(
+ title = "Hyperswitch - API Documentation",
+ contact(
+ name = "Hyperswitch Support",
+ url = "https://hyperswitch.io",
+ email = "[email protected]"
+ ),
+ // terms_of_service = "https://www.juspay.io/terms",
+ description = r#"
+## Get started
+
+Hyperswitch provides a collection of APIs that enable you to process and manage payments.
+Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes.
+
+You can consume the APIs directly using your favorite HTTP/REST library.
+
+We have a testing environment referred to "sandbox", which you can setup to test API calls without
+affecting production data.
+Currently, our sandbox environment is live while our production environment is under development
+and will be available soon.
+You can sign up on our Dashboard to get API keys to access Hyperswitch API.
+
+### Environment
+
+Use the following base URLs when making requests to the APIs:
+
+| Environment | Base URL |
+|---------------|------------------------------------|
+| Sandbox | <https://sandbox.hyperswitch.io> |
+| Production | <https://api.hyperswitch.io> |
+
+## Authentication
+
+When you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant
+account, you are given a secret key (also referred as api-key) and a publishable key.
+You may authenticate all API requests with Hyperswitch server by providing the appropriate key in
+the request Authorization header.
+
+| Key | Description |
+|-----------------|-----------------------------------------------------------------------------------------------|
+| api-key | Private key. Used to authenticate all API requests from your merchant server |
+| publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client |
+
+Never share your secret api keys. Keep them guarded and secure.
+"#,
+ ),
+ servers(
+ (url = "https://sandbox.hyperswitch.io", description = "Sandbox Environment")
+ ),
+ tags(
+ (name = "Merchant Account", description = "Create and manage merchant accounts"),
+ (name = "Business Profile", description = "Create and manage business profiles"),
+ (name = "Merchant Connector Account", description = "Create and manage merchant connector accounts"),
+ (name = "Payments", description = "Create and manage one-time payments, recurring payments and mandates"),
+ (name = "Refunds", description = "Create and manage refunds for successful payments"),
+ (name = "Mandates", description = "Manage mandates"),
+ (name = "Customers", description = "Create and manage customers"),
+ (name = "Payment Methods", description = "Create and manage payment methods of customers"),
+ (name = "Disputes", description = "Manage disputes"),
+ (name = "API Key", description = "Create and manage API Keys"),
+ (name = "Payouts", description = "Create and manage payouts"),
+ (name = "payment link", description = "Create payment link"),
+ (name = "Routing", description = "Create and manage routing configurations"),
+ (name = "Event", description = "Manage events"),
+ ),
+ // The paths will be displayed in the same order as they are registered here
+ paths(
+ // Routes for merchant connector account
+ routes::merchant_connector_account::connector_create,
+ routes::merchant_connector_account::connector_retrieve,
+ routes::merchant_connector_account::connector_update,
+ routes::merchant_connector_account::connector_delete,
+ ),
+ components(schemas(
+ common_utils::types::MinorUnit,
+ common_utils::link_utils::GenericLinkUiConfig,
+ common_utils::link_utils::EnabledPaymentMethod,
+ api_models::refunds::RefundRequest,
+ api_models::refunds::RefundType,
+ api_models::refunds::RefundResponse,
+ api_models::refunds::RefundStatus,
+ api_models::refunds::RefundUpdateRequest,
+ api_models::organization::OrganizationRequest,
+ api_models::organization::OrganizationResponse,
+ api_models::admin::MerchantAccountCreate,
+ api_models::admin::MerchantAccountUpdate,
+ api_models::admin::MerchantAccountDeleteResponse,
+ api_models::admin::MerchantConnectorDeleteResponse,
+ api_models::admin::MerchantConnectorResponse,
+ api_models::admin::MerchantConnectorListResponse,
+ api_models::admin::AuthenticationConnectorDetails,
+ api_models::admin::ExtendedCardInfoConfig,
+ api_models::admin::BusinessGenericLinkConfig,
+ api_models::admin::BusinessCollectLinkConfig,
+ api_models::admin::BusinessPayoutLinkConfig,
+ api_models::customers::CustomerRequest,
+ api_models::customers::CustomerDeleteResponse,
+ api_models::payment_methods::PaymentMethodCreate,
+ api_models::payment_methods::PaymentMethodResponse,
+ api_models::payment_methods::PaymentMethodList,
+ api_models::payment_methods::CustomerPaymentMethod,
+ api_models::payment_methods::PaymentMethodListResponse,
+ api_models::payment_methods::CustomerPaymentMethodsListResponse,
+ api_models::payment_methods::PaymentMethodDeleteResponse,
+ api_models::payment_methods::PaymentMethodUpdate,
+ api_models::payment_methods::CustomerDefaultPaymentMethodResponse,
+ api_models::payment_methods::CardDetailFromLocker,
+ api_models::payment_methods::PaymentMethodCreateData,
+ api_models::payment_methods::CardDetail,
+ api_models::payment_methods::CardDetailUpdate,
+ api_models::payment_methods::RequestPaymentMethodTypes,
+ api_models::poll::PollResponse,
+ api_models::poll::PollStatus,
+ api_models::customers::CustomerResponse,
+ api_models::admin::AcceptedCountries,
+ api_models::admin::AcceptedCurrencies,
+ api_models::enums::PaymentType,
+ api_models::enums::PaymentMethod,
+ api_models::enums::PaymentMethodType,
+ api_models::enums::ConnectorType,
+ api_models::enums::PayoutConnectors,
+ api_models::enums::AuthenticationConnectors,
+ api_models::enums::Currency,
+ api_models::enums::IntentStatus,
+ api_models::enums::CaptureMethod,
+ api_models::enums::FutureUsage,
+ api_models::enums::AuthenticationType,
+ api_models::enums::Connector,
+ api_models::enums::PaymentMethod,
+ api_models::enums::PaymentMethodIssuerCode,
+ api_models::enums::MandateStatus,
+ api_models::enums::PaymentExperience,
+ api_models::enums::BankNames,
+ api_models::enums::CardNetwork,
+ api_models::enums::DisputeStage,
+ api_models::enums::DisputeStatus,
+ api_models::enums::CountryAlpha2,
+ api_models::enums::FieldType,
+ api_models::enums::FrmAction,
+ api_models::enums::FrmPreferredFlowTypes,
+ api_models::enums::RetryAction,
+ api_models::enums::AttemptStatus,
+ api_models::enums::CaptureStatus,
+ api_models::enums::ReconStatus,
+ api_models::enums::ConnectorStatus,
+ api_models::enums::AuthorizationStatus,
+ api_models::enums::PaymentMethodStatus,
+ api_models::admin::MerchantConnectorCreate,
+ api_models::admin::AdditionalMerchantData,
+ api_models::admin::MerchantRecipientData,
+ api_models::admin::MerchantAccountData,
+ api_models::admin::MerchantConnectorUpdate,
+ api_models::admin::PrimaryBusinessDetails,
+ api_models::admin::FrmConfigs,
+ api_models::admin::FrmPaymentMethod,
+ api_models::admin::FrmPaymentMethodType,
+ api_models::admin::PaymentMethodsEnabled,
+ api_models::admin::MerchantConnectorDetailsWrap,
+ api_models::admin::MerchantConnectorDetails,
+ api_models::admin::MerchantConnectorWebhookDetails,
+ api_models::admin::BusinessProfileCreate,
+ api_models::admin::BusinessProfileResponse,
+ api_models::admin::BusinessPaymentLinkConfig,
+ api_models::admin::PaymentLinkConfigRequest,
+ api_models::admin::PaymentLinkConfig,
+ api_models::disputes::DisputeResponse,
+ api_models::disputes::DisputeResponsePaymentsRetrieve,
+ api_models::gsm::GsmCreateRequest,
+ api_models::gsm::GsmRetrieveRequest,
+ api_models::gsm::GsmUpdateRequest,
+ api_models::gsm::GsmDeleteRequest,
+ api_models::gsm::GsmDeleteResponse,
+ api_models::gsm::GsmResponse,
+ api_models::gsm::GsmDecision,
+ api_models::payments::AddressDetails,
+ api_models::payments::BankDebitData,
+ api_models::payments::AliPayQr,
+ api_models::payments::AliPayRedirection,
+ api_models::payments::MomoRedirection,
+ api_models::payments::TouchNGoRedirection,
+ api_models::payments::GcashRedirection,
+ api_models::payments::KakaoPayRedirection,
+ api_models::payments::AliPayHkRedirection,
+ api_models::payments::GoPayRedirection,
+ api_models::payments::MbWayRedirection,
+ api_models::payments::MobilePayRedirection,
+ api_models::payments::WeChatPayRedirection,
+ api_models::payments::WeChatPayQr,
+ api_models::payments::BankDebitBilling,
+ api_models::payments::CryptoData,
+ api_models::payments::RewardData,
+ api_models::payments::UpiData,
+ api_models::payments::UpiCollectData,
+ api_models::payments::UpiIntentData,
+ api_models::payments::VoucherData,
+ api_models::payments::BoletoVoucherData,
+ api_models::payments::AlfamartVoucherData,
+ api_models::payments::IndomaretVoucherData,
+ api_models::payments::Address,
+ api_models::payments::VoucherData,
+ api_models::payments::JCSVoucherData,
+ api_models::payments::AlfamartVoucherData,
+ api_models::payments::IndomaretVoucherData,
+ api_models::payments::BankRedirectData,
+ api_models::payments::RealTimePaymentData,
+ api_models::payments::BankRedirectBilling,
+ api_models::payments::BankRedirectBilling,
+ api_models::payments::ConnectorMetadata,
+ api_models::payments::FeatureMetadata,
+ api_models::payments::ApplepayConnectorMetadataRequest,
+ api_models::payments::SessionTokenInfo,
+ api_models::payments::PaymentProcessingDetailsAt,
+ api_models::payments::ApplepayInitiative,
+ api_models::payments::PaymentProcessingDetails,
+ api_models::payments::PaymentMethodDataResponseWithBilling,
+ api_models::payments::PaymentMethodDataResponse,
+ api_models::payments::CardResponse,
+ api_models::payments::PaylaterResponse,
+ api_models::payments::KlarnaSdkPaymentMethodResponse,
+ api_models::payments::SwishQrData,
+ api_models::payments::AirwallexData,
+ api_models::payments::NoonData,
+ api_models::payments::OrderDetails,
+ api_models::payments::OrderDetailsWithAmount,
+ api_models::payments::NextActionType,
+ api_models::payments::WalletData,
+ api_models::payments::NextActionData,
+ api_models::payments::PayLaterData,
+ api_models::payments::MandateData,
+ api_models::payments::PhoneDetails,
+ api_models::payments::PaymentMethodData,
+ api_models::payments::PaymentMethodDataRequest,
+ api_models::payments::MandateType,
+ api_models::payments::AcceptanceType,
+ api_models::payments::MandateAmountData,
+ api_models::payments::OnlineMandate,
+ api_models::payments::Card,
+ api_models::payments::CardRedirectData,
+ api_models::payments::CardToken,
+ api_models::payments::CustomerAcceptance,
+ api_models::payments::PaymentsRequest,
+ api_models::payments::PaymentsCreateRequest,
+ api_models::payments::PaymentsUpdateRequest,
+ api_models::payments::PaymentsConfirmRequest,
+ api_models::payments::PaymentsResponse,
+ api_models::payments::PaymentsCreateResponseOpenApi,
+ api_models::payments::PaymentsStartRequest,
+ api_models::payments::PaymentRetrieveBody,
+ api_models::payments::PaymentsRetrieveRequest,
+ api_models::payments::PaymentIdType,
+ api_models::payments::PaymentsCaptureRequest,
+ api_models::payments::PaymentsSessionRequest,
+ api_models::payments::PaymentsSessionResponse,
+ api_models::payments::SessionToken,
+ api_models::payments::ApplePaySessionResponse,
+ api_models::payments::ThirdPartySdkSessionResponse,
+ api_models::payments::NoThirdPartySdkSessionResponse,
+ api_models::payments::SecretInfoToInitiateSdk,
+ api_models::payments::ApplePayPaymentRequest,
+ api_models::payments::ApplePayBillingContactFields,
+ api_models::payments::ApplePayShippingContactFields,
+ api_models::payments::ApplePayAddressParameters,
+ api_models::payments::AmountInfo,
+ api_models::payments::ProductType,
+ api_models::payments::GooglePayWalletData,
+ api_models::payments::PayPalWalletData,
+ api_models::payments::PaypalRedirection,
+ api_models::payments::GpayMerchantInfo,
+ api_models::payments::GpayAllowedPaymentMethods,
+ api_models::payments::GpayAllowedMethodsParameters,
+ api_models::payments::GpayTokenizationSpecification,
+ api_models::payments::GpayTokenParameters,
+ api_models::payments::GpayTransactionInfo,
+ api_models::payments::GpaySessionTokenResponse,
+ api_models::payments::GooglePayThirdPartySdkData,
+ api_models::payments::KlarnaSessionTokenResponse,
+ api_models::payments::PaypalSessionTokenResponse,
+ api_models::payments::ApplepaySessionTokenResponse,
+ api_models::payments::SdkNextAction,
+ api_models::payments::NextActionCall,
+ api_models::payments::SdkNextActionData,
+ api_models::payments::SamsungPayWalletData,
+ api_models::payments::WeChatPay,
+ api_models::payments::GpayTokenizationData,
+ api_models::payments::GooglePayPaymentMethodInfo,
+ api_models::payments::ApplePayWalletData,
+ api_models::payments::ApplepayPaymentMethod,
+ api_models::payments::PaymentsCancelRequest,
+ api_models::payments::PaymentListConstraints,
+ api_models::payments::PaymentListResponse,
+ api_models::payments::CashappQr,
+ api_models::payments::BankTransferData,
+ api_models::payments::BankTransferNextStepsData,
+ api_models::payments::SepaAndBacsBillingDetails,
+ api_models::payments::AchBillingDetails,
+ api_models::payments::MultibancoBillingDetails,
+ api_models::payments::DokuBillingDetails,
+ api_models::payments::BankTransferInstructions,
+ api_models::payments::ReceiverDetails,
+ api_models::payments::AchTransfer,
+ api_models::payments::MultibancoTransferInstructions,
+ api_models::payments::DokuBankTransferInstructions,
+ api_models::payments::ApplePayRedirectData,
+ api_models::payments::ApplePayThirdPartySdkData,
+ api_models::payments::GooglePayRedirectData,
+ api_models::payments::GooglePayThirdPartySdk,
+ api_models::payments::GooglePaySessionResponse,
+ api_models::payments::GpayShippingAddressParameters,
+ api_models::payments::GpayBillingAddressParameters,
+ api_models::payments::GpayBillingAddressFormat,
+ api_models::payments::SepaBankTransferInstructions,
+ api_models::payments::BacsBankTransferInstructions,
+ api_models::payments::RedirectResponse,
+ api_models::payments::RequestSurchargeDetails,
+ api_models::payments::PaymentAttemptResponse,
+ api_models::payments::CaptureResponse,
+ api_models::payments::PaymentsIncrementalAuthorizationRequest,
+ api_models::payments::IncrementalAuthorizationResponse,
+ api_models::payments::PaymentsCompleteAuthorizeRequest,
+ api_models::payments::PaymentsExternalAuthenticationRequest,
+ api_models::payments::PaymentsExternalAuthenticationResponse,
+ api_models::payments::SdkInformation,
+ api_models::payments::DeviceChannel,
+ api_models::payments::ThreeDsCompletionIndicator,
+ api_models::payments::MifinityData,
+ api_models::enums::TransactionStatus,
+ api_models::payments::BrowserInformation,
+ api_models::payments::PaymentCreatePaymentLinkConfig,
+ api_models::payments::ThreeDsData,
+ api_models::payments::ThreeDsMethodData,
+ api_models::payments::PollConfigResponse,
+ api_models::payments::ExternalAuthenticationDetailsResponse,
+ api_models::payments::ExtendedCardInfo,
+ api_models::payment_methods::RequiredFieldInfo,
+ api_models::payment_methods::DefaultPaymentMethod,
+ api_models::payment_methods::MaskedBankDetails,
+ api_models::payment_methods::SurchargeDetailsResponse,
+ api_models::payment_methods::SurchargeResponse,
+ api_models::payment_methods::SurchargePercentage,
+ api_models::payment_methods::PaymentMethodCollectLinkRequest,
+ api_models::payment_methods::PaymentMethodCollectLinkResponse,
+ api_models::refunds::RefundListRequest,
+ api_models::refunds::RefundListResponse,
+ api_models::payments::TimeRange,
+ api_models::payments::AmountFilter,
+ api_models::mandates::MandateRevokedResponse,
+ api_models::mandates::MandateResponse,
+ api_models::mandates::MandateCardDetails,
+ api_models::mandates::RecurringDetails,
+ api_models::mandates::ProcessorPaymentToken,
+ api_models::ephemeral_key::EphemeralKeyCreateResponse,
+ api_models::payments::CustomerDetails,
+ api_models::payments::GiftCardData,
+ api_models::payments::GiftCardDetails,
+ api_models::payments::Address,
+ api_models::payouts::CardPayout,
+ api_models::payouts::Wallet,
+ api_models::payouts::Paypal,
+ api_models::payouts::Venmo,
+ api_models::payouts::AchBankTransfer,
+ api_models::payouts::BacsBankTransfer,
+ api_models::payouts::SepaBankTransfer,
+ api_models::payouts::PixBankTransfer,
+ api_models::payouts::PayoutRequest,
+ api_models::payouts::PayoutAttemptResponse,
+ api_models::payouts::PayoutActionRequest,
+ api_models::payouts::PayoutCreateRequest,
+ api_models::payouts::PayoutCreateResponse,
+ api_models::payouts::PayoutListConstraints,
+ api_models::payouts::PayoutListFilterConstraints,
+ api_models::payouts::PayoutListResponse,
+ api_models::payouts::PayoutRetrieveBody,
+ api_models::payouts::PayoutRetrieveRequest,
+ api_models::payouts::PayoutMethodData,
+ api_models::payouts::PayoutLinkResponse,
+ api_models::payouts::Bank,
+ api_models::payouts::PayoutCreatePayoutLinkConfig,
+ api_models::enums::PayoutEntityType,
+ api_models::enums::PayoutSendPriority,
+ api_models::enums::PayoutStatus,
+ api_models::enums::PayoutType,
+ api_models::enums::TransactionType,
+ api_models::payments::FrmMessage,
+ api_models::webhooks::OutgoingWebhook,
+ api_models::webhooks::OutgoingWebhookContent,
+ api_models::enums::EventClass,
+ api_models::enums::EventType,
+ api_models::enums::DecoupledAuthenticationType,
+ api_models::enums::AuthenticationStatus,
+ api_models::admin::MerchantAccountResponse,
+ api_models::admin::MerchantConnectorId,
+ api_models::admin::MerchantDetails,
+ api_models::admin::ToggleKVRequest,
+ api_models::admin::ToggleKVResponse,
+ api_models::admin::WebhookDetails,
+ api_models::api_keys::ApiKeyExpiration,
+ api_models::api_keys::CreateApiKeyRequest,
+ api_models::api_keys::CreateApiKeyResponse,
+ api_models::api_keys::RetrieveApiKeyResponse,
+ api_models::api_keys::RevokeApiKeyResponse,
+ api_models::api_keys::UpdateApiKeyRequest,
+ api_models::payments::RetrievePaymentLinkRequest,
+ api_models::payments::PaymentLinkResponse,
+ api_models::payments::RetrievePaymentLinkResponse,
+ api_models::payments::PaymentLinkInitiateRequest,
+ api_models::payouts::PayoutLinkInitiateRequest,
+ api_models::payments::ExtendedCardInfoResponse,
+ api_models::payments::GooglePayAssuranceDetails,
+ api_models::routing::RoutingConfigRequest,
+ api_models::routing::RoutingDictionaryRecord,
+ api_models::routing::RoutingKind,
+ api_models::routing::RoutableConnectorChoice,
+ api_models::routing::LinkedRoutingConfigRetrieveResponse,
+ api_models::routing::RoutingRetrieveResponse,
+ api_models::routing::ProfileDefaultRoutingConfig,
+ api_models::routing::MerchantRoutingAlgorithm,
+ api_models::routing::RoutingAlgorithmKind,
+ api_models::routing::RoutingDictionary,
+ api_models::routing::RoutingAlgorithm,
+ api_models::routing::StraightThroughAlgorithm,
+ api_models::routing::ConnectorVolumeSplit,
+ api_models::routing::ConnectorSelection,
+ api_models::routing::ast::RoutableChoiceKind,
+ api_models::enums::RoutableConnectors,
+ api_models::routing::ast::ProgramConnectorSelection,
+ api_models::routing::ast::RuleConnectorSelection,
+ api_models::routing::ast::IfStatement,
+ api_models::routing::ast::Comparison,
+ api_models::routing::ast::ComparisonType,
+ api_models::routing::ast::ValueType,
+ api_models::routing::ast::MetadataValue,
+ api_models::routing::ast::NumberComparison,
+ api_models::payment_methods::RequestPaymentMethodTypes,
+ api_models::payments::PaymentLinkStatus,
+ api_models::blocklist::BlocklistRequest,
+ api_models::blocklist::BlocklistResponse,
+ api_models::blocklist::ToggleBlocklistResponse,
+ api_models::blocklist::ListBlocklistQuery,
+ api_models::enums::BlocklistDataKind,
+ api_models::webhook_events::EventListItemResponse,
+ api_models::webhook_events::EventRetrieveResponse,
+ api_models::webhook_events::OutgoingWebhookRequestContent,
+ api_models::webhook_events::OutgoingWebhookResponseContent,
+ api_models::enums::WebhookDeliveryAttempt,
+ api_models::enums::PaymentChargeType,
+ api_models::enums::StripeChargeType,
+ api_models::payments::PaymentChargeRequest,
+ api_models::payments::PaymentChargeResponse,
+ api_models::refunds::ChargeRefunds,
+ api_models::payments::CustomerDetailsResponse,
+ api_models::payments::OpenBankingData,
+ api_models::payments::OpenBankingSessionToken,
+ )),
+ modifiers(&SecurityAddon)
+)]
+// Bypass clippy lint for not being constructed
+#[allow(dead_code)]
+pub(crate) struct ApiDoc;
+
+struct SecurityAddon;
+
+impl utoipa::Modify for SecurityAddon {
+ fn modify(&self, openapi: &mut utoipa::openapi::OpenApi) {
+ use utoipa::openapi::security::{ApiKey, ApiKeyValue, SecurityScheme};
+
+ if let Some(components) = openapi.components.as_mut() {
+ components.add_security_schemes_from_iter([
+ (
+ "api_key",
+ SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::with_description(
+ "api-key",
+ "Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application."
+ ))),
+ ),
+ (
+ "admin_api_key",
+ SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::with_description(
+ "api-key",
+ "Admin API keys allow you to perform some privileged actions such as \
+ creating a merchant account and Merchant Connector account."
+ ))),
+ ),
+ (
+ "publishable_key",
+ SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::with_description(
+ "api-key",
+ "Publishable keys are a type of keys that can be public and have limited \
+ scope of usage."
+ ))),
+ ),
+ (
+ "ephemeral_key",
+ SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::with_description(
+ "api-key",
+ "Ephemeral keys provide temporary access to singular data, such as access \
+ to a single customer object for a short period of time."
+ ))),
+ ),
+ ]);
+ }
+ }
+}
diff --git a/crates/openapi/src/routes/merchant_connector_account.rs b/crates/openapi/src/routes/merchant_connector_account.rs
index ebd2fb8793d..d09414d16f6 100644
--- a/crates/openapi/src/routes/merchant_connector_account.rs
+++ b/crates/openapi/src/routes/merchant_connector_account.rs
@@ -1,6 +1,7 @@
/// Merchant Connector - Create
///
/// Creates a new Merchant Connector for the merchant account. The connector could be a payment processor/facilitator/acquirer or a provider of specialized services like Fraud/Accounting etc.
+#[cfg(feature = "v1")]
#[utoipa::path(
post,
path = "/accounts/{account_id}/connectors",
@@ -10,7 +11,7 @@
(
"Create a merchant connector account with minimal fields" = (
value = json!({
- "connector_type": "fiz_operations",
+ "connector_type": "payment_processor",
"connector_name": "adyen",
"connector_account_details": {
"auth_type": "BodyKey",
@@ -23,7 +24,7 @@
(
"Create a merchant connector account under a specific business profile" = (
value = json!({
- "connector_type": "fiz_operations",
+ "connector_type": "payment_processor",
"connector_name": "adyen",
"connector_account_details": {
"auth_type": "BodyKey",
@@ -37,7 +38,67 @@
(
"Create a merchant account with custom connector label" = (
value = json!({
- "connector_type": "fiz_operations",
+ "connector_type": "payment_processor",
+ "connector_name": "adyen",
+ "connector_label": "EU_adyen",
+ "connector_account_details": {
+ "auth_type": "BodyKey",
+ "api_key": "{{adyen-api-key}}",
+ "key1": "{{adyen_merchant_account}}"
+ }
+ })
+ )
+ ),
+ )
+ ),
+ responses(
+ (status = 200, description = "Merchant Connector Created", body = MerchantConnectorResponse),
+ (status = 400, description = "Missing Mandatory fields"),
+ ),
+ tag = "Merchant Connector Account",
+ operation_id = "Create a Merchant Connector",
+ security(("admin_api_key" = []))
+)]
+pub async fn connector_create() {}
+
+#[cfg(feature = "v2")]
+#[utoipa::path(
+ post,
+ path = "/connector_accounts",
+ request_body(
+ content = MerchantConnectorCreate,
+ examples(
+ (
+ "Create a merchant connector account with minimal fields" = (
+ value = json!({
+ "connector_type": "payment_processor",
+ "connector_name": "adyen",
+ "connector_account_details": {
+ "auth_type": "BodyKey",
+ "api_key": "{{adyen-api-key}}",
+ "key1": "{{adyen_merchant_account}}"
+ }
+ })
+ )
+ ),
+ (
+ "Create a merchant connector account under a specific business profile" = (
+ value = json!({
+ "connector_type": "payment_processor",
+ "connector_name": "adyen",
+ "connector_account_details": {
+ "auth_type": "BodyKey",
+ "api_key": "{{adyen-api-key}}",
+ "key1": "{{adyen_merchant_account}}"
+ },
+ "profile_id": "{{profile_id}}"
+ })
+ )
+ ),
+ (
+ "Create a merchant account with custom connector label" = (
+ value = json!({
+ "connector_type": "payment_processor",
"connector_name": "adyen",
"connector_label": "EU_adyen",
"connector_account_details": {
@@ -63,6 +124,7 @@ pub async fn connector_create() {}
/// Merchant Connector - Retrieve
///
/// Retrieves details of a Connector account
+#[cfg(feature = "v1")]
#[utoipa::path(
get,
path = "/accounts/{account_id}/connectors/{connector_id}",
@@ -81,6 +143,24 @@ pub async fn connector_create() {}
)]
pub async fn connector_retrieve() {}
+#[cfg(feature = "v2")]
+#[utoipa::path(
+ get,
+ path = "/connector_accounts/{id}",
+ params(
+ ("id" = i32, Path, description = "The unique identifier for the Merchant Connector")
+ ),
+ responses(
+ (status = 200, description = "Merchant Connector retrieved successfully", body = MerchantConnectorResponse),
+ (status = 404, description = "Merchant Connector does not exist in records"),
+ (status = 401, description = "Unauthorized request")
+ ),
+ tag = "Merchant Connector Account",
+ operation_id = "Retrieve a Merchant Connector",
+ security(("admin_api_key" = []))
+)]
+pub async fn connector_retrieve() {}
+
/// Merchant Connector - List
///
/// List Merchant Connector Details for the merchant
@@ -104,6 +184,7 @@ pub async fn payment_connector_list() {}
/// Merchant Connector - Update
///
/// To update an existing Merchant Connector account. Helpful in enabling/disabling different payment methods and other settings for the connector
+#[cfg(feature = "v1")]
#[utoipa::path(
post,
path = "/accounts/{account_id}/connectors/{connector_id}",
@@ -113,7 +194,7 @@ pub async fn payment_connector_list() {}
(
"Enable card payment method" = (
value = json! ({
- "connector_type": "fiz_operations",
+ "connector_type": "payment_processor",
"payment_methods_enabled": [
{
"payment_method": "card"
@@ -148,9 +229,54 @@ pub async fn payment_connector_list() {}
)]
pub async fn connector_update() {}
+#[cfg(feature = "v2")]
+#[utoipa::path(
+ post,
+ path = "/connector_accounts/{id}",
+ request_body(
+ content = MerchantConnectorUpdate,
+ examples(
+ (
+ "Enable card payment method" = (
+ value = json! ({
+ "connector_type": "payment_processor",
+ "payment_methods_enabled": [
+ {
+ "payment_method": "card"
+ }
+ ]
+ })
+ )
+ ),
+ (
+ "Update webhook secret" = (
+ value = json! ({
+ "connector_webhook_details": {
+ "merchant_secret": "{{webhook_secret}}"
+ }
+ })
+ )
+ )
+ ),
+ ),
+ params(
+ ("id" = i32, Path, description = "The unique identifier for the Merchant Connector")
+ ),
+ responses(
+ (status = 200, description = "Merchant Connector Updated", body = MerchantConnectorResponse),
+ (status = 404, description = "Merchant Connector does not exist in records"),
+ (status = 401, description = "Unauthorized request")
+ ),
+ tag = "Merchant Connector Account",
+ operation_id = "Update a Merchant Connector",
+ security(("admin_api_key" = []))
+)]
+pub async fn connector_update() {}
+
/// Merchant Connector - Delete
///
/// Delete or Detach a Merchant Connector from Merchant Account
+#[cfg(feature = "v1")]
#[utoipa::path(
delete,
path = "/accounts/{account_id}/connectors/{connector_id}",
@@ -168,3 +294,21 @@ pub async fn connector_update() {}
security(("admin_api_key" = []))
)]
pub async fn connector_delete() {}
+
+#[cfg(feature = "v2")]
+#[utoipa::path(
+ delete,
+ path = "/connector_accounts/{id}",
+ params(
+ ("id" = i32, Path, description = "The unique identifier for the Merchant Connector")
+ ),
+ responses(
+ (status = 200, description = "Merchant Connector Deleted", body = MerchantConnectorDeleteResponse),
+ (status = 404, description = "Merchant Connector does not exist in records"),
+ (status = 401, description = "Unauthorized request")
+ ),
+ tag = "Merchant Connector Account",
+ operation_id = "Delete a Merchant Connector",
+ security(("admin_api_key" = []))
+)]
+pub async fn connector_delete() {}
|
refactor
|
add openapi support for generating v2 api-reference (#5580)
|
89cb63be3328010d26b5f6322449fc50e80593e4
|
2023-10-01 23:48:02
|
korrat
|
refactor(connector): [Klarna] Expand wildcard match arms (#2403)
| false
|
diff --git a/crates/router/src/connector/klarna.rs b/crates/router/src/connector/klarna.rs
index 220b8f4a416..1814f9de809 100644
--- a/crates/router/src/connector/klarna.rs
+++ b/crates/router/src/connector/klarna.rs
@@ -288,12 +288,115 @@ impl
self.base_url(connectors),
token
)),
- _ => Err(error_stack::report!(errors::ConnectorError::NotSupported {
+ (
+ storage_enums::PaymentExperience::DisplayQrCode
+ | storage_enums::PaymentExperience::DisplayWaitScreen
+ | storage_enums::PaymentExperience::InvokePaymentApp
+ | storage_enums::PaymentExperience::InvokeSdkClient
+ | storage_enums::PaymentExperience::LinkWallet
+ | storage_enums::PaymentExperience::OneClick
+ | storage_enums::PaymentExperience::RedirectToUrl,
+ api_models::enums::PaymentMethodType::Ach
+ | api_models::enums::PaymentMethodType::Affirm
+ | api_models::enums::PaymentMethodType::AfterpayClearpay
+ | api_models::enums::PaymentMethodType::Alfamart
+ | api_models::enums::PaymentMethodType::AliPay
+ | api_models::enums::PaymentMethodType::AliPayHk
+ | api_models::enums::PaymentMethodType::Alma
+ | api_models::enums::PaymentMethodType::ApplePay
+ | api_models::enums::PaymentMethodType::Atome
+ | api_models::enums::PaymentMethodType::Bacs
+ | api_models::enums::PaymentMethodType::BancontactCard
+ | api_models::enums::PaymentMethodType::Becs
+ | api_models::enums::PaymentMethodType::Benefit
+ | api_models::enums::PaymentMethodType::Bizum
+ | api_models::enums::PaymentMethodType::Blik
+ | api_models::enums::PaymentMethodType::Boleto
+ | api_models::enums::PaymentMethodType::BcaBankTransfer
+ | api_models::enums::PaymentMethodType::BniVa
+ | api_models::enums::PaymentMethodType::BriVa
+ | api_models::enums::PaymentMethodType::CimbVa
+ | api_models::enums::PaymentMethodType::ClassicReward
+ | api_models::enums::PaymentMethodType::Credit
+ | api_models::enums::PaymentMethodType::CryptoCurrency
+ | api_models::enums::PaymentMethodType::Cashapp
+ | api_models::enums::PaymentMethodType::Dana
+ | api_models::enums::PaymentMethodType::DanamonVa
+ | api_models::enums::PaymentMethodType::Debit
+ | api_models::enums::PaymentMethodType::Efecty
+ | api_models::enums::PaymentMethodType::Eps
+ | api_models::enums::PaymentMethodType::Evoucher
+ | api_models::enums::PaymentMethodType::Giropay
+ | api_models::enums::PaymentMethodType::Givex
+ | api_models::enums::PaymentMethodType::GooglePay
+ | api_models::enums::PaymentMethodType::GoPay
+ | api_models::enums::PaymentMethodType::Gcash
+ | api_models::enums::PaymentMethodType::Ideal
+ | api_models::enums::PaymentMethodType::Interac
+ | api_models::enums::PaymentMethodType::Indomaret
+ | api_models::enums::PaymentMethodType::Klarna
+ | api_models::enums::PaymentMethodType::KakaoPay
+ | api_models::enums::PaymentMethodType::MandiriVa
+ | api_models::enums::PaymentMethodType::Knet
+ | api_models::enums::PaymentMethodType::MbWay
+ | api_models::enums::PaymentMethodType::MobilePay
+ | api_models::enums::PaymentMethodType::Momo
+ | api_models::enums::PaymentMethodType::MomoAtm
+ | api_models::enums::PaymentMethodType::Multibanco
+ | api_models::enums::PaymentMethodType::OnlineBankingThailand
+ | api_models::enums::PaymentMethodType::OnlineBankingCzechRepublic
+ | api_models::enums::PaymentMethodType::OnlineBankingFinland
+ | api_models::enums::PaymentMethodType::OnlineBankingFpx
+ | api_models::enums::PaymentMethodType::OnlineBankingPoland
+ | api_models::enums::PaymentMethodType::OnlineBankingSlovakia
+ | api_models::enums::PaymentMethodType::Oxxo
+ | api_models::enums::PaymentMethodType::PagoEfectivo
+ | api_models::enums::PaymentMethodType::PermataBankTransfer
+ | api_models::enums::PaymentMethodType::OpenBankingUk
+ | api_models::enums::PaymentMethodType::PayBright
+ | api_models::enums::PaymentMethodType::Paypal
+ | api_models::enums::PaymentMethodType::Pix
+ | api_models::enums::PaymentMethodType::PaySafeCard
+ | api_models::enums::PaymentMethodType::Przelewy24
+ | api_models::enums::PaymentMethodType::Pse
+ | api_models::enums::PaymentMethodType::RedCompra
+ | api_models::enums::PaymentMethodType::RedPagos
+ | api_models::enums::PaymentMethodType::SamsungPay
+ | api_models::enums::PaymentMethodType::Sepa
+ | api_models::enums::PaymentMethodType::Sofort
+ | api_models::enums::PaymentMethodType::Swish
+ | api_models::enums::PaymentMethodType::TouchNGo
+ | api_models::enums::PaymentMethodType::Trustly
+ | api_models::enums::PaymentMethodType::Twint
+ | api_models::enums::PaymentMethodType::UpiCollect
+ | api_models::enums::PaymentMethodType::Vipps
+ | api_models::enums::PaymentMethodType::Walley
+ | api_models::enums::PaymentMethodType::WeChatPay
+ | api_models::enums::PaymentMethodType::SevenEleven
+ | api_models::enums::PaymentMethodType::Lawson
+ | api_models::enums::PaymentMethodType::MiniStop
+ | api_models::enums::PaymentMethodType::FamilyMart
+ | api_models::enums::PaymentMethodType::Seicomart
+ | api_models::enums::PaymentMethodType::PayEasy,
+ ) => Err(error_stack::report!(errors::ConnectorError::NotSupported {
message: payment_method_type.to_string(),
connector: "klarna",
})),
},
- _ => Err(error_stack::report!(
+
+ api_payments::PaymentMethodData::Card(_)
+ | api_payments::PaymentMethodData::CardRedirect(_)
+ | api_payments::PaymentMethodData::Wallet(_)
+ | api_payments::PaymentMethodData::PayLater(_)
+ | api_payments::PaymentMethodData::BankRedirect(_)
+ | api_payments::PaymentMethodData::BankDebit(_)
+ | api_payments::PaymentMethodData::BankTransfer(_)
+ | api_payments::PaymentMethodData::Crypto(_)
+ | api_payments::PaymentMethodData::MandatePayment
+ | api_payments::PaymentMethodData::Reward
+ | api_payments::PaymentMethodData::Upi(_)
+ | api_payments::PaymentMethodData::Voucher(_)
+ | api_payments::PaymentMethodData::GiftCard(_) => Err(error_stack::report!(
errors::ConnectorError::MismatchedPaymentData
)),
}
|
refactor
|
[Klarna] Expand wildcard match arms (#2403)
|
4b0564e0e8ad678d8a58832d664eeef01e4a825c
|
2024-09-02 05:54:33
|
github-actions
|
chore(version): 2024.09.02.0
| false
|
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 770f71f6063..09ba040ff70 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,30 @@ All notable changes to HyperSwitch will be documented here.
- - -
+## 2024.09.02.0
+
+### Features
+
+- **connector:** [WELLSFARGO] Remove Wallet Configs ([#5739](https://github.com/juspay/hyperswitch/pull/5739)) ([`2cf0571`](https://github.com/juspay/hyperswitch/commit/2cf05712b2d40a772947f7a09b09a34367899f09))
+
+### Bug Fixes
+
+- **cypress:** Fix undefined errors in auto-retries ([#5750](https://github.com/juspay/hyperswitch/pull/5750)) ([`3798319`](https://github.com/juspay/hyperswitch/commit/379831932a9c1e73b669f40af75cd02e682a0ec7))
+
+### Refactors
+
+- **core:** Make the ppt token flow to accept optional mca_id ([#5744](https://github.com/juspay/hyperswitch/pull/5744)) ([`f682b57`](https://github.com/juspay/hyperswitch/commit/f682b570dd1f90388279c7011ae16f7f81056804))
+- **users:** Add V2 user_roles data support ([#5763](https://github.com/juspay/hyperswitch/pull/5763)) ([`6b41050`](https://github.com/juspay/hyperswitch/commit/6b410505da3a2dbceaf6f07bb3f19f3ceef4efe2))
+
+### Miscellaneous Tasks
+
+- **config:** Add support for some more country and currencies for Mifinity Wallet ([#5639](https://github.com/juspay/hyperswitch/pull/5639)) ([`f7f5ba7`](https://github.com/juspay/hyperswitch/commit/f7f5ba7c0bbf694dbeecec73f8383ac678dd4425))
+- **postman:** Update Postman collection files ([`6342cdc`](https://github.com/juspay/hyperswitch/commit/6342cdcaa4ca8de259aade9a3ca892eb62c2ab73))
+
+**Full Changelog:** [`2024.08.30.0...2024.09.02.0`](https://github.com/juspay/hyperswitch/compare/2024.08.30.0...2024.09.02.0)
+
+- - -
+
## 2024.08.30.0
### Features
|
chore
|
2024.09.02.0
|
e296a49b623004784cece505ab08b172a5aa796c
|
2023-06-23 20:14:36
|
Shankar Singh C
|
fix(connector): fix url_encode issue for paypal and payu (#1534)
| false
|
diff --git a/crates/router/src/connector/paypal.rs b/crates/router/src/connector/paypal.rs
index 2547947c201..28188ae6405 100644
--- a/crates/router/src/connector/paypal.rs
+++ b/crates/router/src/connector/paypal.rs
@@ -248,7 +248,7 @@ impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, t
let req_obj = paypal::PaypalAuthUpdateRequest::try_from(req)?;
let paypal_req = types::RequestBody::log_and_get_request_body(
&req_obj,
- utils::Encode::<paypal::PaypalAuthUpdateRequest>::encode_to_string_of_json,
+ utils::Encode::<paypal::PaypalAuthUpdateRequest>::url_encode,
)
.change_context(errors::ConnectorError::RequestEncodingFailed)?;
diff --git a/crates/router/src/connector/payu.rs b/crates/router/src/connector/payu.rs
index 959dcd5939a..0875fe29b4c 100644
--- a/crates/router/src/connector/payu.rs
+++ b/crates/router/src/connector/payu.rs
@@ -225,7 +225,7 @@ impl ConnectorIntegration<api::AccessTokenAuth, types::AccessTokenRequestData, t
let req_obj = payu::PayuAuthUpdateRequest::try_from(req)?;
let payu_req = types::RequestBody::log_and_get_request_body(
&req_obj,
- utils::Encode::<payu::PayuAuthUpdateRequest>::encode_to_string_of_json,
+ utils::Encode::<payu::PayuAuthUpdateRequest>::url_encode,
)
.change_context(errors::ConnectorError::RequestEncodingFailed)?;
|
fix
|
fix url_encode issue for paypal and payu (#1534)
|
9c49ded104b81f1aefcc288e3ded64ebbd4d466f
|
2024-06-27 13:06:31
|
Sandeep Kumar
|
fix(opensearch): show search results only if user has access permission to the index (#5097)
| false
|
diff --git a/crates/analytics/src/opensearch.rs b/crates/analytics/src/opensearch.rs
index e8f87aaef2e..b8c582df1bf 100644
--- a/crates/analytics/src/opensearch.rs
+++ b/crates/analytics/src/opensearch.rs
@@ -20,7 +20,6 @@ use opensearch::{
};
use serde_json::{json, Value};
use storage_impl::errors::ApplicationError;
-use strum::IntoEnumIterator;
use super::{health_check::HealthCheck, query::QueryResult, types::QueryExecutionError};
use crate::query::QueryBuildingError;
@@ -78,6 +77,10 @@ pub enum OpenSearchError {
QueryBuildingError,
#[error("Opensearch deserialisation error")]
DeserialisationError,
+ #[error("Opensearch index access not present error: {0:?}")]
+ IndexAccessNotPermittedError(SearchIndex),
+ #[error("Opensearch unknown error")]
+ UnknownError,
}
impl ErrorSwitch<OpenSearchError> for QueryBuildingError {
@@ -97,28 +100,39 @@ impl ErrorSwitch<ApiErrorResponse> for OpenSearchError {
)),
Self::ResponseNotOK(response) => ApiErrorResponse::InternalServerError(ApiError::new(
"IR",
- 0,
+ 1,
format!("Something went wrong {}", response),
None,
)),
Self::ResponseError => ApiErrorResponse::InternalServerError(ApiError::new(
"IR",
- 0,
+ 2,
"Something went wrong",
None,
)),
Self::QueryBuildingError => ApiErrorResponse::InternalServerError(ApiError::new(
"IR",
- 0,
+ 3,
"Query building error",
None,
)),
Self::DeserialisationError => ApiErrorResponse::InternalServerError(ApiError::new(
"IR",
- 0,
+ 4,
"Deserialisation error",
None,
)),
+ Self::IndexAccessNotPermittedError(index) => {
+ ApiErrorResponse::ForbiddenCommonResource(ApiError::new(
+ "IR",
+ 5,
+ format!("Index access not permitted: {index:?}"),
+ None,
+ ))
+ }
+ Self::UnknownError => {
+ ApiErrorResponse::InternalServerError(ApiError::new("IR", 6, "Unknown error", None))
+ }
}
}
}
@@ -179,18 +193,16 @@ impl OpenSearchClient {
query_builder: OpenSearchQueryBuilder,
) -> CustomResult<Response, OpenSearchError> {
match query_builder.query_type {
- OpenSearchQuery::Msearch => {
- let search_indexes = SearchIndex::iter();
-
+ OpenSearchQuery::Msearch(ref indexes) => {
let payload = query_builder
- .construct_payload(search_indexes.clone().collect())
+ .construct_payload(indexes)
.change_context(OpenSearchError::QueryBuildingError)?;
- let payload_with_indexes = payload.into_iter().zip(search_indexes).fold(
+ let payload_with_indexes = payload.into_iter().zip(indexes).fold(
Vec::new(),
|mut payload_with_indexes, (index_hit, index)| {
payload_with_indexes.push(
- json!({"index": self.search_index_to_opensearch_index(index)}).into(),
+ json!({"index": self.search_index_to_opensearch_index(*index)}).into(),
);
payload_with_indexes.push(JsonBody::new(index_hit.clone()));
payload_with_indexes
@@ -207,7 +219,7 @@ impl OpenSearchClient {
OpenSearchQuery::Search(index) => {
let payload = query_builder
.clone()
- .construct_payload(vec![index])
+ .construct_payload(&[index])
.change_context(OpenSearchError::QueryBuildingError)?;
let final_payload = payload.first().unwrap_or(&Value::Null);
@@ -349,7 +361,7 @@ pub struct OpenSearchHealth {
#[derive(Debug, Clone)]
pub enum OpenSearchQuery {
- Msearch,
+ Msearch(Vec<SearchIndex>),
Search(SearchIndex),
}
@@ -384,7 +396,7 @@ impl OpenSearchQueryBuilder {
Ok(())
}
- pub fn construct_payload(&self, indexes: Vec<SearchIndex>) -> QueryResult<Vec<Value>> {
+ pub fn construct_payload(&self, indexes: &[SearchIndex]) -> QueryResult<Vec<Value>> {
let mut query =
vec![json!({"multi_match": {"type": "phrase", "query": self.query, "lenient": true}})];
diff --git a/crates/analytics/src/search.rs b/crates/analytics/src/search.rs
index 8810dc1e3a1..373ca3acbb6 100644
--- a/crates/analytics/src/search.rs
+++ b/crates/analytics/src/search.rs
@@ -1,11 +1,10 @@
use api_models::analytics::search::{
GetGlobalSearchRequest, GetSearchRequestWithIndex, GetSearchResponse, OpenMsearchOutput,
- OpensearchOutput, SearchIndex,
+ OpensearchOutput, SearchIndex, SearchStatus,
};
use common_utils::errors::{CustomResult, ReportSwitchExt};
use error_stack::ResultExt;
use router_env::tracing;
-use strum::IntoEnumIterator;
use crate::opensearch::{
OpenSearchClient, OpenSearchError, OpenSearchQuery, OpenSearchQueryBuilder,
@@ -15,8 +14,10 @@ pub async fn msearch_results(
client: &OpenSearchClient,
req: GetGlobalSearchRequest,
merchant_id: &String,
+ indexes: Vec<SearchIndex>,
) -> CustomResult<Vec<GetSearchResponse>, OpenSearchError> {
- let mut query_builder = OpenSearchQueryBuilder::new(OpenSearchQuery::Msearch, req.query);
+ let mut query_builder =
+ OpenSearchQueryBuilder::new(OpenSearchQuery::Msearch(indexes.clone()), req.query);
query_builder
.add_filter_clause("merchant_id".to_string(), merchant_id.to_string())
@@ -40,29 +41,19 @@ pub async fn msearch_results(
Ok(response_body
.responses
.into_iter()
- .zip(SearchIndex::iter())
+ .zip(indexes)
.map(|(index_hit, index)| match index_hit {
- OpensearchOutput::Success(success) => {
- if success.status == 200 {
- GetSearchResponse {
- count: success.hits.total.value,
- index,
- hits: success
- .hits
- .hits
- .into_iter()
- .map(|hit| hit.source)
- .collect(),
- }
- } else {
- tracing::error!("Unexpected status code: {}", success.status,);
- GetSearchResponse {
- count: 0,
- index,
- hits: Vec::new(),
- }
- }
- }
+ OpensearchOutput::Success(success) => GetSearchResponse {
+ count: success.hits.total.value,
+ index,
+ hits: success
+ .hits
+ .hits
+ .into_iter()
+ .map(|hit| hit.source)
+ .collect(),
+ status: SearchStatus::Success,
+ },
OpensearchOutput::Error(error) => {
tracing::error!(
index = ?index,
@@ -73,6 +64,7 @@ pub async fn msearch_results(
count: 0,
index,
hits: Vec::new(),
+ status: SearchStatus::Failure,
}
}
})
@@ -113,27 +105,17 @@ pub async fn search_results(
let response_body: OpensearchOutput = response_text;
match response_body {
- OpensearchOutput::Success(success) => {
- if success.status == 200 {
- Ok(GetSearchResponse {
- count: success.hits.total.value,
- index: req.index,
- hits: success
- .hits
- .hits
- .into_iter()
- .map(|hit| hit.source)
- .collect(),
- })
- } else {
- tracing::error!("Unexpected status code: {}", success.status);
- Ok(GetSearchResponse {
- count: 0,
- index: req.index,
- hits: Vec::new(),
- })
- }
- }
+ OpensearchOutput::Success(success) => Ok(GetSearchResponse {
+ count: success.hits.total.value,
+ index: req.index,
+ hits: success
+ .hits
+ .hits
+ .into_iter()
+ .map(|hit| hit.source)
+ .collect(),
+ status: SearchStatus::Success,
+ }),
OpensearchOutput::Error(error) => {
tracing::error!(
index = ?req.index,
@@ -144,6 +126,7 @@ pub async fn search_results(
count: 0,
index: req.index,
hits: Vec::new(),
+ status: SearchStatus::Failure,
})
}
}
diff --git a/crates/api_models/src/analytics/search.rs b/crates/api_models/src/analytics/search.rs
index c29bb0e9f71..a01349d987f 100644
--- a/crates/api_models/src/analytics/search.rs
+++ b/crates/api_models/src/analytics/search.rs
@@ -30,7 +30,9 @@ pub struct GetSearchRequestWithIndex {
pub search_req: GetSearchRequest,
}
-#[derive(Debug, strum::EnumIter, Clone, serde::Deserialize, serde::Serialize, Copy)]
+#[derive(
+ Debug, strum::EnumIter, Clone, serde::Deserialize, serde::Serialize, Copy, Eq, PartialEq,
+)]
#[serde(rename_all = "snake_case")]
pub enum SearchIndex {
PaymentAttempts,
@@ -39,17 +41,26 @@ pub enum SearchIndex {
Disputes,
}
+#[derive(Debug, strum::EnumIter, Clone, serde::Deserialize, serde::Serialize, Copy)]
+pub enum SearchStatus {
+ Success,
+ Failure,
+}
+
#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
#[serde(rename_all = "camelCase")]
pub struct GetSearchResponse {
pub count: u64,
pub index: SearchIndex,
pub hits: Vec<Value>,
+ pub status: SearchStatus,
}
#[derive(Debug, serde::Deserialize)]
pub struct OpenMsearchOutput {
+ #[serde(default)]
pub responses: Vec<OpensearchOutput>,
+ pub error: Option<OpensearchErrorDetails>,
}
#[derive(Debug, serde::Deserialize)]
@@ -74,7 +85,6 @@ pub struct OpensearchErrorDetails {
#[derive(Debug, serde::Deserialize)]
pub struct OpensearchSuccess {
- pub status: u16,
pub hits: OpensearchHits,
}
diff --git a/crates/router/src/analytics.rs b/crates/router/src/analytics.rs
index ae3b03f7b82..8d8910f7b2c 100644
--- a/crates/router/src/analytics.rs
+++ b/crates/router/src/analytics.rs
@@ -4,7 +4,7 @@ pub mod routes {
use actix_web::{web, Responder, Scope};
use analytics::{
api_event::api_events_core, connector_events::connector_events_core,
- errors::AnalyticsError, lambda_utils::invoke_lambda,
+ errors::AnalyticsError, lambda_utils::invoke_lambda, opensearch::OpenSearchError,
outgoing_webhook_event::outgoing_webhook_events_core, sdk_events::sdk_events_core,
AnalyticsFlow,
};
@@ -20,13 +20,14 @@ pub mod routes {
use error_stack::ResultExt;
use crate::{
- core::api_locking,
+ consts::opensearch::OPENSEARCH_INDEX_PERMISSIONS,
+ core::{api_locking, errors::user::UserErrors},
db::user::UserInterface,
routes::AppState,
services::{
api,
- authentication::{self as auth, AuthenticationData},
- authorization::permissions::Permission,
+ authentication::{self as auth, AuthenticationData, UserFromToken},
+ authorization::{permissions::Permission, roles::RoleInfo},
ApplicationResponse,
},
types::domain::UserEmail,
@@ -694,11 +695,25 @@ pub mod routes {
state.clone(),
&req,
json_payload.into_inner(),
- |state, auth: AuthenticationData, req, _| async move {
+ |state, auth: UserFromToken, req, _| async move {
+ let role_id = auth.role_id;
+ let role_info =
+ RoleInfo::from_role_id(&state, &role_id, &auth.merchant_id, &auth.org_id)
+ .await
+ .change_context(UserErrors::InternalServerError)
+ .change_context(OpenSearchError::UnknownError)?;
+ let permissions = role_info.get_permissions_set();
+ let accessible_indexes: Vec<_> = OPENSEARCH_INDEX_PERMISSIONS
+ .iter()
+ .filter(|(_, perm)| perm.iter().any(|p| permissions.contains(p)))
+ .map(|(i, _)| *i)
+ .collect();
+
analytics::search::msearch_results(
&state.opensearch_client,
req,
- &auth.merchant_account.merchant_id,
+ &auth.merchant_id,
+ accessible_indexes,
)
.await
.map(ApplicationResponse::Json)
@@ -715,24 +730,33 @@ pub mod routes {
json_payload: web::Json<GetSearchRequest>,
index: web::Path<SearchIndex>,
) -> impl Responder {
+ let index = index.into_inner();
let flow = AnalyticsFlow::GetSearchResults;
let indexed_req = GetSearchRequestWithIndex {
search_req: json_payload.into_inner(),
- index: index.into_inner(),
+ index,
};
Box::pin(api::server_wrap(
flow,
state.clone(),
&req,
indexed_req,
- |state, auth: AuthenticationData, req, _| async move {
- analytics::search::search_results(
- &state.opensearch_client,
- req,
- &auth.merchant_account.merchant_id,
- )
- .await
- .map(ApplicationResponse::Json)
+ |state, auth: UserFromToken, req, _| async move {
+ let role_id = auth.role_id;
+ let role_info =
+ RoleInfo::from_role_id(&state, &role_id, &auth.merchant_id, &auth.org_id)
+ .await
+ .change_context(UserErrors::InternalServerError)
+ .change_context(OpenSearchError::UnknownError)?;
+ let permissions = role_info.get_permissions_set();
+ let _ = OPENSEARCH_INDEX_PERMISSIONS
+ .iter()
+ .filter(|(ind, _)| *ind == index)
+ .find(|i| i.1.iter().any(|p| permissions.contains(p)))
+ .ok_or(OpenSearchError::IndexAccessNotPermittedError(index))?;
+ analytics::search::search_results(&state.opensearch_client, req, &auth.merchant_id)
+ .await
+ .map(ApplicationResponse::Json)
},
&auth::JWTAuth(Permission::Analytics),
api_locking::LockAction::NotApplicable,
diff --git a/crates/router/src/consts.rs b/crates/router/src/consts.rs
index 73ff7c428e4..bffc5241339 100644
--- a/crates/router/src/consts.rs
+++ b/crates/router/src/consts.rs
@@ -1,3 +1,4 @@
+pub mod opensearch;
#[cfg(feature = "olap")]
pub mod user;
pub mod user_role;
diff --git a/crates/router/src/consts/opensearch.rs b/crates/router/src/consts/opensearch.rs
new file mode 100644
index 00000000000..fc1c071439a
--- /dev/null
+++ b/crates/router/src/consts/opensearch.rs
@@ -0,0 +1,22 @@
+use api_models::analytics::search::SearchIndex;
+
+use crate::services::authorization::permissions::Permission;
+
+pub const OPENSEARCH_INDEX_PERMISSIONS: &[(SearchIndex, &[Permission])] = &[
+ (
+ SearchIndex::PaymentAttempts,
+ &[Permission::PaymentRead, Permission::PaymentWrite],
+ ),
+ (
+ SearchIndex::PaymentIntents,
+ &[Permission::PaymentRead, Permission::PaymentWrite],
+ ),
+ (
+ SearchIndex::Refunds,
+ &[Permission::RefundRead, Permission::RefundWrite],
+ ),
+ (
+ SearchIndex::Disputes,
+ &[Permission::DisputeRead, Permission::DisputeWrite],
+ ),
+];
diff --git a/crates/router/src/events.rs b/crates/router/src/events.rs
index 632989c4806..1bdd9016c49 100644
--- a/crates/router/src/events.rs
+++ b/crates/router/src/events.rs
@@ -83,7 +83,7 @@ impl EventsConfig {
impl EventsHandler {
pub fn log_event<T: KafkaMessage>(&self, event: &T) {
match self {
- Self::Kafka(kafka) => kafka.log_event(event).map_or((), |e| {
+ Self::Kafka(kafka) => kafka.log_event(event).unwrap_or_else(|e| {
logger::error!("Failed to log event: {:?}", e);
}),
Self::Logs(logger) => logger.log_event(event),
|
fix
|
show search results only if user has access permission to the index (#5097)
|
906d754944e78d75fc0e1f034abaebcf3045c1fe
|
2024-12-27 05:56:32
|
github-actions
|
chore(version): 2024.12.27.0
| false
|
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2bc0977570e..b7df3539fda 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@ All notable changes to HyperSwitch will be documented here.
- - -
+
## 2024.12.26.1
### Bug Fixes
|
chore
|
2024.12.27.0
|
91c8af6ef6d74cc3e0cb55c5f26ca1eae6907709
|
2024-06-18 14:46:31
|
Sanchith Hegde
|
chore(docker-compose): pass correct configuration values for running SDK demo app (#5012)
| false
|
diff --git a/docker-compose-development.yml b/docker-compose-development.yml
index 09750ba8448..868eeba2437 100644
--- a/docker-compose-development.yml
+++ b/docker-compose-development.yml
@@ -25,6 +25,12 @@ services:
- POSTGRES_USER=db_user
- POSTGRES_PASSWORD=db_pass
- POSTGRES_DB=hyperswitch_db
+ healthcheck:
+ test: ["CMD-SHELL", "pg_isready"]
+ interval: 5s
+ retries: 3
+ start_period: 5s
+ timeout: 5s
redis-standalone:
image: redis:7
@@ -32,6 +38,12 @@ services:
- router_net
ports:
- "6379:6379"
+ healthcheck:
+ test: ["CMD-SHELL", "redis-cli ping | grep '^PONG$'"]
+ interval: 5s
+ retries: 3
+ start_period: 5s
+ timeout: 5s
migration_runner:
image: rust:latest
@@ -64,6 +76,11 @@ services:
environment:
- CARGO_HOME=/cargo_cache
- CARGO_TARGET_DIR=/cargo_build_cache
+ depends_on:
+ pg:
+ condition: service_healthy
+ redis-standalone:
+ condition: service_healthy
labels:
logs: "promtail"
healthcheck:
diff --git a/docker-compose.yml b/docker-compose.yml
index c993262e744..d16f946a6e5 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -20,6 +20,12 @@ services:
- POSTGRES_USER=db_user
- POSTGRES_PASSWORD=db_pass
- POSTGRES_DB=hyperswitch_db
+ healthcheck:
+ test: ["CMD-SHELL", "pg_isready"]
+ interval: 5s
+ retries: 3
+ start_period: 5s
+ timeout: 5s
redis-standalone:
image: redis:7
@@ -27,6 +33,12 @@ services:
- router_net
ports:
- "6379:6379"
+ healthcheck:
+ test: ["CMD-SHELL", "redis-cli ping | grep '^PONG$'"]
+ interval: 5s
+ retries: 3
+ start_period: 5s
+ timeout: 5s
migration_runner:
image: rust:latest
@@ -55,14 +67,19 @@ services:
volumes:
- ./config:/local/config
- ./files:/local/bin/files
+ depends_on:
+ pg:
+ condition: service_healthy
+ redis-standalone:
+ condition: service_healthy
labels:
logs: "promtail"
healthcheck:
test: curl --fail http://localhost:8080/health || exit 1
- interval: 10s
+ interval: 5s
retries: 3
start_period: 5s
- timeout: 10s
+ timeout: 5s
hyperswitch-producer:
image: juspaydotin/hyperswitch-producer:standalone
@@ -96,7 +113,7 @@ services:
- SCHEDULER_FLOW=consumer
depends_on:
hyperswitch-server:
- condition: service_started
+ condition: service_healthy
labels:
logs: "promtail"
healthcheck:
@@ -121,7 +138,7 @@ services:
restart: unless-stopped
depends_on:
hyperswitch-server:
- condition: service_started
+ condition: service_healthy
labels:
logs: "promtail"
@@ -131,21 +148,25 @@ services:
- "9050:9050"
- "9060:9060"
- "5252:5252"
+ networks:
+ - router_net
build:
context: ./docker
dockerfile: web.Dockerfile
+ depends_on:
+ hyperswitch-server:
+ condition: service_healthy
environment:
- - HYPERSWITCH_PUBLISHABLE_KEY=${HYPERSWITCH_PUBLISHABLE_KEY:-PUBLISHABLE_KEY}
- - HYPERSWITCH_SECRET_KEY=${HYPERSWITCH_SECRET_KEY:-SECRET_KEY}
- - HYPERSWITCH_SERVER_URL=${HYPERSWITCH_SERVER_URL:-http://hyperswitch-server:8080}
- - HYPERSWITCH_CLIENT_URL=${HYPERSWITCH_CLIENT_URL:-http://localhost:9050}
- - SELF_SERVER_URL=${SELF_SERVER_URL:-http://localhost:5252}
- - SDK_ENV=${SDK_ENV:-local}
- - ENV_SDK_URL=${ENV_SDK_URL:-http://localhost:9050}
- - ENV_BACKEND_URL=${ENV_BACKEND_URL:-http://localhost:8080}
- - ENV_LOGGING_URL=${ENV_LOGGING_URL:-http://localhost:3100}
+ - HYPERSWITCH_PUBLISHABLE_KEY=placeholder_publishable_key
+ - HYPERSWITCH_SECRET_KEY=placeholder_api_key
+ - HYPERSWITCH_SERVER_URL=http://localhost:8080
+ - HYPERSWITCH_SERVER_URL_FOR_DEMO_APP=http://hyperswitch-server:8080
+ - HYPERSWITCH_CLIENT_URL=http://localhost:9050
+ - SELF_SERVER_URL=http://localhost:5252
+ - SDK_ENV=local
+ - ENV_LOGGING_URL=http://localhost:3100
labels:
- logs: "promtail"
+ logs: "promtail"
### Control Center
hyperswitch-control-center:
@@ -158,7 +179,10 @@ services:
volumes:
- ./config/dashboard.toml:/tmp/dashboard-config.toml
depends_on:
- - hyperswitch-web
+ hyperswitch-server:
+ condition: service_healthy
+ hyperswitch-web:
+ condition: service_started
labels:
logs: "promtail"
|
chore
|
pass correct configuration values for running SDK demo app (#5012)
|
bd889c834dd5e201b055233016f7226fa2187aea
|
2023-11-28 17:32:53
|
Sakil Mostak
|
fix(connector): [Adyen] `ErrorHandling` in case of Balance Check for Gift Cards (#1976)
| false
|
diff --git a/crates/router/src/connector/adyen.rs b/crates/router/src/connector/adyen.rs
index e101b796b8d..ddd93bc289a 100644
--- a/crates/router/src/connector/adyen.rs
+++ b/crates/router/src/connector/adyen.rs
@@ -14,11 +14,8 @@ use crate::{
configs::settings,
connector::utils as connector_utils,
consts,
- core::{
- self,
- errors::{self, CustomResult},
- },
- headers, logger, routes,
+ core::errors::{self, CustomResult},
+ headers, logger,
services::{
self,
request::{self, Mask},
@@ -560,7 +557,6 @@ impl
}
}
-#[async_trait::async_trait]
impl
services::ConnectorIntegration<
api::Authorize,
@@ -568,49 +564,6 @@ impl
types::PaymentsResponseData,
> for Adyen
{
- async fn execute_pretasks(
- &self,
- router_data: &mut types::PaymentsAuthorizeRouterData,
- app_state: &routes::AppState,
- ) -> CustomResult<(), errors::ConnectorError> {
- match &router_data.request.payment_method_data {
- api_models::payments::PaymentMethodData::GiftCard(gift_card_data) => {
- match gift_card_data.as_ref() {
- api_models::payments::GiftCardData::Givex(_) => {
- let integ: Box<
- &(dyn services::ConnectorIntegration<
- api::Balance,
- types::PaymentsAuthorizeData,
- types::PaymentsResponseData,
- > + Send
- + Sync
- + 'static),
- > = Box::new(&Self);
-
- let authorize_data = &types::PaymentsBalanceRouterData::from((
- &router_data.to_owned(),
- router_data.request.clone(),
- ));
-
- let resp = services::execute_connector_processing_step(
- app_state,
- integ,
- authorize_data,
- core::payments::CallConnectorAction::Trigger,
- None,
- )
- .await?;
- router_data.payment_method_balance = resp.payment_method_balance;
-
- Ok(())
- }
- _ => Ok(()),
- }
- }
- _ => Ok(()),
- }
- }
-
fn get_headers(
&self,
req: &types::PaymentsAuthorizeRouterData,
@@ -667,7 +620,6 @@ impl
req: &types::PaymentsAuthorizeRouterData,
connectors: &settings::Connectors,
) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
- check_for_payment_method_balance(req)?;
Ok(Some(
services::RequestBuilder::new()
.method(services::Method::Post)
@@ -725,28 +677,23 @@ impl
}
}
+impl api::PaymentsPreProcessing for Adyen {}
+
impl
services::ConnectorIntegration<
- api::Balance,
- types::PaymentsAuthorizeData,
+ api::PreProcessing,
+ types::PaymentsPreProcessingData,
types::PaymentsResponseData,
> for Adyen
{
fn get_headers(
&self,
- req: &types::PaymentsBalanceRouterData,
+ req: &types::PaymentsPreProcessingRouterData,
_connectors: &settings::Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError>
- where
- Self: services::ConnectorIntegration<
- api::Balance,
- types::PaymentsAuthorizeData,
- types::PaymentsResponseData,
- >,
- {
+ ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
let mut header = vec![(
headers::CONTENT_TYPE.to_string(),
- types::PaymentsBalanceType::get_content_type(self)
+ types::PaymentsPreProcessingType::get_content_type(self)
.to_string()
.into(),
)];
@@ -757,7 +704,7 @@ impl
fn get_url(
&self,
- _req: &types::PaymentsBalanceRouterData,
+ _req: &types::PaymentsPreProcessingRouterData,
connectors: &settings::Connectors,
) -> CustomResult<String, errors::ConnectorError> {
Ok(format!(
@@ -768,7 +715,7 @@ impl
fn get_request_body(
&self,
- req: &types::PaymentsBalanceRouterData,
+ req: &types::PaymentsPreProcessingRouterData,
_connectors: &settings::Connectors,
) -> CustomResult<Option<types::RequestBody>, errors::ConnectorError> {
let connector_req = adyen::AdyenBalanceRequest::try_from(req)?;
@@ -783,18 +730,20 @@ impl
fn build_request(
&self,
- req: &types::PaymentsBalanceRouterData,
+ req: &types::PaymentsPreProcessingRouterData,
connectors: &settings::Connectors,
) -> CustomResult<Option<services::Request>, errors::ConnectorError> {
Ok(Some(
services::RequestBuilder::new()
.method(services::Method::Post)
- .url(&types::PaymentsBalanceType::get_url(self, req, connectors)?)
+ .url(&types::PaymentsPreProcessingType::get_url(
+ self, req, connectors,
+ )?)
.attach_default_headers()
- .headers(types::PaymentsBalanceType::get_headers(
+ .headers(types::PaymentsPreProcessingType::get_headers(
self, req, connectors,
)?)
- .body(types::PaymentsBalanceType::get_request_body(
+ .body(types::PaymentsPreProcessingType::get_request_body(
self, req, connectors,
)?)
.build(),
@@ -803,19 +752,47 @@ impl
fn handle_response(
&self,
- data: &types::PaymentsBalanceRouterData,
+ data: &types::PaymentsPreProcessingRouterData,
res: types::Response,
- ) -> CustomResult<types::PaymentsBalanceRouterData, errors::ConnectorError> {
+ ) -> CustomResult<types::PaymentsPreProcessingRouterData, errors::ConnectorError> {
let response: adyen::AdyenBalanceResponse = res
.response
.parse_struct("AdyenBalanceResponse")
.change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
- types::RouterData::try_from(types::ResponseRouterData {
- response,
- data: data.clone(),
- http_code: res.status_code,
- })
- .change_context(errors::ConnectorError::ResponseHandlingFailed)
+
+ let currency = match data.request.currency {
+ Some(currency) => currency,
+ None => Err(errors::ConnectorError::MissingRequiredField {
+ field_name: "currency",
+ })?,
+ };
+ let amount = match data.request.amount {
+ Some(amount) => amount,
+ None => Err(errors::ConnectorError::MissingRequiredField {
+ field_name: "amount",
+ })?,
+ };
+
+ if response.balance.currency != currency || response.balance.value < amount {
+ Ok(types::RouterData {
+ response: Err(types::ErrorResponse {
+ code: consts::NO_ERROR_CODE.to_string(),
+ message: consts::NO_ERROR_MESSAGE.to_string(),
+ reason: Some(consts::LOW_BALANCE_ERROR_MESSAGE.to_string()),
+ status_code: res.status_code,
+ attempt_status: Some(enums::AttemptStatus::Failure),
+ connector_transaction_id: None,
+ }),
+ ..data.clone()
+ })
+ } else {
+ types::RouterData::try_from(types::ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
+ }
}
fn get_error_response(
@@ -1634,7 +1611,7 @@ impl api::IncomingWebhook for Adyen {
.change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
Ok(api::disputes::DisputePayload {
amount: notif.amount.value.to_string(),
- currency: notif.amount.currency,
+ currency: notif.amount.currency.to_string(),
dispute_stage: api_models::enums::DisputeStage::from(notif.event_code.clone()),
connector_dispute_id: notif.psp_reference,
connector_reason: notif.reason,
@@ -1646,27 +1623,3 @@ impl api::IncomingWebhook for Adyen {
})
}
}
-
-pub fn check_for_payment_method_balance(
- req: &types::PaymentsAuthorizeRouterData,
-) -> CustomResult<(), errors::ConnectorError> {
- match &req.request.payment_method_data {
- api_models::payments::PaymentMethodData::GiftCard(gift_card) => match gift_card.as_ref() {
- api_models::payments::GiftCardData::Givex(_) => {
- let payment_method_balance = req
- .payment_method_balance
- .as_ref()
- .ok_or(errors::ConnectorError::RequestEncodingFailed)?;
- if payment_method_balance.currency != req.request.currency.to_string()
- || payment_method_balance.amount < req.request.amount
- {
- Err(errors::ConnectorError::InSufficientBalanceInPaymentMethod.into())
- } else {
- Ok(())
- }
- }
- _ => Ok(()),
- },
- _ => Ok(()),
- }
-}
diff --git a/crates/router/src/connector/adyen/transformers.rs b/crates/router/src/connector/adyen/transformers.rs
index a130ac50cc0..cfa60111267 100644
--- a/crates/router/src/connector/adyen/transformers.rs
+++ b/crates/router/src/connector/adyen/transformers.rs
@@ -213,8 +213,8 @@ pub struct AdyenBalanceRequest<'a> {
#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AdyenBalanceResponse {
- psp_reference: String,
- balance: Amount,
+ pub psp_reference: String,
+ pub balance: Amount,
}
/// This implementation will be used only in Authorize, Automatic capture flow.
@@ -397,8 +397,8 @@ pub enum ActionType {
#[derive(Default, Debug, Clone, Serialize, Deserialize)]
pub struct Amount {
- currency: String,
- value: i64,
+ pub currency: storage_enums::Currency,
+ pub value: i64,
}
#[derive(Debug, Clone, Serialize)]
@@ -1392,11 +1392,11 @@ impl<'a> TryFrom<&AdyenRouterData<&types::PaymentsAuthorizeRouterData>>
}
}
-impl<'a> TryFrom<&types::PaymentsBalanceRouterData> for AdyenBalanceRequest<'a> {
+impl<'a> TryFrom<&types::PaymentsPreProcessingRouterData> for AdyenBalanceRequest<'a> {
type Error = Error;
- fn try_from(item: &types::PaymentsBalanceRouterData) -> Result<Self, Self::Error> {
+ fn try_from(item: &types::PaymentsPreProcessingRouterData) -> Result<Self, Self::Error> {
let payment_method = match &item.request.payment_method_data {
- payments::PaymentMethodData::GiftCard(gift_card_data) => {
+ Some(payments::PaymentMethodData::GiftCard(gift_card_data)) => {
match gift_card_data.as_ref() {
payments::GiftCardData::Givex(gift_card_data) => {
let balance_pm = BalancePmData {
@@ -1510,7 +1510,7 @@ fn get_channel_type(pm_type: &Option<storage_enums::PaymentMethodType>) -> Optio
fn get_amount_data(item: &AdyenRouterData<&types::PaymentsAuthorizeRouterData>) -> Amount {
Amount {
- currency: item.router_data.request.currency.to_string(),
+ currency: item.router_data.request.currency,
value: item.amount.to_owned(),
}
}
@@ -2857,12 +2857,24 @@ impl TryFrom<types::PaymentsCancelResponseRouterData<AdyenCancelResponse>>
}
}
-impl TryFrom<types::PaymentsBalanceResponseRouterData<AdyenBalanceResponse>>
- for types::PaymentsBalanceRouterData
+impl<F>
+ TryFrom<
+ types::ResponseRouterData<
+ F,
+ AdyenBalanceResponse,
+ types::PaymentsPreProcessingData,
+ types::PaymentsResponseData,
+ >,
+ > for types::RouterData<F, types::PaymentsPreProcessingData, types::PaymentsResponseData>
{
type Error = Error;
fn try_from(
- item: types::PaymentsBalanceResponseRouterData<AdyenBalanceResponse>,
+ item: types::ResponseRouterData<
+ F,
+ AdyenBalanceResponse,
+ types::PaymentsPreProcessingData,
+ types::PaymentsResponseData,
+ >,
) -> Result<Self, Self::Error> {
Ok(Self {
response: Ok(types::PaymentsResponseData::TransactionResponse {
@@ -3457,7 +3469,7 @@ impl TryFrom<&AdyenRouterData<&types::PaymentsCaptureRouterData>> for AdyenCaptu
merchant_account: auth_type.merchant_account,
reference,
amount: Amount {
- currency: item.router_data.request.currency.to_string(),
+ currency: item.router_data.request.currency,
value: item.amount.to_owned(),
},
})
@@ -3547,7 +3559,7 @@ impl<F> TryFrom<&AdyenRouterData<&types::RefundsRouterData<F>>> for AdyenRefundR
Ok(Self {
merchant_account: auth_type.merchant_account,
amount: Amount {
- currency: item.router_data.request.currency.to_string(),
+ currency: item.router_data.request.currency,
value: item.router_data.request.refund_amount,
},
merchant_refund_reason: item.router_data.request.reason.clone(),
@@ -3629,7 +3641,7 @@ pub struct AdyenAdditionalDataWH {
#[derive(Debug, Deserialize)]
pub struct AdyenAmountWH {
pub value: i64,
- pub currency: String,
+ pub currency: storage_enums::Currency,
}
#[derive(Clone, Debug, Deserialize, Serialize, strum::Display, PartialEq)]
@@ -3955,7 +3967,7 @@ impl<F> TryFrom<&AdyenRouterData<&types::PayoutsRouterData<F>>> for AdyenPayoutE
)?;
Ok(Self {
amount: Amount {
- currency: item.router_data.request.destination_currency.to_string(),
+ currency: item.router_data.request.destination_currency,
value: item.amount.to_owned(),
},
merchant_account: auth_type.merchant_account,
@@ -4030,7 +4042,7 @@ impl<F> TryFrom<&AdyenRouterData<&types::PayoutsRouterData<F>>> for AdyenPayoutC
Ok(Self {
amount: Amount {
value: item.amount.to_owned(),
- currency: item.router_data.request.destination_currency.to_string(),
+ currency: item.router_data.request.destination_currency,
},
recurring: RecurringContract {
contract: Contract::Payout,
@@ -4077,7 +4089,7 @@ impl<F> TryFrom<&AdyenRouterData<&types::PayoutsRouterData<F>>> for AdyenPayoutF
Ok(Self::Card(Box::new(PayoutFulfillCardRequest {
amount: Amount {
value: item.amount.to_owned(),
- currency: item.router_data.request.destination_currency.to_string(),
+ currency: item.router_data.request.destination_currency,
},
card: get_payout_card_details(&item.router_data.get_payout_method_data()?)
.map_or(
diff --git a/crates/router/src/consts.rs b/crates/router/src/consts.rs
index 8937764409f..4f19562c83c 100644
--- a/crates/router/src/consts.rs
+++ b/crates/router/src/consts.rs
@@ -27,6 +27,7 @@ pub const DEFAULT_FULFILLMENT_TIME: i64 = 15 * 60;
pub(crate) const NO_ERROR_MESSAGE: &str = "No error message";
pub(crate) const NO_ERROR_CODE: &str = "No error code";
pub(crate) const UNSUPPORTED_ERROR_MESSAGE: &str = "Unsupported response type";
+pub(crate) const LOW_BALANCE_ERROR_MESSAGE: &str = "Insufficient balance in the payment method";
pub(crate) const CONNECTOR_UNAUTHORIZED_ERROR: &str = "Authentication Error from the connector";
pub(crate) const CANNOT_CONTINUE_AUTH: &str =
"Cannot continue with Authorization due to failed Liability Shift.";
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index 4fe7ea84800..8cfded8463e 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -1408,6 +1408,17 @@ where
(router_data, should_continue_payment)
}
}
+ Some(api_models::payments::PaymentMethodData::GiftCard(_)) => {
+ if connector.connector_name == router_types::Connector::Adyen {
+ router_data = router_data.preprocessing_steps(state, connector).await?;
+
+ let is_error_in_response = router_data.response.is_err();
+ // If is_error_in_response is true, should_continue_payment should be false, we should throw the error
+ (router_data, !is_error_in_response)
+ } else {
+ (router_data, should_continue_payment)
+ }
+ }
Some(api_models::payments::PaymentMethodData::BankDebit(_)) => {
if connector.connector_name == router_types::Connector::Gocardless {
router_data = router_data.preprocessing_steps(state, connector).await?;
diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs
index d983cd19bdb..9be6f5905b8 100644
--- a/crates/router/src/core/payments/flows.rs
+++ b/crates/router/src/core/payments/flows.rs
@@ -832,7 +832,6 @@ impl<const T: u8>
default_imp_for_pre_processing_steps!(
connector::Aci,
- connector::Adyen,
connector::Airwallex,
connector::Authorizedotnet,
connector::Bambora,
diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs
index db126b81451..cd37fbb549d 100644
--- a/crates/router/src/types.rs
+++ b/crates/router/src/types.rs
@@ -323,7 +323,7 @@ pub struct ApplePayCryptogramData {
#[derive(Debug, Clone)]
pub struct PaymentMethodBalance {
pub amount: i64,
- pub currency: String,
+ pub currency: storage_enums::Currency,
}
#[cfg(feature = "payouts")]
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/.meta.json b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/.meta.json
new file mode 100644
index 00000000000..69b505c6d86
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/.meta.json
@@ -0,0 +1,3 @@
+{
+ "childrenOrder": ["Payments - Create", "Payments - Retrieve"]
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/.event.meta.json b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/.event.meta.json
new file mode 100644
index 00000000000..0731450e6b2
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/.event.meta.json
@@ -0,0 +1,3 @@
+{
+ "eventOrder": ["event.test.js"]
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/event.test.js b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/event.test.js
new file mode 100644
index 00000000000..c48d8e2d054
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/event.test.js
@@ -0,0 +1,71 @@
+// Validate status 2xx
+pm.test("[POST]::/payments - Status code is 2xx", function () {
+ pm.response.to.be.success;
+});
+
+// Validate if response header has matching content-type
+pm.test("[POST]::/payments - Content-Type is application/json", function () {
+ pm.expect(pm.response.headers.get("Content-Type")).to.include(
+ "application/json",
+ );
+});
+
+// Validate if response has JSON Body
+pm.test("[POST]::/payments - Response has JSON Body", function () {
+ pm.response.to.have.jsonBody();
+});
+
+// Set response object as internal variable
+let jsonData = {};
+try {
+ jsonData = pm.response.json();
+} catch (e) {}
+
+// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id
+if (jsonData?.payment_id) {
+ pm.collectionVariables.set("payment_id", jsonData.payment_id);
+ console.log(
+ "- use {{payment_id}} as collection variable for value",
+ jsonData.payment_id,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.",
+ );
+}
+
+// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id
+if (jsonData?.mandate_id) {
+ pm.collectionVariables.set("mandate_id", jsonData.mandate_id);
+ console.log(
+ "- use {{mandate_id}} as collection variable for value",
+ jsonData.mandate_id,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.",
+ );
+}
+
+// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret
+if (jsonData?.client_secret) {
+ pm.collectionVariables.set("client_secret", jsonData.client_secret);
+ console.log(
+ "- use {{client_secret}} as collection variable for value",
+ jsonData.client_secret,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.",
+ );
+}
+
+// Response body should have value "succeeded" for "status"
+if (jsonData?.status) {
+ pm.test(
+ "[POST]::/payments - Content check if value for 'status' matches 'succeeded'",
+ function () {
+ pm.expect(jsonData.status).to.eql("succeeded");
+ },
+ );
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/request.json b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/request.json
new file mode 100644
index 00000000000..0915e9894bb
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/request.json
@@ -0,0 +1,88 @@
+{
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw_json_formatted": {
+ "amount": 1100,
+ "currency": "EUR",
+ "confirm": true,
+ "capture_method": "automatic",
+ "capture_on": "2022-09-10T10:11:12Z",
+ "amount_to_capture": 1100,
+ "customer_id": "StripeCustomer",
+ "email": "[email protected]",
+ "name": "John Doe",
+ "phone": "999999999",
+ "phone_country_code": "+65",
+ "description": "Its my first payment request",
+ "authentication_type": "no_three_ds",
+ "return_url": "https://duck.com",
+ "payment_method": "gift_card",
+ "payment_method_type": "givex",
+ "payment_method_data": {
+ "gift_card": {
+ "givex": {
+ "number": "6364530000000000",
+ "cvc": "122222"
+ }
+ }
+ },
+ "routing": {
+ "type": "single",
+ "data": "adyen"
+ },
+ "billing": {
+ "address": {
+ "line1": "1467",
+ "line2": "Harrison Street",
+ "line3": "Harrison Street",
+ "city": "San Fransico",
+ "state": "California",
+ "zip": "94122",
+ "country": "US",
+ "first_name": "PiX"
+ }
+ },
+ "shipping": {
+ "address": {
+ "line1": "1467",
+ "line2": "Harrison Street",
+ "line3": "Harrison Street",
+ "city": "San Fransico",
+ "state": "California",
+ "zip": "94122",
+ "country": "US",
+ "first_name": "PiX"
+ }
+ },
+ "statement_descriptor_name": "joseph",
+ "statement_descriptor_suffix": "JS",
+ "metadata": {
+ "udf1": "value1",
+ "new_customer": "true",
+ "login_date": "2019-09-10T10:11:12Z"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": ["{{baseUrl}}"],
+ "path": ["payments"]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/response.json b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/response.json
new file mode 100644
index 00000000000..fe51488c706
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Create/response.json
@@ -0,0 +1 @@
+[]
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/.event.meta.json b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/.event.meta.json
new file mode 100644
index 00000000000..0731450e6b2
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/.event.meta.json
@@ -0,0 +1,3 @@
+{
+ "eventOrder": ["event.test.js"]
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/event.test.js b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/event.test.js
new file mode 100644
index 00000000000..0652a2d92fd
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/event.test.js
@@ -0,0 +1,71 @@
+// Validate status 2xx
+pm.test("[GET]::/payments/:id - Status code is 2xx", function () {
+ pm.response.to.be.success;
+});
+
+// Validate if response header has matching content-type
+pm.test("[GET]::/payments/:id - Content-Type is application/json", function () {
+ pm.expect(pm.response.headers.get("Content-Type")).to.include(
+ "application/json",
+ );
+});
+
+// Validate if response has JSON Body
+pm.test("[GET]::/payments/:id - Response has JSON Body", function () {
+ pm.response.to.have.jsonBody();
+});
+
+// Set response object as internal variable
+let jsonData = {};
+try {
+ jsonData = pm.response.json();
+} catch (e) {}
+
+// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id
+if (jsonData?.payment_id) {
+ pm.collectionVariables.set("payment_id", jsonData.payment_id);
+ console.log(
+ "- use {{payment_id}} as collection variable for value",
+ jsonData.payment_id,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.",
+ );
+}
+
+// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id
+if (jsonData?.mandate_id) {
+ pm.collectionVariables.set("mandate_id", jsonData.mandate_id);
+ console.log(
+ "- use {{mandate_id}} as collection variable for value",
+ jsonData.mandate_id,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.",
+ );
+}
+
+// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret
+if (jsonData?.client_secret) {
+ pm.collectionVariables.set("client_secret", jsonData.client_secret);
+ console.log(
+ "- use {{client_secret}} as collection variable for value",
+ jsonData.client_secret,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.",
+ );
+}
+
+// Response body should have value "Succeeded" for "status"
+if (jsonData?.status) {
+ pm.test(
+ "[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'",
+ function () {
+ pm.expect(jsonData.status).to.eql("succeeded");
+ },
+ );
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/request.json b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/request.json
new file mode 100644
index 00000000000..6cd4b7d96c5
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/request.json
@@ -0,0 +1,28 @@
+{
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": ["{{baseUrl}}"],
+ "path": ["payments", ":id"],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/response.json b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/response.json
new file mode 100644
index 00000000000..fe51488c706
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario22-Create Gift Card payment/Payments - Retrieve/response.json
@@ -0,0 +1 @@
+[]
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/QuickStart/Payment Connector - Create/request.json b/postman/collection-dir/adyen_uk/Flow Testcases/QuickStart/Payment Connector - Create/request.json
index 592cff80751..fe25f6f5e68 100644
--- a/postman/collection-dir/adyen_uk/Flow Testcases/QuickStart/Payment Connector - Create/request.json
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/QuickStart/Payment Connector - Create/request.json
@@ -190,6 +190,18 @@
}
]
},
+ {
+ "payment_method": "gift_card",
+ "payment_method_types": [
+ {
+ "payment_method_type": "givex",
+ "minimum_amount": 1,
+ "maximum_amount": 68607706,
+ "recurring_enabled": true,
+ "installment_payment_enabled": true
+ }
+ ]
+ },
{
"payment_method": "bank_redirect",
"payment_method_types": [
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/QuickStart/Payments - Create/request.json b/postman/collection-dir/adyen_uk/Flow Testcases/QuickStart/Payments - Create/request.json
index 8ac3ed14b0a..ed9dbeaa9c4 100644
--- a/postman/collection-dir/adyen_uk/Flow Testcases/QuickStart/Payments - Create/request.json
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/QuickStart/Payments - Create/request.json
@@ -43,6 +43,10 @@
"card_cvc": "7373"
}
},
+ "routing": {
+ "type": "single",
+ "data": "adyen"
+ },
"billing": {
"address": {
"line1": "1467",
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/.meta.json b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/.meta.json
new file mode 100644
index 00000000000..69b505c6d86
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/.meta.json
@@ -0,0 +1,3 @@
+{
+ "childrenOrder": ["Payments - Create", "Payments - Retrieve"]
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/.event.meta.json b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/.event.meta.json
new file mode 100644
index 00000000000..0731450e6b2
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/.event.meta.json
@@ -0,0 +1,3 @@
+{
+ "eventOrder": ["event.test.js"]
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/event.test.js b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/event.test.js
new file mode 100644
index 00000000000..601f4f8fa7f
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/event.test.js
@@ -0,0 +1,81 @@
+// Validate status 2xx
+pm.test("[POST]::/payments - Status code is 2xx", function () {
+ pm.response.to.be.success;
+});
+
+// Validate if response header has matching content-type
+pm.test("[POST]::/payments - Content-Type is application/json", function () {
+ pm.expect(pm.response.headers.get("Content-Type")).to.include(
+ "application/json",
+ );
+});
+
+// Validate if response has JSON Body
+pm.test("[POST]::/payments - Response has JSON Body", function () {
+ pm.response.to.have.jsonBody();
+});
+
+// Set response object as internal variable
+let jsonData = {};
+try {
+ jsonData = pm.response.json();
+} catch (e) {}
+
+// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id
+if (jsonData?.payment_id) {
+ pm.collectionVariables.set("payment_id", jsonData.payment_id);
+ console.log(
+ "- use {{payment_id}} as collection variable for value",
+ jsonData.payment_id,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.",
+ );
+}
+
+// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id
+if (jsonData?.mandate_id) {
+ pm.collectionVariables.set("mandate_id", jsonData.mandate_id);
+ console.log(
+ "- use {{mandate_id}} as collection variable for value",
+ jsonData.mandate_id,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.",
+ );
+}
+
+// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret
+if (jsonData?.client_secret) {
+ pm.collectionVariables.set("client_secret", jsonData.client_secret);
+ console.log(
+ "- use {{client_secret}} as collection variable for value",
+ jsonData.client_secret,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.",
+ );
+}
+
+// Response body should have value "failed" for "status"
+if (jsonData?.status) {
+ pm.test(
+ "[POST]::/payments - Content check if value for 'status' matches 'failed'",
+ function () {
+ pm.expect(jsonData.status).to.eql("failed");
+ },
+ );
+}
+
+// Response body should have error message as "Insufficient balance in the payment method"
+if (jsonData?.error_message) {
+ pm.test(
+ "[POST]::/payments - Content check if value for 'error_message' matches 'Insufficient balance in the payment method'",
+ function () {
+ pm.expect(jsonData.error_message).to.eql("Insufficient balance in the payment method");
+ },
+ );
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/request.json b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/request.json
new file mode 100644
index 00000000000..11437ff5765
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/request.json
@@ -0,0 +1,88 @@
+{
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw_json_formatted": {
+ "amount": 14100,
+ "currency": "EUR",
+ "confirm": true,
+ "capture_method": "automatic",
+ "capture_on": "2022-09-10T10:11:12Z",
+ "amount_to_capture": 14100,
+ "customer_id": "StripeCustomer",
+ "email": "[email protected]",
+ "name": "John Doe",
+ "phone": "999999999",
+ "phone_country_code": "+65",
+ "description": "Its my first payment request",
+ "authentication_type": "no_three_ds",
+ "return_url": "https://duck.com",
+ "payment_method": "gift_card",
+ "payment_method_type": "givex",
+ "payment_method_data": {
+ "gift_card": {
+ "givex": {
+ "number": "6364530000000000",
+ "cvc": "122222"
+ }
+ }
+ },
+ "routing": {
+ "type": "single",
+ "data": "adyen"
+ },
+ "billing": {
+ "address": {
+ "line1": "1467",
+ "line2": "Harrison Street",
+ "line3": "Harrison Street",
+ "city": "San Fransico",
+ "state": "California",
+ "zip": "94122",
+ "country": "US",
+ "first_name": "PiX"
+ }
+ },
+ "shipping": {
+ "address": {
+ "line1": "1467",
+ "line2": "Harrison Street",
+ "line3": "Harrison Street",
+ "city": "San Fransico",
+ "state": "California",
+ "zip": "94122",
+ "country": "US",
+ "first_name": "PiX"
+ }
+ },
+ "statement_descriptor_name": "joseph",
+ "statement_descriptor_suffix": "JS",
+ "metadata": {
+ "udf1": "value1",
+ "new_customer": "true",
+ "login_date": "2019-09-10T10:11:12Z"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": ["{{baseUrl}}"],
+ "path": ["payments"]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/response.json b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/response.json
new file mode 100644
index 00000000000..fe51488c706
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Create/response.json
@@ -0,0 +1 @@
+[]
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/.event.meta.json b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/.event.meta.json
new file mode 100644
index 00000000000..0731450e6b2
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/.event.meta.json
@@ -0,0 +1,3 @@
+{
+ "eventOrder": ["event.test.js"]
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/event.test.js b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/event.test.js
new file mode 100644
index 00000000000..ff2099305d7
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/event.test.js
@@ -0,0 +1,71 @@
+// Validate status 2xx
+pm.test("[GET]::/payments/:id - Status code is 2xx", function () {
+ pm.response.to.be.success;
+});
+
+// Validate if response header has matching content-type
+pm.test("[GET]::/payments/:id - Content-Type is application/json", function () {
+ pm.expect(pm.response.headers.get("Content-Type")).to.include(
+ "application/json",
+ );
+});
+
+// Validate if response has JSON Body
+pm.test("[GET]::/payments/:id - Response has JSON Body", function () {
+ pm.response.to.have.jsonBody();
+});
+
+// Set response object as internal variable
+let jsonData = {};
+try {
+ jsonData = pm.response.json();
+} catch (e) {}
+
+// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id
+if (jsonData?.payment_id) {
+ pm.collectionVariables.set("payment_id", jsonData.payment_id);
+ console.log(
+ "- use {{payment_id}} as collection variable for value",
+ jsonData.payment_id,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.",
+ );
+}
+
+// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id
+if (jsonData?.mandate_id) {
+ pm.collectionVariables.set("mandate_id", jsonData.mandate_id);
+ console.log(
+ "- use {{mandate_id}} as collection variable for value",
+ jsonData.mandate_id,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.",
+ );
+}
+
+// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret
+if (jsonData?.client_secret) {
+ pm.collectionVariables.set("client_secret", jsonData.client_secret);
+ console.log(
+ "- use {{client_secret}} as collection variable for value",
+ jsonData.client_secret,
+ );
+} else {
+ console.log(
+ "INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.",
+ );
+}
+
+// Response body should have value "Failed" for "status"
+if (jsonData?.status) {
+ pm.test(
+ "[POST]::/payments/:id - Content check if value for 'status' matches 'failed'",
+ function () {
+ pm.expect(jsonData.status).to.eql("failed");
+ },
+ );
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/request.json b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/request.json
new file mode 100644
index 00000000000..6cd4b7d96c5
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/request.json
@@ -0,0 +1,28 @@
+{
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": ["{{baseUrl}}"],
+ "path": ["payments", ":id"],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/response.json b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/response.json
new file mode 100644
index 00000000000..fe51488c706
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Variation Cases/Scenario10-Create Gift Card payment where it fails due to insufficient balance/Payments - Retrieve/response.json
@@ -0,0 +1 @@
+[]
|
fix
|
[Adyen] `ErrorHandling` in case of Balance Check for Gift Cards (#1976)
|
67df984c27841ee303eae6ba55577d8bf1ef68fa
|
2024-02-12 14:17:25
|
Narayan Bhat
|
feat(stripe): send billing address to stripe for card payment (#3611)
| false
|
diff --git a/crates/router/src/connector/stripe/transformers.rs b/crates/router/src/connector/stripe/transformers.rs
index eb2cdf506cf..3558d6e487b 100644
--- a/crates/router/src/connector/stripe/transformers.rs
+++ b/crates/router/src/connector/stripe/transformers.rs
@@ -1080,6 +1080,8 @@ impl From<&payments::BankDebitBilling> for StripeBillingAddress {
.address
.as_ref()
.and_then(|address| address.zip.to_owned()),
+ state: None,
+ phone: None,
}
}
}
@@ -1253,6 +1255,7 @@ fn create_stripe_payment_method(
auth_type: enums::AuthenticationType,
payment_method_token: Option<types::PaymentMethodToken>,
is_customer_initiated_mandate_payment: Option<bool>,
+ billing_address: StripeBillingAddress,
) -> Result<
(
StripePaymentMethodData,
@@ -1270,7 +1273,7 @@ fn create_stripe_payment_method(
Ok((
StripePaymentMethodData::try_from((card_details, payment_method_auth_type))?,
Some(StripePaymentMethodType::Card),
- StripeBillingAddress::default(),
+ billing_address,
))
}
payments::PaymentMethodData::PayLater(pay_later_data) => {
@@ -1743,6 +1746,40 @@ impl TryFrom<&types::PaymentsAuthorizeRouterData> for PaymentIntentRequest {
},
None => StripeShippingAddress::default(),
};
+
+ let billing_address = match item.address.billing.clone() {
+ Some(mut billing) => StripeBillingAddress {
+ city: billing.address.as_mut().and_then(|a| a.city.take()),
+ country: billing.address.as_mut().and_then(|a| a.country.take()),
+ address_line1: billing
+ .address
+ .as_mut()
+ .and_then(|a: &mut payments::AddressDetails| a.line1.take()),
+ address_line2: billing.address.as_mut().and_then(|a| a.line2.take()),
+ zip_code: billing.address.as_mut().and_then(|a| a.zip.take()),
+ state: billing.address.as_mut().and_then(|a| a.state.take()),
+ name: billing.address.as_mut().and_then(|a| {
+ a.first_name.as_ref().map(|first_name| {
+ format!(
+ "{} {}",
+ first_name.clone().expose(),
+ a.last_name.clone().expose_option().unwrap_or_default()
+ )
+ .into()
+ })
+ }),
+ email: item.request.email.clone(),
+ phone: billing.phone.map(|p| {
+ format!(
+ "{}{}",
+ p.country_code.unwrap_or_default(),
+ p.number.expose_option().unwrap_or_default()
+ )
+ .into()
+ }),
+ },
+ None => StripeBillingAddress::default(),
+ };
let mut payment_method_options = None;
let (mut payment_data, payment_method, mandate, billing_address, payment_method_types) = {
@@ -1782,6 +1819,7 @@ impl TryFrom<&types::PaymentsAuthorizeRouterData> for PaymentIntentRequest {
Some(connector_util::PaymentsAuthorizeRequestData::is_customer_initiated_mandate_payment(
&item.request,
)),
+ billing_address
)?;
validate_shipping_address_against_payment_method(
@@ -1988,6 +2026,7 @@ impl TryFrom<&types::TokenizationRouterData> for TokenRequest {
item.auth_type,
item.payment_method_token.clone(),
None,
+ StripeBillingAddress::default(),
)?;
Ok(Self {
token_data: payment_data.0,
@@ -2905,6 +2944,10 @@ pub struct StripeBillingAddress {
pub address_line2: Option<Secret<String>>,
#[serde(rename = "payment_method_data[billing_details][address][postal_code]")]
pub zip_code: Option<Secret<String>>,
+ #[serde(rename = "payment_method_data[billing_details][address][state]")]
+ pub state: Option<Secret<String>>,
+ #[serde(rename = "payment_method_data[billing_details][phone]")]
+ pub phone: Option<Secret<String>>,
}
#[derive(Debug, Clone, serde::Deserialize, Eq, PartialEq)]
|
feat
|
send billing address to stripe for card payment (#3611)
|
0e66b1b5dcce6dd87c9d743c9eb73d0cd8e330b2
|
2023-11-28 13:23:53
|
nain-F49FF806
|
refactor(masking): use empty enums as masking:Strategy<T> types (#2874)
| false
|
diff --git a/crates/cards/src/validate.rs b/crates/cards/src/validate.rs
index db6957057ec..d083a420a1e 100644
--- a/crates/cards/src/validate.rs
+++ b/crates/cards/src/validate.rs
@@ -72,7 +72,7 @@ impl<'de> Deserialize<'de> for CardNumber {
}
}
-pub struct CardNumberStrategy;
+pub enum CardNumberStrategy {}
impl<T> Strategy<T> for CardNumberStrategy
where
diff --git a/crates/common_utils/src/pii.rs b/crates/common_utils/src/pii.rs
index c246d204226..39793de5c2b 100644
--- a/crates/common_utils/src/pii.rs
+++ b/crates/common_utils/src/pii.rs
@@ -27,7 +27,7 @@ pub type SecretSerdeValue = Secret<serde_json::Value>;
/// Strategy for masking a PhoneNumber
#[derive(Debug)]
-pub struct PhoneNumberStrategy;
+pub enum PhoneNumberStrategy {}
/// Phone Number
#[derive(Debug, serde::Deserialize, serde::Serialize)]
@@ -144,7 +144,7 @@ where
/// Strategy for Encryption
#[derive(Debug)]
-pub struct EncryptionStratergy;
+pub enum EncryptionStratergy {}
impl<T> Strategy<T> for EncryptionStratergy
where
@@ -157,7 +157,7 @@ where
/// Client secret
#[derive(Debug)]
-pub struct ClientSecret;
+pub enum ClientSecret {}
impl<T> Strategy<T> for ClientSecret
where
@@ -189,7 +189,7 @@ where
/// Strategy for masking Email
#[derive(Debug)]
-pub struct EmailStrategy;
+pub enum EmailStrategy {}
impl<T> Strategy<T> for EmailStrategy
where
@@ -305,7 +305,7 @@ impl FromStr for Email {
/// IP address
#[derive(Debug)]
-pub struct IpAddress;
+pub enum IpAddress {}
impl<T> Strategy<T> for IpAddress
where
@@ -332,7 +332,7 @@ where
/// Strategy for masking UPI VPA's
#[derive(Debug)]
-pub struct UpiVpaMaskingStrategy;
+pub enum UpiVpaMaskingStrategy {}
impl<T> Strategy<T> for UpiVpaMaskingStrategy
where
diff --git a/crates/masking/src/secret.rs b/crates/masking/src/secret.rs
index 96411d4632b..b2e9124688c 100644
--- a/crates/masking/src/secret.rs
+++ b/crates/masking/src/secret.rs
@@ -12,8 +12,8 @@ use crate::{strategy::Strategy, PeekInterface};
/// To get access to value use method `expose()` of trait [`crate::ExposeInterface`].
///
/// ## Masking
-/// Use the [`crate::strategy::Strategy`] trait to implement a masking strategy on a unit struct
-/// and pass the unit struct as a second generic parameter to [`Secret`] while defining it.
+/// Use the [`crate::strategy::Strategy`] trait to implement a masking strategy on a zero-variant
+/// enum and pass this enum as a second generic parameter to [`Secret`] while defining it.
/// [`Secret`] will take care of applying the masking strategy on the inner secret when being
/// displayed.
///
@@ -24,7 +24,7 @@ use crate::{strategy::Strategy, PeekInterface};
/// use masking::Secret;
/// use std::fmt;
///
-/// struct MyStrategy;
+/// enum MyStrategy {}
///
/// impl<T> Strategy<T> for MyStrategy
/// where
diff --git a/crates/masking/src/strategy.rs b/crates/masking/src/strategy.rs
index f744ee1f4b5..8b4d9b0ec34 100644
--- a/crates/masking/src/strategy.rs
+++ b/crates/masking/src/strategy.rs
@@ -7,7 +7,7 @@ pub trait Strategy<T> {
}
/// Debug with type
-pub struct WithType;
+pub enum WithType {}
impl<T> Strategy<T> for WithType {
fn fmt(_: &T, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
@@ -18,7 +18,7 @@ impl<T> Strategy<T> for WithType {
}
/// Debug without type
-pub struct WithoutType;
+pub enum WithoutType {}
impl<T> Strategy<T> for WithoutType {
fn fmt(_: &T, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
|
refactor
|
use empty enums as masking:Strategy<T> types (#2874)
|
9d096e6b4883e34908eca0d5aa134a88bec22b40
|
2024-04-25 16:00:00
|
Prasunna Soppa
|
refactor(configs): add comments to configs for deployments to environments (#4458)
| false
|
diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml
index 9ee70479d7d..1c74e1a1c3a 100644
--- a/config/deployments/integration_test.toml
+++ b/config/deployments/integration_test.toml
@@ -1,3 +1,4 @@
+# Bank redirect configs for allowed banks
[bank_config]
eps.adyen.banks = "bank_austria,bawag_psk_ag,dolomitenbank,easybank_ag,erste_bank_und_sparkassen,hypo_tirol_bank_ag,posojilnica_bank_e_gen,raiffeisen_bankengruppe_osterreich,schoellerbank_ag,sparda_bank_wien,volksbank_gruppe,volkskreditbank_ag"
eps.stripe.banks = "arzte_und_apotheker_bank,austrian_anadi_bank_ag,bank_austria,bankhaus_carl_spangler,bankhaus_schelhammer_und_schattera_ag,bawag_psk_ag,bks_bank_ag,brull_kallmus_bank_ag,btv_vier_lander_bank,capital_bank_grawe_gruppe_ag,dolomitenbank,easybank_ag,erste_bank_und_sparkassen,hypo_alpeadriabank_international_ag,hypo_noe_lb_fur_niederosterreich_u_wien,hypo_oberosterreich_salzburg_steiermark,hypo_tirol_bank_ag,hypo_vorarlberg_bank_ag,hypo_bank_burgenland_aktiengesellschaft,marchfelder_bank,oberbank_ag,raiffeisen_bankengruppe_osterreich,schoellerbank_ag,sparda_bank_wien,volksbank_gruppe,volkskreditbank_ag,vr_bank_braunau"
@@ -11,6 +12,10 @@ online_banking_thailand.adyen.banks = "bangkok_bank,krungsri_bank,krung_thai_ban
open_banking_uk.adyen.banks = "aib,bank_of_scotland,danske_bank,first_direct,first_trust,halifax,lloyds,monzo,nat_west,nationwide_bank,royal_bank_of_scotland,starling,tsb_bank,tesco_bank,ulster_bank,barclays,hsbc_bank,revolut,santander_przelew24,open_bank_success,open_bank_failure,open_bank_cancelled"
przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_pekao_sa,banki_spbdzielcze,blik,bnp_paribas,boz,citi,credit_agricole,e_transfer_pocztowy24,getin_bank,idea_bank,inteligo,mbank_mtransfer,nest_przelew,noble_pay,pbac_z_ipko,plus_bank,santander_przelew24,toyota_bank,volkswagen_bank"
+# Connector configuration, provided attributes will be used to fulfill API requests.
+# Examples provided here are sandbox/test base urls, can be replaced by live or mock
+# base urls based on your need.
+# Note: These are not optional attributes. hyperswitch request can fail due to invalid/empty values.
[connectors]
aci.base_url = "https://eu-test.oppwa.com/"
adyen.base_url = "https://checkout-test.adyen.com/"
@@ -84,24 +89,24 @@ threedsecureio.base_url = "https://service.sandbox.3dsecure.io"
netcetera.base_url = "https://{{merchant_endpoint_prefix}}.3ds-server.prev.netcetera-cloud-payment.ch"
[dummy_connector]
-enabled = true
-assets_base_url = "https://app.hyperswitch.io/assets/TestProcessor/"
-authorize_ttl = 36000
-default_return_url = "https://app.hyperswitch.io/"
-discord_invite_url = "https://discord.gg/wJZ7DVW8mm"
-payment_complete_duration = 500
-payment_complete_tolerance = 100
-payment_duration = 1000
-payment_retrieve_duration = 500
-payment_retrieve_tolerance = 100
-payment_tolerance = 100
-payment_ttl = 172800
-refund_duration = 1000
-refund_retrieve_duration = 500
-refund_retrieve_tolerance = 100
-refund_tolerance = 100
-refund_ttl = 172800
-slack_invite_url = "https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2awm23agh-p_G5xNpziv6yAiedTkkqLg"
+enabled = true # Whether dummy connector is enabled or not
+assets_base_url = "https://app.hyperswitch.io/assets/TestProcessor/" # Base url for dummy connector assets
+authorize_ttl = 36000 # Time to live for dummy connector authorize request in redis
+default_return_url = "https://app.hyperswitch.io/" # Default return url when no return url is passed while payment
+discord_invite_url = "https://discord.gg/wJZ7DVW8mm" # Discord invite url for hyperswitch
+payment_complete_duration = 500 # Fake delay duration for dummy connector payment complete
+payment_complete_tolerance = 100 # Fake delay tolerance for dummy connector payment complete
+payment_duration = 1000 # Fake delay duration for dummy connector payment
+payment_retrieve_duration = 500 # Fake delay duration for dummy connector payment sync
+payment_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector payment sync
+payment_tolerance = 100 # Fake delay tolerance for dummy connector payment
+payment_ttl = 172800 # Time to live for dummy connector payment in redis
+refund_duration = 1000 # Fake delay duration for dummy connector refund
+refund_retrieve_duration = 500 # Fake delay duration for dummy connector refund sync
+refund_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector refund sync
+refund_tolerance = 100 # Fake delay tolerance for dummy connector refund
+refund_ttl = 172800 # Time to live for dummy connector refund in redis
+slack_invite_url = "https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2awm23agh-p_G5xNpziv6yAiedTkkqLg" # Slack invite url for hyperswitch
[frm]
enabled = true
@@ -111,26 +116,26 @@ connector_list = "gocardless,stax,stripe"
payout_connector_list = "wise"
[delayed_session_response]
-connectors_with_delayed_session_response = "trustpay,payme"
+connectors_with_delayed_session_response = "trustpay,payme" # List of connectors which have delayed session response
[mandates.supported_payment_methods]
-bank_debit.ach.connector_list = "gocardless"
-bank_debit.becs.connector_list = "gocardless"
-bank_debit.sepa.connector_list = "gocardless"
-card.credit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica"
-card.debit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica"
-pay_later.klarna.connector_list = "adyen"
-wallet.apple_pay.connector_list = "stripe,adyen,cybersource,noon,bankofamerica"
-wallet.google_pay.connector_list = "stripe,adyen,cybersource,bankofamerica"
-wallet.paypal.connector_list = "adyen"
-bank_redirect.ideal.connector_list = "stripe,adyen,globalpay"
-bank_redirect.sofort.connector_list = "stripe,adyen,globalpay"
-bank_redirect.giropay.connector_list = "adyen,globalpay"
+bank_debit.ach.connector_list = "gocardless" # Mandate supported payment method type and connector for bank_debit
+bank_debit.becs.connector_list = "gocardless" # Mandate supported payment method type and connector for bank_debit
+bank_debit.sepa.connector_list = "gocardless" # Mandate supported payment method type and connector for bank_debit
+card.credit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica" # Mandate supported payment method type and connector for card
+card.debit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica" # Mandate supported payment method type and connector for card
+pay_later.klarna.connector_list = "adyen" # Mandate supported payment method type and connector for pay_later
+wallet.apple_pay.connector_list = "stripe,adyen,cybersource,noon,bankofamerica" # Mandate supported payment method type and connector for wallets
+wallet.google_pay.connector_list = "stripe,adyen,cybersource,bankofamerica" # Mandate supported payment method type and connector for wallets
+wallet.paypal.connector_list = "adyen" # Mandate supported payment method type and connector for wallets
+bank_redirect.ideal.connector_list = "stripe,adyen,globalpay" # Mandate supported payment method type and connector for bank_redirect
+bank_redirect.sofort.connector_list = "stripe,adyen,globalpay" # Mandate supported payment method type and connector for bank_redirect
+bank_redirect.giropay.connector_list = "adyen,globalpay" # Mandate supported payment method type and connector for bank_redirect
[mandates.update_mandate_supported]
-card.credit ={connector_list ="cybersource"}
-card.debit = {connector_list ="cybersource"}
+card.credit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card
+card.debit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card
[network_transaction_id_supported_connectors]
connector_list = "stripe,adyen,cybersource"
@@ -139,8 +144,9 @@ connector_list = "stripe,adyen,cybersource"
supported_connectors = "braintree"
[payouts]
-payout_eligibility = true
+payout_eligibility = true # Defaults the eligibility of a payout method to true in case connector does not provide checks for payout eligibility
+#Payment Method Filters Based on Country and Currency
[pm_filters.default]
affirm = { country = "US", currency = "USD" }
afterpay_clearpay = { country = "US,CA,GB,AU,NZ,FR,ES", currency = "GBP" }
@@ -293,6 +299,7 @@ cybersource = { payment_method = "card" }
nmi.payment_method = "card"
payme.payment_method = "card"
+#tokenization configuration which describe token lifetime and payment method for specific connector
[tokenization]
braintree = { long_lived_token = false, payment_method = "card" }
checkout = { long_lived_token = false, payment_method = "wallet", apple_pay_pre_decrypt_flow = "network_tokenization" }
@@ -308,7 +315,7 @@ billwerk = {long_lived_token = false, payment_method = "card"}
outgoing_enabled = true
[webhook_source_verification_call]
-connectors_with_webhook_source_verification_call = "paypal"
+connectors_with_webhook_source_verification_call = "paypal" # List of connectors which has additional source verification api-call
[unmasked_headers]
keys = "user-agent"
diff --git a/config/deployments/production.toml b/config/deployments/production.toml
index 1bc4319b2d3..45a6fec35ac 100644
--- a/config/deployments/production.toml
+++ b/config/deployments/production.toml
@@ -1,3 +1,4 @@
+# Bank redirect configs for allowed banks
[bank_config]
eps.adyen.banks = "bank_austria,bawag_psk_ag,dolomitenbank,easybank_ag,erste_bank_und_sparkassen,hypo_tirol_bank_ag,posojilnica_bank_e_gen,raiffeisen_bankengruppe_osterreich,schoellerbank_ag,sparda_bank_wien,volksbank_gruppe,volkskreditbank_ag"
eps.stripe.banks = "arzte_und_apotheker_bank,austrian_anadi_bank_ag,bank_austria,bankhaus_carl_spangler,bankhaus_schelhammer_und_schattera_ag,bawag_psk_ag,bks_bank_ag,brull_kallmus_bank_ag,btv_vier_lander_bank,capital_bank_grawe_gruppe_ag,dolomitenbank,easybank_ag,erste_bank_und_sparkassen,hypo_alpeadriabank_international_ag,hypo_noe_lb_fur_niederosterreich_u_wien,hypo_oberosterreich_salzburg_steiermark,hypo_tirol_bank_ag,hypo_vorarlberg_bank_ag,hypo_bank_burgenland_aktiengesellschaft,marchfelder_bank,oberbank_ag,raiffeisen_bankengruppe_osterreich,schoellerbank_ag,sparda_bank_wien,volksbank_gruppe,volkskreditbank_ag,vr_bank_braunau"
@@ -15,6 +16,10 @@ przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_peka
connector_list = "stax,stripe,gocardless"
payout_connector_list = "wise"
+# Connector configuration, provided attributes will be used to fulfill API requests.
+# Examples provided here are sandbox/test base urls, can be replaced by live or mock
+# base urls based on your need.
+# Note: These are not optional attributes. hyperswitch request can fail due to invalid/empty values.
[connectors]
aci.base_url = "https://eu-test.oppwa.com/"
adyen.base_url = "https://{{merchant_endpoint_prefix}}-checkout-live.adyenpayments.com/checkout/"
@@ -88,55 +93,56 @@ threedsecureio.base_url = "https://service.3dsecure.io"
netcetera.base_url = "https://{{merchant_endpoint_prefix}}.3ds-server.prev.netcetera-cloud-payment.ch"
[delayed_session_response]
-connectors_with_delayed_session_response = "trustpay,payme"
+connectors_with_delayed_session_response = "trustpay,payme" # List of connectors which have delayed session response
[dummy_connector]
-assets_base_url = "https://app.hyperswitch.io/assets/TestProcessor/"
-authorize_ttl = 36000
-default_return_url = "https://app.hyperswitch.io/"
-discord_invite_url = "https://discord.gg/wJZ7DVW8mm"
-enabled = false
-payment_complete_duration = 500
-payment_complete_tolerance = 100
-payment_duration = 1000
-payment_retrieve_duration = 500
-payment_retrieve_tolerance = 100
-payment_tolerance = 100
-payment_ttl = 172800
-refund_duration = 1000
-refund_retrieve_duration = 500
-refund_retrieve_tolerance = 100
-refund_tolerance = 100
-refund_ttl = 172800
-slack_invite_url = "https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2awm23agh-p_G5xNpziv6yAiedTkkqLg"
+enabled = false # Whether dummy connector is enabled or not
+assets_base_url = "https://app.hyperswitch.io/assets/TestProcessor/" # Base url for dummy connector assets
+authorize_ttl = 36000 # Time to live for dummy connector authorize request in redis
+default_return_url = "https://app.hyperswitch.io/" # Default return url when no return url is passed while payment
+discord_invite_url = "https://discord.gg/wJZ7DVW8mm" # Discord invite url for hyperswitch
+payment_complete_duration = 500 # Fake delay duration for dummy connector payment complete
+payment_complete_tolerance = 100 # Fake delay tolerance for dummy connector payment complete
+payment_duration = 1000 # Fake delay duration for dummy connector payment
+payment_retrieve_duration = 500 # Fake delay duration for dummy connector payment sync
+payment_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector payment sync
+payment_tolerance = 100 # Fake delay tolerance for dummy connector payment
+payment_ttl = 172800 # Time to live for dummy connector payment in redis
+refund_duration = 1000 # Fake delay duration for dummy connector refund
+refund_retrieve_duration = 500 # Fake delay duration for dummy connector refund sync
+refund_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector refund sync
+refund_tolerance = 100 # Fake delay tolerance for dummy connector refund
+refund_ttl = 172800 # Time to live for dummy connector refund in redis
+slack_invite_url = "https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2awm23agh-p_G5xNpziv6yAiedTkkqLg" # Slack invite url for hyperswitch
[frm]
enabled = false
[mandates.supported_payment_methods]
-bank_debit.ach.connector_list = "gocardless"
-bank_debit.becs.connector_list = "gocardless"
-bank_debit.sepa.connector_list = "gocardless"
-card.credit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica"
-card.debit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica"
-pay_later.klarna.connector_list = "adyen"
-wallet.apple_pay.connector_list = "stripe,adyen,cybersource,noon,bankofamerica"
-wallet.google_pay.connector_list = "stripe,adyen,cybersource,bankofamerica"
-wallet.paypal.connector_list = "adyen"
-bank_redirect.ideal.connector_list = "stripe,adyen,globalpay"
-bank_redirect.sofort.connector_list = "stripe,adyen,globalpay"
-bank_redirect.giropay.connector_list = "adyen,globalpay"
+bank_debit.ach.connector_list = "gocardless" # Mandate supported payment method type and connector for bank_debit
+bank_debit.becs.connector_list = "gocardless" # Mandate supported payment method type and connector for bank_debit
+bank_debit.sepa.connector_list = "gocardless" # Mandate supported payment method type and connector for bank_debit
+card.credit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica" # Mandate supported payment method type and connector for card
+card.debit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica" # Mandate supported payment method type and connector for card
+pay_later.klarna.connector_list = "adyen" # Mandate supported payment method type and connector for pay_later
+wallet.apple_pay.connector_list = "stripe,adyen,cybersource,noon,bankofamerica" # Mandate supported payment method type and connector for wallets
+wallet.google_pay.connector_list = "stripe,adyen,cybersource,bankofamerica" # Mandate supported payment method type and connector for wallets
+wallet.paypal.connector_list = "adyen" # Mandate supported payment method type and connector for wallets
+bank_redirect.ideal.connector_list = "stripe,adyen,globalpay" # Mandate supported payment method type and connector for bank_redirect
+bank_redirect.sofort.connector_list = "stripe,adyen,globalpay" # Mandate supported payment method type and connector for bank_redirect
+bank_redirect.giropay.connector_list = "adyen,globalpay" # Mandate supported payment method type and connector for bank_redirect
[mandates.update_mandate_supported]
-card.credit ={connector_list ="cybersource"}
-card.debit = {connector_list ="cybersource"}
+card.credit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card
+card.debit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card
[multiple_api_version_supported_connectors]
supported_connectors = "braintree"
[payouts]
-payout_eligibility = true
+payout_eligibility = true # Defaults the eligibility of a payout method to true in case connector does not provide checks for payout eligibility
+#Payment Method Filters Based on Country and Currency
[pm_filters.default]
ach = { country = "US", currency = "USD" }
affirm = { country = "US", currency = "USD" }
@@ -304,6 +310,7 @@ cybersource = { payment_method = "card" }
nmi.payment_method = "card"
payme.payment_method = "card"
+#tokenization configuration which describe token lifetime and payment method for specific connector
[tokenization]
braintree = { long_lived_token = false, payment_method = "card" }
checkout = { long_lived_token = false, payment_method = "wallet", apple_pay_pre_decrypt_flow = "network_tokenization" }
@@ -319,7 +326,7 @@ billwerk = {long_lived_token = false, payment_method = "card"}
outgoing_enabled = true
[webhook_source_verification_call]
-connectors_with_webhook_source_verification_call = "paypal"
+connectors_with_webhook_source_verification_call = "paypal" # List of connectors which has additional source verification api-call
[unmasked_headers]
keys = "user-agent"
diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml
index acec5bbadf0..1f404cccb45 100644
--- a/config/deployments/sandbox.toml
+++ b/config/deployments/sandbox.toml
@@ -1,3 +1,4 @@
+# Bank redirect configs for allowed banks
[bank_config]
eps.adyen.banks = "bank_austria,bawag_psk_ag,dolomitenbank,easybank_ag,erste_bank_und_sparkassen,hypo_tirol_bank_ag,posojilnica_bank_e_gen,raiffeisen_bankengruppe_osterreich,schoellerbank_ag,sparda_bank_wien,volksbank_gruppe,volkskreditbank_ag"
eps.stripe.banks = "arzte_und_apotheker_bank,austrian_anadi_bank_ag,bank_austria,bankhaus_carl_spangler,bankhaus_schelhammer_und_schattera_ag,bawag_psk_ag,bks_bank_ag,brull_kallmus_bank_ag,btv_vier_lander_bank,capital_bank_grawe_gruppe_ag,dolomitenbank,easybank_ag,erste_bank_und_sparkassen,hypo_alpeadriabank_international_ag,hypo_noe_lb_fur_niederosterreich_u_wien,hypo_oberosterreich_salzburg_steiermark,hypo_tirol_bank_ag,hypo_vorarlberg_bank_ag,hypo_bank_burgenland_aktiengesellschaft,marchfelder_bank,oberbank_ag,raiffeisen_bankengruppe_osterreich,schoellerbank_ag,sparda_bank_wien,volksbank_gruppe,volkskreditbank_ag,vr_bank_braunau"
@@ -15,6 +16,10 @@ przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_peka
connector_list = "stax,stripe,gocardless"
payout_connector_list = "wise"
+# Connector configuration, provided attributes will be used to fulfill API requests.
+# Examples provided here are sandbox/test base urls, can be replaced by live or mock
+# base urls based on your need.
+# Note: These are not optional attributes. hyperswitch request can fail due to invalid/empty values.
[connectors]
aci.base_url = "https://eu-test.oppwa.com/"
adyen.base_url = "https://checkout-test.adyen.com/"
@@ -88,48 +93,48 @@ threedsecureio.base_url = "https://service.sandbox.3dsecure.io"
netcetera.base_url = "https://{{merchant_endpoint_prefix}}.3ds-server.prev.netcetera-cloud-payment.ch"
[delayed_session_response]
-connectors_with_delayed_session_response = "trustpay,payme"
+connectors_with_delayed_session_response = "trustpay,payme" # List of connectors which have delayed session response
[dummy_connector]
-enabled = true
-assets_base_url = "https://app.hyperswitch.io/assets/TestProcessor/"
-authorize_ttl = 36000
-default_return_url = "https://app.hyperswitch.io/"
-discord_invite_url = "https://discord.gg/wJZ7DVW8mm"
-payment_complete_duration = 500
-payment_complete_tolerance = 100
-payment_duration = 1000
-payment_retrieve_duration = 500
-payment_retrieve_tolerance = 100
-payment_tolerance = 100
-payment_ttl = 172800
-refund_duration = 1000
-refund_retrieve_duration = 500
-refund_retrieve_tolerance = 100
-refund_tolerance = 100
-refund_ttl = 172800
-slack_invite_url = "https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2awm23agh-p_G5xNpziv6yAiedTkkqLg"
+enabled = true # Whether dummy connector is enabled or not
+assets_base_url = "https://app.hyperswitch.io/assets/TestProcessor/" # Base url for dummy connector assets
+authorize_ttl = 36000 # Time to live for dummy connector authorize request in redis
+default_return_url = "https://app.hyperswitch.io/" # Default return url when no return url is passed while payment
+discord_invite_url = "https://discord.gg/wJZ7DVW8mm" # Discord invite url for hyperswitch
+payment_complete_duration = 500 # Fake delay duration for dummy connector payment complete
+payment_complete_tolerance = 100 # Fake delay tolerance for dummy connector payment complete
+payment_duration = 1000 # Fake delay duration for dummy connector payment
+payment_retrieve_duration = 500 # Fake delay duration for dummy connector payment sync
+payment_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector payment sync
+payment_tolerance = 100 # Fake delay tolerance for dummy connector payment
+payment_ttl = 172800 # Time to live for dummy connector payment in redis
+refund_duration = 1000 # Fake delay duration for dummy connector refund
+refund_retrieve_duration = 500 # Fake delay duration for dummy connector refund sync
+refund_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector refund sync
+refund_tolerance = 100 # Fake delay tolerance for dummy connector refund
+refund_ttl = 172800 # Time to live for dummy connector refund in redis
+slack_invite_url = "https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2awm23agh-p_G5xNpziv6yAiedTkkqLg" # Slack invite url for hyperswitch
[frm]
enabled = true
[mandates.supported_payment_methods]
-bank_debit.ach.connector_list = "gocardless"
-bank_debit.becs.connector_list = "gocardless"
-bank_debit.sepa.connector_list = "gocardless"
-card.credit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica"
-card.debit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica"
-pay_later.klarna.connector_list = "adyen"
-wallet.apple_pay.connector_list = "stripe,adyen,cybersource,noon,bankofamerica"
-wallet.google_pay.connector_list = "stripe,adyen,cybersource,bankofamerica"
-wallet.paypal.connector_list = "adyen"
-bank_redirect.ideal.connector_list = "stripe,adyen,globalpay"
-bank_redirect.sofort.connector_list = "stripe,adyen,globalpay"
-bank_redirect.giropay.connector_list = "adyen,globalpay"
+bank_debit.ach.connector_list = "gocardless" # Mandate supported payment method type and connector for bank_debit
+bank_debit.becs.connector_list = "gocardless" # Mandate supported payment method type and connector for bank_debit
+bank_debit.sepa.connector_list = "gocardless" # Mandate supported payment method type and connector for bank_debit
+card.credit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica" # Mandate supported payment method type and connector for card
+card.debit.connector_list = "stripe,adyen,authorizedotnet,cybersource,globalpay,worldpay,multisafepay,nmi,nexinets,noon,bankofamerica" # Mandate supported payment method type and connector for card
+pay_later.klarna.connector_list = "adyen" # Mandate supported payment method type and connector for pay_later
+wallet.apple_pay.connector_list = "stripe,adyen,cybersource,noon,bankofamerica" # Mandate supported payment method type and connector for wallets
+wallet.google_pay.connector_list = "stripe,adyen,cybersource,bankofamerica" # Mandate supported payment method type and connector for wallets
+wallet.paypal.connector_list = "adyen" # Mandate supported payment method type and connector for wallets
+bank_redirect.ideal.connector_list = "stripe,adyen,globalpay" # Mandate supported payment method type and connector for bank_redirect
+bank_redirect.sofort.connector_list = "stripe,adyen,globalpay" # Mandate supported payment method type and connector for bank_redirect
+bank_redirect.giropay.connector_list = "adyen,globalpay" # Mandate supported payment method type and connector for bank_redirect
[mandates.update_mandate_supported]
-card.credit = { connector_list = "cybersource" }
-card.debit = { connector_list = "cybersource" }
+card.credit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card
+card.debit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card
[network_transaction_id_supported_connectors]
connector_list = "stripe,adyen,cybersource"
@@ -138,8 +143,9 @@ connector_list = "stripe,adyen,cybersource"
supported_connectors = "braintree"
[payouts]
-payout_eligibility = true
+payout_eligibility = true # Defaults the eligibility of a payout method to true in case connector does not provide checks for payout eligibility
+#Payment Method Filters Based on Country and Currency
[pm_filters.default]
ach = { country = "US", currency = "USD" }
affirm = { country = "US", currency = "USD" }
@@ -308,6 +314,7 @@ cybersource = { payment_method = "card" }
nmi.payment_method = "card"
payme.payment_method = "card"
+#tokenization configuration which describe token lifetime and payment method for specific connector
[tokenization]
braintree = { long_lived_token = false, payment_method = "card" }
checkout = { long_lived_token = false, payment_method = "wallet", apple_pay_pre_decrypt_flow = "network_tokenization" }
@@ -323,7 +330,7 @@ billwerk = {long_lived_token = false, payment_method = "card"}
outgoing_enabled = true
[webhook_source_verification_call]
-connectors_with_webhook_source_verification_call = "paypal"
+connectors_with_webhook_source_verification_call = "paypal" # List of connectors which has additional source verification api-call
[unmasked_headers]
keys = "user-agent"
|
refactor
|
add comments to configs for deployments to environments (#4458)
|
f735fb0551812fd781a2db8bac5a0deef4cabb2b
|
2023-11-16 22:54:14
|
Shankar Singh C
|
feat(router): add fallback while add card and retrieve card from rust locker (#2888)
| false
|
diff --git a/.typos.toml b/.typos.toml
index 1ac38a005c9..4ce21526604 100644
--- a/.typos.toml
+++ b/.typos.toml
@@ -24,6 +24,7 @@ optin = "optin" # Boku preflow name
optin_id = "optin_id" # Boku's id for optin flow
deriver = "deriver"
Deriver = "Deriver"
+requestor_card_reference = "requestor_card_reference"
[default.extend-words]
aci = "aci" # Name of a connector
diff --git a/config/config.example.toml b/config/config.example.toml
index 02eff1d4297..7815f2400d0 100644
--- a/config/config.example.toml
+++ b/config/config.example.toml
@@ -21,25 +21,25 @@ idle_pool_connection_timeout = 90 # Timeout for idle pool connections (defaults
# Main SQL data store credentials
[master_database]
-username = "db_user" # DB Username
-password = "db_pass" # DB Password. Use base-64 encoded kms encrypted value here when kms is enabled
-host = "localhost" # DB Host
-port = 5432 # DB Port
-dbname = "hyperswitch_db" # Name of Database
-pool_size = 5 # Number of connections to keep open
-connection_timeout = 10 # Timeout for database connection in seconds
-queue_strategy = "Fifo" # Add the queue strategy used by the database bb8 client
+username = "db_user" # DB Username
+password = "db_pass" # DB Password. Use base-64 encoded kms encrypted value here when kms is enabled
+host = "localhost" # DB Host
+port = 5432 # DB Port
+dbname = "hyperswitch_db" # Name of Database
+pool_size = 5 # Number of connections to keep open
+connection_timeout = 10 # Timeout for database connection in seconds
+queue_strategy = "Fifo" # Add the queue strategy used by the database bb8 client
# Replica SQL data store credentials
[replica_database]
-username = "replica_user" # DB Username
-password = "db_pass" # DB Password. Use base-64 encoded kms encrypted value here when kms is enabled
-host = "localhost" # DB Host
-port = 5432 # DB Port
-dbname = "hyperswitch_db" # Name of Database
-pool_size = 5 # Number of connections to keep open
-connection_timeout = 10 # Timeout for database connection in seconds
-queue_strategy = "Fifo" # Add the queue strategy used by the database bb8 client
+username = "replica_user" # DB Username
+password = "db_pass" # DB Password. Use base-64 encoded kms encrypted value here when kms is enabled
+host = "localhost" # DB Host
+port = 5432 # DB Port
+dbname = "hyperswitch_db" # Name of Database
+pool_size = 5 # Number of connections to keep open
+connection_timeout = 10 # Timeout for database connection in seconds
+queue_strategy = "Fifo" # Add the queue strategy used by the database bb8 client
# Redis credentials
[redis]
@@ -95,17 +95,17 @@ sampling_rate = 0.1 # decimal rate between 0.0
otel_exporter_otlp_endpoint = "http://localhost:4317" # endpoint to send metrics and traces to, can include port number
otel_exporter_otlp_timeout = 5000 # timeout (in milliseconds) for sending metrics and traces
use_xray_generator = false # Set this to true for AWS X-ray compatible traces
-route_to_trace = [ "*/confirm" ]
+route_to_trace = ["*/confirm"]
# This section provides some secret values.
[secrets]
-master_enc_key = "sample_key" # Master Encryption key used to encrypt merchant wise encryption key. Should be 32-byte long.
-admin_api_key = "test_admin" # admin API key for admin authentication. Only applicable when KMS is disabled.
-kms_encrypted_admin_api_key = "" # Base64-encoded (KMS encrypted) ciphertext of the admin_api_key. Only applicable when KMS is enabled.
-jwt_secret = "secret" # JWT secret used for user authentication. Only applicable when KMS is disabled.
-kms_encrypted_jwt_secret = "" # Base64-encoded (KMS encrypted) ciphertext of the jwt_secret. Only applicable when KMS is enabled.
-recon_admin_api_key = "recon_test_admin" # recon_admin API key for recon authentication. Only applicable when KMS is disabled.
-kms_encrypted_recon_admin_api_key = "" # Base64-encoded (KMS encrypted) ciphertext of the recon_admin_api_key. Only applicable when KMS is enabled
+master_enc_key = "sample_key" # Master Encryption key used to encrypt merchant wise encryption key. Should be 32-byte long.
+admin_api_key = "test_admin" # admin API key for admin authentication. Only applicable when KMS is disabled.
+kms_encrypted_admin_api_key = "" # Base64-encoded (KMS encrypted) ciphertext of the admin_api_key. Only applicable when KMS is enabled.
+jwt_secret = "secret" # JWT secret used for user authentication. Only applicable when KMS is disabled.
+kms_encrypted_jwt_secret = "" # Base64-encoded (KMS encrypted) ciphertext of the jwt_secret. Only applicable when KMS is enabled.
+recon_admin_api_key = "recon_test_admin" # recon_admin API key for recon authentication. Only applicable when KMS is disabled.
+kms_encrypted_recon_admin_api_key = "" # Base64-encoded (KMS encrypted) ciphertext of the recon_admin_api_key. Only applicable when KMS is enabled
# Locker settings contain details for accessing a card locker, a
# PCI Compliant storage entity which stores payment method information
@@ -124,15 +124,15 @@ connectors_with_delayed_session_response = "trustpay,payme" # List of connectors
connectors_with_webhook_source_verification_call = "paypal" # List of connectors which has additional source verification api-call
[jwekey] # 4 priv/pub key pair
-locker_key_identifier1 = "" # key identifier for key rotation , should be same as basilisk
-locker_key_identifier2 = "" # key identifier for key rotation , should be same as basilisk
-locker_encryption_key1 = "" # public key 1 in pem format, corresponding private key in basilisk
-locker_encryption_key2 = "" # public key 2 in pem format, corresponding private key in basilisk
-locker_decryption_key1 = "" # private key 1 in pem format, corresponding public key in basilisk
-locker_decryption_key2 = "" # private key 2 in pem format, corresponding public key in basilisk
-vault_encryption_key = "" # public key in pem format, corresponding private key in basilisk-hs
+locker_key_identifier1 = "" # key identifier for key rotation , should be same as basilisk
+locker_key_identifier2 = "" # key identifier for key rotation , should be same as basilisk
+locker_encryption_key1 = "" # public key 1 in pem format, corresponding private key in basilisk
+locker_encryption_key2 = "" # public key 2 in pem format, corresponding private key in basilisk
+locker_decryption_key1 = "" # private key 1 in pem format, corresponding public key in basilisk
+locker_decryption_key2 = "" # private key 2 in pem format, corresponding public key in basilisk
+vault_encryption_key = "" # public key in pem format, corresponding private key in basilisk-hs
rust_locker_encryption_key = "" # public key in pem format, corresponding private key in rust locker
-vault_private_key = "" # private key in pem format, corresponding public key in basilisk-hs
+vault_private_key = "" # private key in pem format, corresponding public key in basilisk-hs
# Refund configuration
@@ -234,11 +234,11 @@ adyen = { banks = "e_platby_vub,postova_banka,sporo_pay,tatra_pay,viamo" }
# Bank redirect configs for allowed banks through online_banking_poland payment method
[bank_config.online_banking_poland]
-adyen = { banks = "blik_psp,place_zipko,m_bank,pay_with_ing,santander_przelew24,bank_pekaosa,bank_millennium,pay_with_alior_bank,banki_spoldzielcze,pay_with_inteligo,bnp_paribas_poland,bank_nowy_sa,credit_agricole,pay_with_bos,pay_with_citi_handlowy,pay_with_plus_bank,toyota_bank,velo_bank,e_transfer_pocztowy24"}
+adyen = { banks = "blik_psp,place_zipko,m_bank,pay_with_ing,santander_przelew24,bank_pekaosa,bank_millennium,pay_with_alior_bank,banki_spoldzielcze,pay_with_inteligo,bnp_paribas_poland,bank_nowy_sa,credit_agricole,pay_with_bos,pay_with_citi_handlowy,pay_with_plus_bank,toyota_bank,velo_bank,e_transfer_pocztowy24" }
# Bank redirect configs for allowed banks through open_banking_uk payment method
[bank_config.open_banking_uk]
-adyen = { banks = "aib,bank_of_scotland,danske_bank,first_direct,first_trust,halifax,lloyds,monzo,nat_west,nationwide_bank,royal_bank_of_scotland,starling,tsb_bank,tesco_bank,ulster_bank,barclays,hsbc_bank,revolut,santander_przelew24,open_bank_success,open_bank_failure,open_bank_cancelled"}
+adyen = { banks = "aib,bank_of_scotland,danske_bank,first_direct,first_trust,halifax,lloyds,monzo,nat_west,nationwide_bank,royal_bank_of_scotland,starling,tsb_bank,tesco_bank,ulster_bank,barclays,hsbc_bank,revolut,santander_przelew24,open_bank_success,open_bank_failure,open_bank_cancelled" }
# Bank redirect configs for allowed banks through przelewy24 payment method
[bank_config.przelewy24]
@@ -313,89 +313,92 @@ region = "" # The AWS region used by the KMS SDK for decrypting data.
# EmailClient configuration. Only applicable when the `email` feature flag is enabled.
[email]
from_email = "[email protected]" # Sender email
-aws_region = "" # AWS region used by AWS SES
-base_url = "" # Base url used when adding links that should redirect to self
+aws_region = "" # AWS region used by AWS SES
+base_url = "" # Base url used when adding links that should redirect to self
#tokenization configuration which describe token lifetime and payment method for specific connector
[tokenization]
stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { type = "disable_only", list = "google_pay" } }
checkout = { long_lived_token = false, payment_method = "wallet" }
-mollie = {long_lived_token = false, payment_method = "card"}
+mollie = { long_lived_token = false, payment_method = "card" }
stax = { long_lived_token = true, payment_method = "card,bank_debit" }
-square = {long_lived_token = false, payment_method = "card"}
+square = { long_lived_token = false, payment_method = "card" }
braintree = { long_lived_token = false, payment_method = "card" }
-gocardless = {long_lived_token = true, payment_method = "bank_debit"}
+gocardless = { long_lived_token = true, payment_method = "bank_debit" }
[temp_locker_enable_config]
-stripe = {payment_method = "bank_transfer"}
-nuvei = {payment_method = "card"}
-shift4 = {payment_method = "card"}
-bluesnap = {payment_method = "card"}
+stripe = { payment_method = "bank_transfer" }
+nuvei = { payment_method = "card" }
+shift4 = { payment_method = "card" }
+bluesnap = { payment_method = "card" }
[dummy_connector]
-enabled = true # Whether dummy connector is enabled or not
-payment_ttl = 172800 # Time to live for dummy connector payment in redis
-payment_duration = 1000 # Fake delay duration for dummy connector payment
-payment_tolerance = 100 # Fake delay tolerance for dummy connector payment
-payment_retrieve_duration = 500 # Fake delay duration for dummy connector payment sync
-payment_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector payment sync
-payment_complete_duration = 500 # Fake delay duration for dummy connector payment complete
-payment_complete_tolerance = 100 # Fake delay tolerance for dummy connector payment complete
-refund_ttl = 172800 # Time to live for dummy connector refund in redis
-refund_duration = 1000 # Fake delay duration for dummy connector refund
-refund_tolerance = 100 # Fake delay tolerance for dummy connector refund
-refund_retrieve_duration = 500 # Fake delay duration for dummy connector refund sync
-refund_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector refund sync
-authorize_ttl = 36000 # Time to live for dummy connector authorize request in redis
+enabled = true # Whether dummy connector is enabled or not
+payment_ttl = 172800 # Time to live for dummy connector payment in redis
+payment_duration = 1000 # Fake delay duration for dummy connector payment
+payment_tolerance = 100 # Fake delay tolerance for dummy connector payment
+payment_retrieve_duration = 500 # Fake delay duration for dummy connector payment sync
+payment_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector payment sync
+payment_complete_duration = 500 # Fake delay duration for dummy connector payment complete
+payment_complete_tolerance = 100 # Fake delay tolerance for dummy connector payment complete
+refund_ttl = 172800 # Time to live for dummy connector refund in redis
+refund_duration = 1000 # Fake delay duration for dummy connector refund
+refund_tolerance = 100 # Fake delay tolerance for dummy connector refund
+refund_retrieve_duration = 500 # Fake delay duration for dummy connector refund sync
+refund_retrieve_tolerance = 100 # Fake delay tolerance for dummy connector refund sync
+authorize_ttl = 36000 # Time to live for dummy connector authorize request in redis
assets_base_url = "https://www.example.com/" # Base url for dummy connector assets
default_return_url = "https://www.example.com/" # Default return url when no return url is passed while payment
slack_invite_url = "https://www.example.com/" # Slack invite url for hyperswitch
discord_invite_url = "https://www.example.com/" # Discord invite url for hyperswitch
[mandates.supported_payment_methods]
-card.credit = {connector_list = "stripe,adyen"} # Mandate supported payment method type and connector for card
-wallet.paypal = {connector_list = "adyen"} # Mandate supported payment method type and connector for wallets
-pay_later.klarna = {connector_list = "adyen"} # Mandate supported payment method type and connector for pay_later
-bank_debit.ach = { connector_list = "gocardless"} # Mandate supported payment method type and connector for bank_debit
-bank_debit.becs = { connector_list = "gocardless"} # Mandate supported payment method type and connector for bank_debit
-bank_debit.sepa = { connector_list = "gocardless"} # Mandate supported payment method type and connector for bank_debit
+card.credit = { connector_list = "stripe,adyen" } # Mandate supported payment method type and connector for card
+wallet.paypal = { connector_list = "adyen" } # Mandate supported payment method type and connector for wallets
+pay_later.klarna = { connector_list = "adyen" } # Mandate supported payment method type and connector for pay_later
+bank_debit.ach = { connector_list = "gocardless" } # Mandate supported payment method type and connector for bank_debit
+bank_debit.becs = { connector_list = "gocardless" } # Mandate supported payment method type and connector for bank_debit
+bank_debit.sepa = { connector_list = "gocardless" } # Mandate supported payment method type and connector for bank_debit
# Required fields info used while listing the payment_method_data
[required_fields.pay_later] # payment_method = "pay_later"
-afterpay_clearpay = {fields = {stripe = [ # payment_method_type = afterpay_clearpay, connector = "stripe"
- # Required fields vector with its respective display name in front-end and field_type
- { required_field = "shipping.address.first_name", display_name = "first_name", field_type = "text" },
- { required_field = "shipping.address.last_name", display_name = "last_name", field_type = "text" },
- { required_field = "shipping.address.country", display_name = "country", field_type = { drop_down = { options = [ "US", "IN" ] } } },
- ] } }
+afterpay_clearpay = { fields = { stripe = [ # payment_method_type = afterpay_clearpay, connector = "stripe"
+ # Required fields vector with its respective display name in front-end and field_type
+ { required_field = "shipping.address.first_name", display_name = "first_name", field_type = "text" },
+ { required_field = "shipping.address.last_name", display_name = "last_name", field_type = "text" },
+ { required_field = "shipping.address.country", display_name = "country", field_type = { drop_down = { options = [
+ "US",
+ "IN",
+ ] } } },
+] } }
[payouts]
-payout_eligibility = true # Defaults the eligibility of a payout method to true in case connector does not provide checks for payout eligibility
+payout_eligibility = true # Defaults the eligibility of a payout method to true in case connector does not provide checks for payout eligibility
[pm_filters.adyen]
-online_banking_fpx = {country = "MY", currency = "MYR"}
-online_banking_thailand = {country = "TH", currency = "THB"}
-touch_n_go = {country = "MY", currency = "MYR"}
-atome = {country = "MY,SG", currency = "MYR,SGD"}
-swish = {country = "SE", currency = "SEK"}
-permata_bank_transfer = {country = "ID", currency = "IDR"}
-bca_bank_transfer = {country = "ID", currency = "IDR"}
-bni_va = {country = "ID", currency = "IDR"}
-bri_va = {country = "ID", currency = "IDR"}
-cimb_va = {country = "ID", currency = "IDR"}
-danamon_va = {country = "ID", currency = "IDR"}
-mandiri_va = {country = "ID", currency = "IDR"}
-alfamart = {country = "ID", currency = "IDR"}
-indomaret = {country = "ID", currency = "IDR"}
-open_banking_uk = {country = "GB", currency = "GBP"}
-oxxo = {country = "MX", currency = "MXN"}
-pay_safe_card = {country = "AT,AU,BE,BR,BE,CA,HR,CY,CZ,DK,FI,FR,GE,DE,GI,HU,IS,IE,KW,LV,IE,LI,LT,LU,MT,MX,MD,ME,NL,NZ,NO,PY,PE,PL,PT,RO,SA,RS,SK,SI,ES,SE,CH,TR,UAE,UK,US,UY", currency = "EUR,AUD,BRL,CAD,CZK,DKK,GEL,GIP,HUF,ISK,KWD,CHF,MXN,MDL,NZD,NOK,PYG,PEN,PLN,RON,SAR,RSD,SEK,TRY,AED,GBP,USD,UYU"}
-seven_eleven = {country = "JP", currency = "JPY"}
-lawson = {country = "JP", currency = "JPY"}
-mini_stop = {country = "JP", currency = "JPY"}
-family_mart = {country = "JP", currency = "JPY"}
-seicomart = {country = "JP", currency = "JPY"}
-pay_easy = {country = "JP", currency = "JPY"}
+online_banking_fpx = { country = "MY", currency = "MYR" }
+online_banking_thailand = { country = "TH", currency = "THB" }
+touch_n_go = { country = "MY", currency = "MYR" }
+atome = { country = "MY,SG", currency = "MYR,SGD" }
+swish = { country = "SE", currency = "SEK" }
+permata_bank_transfer = { country = "ID", currency = "IDR" }
+bca_bank_transfer = { country = "ID", currency = "IDR" }
+bni_va = { country = "ID", currency = "IDR" }
+bri_va = { country = "ID", currency = "IDR" }
+cimb_va = { country = "ID", currency = "IDR" }
+danamon_va = { country = "ID", currency = "IDR" }
+mandiri_va = { country = "ID", currency = "IDR" }
+alfamart = { country = "ID", currency = "IDR" }
+indomaret = { country = "ID", currency = "IDR" }
+open_banking_uk = { country = "GB", currency = "GBP" }
+oxxo = { country = "MX", currency = "MXN" }
+pay_safe_card = { country = "AT,AU,BE,BR,BE,CA,HR,CY,CZ,DK,FI,FR,GE,DE,GI,HU,IS,IE,KW,LV,IE,LI,LT,LU,MT,MX,MD,ME,NL,NZ,NO,PY,PE,PL,PT,RO,SA,RS,SK,SI,ES,SE,CH,TR,UAE,UK,US,UY", currency = "EUR,AUD,BRL,CAD,CZK,DKK,GEL,GIP,HUF,ISK,KWD,CHF,MXN,MDL,NZD,NOK,PYG,PEN,PLN,RON,SAR,RSD,SEK,TRY,AED,GBP,USD,UYU" }
+seven_eleven = { country = "JP", currency = "JPY" }
+lawson = { country = "JP", currency = "JPY" }
+mini_stop = { country = "JP", currency = "JPY" }
+family_mart = { country = "JP", currency = "JPY" }
+seicomart = { country = "JP", currency = "JPY" }
+pay_easy = { country = "JP", currency = "JPY" }
[pm_filters.zen]
credit = { not_available_flows = { capture_method = "manual" } }
@@ -415,7 +418,7 @@ debit = { currency = "USD" }
ach = { currency = "USD" }
[pm_filters.stripe]
-cashapp = {country = "US", currency = "USD"}
+cashapp = { country = "US", currency = "USD" }
[pm_filters.prophetpay]
card_redirect = { currency = "USD" }
@@ -434,10 +437,10 @@ adyen.banks = "bangkok_bank,krungsri_bank,krung_thai_bank,the_siam_commercial_ba
supported_connectors = "braintree"
[applepay_decrypt_keys]
-apple_pay_ppc = "APPLE_PAY_PAYMENT_PROCESSING_CERTIFICATE" #Payment Processing Certificate provided by Apple Pay (https://developer.apple.com/) Certificates, Identifiers & Profiles > Apple Pay Payment Processing Certificate
-apple_pay_ppc_key = "APPLE_PAY_PAYMENT_PROCESSING_CERTIFICATE_KEY" #Private key generate by Elliptic-curve prime256v1 curve
-apple_pay_merchant_cert = "APPLE_PAY_MERCHNAT_CERTIFICATE" #Merchant Certificate provided by Apple Pay (https://developer.apple.com/) Certificates, Identifiers & Profiles > Apple Pay Merchant Identity Certificate
-apple_pay_merchant_cert_key = "APPLE_PAY_MERCHNAT_CERTIFICATE_KEY" #Private key generate by RSA:2048 algorithm
+apple_pay_ppc = "APPLE_PAY_PAYMENT_PROCESSING_CERTIFICATE" #Payment Processing Certificate provided by Apple Pay (https://developer.apple.com/) Certificates, Identifiers & Profiles > Apple Pay Payment Processing Certificate
+apple_pay_ppc_key = "APPLE_PAY_PAYMENT_PROCESSING_CERTIFICATE_KEY" #Private key generate by Elliptic-curve prime256v1 curve
+apple_pay_merchant_cert = "APPLE_PAY_MERCHNAT_CERTIFICATE" #Merchant Certificate provided by Apple Pay (https://developer.apple.com/) Certificates, Identifiers & Profiles > Apple Pay Merchant Identity Certificate
+apple_pay_merchant_cert_key = "APPLE_PAY_MERCHNAT_CERTIFICATE_KEY" #Private key generate by RSA:2048 algorithm
[payment_link]
sdk_url = "http://localhost:9090/dist/HyperLoader.js"
diff --git a/crates/router/src/core/locker_migration.rs b/crates/router/src/core/locker_migration.rs
index aa82b4a3a63..f036a03a2f0 100644
--- a/crates/router/src/core/locker_migration.rs
+++ b/crates/router/src/core/locker_migration.rs
@@ -106,7 +106,7 @@ pub async fn call_to_locker(
let (_add_card_rs_resp, _is_duplicate) = cards::add_card_hs(
state,
pm_create,
- card_details,
+ &card_details,
customer_id.to_string(),
merchant_account,
api_enums::LockerChoice::Tartarus,
diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs
index f9c666cbb95..4ab7d334f88 100644
--- a/crates/router/src/core/payment_methods/cards.rs
+++ b/crates/router/src/core/payment_methods/cards.rs
@@ -103,16 +103,12 @@ pub async fn add_payment_method(
let merchant_id = &merchant_account.merchant_id;
let customer_id = req.customer_id.clone().get_required_value("customer_id")?;
let response = match req.card.clone() {
- Some(card) => add_card_to_locker(
- &state,
- req.clone(),
- card,
- customer_id.clone(),
- merchant_account,
- )
- .await
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Add Card Failed"),
+ Some(card) => {
+ add_card_to_locker(&state, req.clone(), &card, &customer_id, merchant_account)
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Add Card Failed")
+ }
None => {
let pm_id = generate_id(consts::ID_LENGTH, "pm");
let payment_method_response = api::PaymentMethodResponse {
@@ -207,18 +203,18 @@ pub async fn update_customer_payment_method(
pub async fn add_card_to_locker(
state: &routes::AppState,
req: api::PaymentMethodCreate,
- card: api::CardDetail,
- customer_id: String,
+ card: &api::CardDetail,
+ customer_id: &String,
merchant_account: &domain::MerchantAccount,
) -> errors::CustomResult<(api::PaymentMethodResponse, bool), errors::VaultError> {
metrics::STORED_TO_LOCKER.add(&metrics::CONTEXT, 1, &[]);
- request::record_operation_time(
+ let add_card_to_hs_resp = request::record_operation_time(
async {
add_card_hs(
state,
- req,
+ req.clone(),
card,
- customer_id,
+ customer_id.to_string(),
merchant_account,
api_enums::LockerChoice::Basilisk,
None,
@@ -232,7 +228,34 @@ pub async fn add_card_to_locker(
&metrics::CARD_ADD_TIME,
&[],
)
- .await
+ .await?;
+ logger::debug!("card added to basilisk locker");
+
+ let add_card_to_rs_resp = request::record_operation_time(
+ async {
+ add_card_hs(
+ state,
+ req,
+ card,
+ customer_id.to_string(),
+ merchant_account,
+ api_enums::LockerChoice::Tartarus,
+ Some(&add_card_to_hs_resp.0.payment_method_id),
+ )
+ .await
+ .map_err(|error| {
+ metrics::CARD_LOCKER_FAILURES.add(&metrics::CONTEXT, 1, &[]);
+ error
+ })
+ },
+ &metrics::CARD_ADD_TIME,
+ &[],
+ )
+ .await?;
+
+ logger::debug!("card added to rust locker");
+
+ Ok(add_card_to_rs_resp)
}
pub async fn get_card_from_locker(
@@ -243,9 +266,38 @@ pub async fn get_card_from_locker(
) -> errors::RouterResult<payment_methods::Card> {
metrics::GET_FROM_LOCKER.add(&metrics::CONTEXT, 1, &[]);
- request::record_operation_time(
+ let get_card_from_rs_locker_resp = request::record_operation_time(
async {
- get_card_from_hs_locker(state, customer_id, merchant_id, card_reference)
+ get_card_from_hs_locker(
+ state,
+ customer_id,
+ merchant_id,
+ card_reference,
+ api_enums::LockerChoice::Tartarus,
+ )
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed while getting card from basilisk_hs")
+ .map_err(|error| {
+ metrics::CARD_LOCKER_FAILURES.add(&metrics::CONTEXT, 1, &[]);
+ error
+ })
+ },
+ &metrics::CARD_GET_TIME,
+ &[],
+ )
+ .await;
+
+ match get_card_from_rs_locker_resp {
+ Err(_) => request::record_operation_time(
+ async {
+ get_card_from_hs_locker(
+ state,
+ customer_id,
+ merchant_id,
+ card_reference,
+ api_enums::LockerChoice::Basilisk,
+ )
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed while getting card from basilisk_hs")
@@ -253,11 +305,20 @@ pub async fn get_card_from_locker(
metrics::CARD_LOCKER_FAILURES.add(&metrics::CONTEXT, 1, &[]);
error
})
- },
- &metrics::CARD_GET_TIME,
- &[],
- )
- .await
+ },
+ &metrics::CARD_GET_TIME,
+ &[],
+ )
+ .await
+ .map(|inner_card| {
+ logger::debug!("card retrieved from basilisk locker");
+ inner_card
+ }),
+ Ok(_) => {
+ logger::debug!("card retrieved from rust locker");
+ get_card_from_rs_locker_resp
+ }
+ }
}
pub async fn delete_card_from_locker(
@@ -287,7 +348,7 @@ pub async fn delete_card_from_locker(
pub async fn add_card_hs(
state: &routes::AppState,
req: api::PaymentMethodCreate,
- card: api::CardDetail,
+ card: &api::CardDetail,
customer_id: String,
merchant_account: &domain::MerchantAccount,
locker_choice: api_enums::LockerChoice,
@@ -296,7 +357,7 @@ pub async fn add_card_hs(
let payload = payment_methods::StoreLockerReq::LockerCard(payment_methods::StoreCardReq {
merchant_id: &merchant_account.merchant_id,
merchant_customer_id: customer_id.to_owned(),
- card_reference: card_reference.map(str::to_string),
+ requestor_card_reference: card_reference.map(str::to_string),
card: payment_methods::Card {
card_number: card.card_number.to_owned(),
name_on_card: card.card_holder_name.to_owned(),
@@ -307,11 +368,12 @@ pub async fn add_card_hs(
nick_name: card.nick_name.as_ref().map(masking::Secret::peek).cloned(),
},
});
+
let store_card_payload =
call_to_locker_hs(state, &payload, &customer_id, locker_choice).await?;
let payment_method_resp = payment_methods::mk_add_card_response_hs(
- card,
+ card.clone(),
store_card_payload.card_reference,
req,
&merchant_account.merchant_id,
@@ -351,6 +413,7 @@ pub async fn get_payment_method_from_hs_locker<'a>(
customer_id: &str,
merchant_id: &str,
payment_method_reference: &'a str,
+ locker_choice: Option<api_enums::LockerChoice>,
) -> errors::CustomResult<Secret<String>, errors::VaultError> {
let locker = &state.conf.locker;
#[cfg(not(feature = "kms"))]
@@ -365,6 +428,7 @@ pub async fn get_payment_method_from_hs_locker<'a>(
customer_id,
merchant_id,
payment_method_reference,
+ locker_choice,
)
.await
.change_context(errors::VaultError::FetchPaymentMethodFailed)
@@ -466,6 +530,7 @@ pub async fn get_card_from_hs_locker<'a>(
customer_id: &str,
merchant_id: &str,
card_reference: &'a str,
+ locker_choice: api_enums::LockerChoice,
) -> errors::CustomResult<payment_methods::Card, errors::VaultError> {
let locker = &state.conf.locker;
#[cfg(not(feature = "kms"))]
@@ -480,6 +545,7 @@ pub async fn get_card_from_hs_locker<'a>(
customer_id,
merchant_id,
card_reference,
+ Some(locker_choice),
)
.await
.change_context(errors::VaultError::FetchCardFailed)
@@ -2193,6 +2259,7 @@ pub async fn get_lookup_key_for_payout_method(
&pm.customer_id,
&pm.merchant_id,
&pm.payment_method_id,
+ None,
)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
diff --git a/crates/router/src/core/payment_methods/transformers.rs b/crates/router/src/core/payment_methods/transformers.rs
index 63a0479375e..45182411c28 100644
--- a/crates/router/src/core/payment_methods/transformers.rs
+++ b/crates/router/src/core/payment_methods/transformers.rs
@@ -28,7 +28,7 @@ pub struct StoreCardReq<'a> {
pub merchant_id: &'a str,
pub merchant_customer_id: String,
#[serde(skip_serializing_if = "Option::is_none")]
- pub card_reference: Option<String>,
+ pub requestor_card_reference: Option<String>,
pub card: Card,
}
@@ -428,6 +428,7 @@ pub async fn mk_get_card_request_hs(
customer_id: &str,
merchant_id: &str,
card_reference: &str,
+ locker_choice: Option<api_enums::LockerChoice>,
) -> CustomResult<services::Request, errors::VaultError> {
let merchant_customer_id = customer_id.to_owned();
let card_req_body = CardReqBody {
@@ -448,11 +449,16 @@ pub async fn mk_get_card_request_hs(
.await
.change_context(errors::VaultError::RequestEncodingFailed)?;
- let jwe_payload = mk_basilisk_req(jwekey, &jws, api_enums::LockerChoice::Basilisk).await?;
+ let target_locker = locker_choice.unwrap_or(api_enums::LockerChoice::Basilisk);
+
+ let jwe_payload = mk_basilisk_req(jwekey, &jws, target_locker).await?;
let body = utils::Encode::<encryption::JweBody>::encode_to_value(&jwe_payload)
.change_context(errors::VaultError::RequestEncodingFailed)?;
- let mut url = locker.host.to_owned();
+ let mut url = match target_locker {
+ api_enums::LockerChoice::Basilisk => locker.host.to_owned(),
+ api_enums::LockerChoice::Tartarus => locker.host_rs.to_owned(),
+ };
url.push_str("/cards/retrieve");
let mut request = services::Request::new(services::Method::Post, &url);
request.add_header(headers::CONTENT_TYPE, "application/json".into());
diff --git a/crates/router/src/core/payments/tokenization.rs b/crates/router/src/core/payments/tokenization.rs
index 794180e2112..551d1c8abb9 100644
--- a/crates/router/src/core/payments/tokenization.rs
+++ b/crates/router/src/core/payments/tokenization.rs
@@ -183,8 +183,8 @@ pub async fn save_in_locker(
Some(card) => payment_methods::cards::add_card_to_locker(
state,
payment_method_request,
- card,
- customer_id,
+ &card,
+ &customer_id,
merchant_account,
)
.await
diff --git a/crates/router/src/core/payouts/helpers.rs b/crates/router/src/core/payouts/helpers.rs
index c1e00b9b800..9ddc8395738 100644
--- a/crates/router/src/core/payouts/helpers.rs
+++ b/crates/router/src/core/payouts/helpers.rs
@@ -152,7 +152,7 @@ pub async fn save_payout_data_to_locker(
card_isin: None,
nick_name: None,
},
- card_reference: None,
+ requestor_card_reference: None,
});
(
payload,
|
feat
|
add fallback while add card and retrieve card from rust locker (#2888)
|
10691c5fce630d60aade862080d25c62a5cddb44
|
2023-06-03 18:55:15
|
Younes
|
feat(db): implement `RefundInterface` for `MockDb` (#1277)
| false
|
diff --git a/crates/router/src/db/refund.rs b/crates/router/src/db/refund.rs
index e3ff8b8dc6d..bb40bd76429 100644
--- a/crates/router/src/db/refund.rs
+++ b/crates/router/src/db/refund.rs
@@ -1,4 +1,4 @@
-use storage_models::errors::DatabaseError;
+use storage_models::{errors::DatabaseError, refund::RefundUpdateInternal};
use super::MockDb;
use crate::{
@@ -604,12 +604,21 @@ mod storage {
impl RefundInterface for MockDb {
async fn find_refund_by_internal_reference_id_merchant_id(
&self,
- _internal_reference_id: &str,
- _merchant_id: &str,
+ internal_reference_id: &str,
+ merchant_id: &str,
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<storage_types::Refund, errors::StorageError> {
- // [#172]: Implement function for `MockDb`
- Err(errors::StorageError::MockDbError)?
+ let refunds = self.refunds.lock().await;
+ refunds
+ .iter()
+ .find(|refund| {
+ refund.merchant_id == merchant_id
+ && refund.internal_reference_id == internal_reference_id
+ })
+ .cloned()
+ .ok_or_else(|| {
+ errors::StorageError::DatabaseError(DatabaseError::NotFound.into()).into()
+ })
}
async fn insert_refund(
@@ -670,12 +679,24 @@ impl RefundInterface for MockDb {
async fn update_refund(
&self,
- _this: storage_types::Refund,
- _refund: storage_types::RefundUpdate,
+ this: storage_types::Refund,
+ refund: storage_types::RefundUpdate,
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<storage_types::Refund, errors::StorageError> {
- // [#172]: Implement function for `MockDb`
- Err(errors::StorageError::MockDbError)?
+ self.refunds
+ .lock()
+ .await
+ .iter_mut()
+ .find(|refund| this.refund_id == refund.refund_id)
+ .map(|r| {
+ let refund_updated = RefundUpdateInternal::from(refund).create_refund(r.clone());
+ *r = refund_updated.clone();
+ refund_updated
+ })
+ .ok_or_else(|| {
+ errors::StorageError::ValueNotFound("cannot find refund to update".to_string())
+ .into()
+ })
}
async fn find_refund_by_merchant_id_refund_id(
@@ -719,23 +740,34 @@ impl RefundInterface for MockDb {
async fn find_refund_by_payment_id_merchant_id(
&self,
- _payment_id: &str,
- _merchant_id: &str,
+ payment_id: &str,
+ merchant_id: &str,
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<Vec<storage_types::Refund>, errors::StorageError> {
- // [#172]: Implement function for `MockDb`
- Err(errors::StorageError::MockDbError)?
+ let refunds = self.refunds.lock().await;
+
+ Ok(refunds
+ .iter()
+ .filter(|refund| refund.merchant_id == merchant_id && refund.payment_id == payment_id)
+ .cloned()
+ .collect::<Vec<_>>())
}
#[cfg(feature = "olap")]
async fn filter_refund_by_constraints(
&self,
- _merchant_id: &str,
+ merchant_id: &str,
_refund_details: &api_models::refunds::RefundListRequest,
_storage_scheme: enums::MerchantStorageScheme,
- _limit: i64,
+ limit: i64,
) -> CustomResult<Vec<storage_models::refund::Refund>, errors::StorageError> {
- // [#172]: Implement function for `MockDb`
- Err(errors::StorageError::MockDbError)?
+ let refunds = self.refunds.lock().await;
+
+ Ok(refunds
+ .iter()
+ .filter(|refund| refund.merchant_id == merchant_id)
+ .take(usize::try_from(limit).unwrap_or(usize::MAX))
+ .cloned()
+ .collect::<Vec<_>>())
}
}
diff --git a/crates/storage_models/src/refund.rs b/crates/storage_models/src/refund.rs
index ae590532d1f..b0b1f03f200 100644
--- a/crates/storage_models/src/refund.rs
+++ b/crates/storage_models/src/refund.rs
@@ -115,6 +115,22 @@ pub struct RefundUpdateInternal {
refund_error_code: Option<String>,
}
+impl RefundUpdateInternal {
+ pub fn create_refund(self, source: Refund) -> Refund {
+ Refund {
+ connector_refund_id: self.connector_refund_id,
+ refund_status: self.refund_status.unwrap_or_default(),
+ sent_to_gateway: self.sent_to_gateway.unwrap_or_default(),
+ refund_error_message: self.refund_error_message,
+ refund_arn: self.refund_arn,
+ metadata: self.metadata,
+ refund_reason: self.refund_reason,
+ refund_error_code: self.refund_error_code,
+ ..source
+ }
+ }
+}
+
impl From<RefundUpdate> for RefundUpdateInternal {
fn from(refund_update: RefundUpdate) -> Self {
match refund_update {
|
feat
|
implement `RefundInterface` for `MockDb` (#1277)
|
5bb9e745d8b290feaca994af3983716076be7ac6
|
2023-01-13 00:33:43
|
Jagan
|
fix(connector): pass error message to response body instead of changing the context for required field validation (#365)
| false
|
diff --git a/crates/router/src/connector/globalpay.rs b/crates/router/src/connector/globalpay.rs
index 2171d8e2db5..b1244c0f097 100644
--- a/crates/router/src/connector/globalpay.rs
+++ b/crates/router/src/connector/globalpay.rs
@@ -147,8 +147,10 @@ impl ConnectorIntegration<api::Void, types::PaymentsCancelData, types::PaymentsR
&self,
req: &types::PaymentsCancelRouterData,
) -> CustomResult<Option<String>, errors::ConnectorError> {
- let globalpay_req = utils::Encode::<GlobalpayPaymentsRequest>::convert_and_encode(req)
- .change_context(errors::ConnectorError::RequestEncodingFailed)?;
+ let req_obj = GlobalpayPaymentsRequest::try_from(req)?;
+ let globalpay_req =
+ utils::Encode::<GlobalpayPaymentsRequest>::encode_to_string_of_json(&req_obj)
+ .change_context(errors::ConnectorError::RequestEncodingFailed)?;
Ok(Some(globalpay_req))
}
@@ -282,8 +284,10 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
&self,
req: &types::PaymentsCaptureRouterData,
) -> CustomResult<Option<String>, errors::ConnectorError> {
- let globalpay_req = utils::Encode::<GlobalpayPaymentsRequest>::convert_and_encode(req)
- .change_context(errors::ConnectorError::RequestEncodingFailed)?;
+ let req_obj = GlobalpayPaymentsRequest::try_from(req)?;
+ let globalpay_req =
+ utils::Encode::<GlobalpayPaymentsRequest>::encode_to_string_of_json(&req_obj)
+ .change_context(errors::ConnectorError::RequestEncodingFailed)?;
Ok(Some(globalpay_req))
}
@@ -367,8 +371,10 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
&self,
req: &types::PaymentsAuthorizeRouterData,
) -> CustomResult<Option<String>, errors::ConnectorError> {
- let globalpay_req = utils::Encode::<GlobalpayPaymentsRequest>::convert_and_encode(req)
- .change_context(errors::ConnectorError::RequestEncodingFailed)?;
+ let req_obj = GlobalpayPaymentsRequest::try_from(req)?;
+ let globalpay_req =
+ utils::Encode::<GlobalpayPaymentsRequest>::encode_to_string_of_json(&req_obj)
+ .change_context(errors::ConnectorError::RequestEncodingFailed)?;
Ok(Some(globalpay_req))
}
diff --git a/crates/router/src/core/errors/utils.rs b/crates/router/src/core/errors/utils.rs
index 5241881c16d..97297fb637d 100644
--- a/crates/router/src/core/errors/utils.rs
+++ b/crates/router/src/core/errors/utils.rs
@@ -83,6 +83,9 @@ impl ConnectorErrorExt for error_stack::Report<errors::ConnectorError> {
errors::ConnectorError::RequestEncodingFailedWithReason(reason) => {
Some(serde_json::json!(reason))
}
+ errors::ConnectorError::MissingRequiredField { field_name } => {
+ Some(serde_json::json!({ "missing_field": field_name }))
+ }
_ => None,
};
self.change_context(errors::ApiErrorResponse::PaymentAuthorizationFailed { data })
|
fix
|
pass error message to response body instead of changing the context for required field validation (#365)
|
b08ce22108a5f64d33430806a8bea034c5ccb44a
|
2024-06-28 12:01:15
|
Sahkal Poddar
|
refactor(connector): added amount framework to paypal, payouts and routing (#4865)
| false
|
diff --git a/Cargo.lock b/Cargo.lock
index 9b08fcbd57b..33a587ca0ca 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2870,6 +2870,7 @@ name = "euclid"
version = "0.1.0"
dependencies = [
"common_enums",
+ "common_utils",
"criterion",
"erased-serde 0.4.4",
"euclid_macros",
@@ -4149,6 +4150,7 @@ version = "0.1.0"
dependencies = [
"api_models",
"common_enums",
+ "common_utils",
"criterion",
"euclid",
"hyperswitch_constraint_graph",
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
index c586fce896c..e8d82cffddd 100644
--- a/api-reference/openapi_spec.json
+++ b/api-reference/openapi_spec.json
@@ -12460,8 +12460,7 @@
"$ref": "#/components/schemas/ComparisonType"
},
"number": {
- "type": "integer",
- "format": "int64"
+ "$ref": "#/components/schemas/MinorUnit"
}
}
},
@@ -17003,7 +17002,8 @@
"amount": {
"type": "integer",
"format": "int64",
- "description": "The payout attempt amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,"
+ "description": "The payout attempt amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,",
+ "example": 6583
},
"currency": {
"allOf": [
@@ -18586,17 +18586,19 @@
"nullable": true
},
"minimum_amount": {
- "type": "integer",
- "format": "int32",
- "description": "Minimum amount supported by the processor. To be represented in the lowest denomination of the target currency (For example, for USD it should be in cents)",
- "example": 1,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MinorUnit"
+ }
+ ],
"nullable": true
},
"maximum_amount": {
- "type": "integer",
- "format": "int32",
- "description": "Maximum amount supported by the processor. To be represented in the lowest denomination of\nthe target currency (For example, for USD it should be in cents)",
- "example": 1313,
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/MinorUnit"
+ }
+ ],
"nullable": true
},
"recurring_enabled": {
@@ -19916,9 +19918,7 @@
]
},
"value": {
- "type": "integer",
- "format": "int64",
- "description": "Represents a number literal"
+ "$ref": "#/components/schemas/MinorUnit"
}
}
},
@@ -19994,8 +19994,7 @@
"value": {
"type": "array",
"items": {
- "type": "integer",
- "format": "int64"
+ "$ref": "#/components/schemas/MinorUnit"
},
"description": "Represents an array of numbers. This is basically used for\n\"one of the given numbers\" operations\neg: payment.method.amount = (1, 2, 3)"
}
diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs
index 1f82508e15f..19f183d28f5 100644
--- a/crates/api_models/src/payment_methods.rs
+++ b/crates/api_models/src/payment_methods.rs
@@ -605,12 +605,12 @@ pub struct RequestPaymentMethodTypes {
/// Minimum amount supported by the processor. To be represented in the lowest denomination of the target currency (For example, for USD it should be in cents)
#[schema(example = 1)]
- pub minimum_amount: Option<i32>,
+ pub minimum_amount: Option<MinorUnit>,
/// Maximum amount supported by the processor. To be represented in the lowest denomination of
/// the target currency (For example, for USD it should be in cents)
#[schema(example = 1313)]
- pub maximum_amount: Option<i32>,
+ pub maximum_amount: Option<MinorUnit>,
/// Boolean to enable recurring payments / mandates. Default is true.
#[schema(default = true, example = false)]
diff --git a/crates/api_models/src/payouts.rs b/crates/api_models/src/payouts.rs
index 33be58af10c..a7eb2cd568a 100644
--- a/crates/api_models/src/payouts.rs
+++ b/crates/api_models/src/payouts.rs
@@ -366,7 +366,7 @@ pub struct PayoutCreateResponse {
/// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,
#[schema(value_type = i64, example = 1000)]
- pub amount: i64,
+ pub amount: common_utils::types::MinorUnit,
/// Recipient's currency for the payout request
#[schema(value_type = Currency, example = "USD")]
@@ -501,7 +501,8 @@ pub struct PayoutAttemptResponse {
#[schema(value_type = PayoutStatus, example = "failed")]
pub status: api_enums::PayoutStatus,
/// The payout attempt amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc.,
- pub amount: i64,
+ #[schema(value_type = i64, example = 6583)]
+ pub amount: common_utils::types::MinorUnit,
/// The currency of the amount of the payout attempt
#[schema(value_type = Option<Currency>, example = "USD")]
pub currency: Option<api_enums::Currency>,
@@ -723,7 +724,7 @@ pub struct PayoutLinkDetails {
#[serde(flatten)]
pub ui_config: link_utils::GenericLinkUIConfigFormData,
pub enabled_payment_methods: Vec<link_utils::EnabledPaymentMethod>,
- pub amount: String,
+ pub amount: common_utils::types::StringMajorUnit,
pub currency: common_enums::Currency,
}
diff --git a/crates/common_utils/src/types.rs b/crates/common_utils/src/types.rs
index 0f30270d323..36f40da2dc8 100644
--- a/crates/common_utils/src/types.rs
+++ b/crates/common_utils/src/types.rs
@@ -343,6 +343,11 @@ impl MinorUnit {
self.0
}
+ /// forms a new minor default unit i.e zero
+ pub fn zero() -> Self {
+ Self(0)
+ }
+
/// forms a new minor unit from amount
pub fn new(value: i64) -> Self {
Self(value)
@@ -543,6 +548,11 @@ impl StringMajorUnit {
.ok_or(ParsingError::DecimalToI64ConversionFailure)?;
Ok(MinorUnit::new(amount_i64))
}
+
+ /// Get string amount from struct to be removed in future
+ pub fn get_amount_as_string(&self) -> String {
+ self.0.clone()
+ }
}
#[cfg(test)]
diff --git a/crates/connector_configs/src/transformer.rs b/crates/connector_configs/src/transformer.rs
index 5003013ac9d..2e42d756571 100644
--- a/crates/connector_configs/src/transformer.rs
+++ b/crates/connector_configs/src/transformer.rs
@@ -2,10 +2,11 @@ use std::str::FromStr;
use api_models::{
enums::{
- Connector, PaymentMethod, PaymentMethodType,
- PaymentMethodType::{AliPay, ApplePay, GooglePay, Klarna, Paypal, WeChatPay},
+ Connector, PaymentMethod,
+ PaymentMethodType::{self, AliPay, ApplePay, GooglePay, Klarna, Paypal, WeChatPay},
},
payment_methods, payments,
+ refunds::MinorUnit,
};
use crate::common_config::{
@@ -21,8 +22,8 @@ impl DashboardRequestPayload {
payment_methods::RequestPaymentMethodTypes {
payment_method_type,
card_networks: Some(card_provider),
- minimum_amount: Some(0),
- maximum_amount: Some(68607706),
+ minimum_amount: Some(MinorUnit::zero()),
+ maximum_amount: Some(MinorUnit::new(68607706)),
recurring_enabled: true,
installment_payment_enabled: false,
accepted_currencies: None,
@@ -74,8 +75,8 @@ impl DashboardRequestPayload {
let data = payment_methods::RequestPaymentMethodTypes {
payment_method_type: method_type.payment_method_type,
card_networks: None,
- minimum_amount: Some(0),
- maximum_amount: Some(68607706),
+ minimum_amount: Some(MinorUnit::zero()),
+ maximum_amount: Some(MinorUnit::new(68607706)),
recurring_enabled: true,
installment_payment_enabled: false,
accepted_currencies: method_type.accepted_currencies,
@@ -113,8 +114,8 @@ impl DashboardRequestPayload {
let data = payment_methods::RequestPaymentMethodTypes {
payment_method_type: payment_type,
card_networks: Some(vec![method.payment_method_type]),
- minimum_amount: Some(0),
- maximum_amount: Some(68607706),
+ minimum_amount: Some(MinorUnit::zero()),
+ maximum_amount: Some(MinorUnit::new(68607706)),
recurring_enabled: true,
installment_payment_enabled: false,
accepted_currencies: method.accepted_currencies,
diff --git a/crates/diesel_models/src/payouts.rs b/crates/diesel_models/src/payouts.rs
index bf6ce772cb8..5cb06d7755b 100644
--- a/crates/diesel_models/src/payouts.rs
+++ b/crates/diesel_models/src/payouts.rs
@@ -1,4 +1,4 @@
-use common_utils::{id_type, pii};
+use common_utils::{id_type, pii, types::MinorUnit};
use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
use serde::{self, Deserialize, Serialize};
use time::PrimitiveDateTime;
@@ -16,7 +16,7 @@ pub struct Payouts {
pub address_id: String,
pub payout_type: Option<storage_enums::PayoutType>,
pub payout_method_id: Option<String>,
- pub amount: i64,
+ pub amount: MinorUnit,
pub destination_currency: storage_enums::Currency,
pub source_currency: storage_enums::Currency,
pub description: Option<String>,
@@ -57,7 +57,7 @@ pub struct PayoutsNew {
pub address_id: String,
pub payout_type: Option<storage_enums::PayoutType>,
pub payout_method_id: Option<String>,
- pub amount: i64,
+ pub amount: MinorUnit,
pub destination_currency: storage_enums::Currency,
pub source_currency: storage_enums::Currency,
pub description: Option<String>,
@@ -82,7 +82,7 @@ pub struct PayoutsNew {
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum PayoutsUpdate {
Update {
- amount: i64,
+ amount: MinorUnit,
destination_currency: storage_enums::Currency,
source_currency: storage_enums::Currency,
description: Option<String>,
@@ -113,7 +113,7 @@ pub enum PayoutsUpdate {
#[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)]
#[diesel(table_name = payouts)]
pub struct PayoutsUpdateInternal {
- pub amount: Option<i64>,
+ pub amount: Option<MinorUnit>,
pub destination_currency: Option<storage_enums::Currency>,
pub source_currency: Option<storage_enums::Currency>,
pub description: Option<String>,
diff --git a/crates/euclid/Cargo.toml b/crates/euclid/Cargo.toml
index b408c013572..295f0327788 100644
--- a/crates/euclid/Cargo.toml
+++ b/crates/euclid/Cargo.toml
@@ -23,6 +23,7 @@ utoipa = { version = "4.2.0", features = ["preserve_order", "preserve_path_order
common_enums = { version = "0.1.0", path = "../common_enums" }
hyperswitch_constraint_graph = { version = "0.1.0", path = "../hyperswitch_constraint_graph", features = ["viz"] }
euclid_macros = { version = "0.1.0", path = "../euclid_macros" }
+common_utils = { version = "0.1.0", path = "../common_utils"}
[features]
default = []
diff --git a/crates/euclid/benches/backends.rs b/crates/euclid/benches/backends.rs
index 9d29c41d34c..b699991ffb2 100644
--- a/crates/euclid/benches/backends.rs
+++ b/crates/euclid/benches/backends.rs
@@ -1,5 +1,6 @@
#![allow(unused, clippy::expect_used)]
+use common_utils::types::MinorUnit;
use criterion::{black_box, criterion_group, criterion_main, Criterion};
use euclid::{
backend::{inputs, EuclidBackend, InterpreterBackend, VirInterpreterBackend},
@@ -37,7 +38,7 @@ fn get_program_data() -> (ast::Program<DummyOutput>, inputs::BackendInput) {
let inp = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
card_bin: None,
currency: enums::Currency::USD,
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
diff --git a/crates/euclid/src/backend/inputs.rs b/crates/euclid/src/backend/inputs.rs
index 18298d4c358..3872ed2d346 100644
--- a/crates/euclid/src/backend/inputs.rs
+++ b/crates/euclid/src/backend/inputs.rs
@@ -19,7 +19,7 @@ pub struct PaymentMethodInput {
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PaymentInput {
- pub amount: i64,
+ pub amount: common_utils::types::MinorUnit,
pub currency: enums::Currency,
pub authentication_type: Option<enums::AuthenticationType>,
pub card_bin: Option<String>,
diff --git a/crates/euclid/src/backend/interpreter.rs b/crates/euclid/src/backend/interpreter.rs
index bf0a561bf3f..a6b0dd55fd0 100644
--- a/crates/euclid/src/backend/interpreter.rs
+++ b/crates/euclid/src/backend/interpreter.rs
@@ -1,5 +1,7 @@
pub mod types;
+use common_utils::types::MinorUnit;
+
use crate::{
backend::{self, inputs, EuclidBackend},
frontend::ast,
@@ -14,7 +16,7 @@ where
O: Clone,
{
fn eval_number_comparison_array(
- num: i64,
+ num: MinorUnit,
array: &[ast::NumberComparison],
) -> Result<bool, types::InterpreterError> {
for comparison in array {
diff --git a/crates/euclid/src/backend/vir_interpreter.rs b/crates/euclid/src/backend/vir_interpreter.rs
index b8d14e228aa..0e7988bb3be 100644
--- a/crates/euclid/src/backend/vir_interpreter.rs
+++ b/crates/euclid/src/backend/vir_interpreter.rs
@@ -105,6 +105,7 @@ where
#[cfg(all(test, feature = "ast_parser"))]
mod test {
#![allow(clippy::expect_used)]
+ use common_utils::types::MinorUnit;
use rustc_hash::FxHashMap;
use super::*;
@@ -130,7 +131,7 @@ mod test {
let inp = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
card_bin: None,
currency: enums::Currency::USD,
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -170,7 +171,7 @@ mod test {
let inp = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
currency: enums::Currency::USD,
card_bin: Some("123456".to_string()),
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -211,7 +212,7 @@ mod test {
let inp = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
currency: enums::Currency::USD,
card_bin: Some("123456".to_string()),
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -252,7 +253,7 @@ mod test {
let inp = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
currency: enums::Currency::USD,
card_bin: Some("123456".to_string()),
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -293,7 +294,7 @@ mod test {
let inp = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
currency: enums::Currency::USD,
card_bin: Some("123456".to_string()),
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -334,7 +335,7 @@ mod test {
let inp = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
currency: enums::Currency::USD,
card_bin: None,
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -375,7 +376,7 @@ mod test {
let inp = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
currency: enums::Currency::USD,
card_bin: None,
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -416,7 +417,7 @@ mod test {
let inp = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
currency: enums::Currency::USD,
card_bin: None,
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -459,7 +460,7 @@ mod test {
let inp = inputs::BackendInput {
metadata: Some(meta_map),
payment: inputs::PaymentInput {
- amount: 32,
+ amount: MinorUnit::new(32),
card_bin: None,
currency: enums::Currency::USD,
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -500,7 +501,7 @@ mod test {
let inp_greater = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 150,
+ amount: MinorUnit::new(150),
card_bin: None,
currency: enums::Currency::USD,
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -522,7 +523,7 @@ mod test {
},
};
let mut inp_equal = inp_greater.clone();
- inp_equal.payment.amount = 123;
+ inp_equal.payment.amount = MinorUnit::new(123);
let backend = VirInterpreterBackend::<DummyOutput>::with_program(program).expect("Program");
let result_greater = backend.execute(inp_greater).expect("Execution");
let result_equal = backend.execute(inp_equal).expect("Execution");
@@ -550,7 +551,7 @@ mod test {
let inp_lower = inputs::BackendInput {
metadata: None,
payment: inputs::PaymentInput {
- amount: 120,
+ amount: MinorUnit::new(120),
card_bin: None,
currency: enums::Currency::USD,
authentication_type: Some(enums::AuthenticationType::NoThreeDs),
@@ -572,7 +573,7 @@ mod test {
},
};
let mut inp_equal = inp_lower.clone();
- inp_equal.payment.amount = 123;
+ inp_equal.payment.amount = MinorUnit::new(123);
let backend = VirInterpreterBackend::<DummyOutput>::with_program(program).expect("Program");
let result_equal = backend.execute(inp_equal).expect("Execution");
let result_lower = backend.execute(inp_lower).expect("Execution");
diff --git a/crates/euclid/src/frontend/ast.rs b/crates/euclid/src/frontend/ast.rs
index 905bf04de0a..ecb6aa87f27 100644
--- a/crates/euclid/src/frontend/ast.rs
+++ b/crates/euclid/src/frontend/ast.rs
@@ -3,6 +3,7 @@ pub mod lowering;
pub mod parser;
use common_enums::RoutableConnectors;
+use common_utils::types::MinorUnit;
use serde::{Deserialize, Serialize};
use utoipa::ToSchema;
@@ -26,7 +27,7 @@ pub struct MetadataValue {
#[serde(tag = "type", content = "value", rename_all = "snake_case")]
pub enum ValueType {
/// Represents a number literal
- Number(i64),
+ Number(MinorUnit),
/// Represents an enum variant
EnumVariant(String),
/// Represents a Metadata variant
@@ -36,7 +37,7 @@ pub enum ValueType {
/// Represents an array of numbers. This is basically used for
/// "one of the given numbers" operations
/// eg: payment.method.amount = (1, 2, 3)
- NumberArray(Vec<i64>),
+ NumberArray(Vec<MinorUnit>),
/// Similar to NumberArray but for enum variants
/// eg: payment.method.cardtype = (debit, credit)
EnumVariantArray(Vec<String>),
@@ -65,7 +66,7 @@ impl ValueType {
#[serde(rename_all = "camelCase")]
pub struct NumberComparison {
pub comparison_type: ComparisonType,
- pub number: i64,
+ pub number: MinorUnit,
}
/// Conditional comparison type
diff --git a/crates/euclid/src/frontend/ast/parser.rs b/crates/euclid/src/frontend/ast/parser.rs
index cbfc21c96a7..0c586e178e6 100644
--- a/crates/euclid/src/frontend/ast/parser.rs
+++ b/crates/euclid/src/frontend/ast/parser.rs
@@ -1,3 +1,4 @@
+use common_utils::types::MinorUnit;
use nom::{
branch, bytes::complete, character::complete as pchar, combinator, error, multi, sequence,
};
@@ -115,7 +116,7 @@ pub fn percentage(input: &str) -> ParseResult<&str, u8> {
pub fn number_value(input: &str) -> ParseResult<&str, ast::ValueType> {
error::context(
"number_value",
- combinator::map(num_i64, ast::ValueType::Number),
+ combinator::map(num_i64, |n| ast::ValueType::Number(MinorUnit::new(n))),
)(input)
}
@@ -143,12 +144,15 @@ pub fn enum_variant_value(input: &str) -> ParseResult<&str, ast::ValueType> {
}
pub fn number_array_value(input: &str) -> ParseResult<&str, ast::ValueType> {
+ fn num_minor_unit(input: &str) -> ParseResult<&str, MinorUnit> {
+ combinator::map(num_i64, MinorUnit::new)(input)
+ }
let many_with_comma = multi::many0(sequence::preceded(
skip_ws(complete::tag(",")),
- skip_ws(num_i64),
+ skip_ws(num_minor_unit),
));
- let full_sequence = sequence::pair(skip_ws(num_i64), many_with_comma);
+ let full_sequence = sequence::pair(skip_ws(num_minor_unit), many_with_comma);
error::context(
"number_array_value",
@@ -158,7 +162,7 @@ pub fn number_array_value(input: &str) -> ParseResult<&str, ast::ValueType> {
full_sequence,
skip_ws(complete::tag(")")),
),
- |tup: (i64, Vec<i64>)| {
+ |tup: (MinorUnit, Vec<MinorUnit>)| {
let mut rest = tup.1;
rest.insert(0, tup.0);
ast::ValueType::NumberArray(rest)
@@ -215,7 +219,7 @@ pub fn number_comparison(input: &str) -> ParseResult<&str, ast::NumberComparison
sequence::pair(operator, num_i64),
|tup: (ast::ComparisonType, i64)| ast::NumberComparison {
comparison_type: tup.0,
- number: tup.1,
+ number: MinorUnit::new(tup.1),
},
),
)(input)
diff --git a/crates/euclid/src/frontend/dir.rs b/crates/euclid/src/frontend/dir.rs
index 68a32a528b8..a21ae104882 100644
--- a/crates/euclid/src/frontend/dir.rs
+++ b/crates/euclid/src/frontend/dir.rs
@@ -5,6 +5,7 @@ pub mod transformers;
use strum::IntoEnumIterator;
+// use common_utils::types::MinorUnit;
use crate::{enums as euclid_enums, frontend::ast, types};
#[macro_export]
@@ -26,7 +27,7 @@ macro_rules! dirval {
($key:ident = $num:literal) => {{
$crate::frontend::dir::DirValue::$key($crate::types::NumValue {
- number: $num,
+ number: common_utils::types::MinorUnit::new($num),
refinement: None,
})
}};
@@ -74,7 +75,7 @@ macro_rules! dirval {
($key:ident = $num:literal) => {{
$crate::frontend::dir::DirValue::$key($crate::types::NumValue {
- number: $num,
+ number: common_utils::types::MinorUnit::new($num),
refinement: None,
})
}};
diff --git a/crates/euclid/src/types.rs b/crates/euclid/src/types.rs
index 05d3fe6bb8e..d7122d8ea80 100644
--- a/crates/euclid/src/types.rs
+++ b/crates/euclid/src/types.rs
@@ -1,5 +1,6 @@
pub mod transformers;
+use common_utils::types::MinorUnit;
use euclid_macros::EnumNums;
use serde::{Deserialize, Serialize};
use strum::VariantNames;
@@ -191,7 +192,7 @@ pub struct MetadataValue {
#[derive(Debug, Default, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
pub struct NumValue {
- pub number: i64,
+ pub number: MinorUnit,
pub refinement: Option<NumValueRefinement>,
}
@@ -291,11 +292,11 @@ mod global_type_tests {
#[test]
fn test_num_value_fits_greater_than() {
let val1 = NumValue {
- number: 10,
+ number: MinorUnit::new(10),
refinement: Some(NumValueRefinement::GreaterThan),
};
let val2 = NumValue {
- number: 30,
+ number: MinorUnit::new(30),
refinement: Some(NumValueRefinement::GreaterThan),
};
@@ -305,11 +306,11 @@ mod global_type_tests {
#[test]
fn test_num_value_fits_less_than() {
let val1 = NumValue {
- number: 30,
+ number: MinorUnit::new(30),
refinement: Some(NumValueRefinement::LessThan),
};
let val2 = NumValue {
- number: 10,
+ number: MinorUnit::new(10),
refinement: Some(NumValueRefinement::LessThan),
};
diff --git a/crates/hyperswitch_domain_models/src/payouts/payouts.rs b/crates/hyperswitch_domain_models/src/payouts/payouts.rs
index 206e9bcdbfc..78cb572a8bb 100644
--- a/crates/hyperswitch_domain_models/src/payouts/payouts.rs
+++ b/crates/hyperswitch_domain_models/src/payouts/payouts.rs
@@ -1,5 +1,5 @@
use common_enums as storage_enums;
-use common_utils::{id_type, pii};
+use common_utils::{id_type, pii, types::MinorUnit};
use serde::{Deserialize, Serialize};
use storage_enums::MerchantStorageScheme;
use time::PrimitiveDateTime;
@@ -75,7 +75,7 @@ pub struct Payouts {
pub address_id: String,
pub payout_type: Option<storage_enums::PayoutType>,
pub payout_method_id: Option<String>,
- pub amount: i64,
+ pub amount: MinorUnit,
pub destination_currency: storage_enums::Currency,
pub source_currency: storage_enums::Currency,
pub description: Option<String>,
@@ -103,7 +103,7 @@ pub struct PayoutsNew {
pub address_id: String,
pub payout_type: Option<storage_enums::PayoutType>,
pub payout_method_id: Option<String>,
- pub amount: i64,
+ pub amount: MinorUnit,
pub destination_currency: storage_enums::Currency,
pub source_currency: storage_enums::Currency,
pub description: Option<String>,
@@ -134,7 +134,7 @@ impl Default for PayoutsNew {
address_id: String::default(),
payout_type: Some(storage_enums::PayoutType::default()),
payout_method_id: Option::default(),
- amount: i64::default(),
+ amount: MinorUnit::new(i64::default()),
destination_currency: storage_enums::Currency::default(),
source_currency: storage_enums::Currency::default(),
description: Option::default(),
@@ -159,7 +159,7 @@ impl Default for PayoutsNew {
#[derive(Debug, Serialize, Deserialize)]
pub enum PayoutsUpdate {
Update {
- amount: i64,
+ amount: MinorUnit,
destination_currency: storage_enums::Currency,
source_currency: storage_enums::Currency,
description: Option<String>,
@@ -189,7 +189,7 @@ pub enum PayoutsUpdate {
#[derive(Clone, Debug, Default)]
pub struct PayoutsUpdateInternal {
- pub amount: Option<i64>,
+ pub amount: Option<MinorUnit>,
pub destination_currency: Option<storage_enums::Currency>,
pub source_currency: Option<storage_enums::Currency>,
pub description: Option<String>,
diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs
index bcf84e560e3..8fc32991a32 100644
--- a/crates/hyperswitch_domain_models/src/router_request_types.rs
+++ b/crates/hyperswitch_domain_models/src/router_request_types.rs
@@ -653,6 +653,9 @@ pub struct PayoutsData {
pub entity_type: storage_enums::PayoutEntityType,
pub customer_details: Option<CustomerDetails>,
pub vendor_details: Option<api_models::payouts::PayoutVendorAccountDetails>,
+
+ // New minor amount for amount framework
+ pub minor_amount: MinorUnit,
pub priority: Option<storage_enums::PayoutSendPriority>,
}
diff --git a/crates/kgraph_utils/Cargo.toml b/crates/kgraph_utils/Cargo.toml
index aafec6c8e15..7528461dbc5 100644
--- a/crates/kgraph_utils/Cargo.toml
+++ b/crates/kgraph_utils/Cargo.toml
@@ -16,6 +16,7 @@ common_enums = { version = "0.1.0", path = "../common_enums" }
hyperswitch_constraint_graph = { version = "0.1.0", path = "../hyperswitch_constraint_graph", features = ["viz"] }
euclid = { version = "0.1.0", path = "../euclid" }
masking = { version = "0.1.0", path = "../masking/" }
+common_utils = {version = "0.1.0", path = "../common_utils"}
# Third party crates
serde = "1.0.197"
diff --git a/crates/kgraph_utils/benches/evaluation.rs b/crates/kgraph_utils/benches/evaluation.rs
index 4cc526f973f..6710dfc764e 100644
--- a/crates/kgraph_utils/benches/evaluation.rs
+++ b/crates/kgraph_utils/benches/evaluation.rs
@@ -5,6 +5,7 @@ use std::{collections::HashMap, str::FromStr};
use api_models::{
admin as admin_api, enums as api_enums, payment_methods::RequestPaymentMethodTypes,
};
+use common_utils::types::MinorUnit;
use criterion::{black_box, criterion_group, criterion_main, Criterion};
use euclid::{
dirval,
@@ -38,8 +39,8 @@ fn build_test_data<'a>(
api_enums::Currency::INR,
])),
accepted_countries: None,
- minimum_amount: Some(10),
- maximum_amount: Some(1000),
+ minimum_amount: Some(MinorUnit::new(10)),
+ maximum_amount: Some(MinorUnit::new(1000)),
recurring_enabled: true,
installment_payment_enabled: true,
});
diff --git a/crates/kgraph_utils/src/mca.rs b/crates/kgraph_utils/src/mca.rs
index cb24d9de930..453ccb74e2a 100644
--- a/crates/kgraph_utils/src/mca.rs
+++ b/crates/kgraph_utils/src/mca.rs
@@ -2,6 +2,7 @@ use std::str::FromStr;
use api_models::{
admin as admin_api, enums as api_enums, payment_methods::RequestPaymentMethodTypes,
+ refunds::MinorUnit,
};
use euclid::{
dirval,
@@ -227,7 +228,7 @@ fn compile_request_pm_types(
if let Some(min_amt) = pm_types.minimum_amount {
let num_val = NumValue {
- number: min_amt.into(),
+ number: min_amt,
refinement: Some(NumValueRefinement::GreaterThanEqual),
};
@@ -243,7 +244,7 @@ fn compile_request_pm_types(
if let Some(max_amt) = pm_types.maximum_amount {
let num_val = NumValue {
- number: max_amt.into(),
+ number: max_amt,
refinement: Some(NumValueRefinement::LessThanEqual),
};
@@ -259,7 +260,7 @@ fn compile_request_pm_types(
if !amount_nodes.is_empty() {
let zero_num_val = NumValue {
- number: 0,
+ number: MinorUnit::zero(),
refinement: None,
};
@@ -729,8 +730,8 @@ mod tests {
api_enums::Currency::INR,
])),
accepted_countries: None,
- minimum_amount: Some(10),
- maximum_amount: Some(1000),
+ minimum_amount: Some(MinorUnit::new(10)),
+ maximum_amount: Some(MinorUnit::new(1000)),
recurring_enabled: true,
installment_payment_enabled: true,
},
@@ -745,8 +746,8 @@ mod tests {
api_enums::Currency::GBP,
])),
accepted_countries: None,
- minimum_amount: Some(10),
- maximum_amount: Some(1000),
+ minimum_amount: Some(MinorUnit::new(10)),
+ maximum_amount: Some(MinorUnit::new(1000)),
recurring_enabled: true,
installment_payment_enabled: true,
},
diff --git a/crates/router/src/compatibility/stripe/webhooks.rs b/crates/router/src/compatibility/stripe/webhooks.rs
index e02c55a0e70..4b08b0d36e8 100644
--- a/crates/router/src/compatibility/stripe/webhooks.rs
+++ b/crates/router/src/compatibility/stripe/webhooks.rs
@@ -169,7 +169,7 @@ impl From<payout_models::PayoutCreateResponse> for StripePayoutResponse {
fn from(res: payout_models::PayoutCreateResponse) -> Self {
Self {
id: res.payout_id,
- amount: res.amount,
+ amount: res.amount.get_amount_as_i64(),
currency: res.currency.to_string(),
payout_type: res.payout_type,
status: StripePayoutStatus::from(res.status),
diff --git a/crates/router/src/connector/paypal.rs b/crates/router/src/connector/paypal.rs
index 9e7b208ef70..456332ea0f1 100644
--- a/crates/router/src/connector/paypal.rs
+++ b/crates/router/src/connector/paypal.rs
@@ -1,8 +1,12 @@
pub mod transformers;
-use std::fmt::{Debug, Write};
+use std::fmt::Write;
use base64::Engine;
-use common_utils::{ext_traits::ByteSliceExt, request::RequestContent};
+use common_utils::{
+ ext_traits::ByteSliceExt,
+ request::RequestContent,
+ types::{AmountConvertor, StringMajorUnit, StringMajorUnitForConnector},
+};
use diesel_models::enums;
use error_stack::ResultExt;
use masking::{ExposeInterface, PeekInterface, Secret};
@@ -40,8 +44,18 @@ use crate::{
utils::BytesExt,
};
-#[derive(Debug, Clone)]
-pub struct Paypal;
+#[derive(Clone)]
+pub struct Paypal {
+ amount_converter: &'static (dyn AmountConvertor<Output = StringMajorUnit> + Sync),
+}
+
+impl Paypal {
+ pub fn new() -> &'static Self {
+ &Self {
+ amount_converter: &StringMajorUnitForConnector,
+ }
+ }
+}
impl api::Payment for Paypal {}
impl api::PaymentSession for Paypal {}
@@ -103,7 +117,7 @@ impl Paypal {
let errors_list = response.details.unwrap_or_default();
let option_error_code_message =
connector_utils::get_error_code_error_message_based_on_priority(
- Self.clone(),
+ self.clone(),
errors_list
.into_iter()
.map(|errors| errors.into())
@@ -274,7 +288,7 @@ impl ConnectorCommon for Paypal {
let errors_list = response.details.unwrap_or_default();
let option_error_code_message =
connector_utils::get_error_code_error_message_based_on_priority(
- Self.clone(),
+ self.clone(),
errors_list
.into_iter()
.map(|errors| errors.into())
@@ -458,12 +472,12 @@ impl ConnectorIntegration<api::PoFulfill, types::PayoutsData, types::PayoutsResp
req: &types::PayoutsRouterData<api::PoFulfill>,
_connectors: &settings::Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
- let connector_router_data = paypal::PaypalRouterData::try_from((
- &self.get_currency_unit(),
+ let amount = connector_utils::convert_amount(
+ self.amount_converter,
+ req.request.minor_amount,
req.request.destination_currency,
- req.request.amount,
- req,
- ))?;
+ )?;
+ let connector_router_data = paypal::PaypalRouterData::try_from((amount, req))?;
let connector_req = paypal::PaypalFulfillRequest::try_from(&connector_router_data)?;
Ok(RequestContent::Json(Box::new(connector_req)))
}
@@ -588,12 +602,12 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
req: &types::PaymentsAuthorizeRouterData,
_connectors: &settings::Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
- let connector_router_data = paypal::PaypalRouterData::try_from((
- &self.get_currency_unit(),
+ let amount = connector_utils::convert_amount(
+ self.amount_converter,
+ req.request.minor_amount,
req.request.currency,
- req.request.amount,
- req,
- ))?;
+ )?;
+ let connector_router_data = paypal::PaypalRouterData::try_from((amount, req))?;
let connector_req = paypal::PaypalPaymentsRequest::try_from(&connector_router_data)?;
Ok(RequestContent::Json(Box::new(connector_req)))
}
@@ -1093,12 +1107,12 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
req: &types::PaymentsCaptureRouterData,
_connectors: &settings::Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
- let connector_router_data = paypal::PaypalRouterData::try_from((
- &self.get_currency_unit(),
+ let amount_to_capture = connector_utils::convert_amount(
+ self.amount_converter,
+ req.request.minor_amount_to_capture,
req.request.currency,
- req.request.amount_to_capture,
- req,
- ))?;
+ )?;
+ let connector_router_data = paypal::PaypalRouterData::try_from((amount_to_capture, req))?;
let connector_req = paypal::PaypalPaymentsCaptureRequest::try_from(&connector_router_data)?;
Ok(RequestContent::Json(Box::new(connector_req)))
}
@@ -1260,12 +1274,12 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
req: &types::RefundsRouterData<api::Execute>,
_connectors: &settings::Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
- let connector_router_data = paypal::PaypalRouterData::try_from((
- &self.get_currency_unit(),
+ let amount = connector_utils::convert_amount(
+ self.amount_converter,
+ req.request.minor_refund_amount,
req.request.currency,
- req.request.refund_amount,
- req,
- ))?;
+ )?;
+ let connector_router_data = paypal::PaypalRouterData::try_from((amount, req))?;
let connector_req = paypal::PaypalRefundRequest::try_from(&connector_router_data)?;
Ok(RequestContent::Json(Box::new(connector_req)))
}
@@ -1614,7 +1628,7 @@ impl api::IncomingWebhook for Paypal {
.change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
Ok(api::disputes::DisputePayload {
amount: connector_utils::to_currency_lower_unit(
- payload.dispute_amount.value,
+ payload.dispute_amount.value.get_amount_as_string(),
payload.dispute_amount.currency_code,
)?,
currency: payload.dispute_amount.currency_code.to_string(),
diff --git a/crates/router/src/connector/paypal/transformers.rs b/crates/router/src/connector/paypal/transformers.rs
index 755623b8781..c12c7d5da15 100644
--- a/crates/router/src/connector/paypal/transformers.rs
+++ b/crates/router/src/connector/paypal/transformers.rs
@@ -1,8 +1,8 @@
use api_models::enums;
use base64::Engine;
-use common_utils::errors::CustomResult;
#[cfg(feature = "payouts")]
use common_utils::pii::Email;
+use common_utils::{errors::CustomResult, types::StringMajorUnit};
use error_stack::ResultExt;
use masking::{ExposeInterface, Secret};
use serde::{Deserialize, Serialize};
@@ -27,23 +27,13 @@ use crate::{
#[derive(Debug, Serialize)]
pub struct PaypalRouterData<T> {
- pub amount: String,
+ pub amount: StringMajorUnit,
pub router_data: T,
}
-impl<T> TryFrom<(&api::CurrencyUnit, types::storage::enums::Currency, i64, T)>
- for PaypalRouterData<T>
-{
+impl<T> TryFrom<(StringMajorUnit, T)> for PaypalRouterData<T> {
type Error = error_stack::Report<errors::ConnectorError>;
- fn try_from(
- (currency_unit, currency, amount, item): (
- &api::CurrencyUnit,
- types::storage::enums::Currency,
- i64,
- T,
- ),
- ) -> Result<Self, Self::Error> {
- let amount = utils::get_amount_as_string(currency_unit, amount, currency)?;
+ fn try_from((amount, item): (StringMajorUnit, T)) -> Result<Self, Self::Error> {
Ok(Self {
amount,
router_data: item,
@@ -76,13 +66,13 @@ pub enum PaypalPaymentIntent {
#[derive(Default, Debug, Clone, Serialize, Eq, PartialEq, Deserialize)]
pub struct OrderAmount {
pub currency_code: storage_enums::Currency,
- pub value: String,
+ pub value: StringMajorUnit,
}
#[derive(Default, Debug, Serialize, Deserialize, Eq, PartialEq)]
pub struct OrderRequestAmount {
pub currency_code: storage_enums::Currency,
- pub value: String,
+ pub value: StringMajorUnit,
pub breakdown: AmountBreakdown,
}
@@ -90,11 +80,11 @@ impl From<&PaypalRouterData<&types::PaymentsAuthorizeRouterData>> for OrderReque
fn from(item: &PaypalRouterData<&types::PaymentsAuthorizeRouterData>) -> Self {
Self {
currency_code: item.router_data.request.currency,
- value: item.amount.to_owned(),
+ value: item.amount.clone(),
breakdown: AmountBreakdown {
item_total: OrderAmount {
currency_code: item.router_data.request.currency,
- value: item.amount.to_owned(),
+ value: item.amount.clone(),
},
},
}
@@ -140,7 +130,7 @@ impl From<&PaypalRouterData<&types::PaymentsAuthorizeRouterData>> for ItemDetail
quantity: 1,
unit_amount: OrderAmount {
currency_code: item.router_data.request.currency,
- value: item.amount.to_string(),
+ value: item.amount.clone(),
},
}
}
@@ -1564,7 +1554,7 @@ pub enum PaypalPayoutDataType {
#[cfg(feature = "payouts")]
#[derive(Debug, Serialize)]
pub struct PayoutAmount {
- value: String,
+ value: StringMajorUnit,
currency: storage_enums::Currency,
}
@@ -1593,7 +1583,7 @@ impl TryFrom<&PaypalRouterData<&types::PayoutsRouterData<api::PoFulfill>>> for P
item: &PaypalRouterData<&types::PayoutsRouterData<api::PoFulfill>>,
) -> Result<Self, Self::Error> {
let amount = PayoutAmount {
- value: item.amount.to_owned(),
+ value: item.amount.clone(),
currency: item.router_data.request.destination_currency,
};
@@ -1726,7 +1716,7 @@ impl TryFrom<&PaypalRouterData<&types::PaymentsCaptureRouterData>>
) -> Result<Self, Self::Error> {
let amount = OrderAmount {
currency_code: item.router_data.request.currency,
- value: item.amount.to_owned(),
+ value: item.amount.clone(),
};
Ok(Self {
amount,
@@ -1907,7 +1897,7 @@ impl<F> TryFrom<&PaypalRouterData<&types::RefundsRouterData<F>>> for PaypalRefun
Ok(Self {
amount: OrderAmount {
currency_code: item.router_data.request.currency,
- value: item.amount.to_owned(),
+ value: item.amount.clone(),
},
})
}
diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs
index 53b0063c6ef..7d0ab750545 100644
--- a/crates/router/src/core/payment_methods/cards.rs
+++ b/crates/router/src/core/payment_methods/cards.rs
@@ -24,6 +24,7 @@ use common_utils::{
consts,
ext_traits::{AsyncExt, Encode, StringExt, ValueExt},
generate_id, id_type,
+ types::MinorUnit,
};
use diesel_models::{
business_profile::BusinessProfile, encryption::Encryption, enums as storage_enums,
@@ -2862,11 +2863,7 @@ pub async fn filter_payment_methods(
&payment_method_type_info,
req.installment_payment_enabled,
)
- && filter_amount_based(
- &payment_method_type_info,
- req.amount
- .map(|minor_amount| minor_amount.get_amount_as_i64()),
- )
+ && filter_amount_based(&payment_method_type_info, req.amount)
{
let mut payment_method_object = payment_method_type_info;
@@ -3108,6 +3105,19 @@ fn filter_pm_based_on_capture_method_used(
.unwrap_or(true)
}
+fn filter_amount_based(
+ payment_method: &RequestPaymentMethodTypes,
+ amount: Option<MinorUnit>,
+) -> bool {
+ let min_check = amount
+ .and_then(|amt| payment_method.minimum_amount.map(|min_amt| amt >= min_amt))
+ .unwrap_or(true);
+ let max_check = amount
+ .and_then(|amt| payment_method.maximum_amount.map(|max_amt| amt <= max_amt))
+ .unwrap_or(true);
+ (min_check && max_check) || amount == Some(MinorUnit::zero())
+}
+
fn card_network_filter(
country: &Option<api_enums::CountryAlpha2>,
currency: Option<api_enums::Currency>,
@@ -3279,32 +3289,6 @@ fn filter_disabled_enum_based<T: Eq + std::hash::Hash + Clone>(
}
}
-fn filter_amount_based(payment_method: &RequestPaymentMethodTypes, amount: Option<i64>) -> bool {
- let min_check = amount
- .and_then(|amt| {
- payment_method
- .minimum_amount
- .map(|min_amt| amt >= min_amt.into())
- })
- .unwrap_or(true);
- let max_check = amount
- .and_then(|amt| {
- payment_method
- .maximum_amount
- .map(|max_amt| amt <= max_amt.into())
- })
- .unwrap_or(true);
- // let min_check = match (amount, payment_method.minimum_amount) {
- // (Some(amt), Some(min_amt)) => amt >= min_amt,
- // (_, _) => true,
- // };
- // let max_check = match (amount, payment_method.maximum_amount) {
- // (Some(amt), Some(max_amt)) => amt <= max_amt,
- // (_, _) => true,
- // };
- (min_check && max_check) || amount == Some(0)
-}
-
fn filter_pm_based_on_allowed_types(
allowed_types: Option<&Vec<api_enums::PaymentMethodType>>,
payment_method_type: &api_enums::PaymentMethodType,
@@ -3360,10 +3344,10 @@ fn filter_payment_amount_based(
payment_intent: &storage::PaymentIntent,
pm: &RequestPaymentMethodTypes,
) -> bool {
- let amount = payment_intent.amount.get_amount_as_i64();
- (pm.maximum_amount.map_or(true, |amt| amount <= amt.into())
- && pm.minimum_amount.map_or(true, |amt| amount >= amt.into()))
- || payment_intent.amount.get_amount_as_i64() == 0
+ let amount = payment_intent.amount;
+ (pm.maximum_amount.map_or(true, |amt| amount <= amt)
+ && pm.minimum_amount.map_or(true, |amt| amount >= amt))
+ || payment_intent.amount == MinorUnit::zero()
}
async fn filter_payment_mandate_based(
diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs
index 3afb933d467..042bf8612e7 100644
--- a/crates/router/src/core/payments/routing.rs
+++ b/crates/router/src/core/payments/routing.rs
@@ -211,7 +211,7 @@ where
};
let payment_input = dsl_inputs::PaymentInput {
- amount: payment_data.payment_intent.amount.get_amount_as_i64(),
+ amount: payment_data.payment_intent.amount,
card_bin: payment_data
.payment_method_data
.as_ref()
@@ -904,7 +904,7 @@ pub async fn perform_session_flow_routing(
};
let payment_input = dsl_inputs::PaymentInput {
- amount: session_input.payment_intent.amount.get_amount_as_i64(),
+ amount: session_input.payment_intent.amount,
currency: session_input
.payment_intent
.currency
@@ -1138,7 +1138,7 @@ pub fn make_dsl_input_for_surcharge(
payment_type: None,
};
let payment_input = dsl_inputs::PaymentInput {
- amount: payment_attempt.amount.get_amount_as_i64(),
+ amount: payment_attempt.amount,
// currency is always populated in payment_attempt during payment create
currency: payment_attempt
.currency
diff --git a/crates/router/src/core/payout_link.rs b/crates/router/src/core/payout_link.rs
index 200f23f49a4..ec5935d0abe 100644
--- a/crates/router/src/core/payout_link.rs
+++ b/crates/router/src/core/payout_link.rs
@@ -4,6 +4,7 @@ use api_models::payouts;
use common_utils::{
ext_traits::{Encode, OptionExt},
link_utils,
+ types::{AmountConvertor, StringMajorUnitForConnector},
};
use diesel_models::PayoutLinkUpdate;
use error_stack::ResultExt;
@@ -102,9 +103,9 @@ pub async fn initiate_payout_link(
// Initiate Payout link flow
(_, link_utils::PayoutLinkStatus::Initiated) => {
let customer_id = link_data.customer_id;
- let amount = payout
- .destination_currency
- .to_currency_base_unit(payout.amount)
+ let required_amount_type = StringMajorUnitForConnector;
+ let amount = required_amount_type
+ .convert(payout.amount, payout.destination_currency)
.change_context(errors::ApiErrorResponse::CurrencyConversionFailed)?;
// Fetch customer
let customer = db
diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs
index 63059075004..e968f8bb6fd 100644
--- a/crates/router/src/core/payouts.rs
+++ b/crates/router/src/core/payouts.rs
@@ -1919,7 +1919,7 @@ pub async fn response_handler(
let response = api::PayoutCreateResponse {
payout_id: payouts.payout_id.to_owned(),
merchant_id: merchant_account.merchant_id.to_owned(),
- amount: payouts.amount.to_owned(),
+ amount: payouts.amount,
currency: payouts.destination_currency.to_owned(),
connector: payout_attempt.connector.to_owned(),
payout_type: payouts.payout_type.to_owned(),
@@ -2045,7 +2045,7 @@ pub async fn payout_create_db_entries(
consts::ID_LENGTH,
format!("payout_{payout_id}_secret").as_str(),
);
- let amount = MinorUnit::from(req.amount.unwrap_or(api::Amount::Zero)).get_amount_as_i64();
+ let amount = MinorUnit::from(req.amount.unwrap_or(api::Amount::Zero));
let payouts_req = storage::PayoutsNew {
payout_id: payout_id.to_string(),
merchant_id: merchant_id.to_string(),
diff --git a/crates/router/src/core/payouts/helpers.rs b/crates/router/src/core/payouts/helpers.rs
index 0b54205bf67..7a353ec1571 100644
--- a/crates/router/src/core/payouts/helpers.rs
+++ b/crates/router/src/core/payouts/helpers.rs
@@ -959,8 +959,7 @@ pub async fn update_payouts_and_payout_attempt(
// Update DB with new data
let payouts = payout_data.payouts.to_owned();
- let amount = MinorUnit::from(req.amount.unwrap_or(MinorUnit::new(payouts.amount).into()))
- .get_amount_as_i64();
+ let amount = MinorUnit::from(req.amount.unwrap_or(payouts.amount.into()));
let updated_payouts = storage::PayoutsUpdate::Update {
amount,
destination_currency: req
diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs
index bcd7a451c98..7c7215b57cc 100644
--- a/crates/router/src/core/utils.rs
+++ b/crates/router/src/core/utils.rs
@@ -170,7 +170,8 @@ pub async fn construct_payout_router_data<'a, F>(
payment_method_status: None,
request: types::PayoutsData {
payout_id: payouts.payout_id.to_owned(),
- amount: payouts.amount,
+ amount: payouts.amount.get_amount_as_i64(),
+ minor_amount: payouts.amount,
connector_payout_id: payout_attempt.connector_payout_id.clone(),
destination_currency: payouts.destination_currency,
source_currency: payouts.source_currency,
diff --git a/crates/router/src/services/kafka/payout.rs b/crates/router/src/services/kafka/payout.rs
index ed00888a46f..8796d2ca901 100644
--- a/crates/router/src/services/kafka/payout.rs
+++ b/crates/router/src/services/kafka/payout.rs
@@ -1,4 +1,4 @@
-use common_utils::{id_type, pii};
+use common_utils::{id_type, pii, types::MinorUnit};
use diesel_models::enums as storage_enums;
use hyperswitch_domain_models::payouts::{payout_attempt::PayoutAttempt, payouts::Payouts};
use time::OffsetDateTime;
@@ -13,7 +13,7 @@ pub struct KafkaPayout<'a> {
pub profile_id: &'a String,
pub payout_method_id: Option<&'a String>,
pub payout_type: Option<storage_enums::PayoutType>,
- pub amount: i64,
+ pub amount: MinorUnit,
pub destination_currency: storage_enums::Currency,
pub source_currency: storage_enums::Currency,
pub description: Option<&'a String>,
diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs
index 03ea2b2d613..58bb0d8c1d6 100644
--- a/crates/router/src/types/api.rs
+++ b/crates/router/src/types/api.rs
@@ -477,7 +477,9 @@ impl ConnectorData {
enums::Connector::Nexinets => {
Ok(ConnectorEnum::Old(Box::new(&connector::Nexinets)))
}
- enums::Connector::Paypal => Ok(ConnectorEnum::Old(Box::new(&connector::Paypal))),
+ enums::Connector::Paypal => {
+ Ok(ConnectorEnum::Old(Box::new(connector::Paypal::new())))
+ }
enums::Connector::Trustpay => {
Ok(ConnectorEnum::Old(Box::new(connector::Trustpay::new())))
}
diff --git a/crates/router/tests/connectors/paypal.rs b/crates/router/tests/connectors/paypal.rs
index 51effb276cf..0b3d040838b 100644
--- a/crates/router/tests/connectors/paypal.rs
+++ b/crates/router/tests/connectors/paypal.rs
@@ -14,7 +14,7 @@ impl Connector for PaypalTest {
fn get_data(&self) -> types::api::ConnectorData {
use router::connector::Paypal;
utils::construct_connector_data_old(
- Box::new(&Paypal),
+ Box::new(Paypal::new()),
types::Connector::Paypal,
types::api::GetToken::Connector,
None,
diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs
index ea7787a2c21..a9ffdbe6974 100644
--- a/crates/router/tests/connectors/utils.rs
+++ b/crates/router/tests/connectors/utils.rs
@@ -451,6 +451,7 @@ pub trait ConnectorActions: Connector {
payout_id: core_utils::get_or_generate_uuid("payout_id", None)
.map_or("payout_3154763247".to_string(), |p| p),
amount: 1,
+ minor_amount: MinorUnit::new(1),
connector_payout_id,
destination_currency: payment_info.to_owned().map_or(enums::Currency::EUR, |pi| {
pi.currency.map_or(enums::Currency::EUR, |c| c)
|
refactor
|
added amount framework to paypal, payouts and routing (#4865)
|
d622b7438e7c82ac84403b05334fcffcc8edf064
|
2023-03-02 12:49:12
|
Kartikeya Hegde
|
fix: Populate amount_captured in case of success (#700)
| false
|
diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs
index 1236b71e245..43f08b93917 100644
--- a/crates/router/src/core/payments/operations/payment_response.rs
+++ b/crates/router/src/core/payments/operations/payment_response.rs
@@ -362,6 +362,13 @@ async fn payment_response_update_tracker<F: Clone, T>(
None => payment_data.connector_response,
};
+ let amount_captured = router_data.amount_captured.or_else(|| {
+ if router_data.status == enums::AttemptStatus::Charged {
+ Some(payment_data.payment_intent.amount)
+ } else {
+ None
+ }
+ });
let payment_intent_update = match router_data.response {
Err(_) => storage::PaymentIntentUpdate::PGStatusUpdate {
status: enums::IntentStatus::Failed,
@@ -369,7 +376,7 @@ async fn payment_response_update_tracker<F: Clone, T>(
Ok(_) => storage::PaymentIntentUpdate::ResponseUpdate {
status: router_data.status.foreign_into(),
return_url: router_data.return_url.clone(),
- amount_captured: router_data.amount_captured,
+ amount_captured,
},
};
|
fix
|
Populate amount_captured in case of success (#700)
|
c0c08d05ef04d914e07d49f163e43bdddf5c885b
|
2025-03-12 15:16:59
|
Sarthak Soni
|
fix(routing): Enable filtering of default connectors for contract based routing (#7420)
| false
|
diff --git a/crates/api_models/src/routing.rs b/crates/api_models/src/routing.rs
index d4b4f76e178..cc87b85c1c8 100644
--- a/crates/api_models/src/routing.rs
+++ b/crates/api_models/src/routing.rs
@@ -1018,12 +1018,18 @@ impl ContractBasedRoutingConfig {
if let Some(new_label_info) = new.label_info {
new_label_info.iter().for_each(|new_label_info| {
if let Some(existing_label_infos) = &mut self.label_info {
- for existing_label_info in existing_label_infos {
+ let mut updated = false;
+ for existing_label_info in &mut *existing_label_infos {
if existing_label_info.mca_id == new_label_info.mca_id {
existing_label_info.update_target_time(new_label_info);
existing_label_info.update_target_count(new_label_info);
+ updated = true;
}
}
+
+ if !updated {
+ existing_label_infos.push(new_label_info.clone());
+ }
} else {
self.label_info = Some(vec![new_label_info.clone()]);
}
diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs
index e78861d4327..ceac9eaf43a 100644
--- a/crates/router/src/core/payments/routing.rs
+++ b/crates/router/src/core/payments/routing.rs
@@ -1600,12 +1600,37 @@ pub async fn perform_contract_based_routing(
.change_context(errors::RoutingError::ContractBasedRoutingConfigError)
.attach_printable("unable to fetch contract based dynamic routing configs")?;
+ let label_info = contract_based_routing_configs
+ .label_info
+ .clone()
+ .ok_or(errors::RoutingError::ContractBasedRoutingConfigError)
+ .attach_printable("Label information not found in contract routing configs")?;
+
+ let contract_based_connectors = routable_connectors
+ .clone()
+ .into_iter()
+ .filter(|conn| {
+ label_info
+ .iter()
+ .any(|info| Some(info.mca_id.clone()) == conn.merchant_connector_id.clone())
+ })
+ .collect::<Vec<_>>();
+
+ let mut other_connectors = routable_connectors
+ .into_iter()
+ .filter(|conn| {
+ label_info
+ .iter()
+ .all(|info| Some(info.mca_id.clone()) != conn.merchant_connector_id.clone())
+ })
+ .collect::<Vec<_>>();
+
let contract_based_connectors_result = client
.calculate_contract_score(
profile_id.get_string_repr().into(),
contract_based_routing_configs.clone(),
"".to_string(),
- routable_connectors,
+ contract_based_connectors,
state.get_grpc_headers(),
)
.await
@@ -1617,13 +1642,6 @@ pub async fn perform_contract_based_routing(
Ok(resp) => resp,
Err(err) => match err.current_context() {
DynamicRoutingError::ContractNotFound => {
- let label_info = contract_based_routing_configs
- .label_info
- .ok_or(errors::RoutingError::ContractBasedRoutingConfigError)
- .attach_printable(
- "Label information not found in contract routing configs",
- )?;
-
client
.update_contracts(
profile_id.get_string_repr().into(),
@@ -1683,6 +1701,8 @@ pub async fn perform_contract_based_routing(
});
}
+ connectors.append(&mut other_connectors);
+
logger::debug!(contract_based_routing_connectors=?connectors);
Ok(connectors)
} else {
diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs
index 64207b4b5d7..6c138488248 100644
--- a/crates/router/src/core/routing.rs
+++ b/crates/router/src/core/routing.rs
@@ -1639,7 +1639,23 @@ pub async fn contract_based_dynamic_routing_setup(
};
// validate the contained mca_ids
+ let mut contained_mca = Vec::new();
if let Some(info_vec) = &config.label_info {
+ for info in info_vec {
+ utils::when(
+ contained_mca.iter().any(|mca_id| mca_id == &info.mca_id),
+ || {
+ Err(error_stack::Report::new(
+ errors::ApiErrorResponse::InvalidRequestData {
+ message: "Duplicate mca configuration received".to_string(),
+ },
+ ))
+ },
+ )?;
+
+ contained_mca.push(info.mca_id.to_owned());
+ }
+
let validation_futures: Vec<_> = info_vec
.iter()
.map(|info| async {
@@ -1724,6 +1740,7 @@ pub async fn contract_based_routing_update_configs(
.attach_printable("unable to deserialize algorithm data from routing table into ContractBasedRoutingConfig")?;
// validate the contained mca_ids
+ let mut contained_mca = Vec::new();
if let Some(info_vec) = &request.label_info {
for info in info_vec {
let mca = db
@@ -1743,6 +1760,19 @@ pub async fn contract_based_routing_update_configs(
message: "Incorrect mca configuration received".to_string(),
})
})?;
+
+ utils::when(
+ contained_mca.iter().any(|mca_id| mca_id == &info.mca_id),
+ || {
+ Err(error_stack::Report::new(
+ errors::ApiErrorResponse::InvalidRequestData {
+ message: "Duplicate mca configuration received".to_string(),
+ },
+ ))
+ },
+ )?;
+
+ contained_mca.push(info.mca_id.to_owned());
}
}
diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs
index 17edc50a30d..1d40039e2a3 100644
--- a/crates/router/src/core/routing/helpers.rs
+++ b/crates/router/src/core/routing/helpers.rs
@@ -1062,12 +1062,19 @@ pub async fn push_metrics_with_update_window_for_contract_based_routing(
)?;
}
+ let contract_based_connectors = routable_connectors
+ .into_iter()
+ .filter(|conn| {
+ conn.merchant_connector_id.clone() == Some(final_label_info.mca_id.clone())
+ })
+ .collect::<Vec<_>>();
+
let contract_scores = client
.calculate_contract_score(
profile_id.get_string_repr().into(),
contract_based_routing_config.clone(),
"".to_string(),
- routable_connectors.clone(),
+ contract_based_connectors,
state.get_grpc_headers(),
)
.await
|
fix
|
Enable filtering of default connectors for contract based routing (#7420)
|
38ab6e54f1aa0e2cf03c67164d6787850d40e070
|
2023-09-01 13:52:22
|
Shankar Singh C
|
refactor(router): return generic message for UnprocessableEntity in make_pm_data (#2050)
| false
|
diff --git a/Cargo.lock b/Cargo.lock
index 35f27b8ce21..88dfe3a9e08 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -297,6 +297,12 @@ version = "1.0.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe"
+[[package]]
+name = "adler32"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "aae1277d39aeec15cb388266ecc24b11c80469deae6067e17a1a7aa9e5c1f234"
+
[[package]]
name = "ahash"
version = "0.7.6"
@@ -379,15 +385,14 @@ dependencies = [
"cards",
"common_enums",
"common_utils",
- "frunk",
- "frunk_core",
+ "error-stack",
"masking",
"mime",
"reqwest",
"router_derive",
"serde",
"serde_json",
- "strum",
+ "strum 0.24.1",
"time 0.3.22",
"url",
"utoipa",
@@ -511,18 +516,18 @@ checksum = "16e62a023e7c117e27523144c5d2459f4397fcc3cab0085af8e2224f643a0193"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
name = "async-trait"
-version = "0.1.68"
+version = "0.1.73"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b9ccdd8f2a161be9bd5c023df56f1b2a0bd1d83872ae53b71a84a12c9bf6e842"
+checksum = "bc00ceb34980c03614e35a3a4e218276a0a824e911d07651cd0d858a51e8c0f0"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -1160,6 +1165,12 @@ version = "0.6.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2c676a478f63e9fa2dd5368a42f28bba0d6c560b775f38583c8bbaa7fcd67c9c"
+[[package]]
+name = "bytemuck"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "17febce684fd15d89027105661fec94afb475cb995fbc59d2865198446ba2eea"
+
[[package]]
name = "byteorder"
version = "1.4.3"
@@ -1276,6 +1287,12 @@ version = "1.0.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+[[package]]
+name = "checked_int_cast"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "17cc5e6b5ab06331c33589842070416baa137e8b0eb912b008cfd4a78ada7919"
+
[[package]]
name = "chrono"
version = "0.4.26"
@@ -1323,7 +1340,7 @@ dependencies = [
"heck",
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -1332,15 +1349,23 @@ version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2da6da31387c7e4ef160ffab6d5e7f00c42626fe39aea70a7b0f1773f7dd6c1b"
+[[package]]
+name = "color_quant"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3d7b894f5411737b7867f4827955924d7c254fc9f4d91a6aad6b097804b1018b"
+
[[package]]
name = "common_enums"
version = "0.1.0"
dependencies = [
+ "common_utils",
"diesel",
"router_derive",
"serde",
"serde_json",
- "strum",
+ "strum 0.25.0",
+ "time 0.3.22",
"utoipa",
]
@@ -1493,6 +1518,17 @@ dependencies = [
"crossbeam-utils",
]
+[[package]]
+name = "crossbeam-deque"
+version = "0.8.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce6fd6f855243022dcecf8702fef0c297d4338e226845fe067f6341ad9fa0cef"
+dependencies = [
+ "cfg-if",
+ "crossbeam-epoch",
+ "crossbeam-utils",
+]
+
[[package]]
name = "crossbeam-epoch"
version = "0.9.15"
@@ -1570,7 +1606,7 @@ dependencies = [
"proc-macro2",
"quote",
"strsim",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -1592,7 +1628,7 @@ checksum = "29a358ff9f12ec09c3e61fef9b5a9902623a695a46a917b07f269bff1445611a"
dependencies = [
"darling_core 0.20.1",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -1608,6 +1644,22 @@ dependencies = [
"parking_lot_core",
]
+[[package]]
+name = "data_models"
+version = "0.1.0"
+dependencies = [
+ "api_models",
+ "async-trait",
+ "common_enums",
+ "common_utils",
+ "error-stack",
+ "serde",
+ "serde_json",
+ "strum 0.25.0",
+ "thiserror",
+ "time 0.3.22",
+]
+
[[package]]
name = "deadpool"
version = "0.9.5"
@@ -1627,6 +1679,16 @@ version = "0.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "eaa37046cc0f6c3cc6090fbdbf73ef0b8ef4cfcc37f6befc0020f63e8cf121e1"
+[[package]]
+name = "deflate"
+version = "0.8.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "73770f8e1fe7d64df17ca66ad28994a0a623ea497fa69486e14984e715c5d174"
+dependencies = [
+ "adler32",
+ "byteorder",
+]
+
[[package]]
name = "derive_deref"
version = "1.1.1"
@@ -1676,7 +1738,28 @@ dependencies = [
"diesel_table_macro_syntax",
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
+]
+
+[[package]]
+name = "diesel_models"
+version = "0.1.0"
+dependencies = [
+ "async-bb8-diesel",
+ "common_enums",
+ "common_utils",
+ "diesel",
+ "error-stack",
+ "frunk",
+ "frunk_core",
+ "masking",
+ "router_derive",
+ "router_env",
+ "serde",
+ "serde_json",
+ "strum 0.24.1",
+ "thiserror",
+ "time 0.3.22",
]
[[package]]
@@ -1685,7 +1768,7 @@ version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fc5557efc453706fed5e4fa85006fe9817c224c3f480a34c7e5959fd700921c5"
dependencies = [
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -1741,24 +1824,25 @@ dependencies = [
"common_utils",
"config",
"diesel",
+ "diesel_models",
"error-stack",
"external_services",
+ "masking",
"once_cell",
"redis_interface",
"router_env",
"serde",
"serde_json",
"serde_path_to_error",
- "storage_models",
"thiserror",
"tokio",
]
[[package]]
name = "dyn-clone"
-version = "1.0.11"
+version = "1.0.13"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "68b0cf012f1230e43cd00ebb729c6bb58707ecfa8ad08b52ef3a4ccd2697fc30"
+checksum = "bbfc4744c1b8f2a09adc0e55242f60b1af195d88596bd8700be74418c056c555"
[[package]]
name = "either"
@@ -1910,7 +1994,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3b9429470923de8e8cbd4d2dc513535400b4b3fef0319fb5c4e1f520a7bef743"
dependencies = [
"crc32fast",
- "miniz_oxide",
+ "miniz_oxide 0.7.1",
]
[[package]]
@@ -2117,7 +2201,7 @@ checksum = "89ca545a94061b6365f2c7355b4b32bd20df3ff95f02da9329b34ccc3bd6ee72"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -2198,6 +2282,16 @@ dependencies = [
"wasi 0.11.0+wasi-snapshot-preview1",
]
+[[package]]
+name = "gif"
+version = "0.11.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3edd93c6756b4dfaf2709eafcc345ba2636565295c198a9cfbf75fa5e3e00b06"
+dependencies = [
+ "color_quant",
+ "weezl",
+]
+
[[package]]
name = "git2"
version = "0.17.2"
@@ -2463,6 +2557,25 @@ dependencies = [
"unicode-normalization",
]
+[[package]]
+name = "image"
+version = "0.23.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "24ffcb7e7244a9bf19d35bf2883b9c080c4ced3c07a9895572178cdb8f13f6a1"
+dependencies = [
+ "bytemuck",
+ "byteorder",
+ "color_quant",
+ "gif",
+ "jpeg-decoder",
+ "num-iter",
+ "num-rational",
+ "num-traits",
+ "png",
+ "scoped_threadpool",
+ "tiff",
+]
+
[[package]]
name = "indexmap"
version = "1.9.3"
@@ -2567,6 +2680,15 @@ dependencies = [
"time 0.3.22",
]
+[[package]]
+name = "jpeg-decoder"
+version = "0.1.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "229d53d58899083193af11e15917b5640cd40b29ff475a1fe4ef725deb02d0f2"
+dependencies = [
+ "rayon",
+]
+
[[package]]
name = "js-sys"
version = "0.3.64"
@@ -2850,6 +2972,25 @@ version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a"
+[[package]]
+name = "miniz_oxide"
+version = "0.3.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "791daaae1ed6889560f8c4359194f56648355540573244a5448a83ba1ecc7435"
+dependencies = [
+ "adler32",
+]
+
+[[package]]
+name = "miniz_oxide"
+version = "0.4.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a92518e98c078586bc6c934028adcca4c92a53d6a958196de835170a01d84e4b"
+dependencies = [
+ "adler",
+ "autocfg",
+]
+
[[package]]
name = "miniz_oxide"
version = "0.7.1"
@@ -2873,9 +3014,9 @@ dependencies = [
[[package]]
name = "moka"
-version = "0.11.2"
+version = "0.11.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "206bf83f415b0579fd885fe0804eb828e727636657dc1bf73d80d2f1218e14a1"
+checksum = "fa6e72583bf6830c956235bff0d5afec8cf2952f579ebad18ae7821a917d950f"
dependencies = [
"async-io",
"async-lock",
@@ -2964,6 +3105,28 @@ dependencies = [
"num-traits",
]
+[[package]]
+name = "num-iter"
+version = "0.1.43"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7d03e6c028c5dc5cac6e2dec0efda81fc887605bb3d884578bb6d6bf7514e252"
+dependencies = [
+ "autocfg",
+ "num-integer",
+ "num-traits",
+]
+
+[[package]]
+name = "num-rational"
+version = "0.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "12ac428b1cb17fce6f731001d307d351ec70a6d202fc2e60f7d4c5e42d8f4f07"
+dependencies = [
+ "autocfg",
+ "num-integer",
+ "num-traits",
+]
+
[[package]]
name = "num-traits"
version = "0.2.15"
@@ -3019,7 +3182,7 @@ checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -3233,7 +3396,7 @@ dependencies = [
"pest_meta",
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -3284,7 +3447,7 @@ checksum = "39407670928234ebc5e6e580247dd567ad73a3578460c5990f9503df207e8f07"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -3305,6 +3468,18 @@ version = "0.3.27"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "26072860ba924cbfa98ea39c8c19b4dd6a4a25423dbdf219c1eca91aa0cf6964"
+[[package]]
+name = "png"
+version = "0.16.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3c3287920cb847dee3de33d301c463fba14dda99db24214ddf93f83d3021f4c6"
+dependencies = [
+ "bitflags 1.3.2",
+ "crc32fast",
+ "deflate",
+ "miniz_oxide 0.3.7",
+]
+
[[package]]
name = "polling"
version = "2.8.0"
@@ -3378,9 +3553,9 @@ checksum = "dc375e1527247fe1a97d8b7156678dfe7c1af2fc075c9a4db3690ecd2a148068"
[[package]]
name = "proc-macro2"
-version = "1.0.60"
+version = "1.0.66"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dec2b086b7a862cf4de201096214fa870344cf922b2b30c167badb3af3195406"
+checksum = "18fb31db3f9bddb2ea821cde30a9f70117e3f119938b5ee630b7403aa6e2ead9"
dependencies = [
"unicode-ident",
]
@@ -3439,6 +3614,16 @@ dependencies = [
"unicase",
]
+[[package]]
+name = "qrcode"
+version = "0.12.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "16d2f1455f3630c6e5107b4f2b94e74d76dea80736de0981fd27644216cff57f"
+dependencies = [
+ "checked_int_cast",
+ "image",
+]
+
[[package]]
name = "quanta"
version = "0.11.1"
@@ -3473,9 +3658,9 @@ dependencies = [
[[package]]
name = "quote"
-version = "1.0.28"
+version = "1.0.33"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1b9ab9c7eadfd8df19006f1cf1a4aed13540ed5cbc047010ece5826e10825488"
+checksum = "5267fca4496028628a95160fc423a33e8b2e6af8a5302579e322e4b520293cae"
dependencies = [
"proc-macro2",
]
@@ -3580,6 +3765,28 @@ dependencies = [
"bitflags 1.3.2",
]
+[[package]]
+name = "rayon"
+version = "1.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1d2df5196e37bcc87abebc0053e20787d73847bb33134a69841207dd0a47f03b"
+dependencies = [
+ "either",
+ "rayon-core",
+]
+
+[[package]]
+name = "rayon-core"
+version = "1.11.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4b8f95bd6966f5c87776639160a66bd8ab9895d9d4ab01ddba9fc60661aebe8d"
+dependencies = [
+ "crossbeam-channel",
+ "crossbeam-deque",
+ "crossbeam-utils",
+ "num_cpus",
+]
+
[[package]]
name = "redis-protocol"
version = "4.1.0"
@@ -3777,15 +3984,14 @@ dependencies = [
"clap",
"common_utils",
"config",
- "crc32fast",
+ "data_models",
"derive_deref",
"diesel",
+ "diesel_models",
"dyn-clone",
"encoding_rs",
"error-stack",
"external_services",
- "frunk",
- "frunk_core",
"futures",
"hex",
"http",
@@ -3799,10 +4005,10 @@ dependencies = [
"maud",
"mimalloc",
"mime",
- "moka",
"nanoid",
"num_cpus",
"once_cell",
+ "qrcode",
"rand 0.8.5",
"redis_interface",
"regex",
@@ -3810,6 +4016,7 @@ dependencies = [
"ring",
"router_derive",
"router_env",
+ "roxmltree",
"serde",
"serde_json",
"serde_path_to_error",
@@ -3819,8 +4026,8 @@ dependencies = [
"serial_test",
"signal-hook",
"signal-hook-tokio",
- "storage_models",
- "strum",
+ "storage_impl",
+ "strum 0.24.1",
"test_utils",
"thirtyfour",
"thiserror",
@@ -3845,7 +4052,7 @@ dependencies = [
"quote",
"serde",
"serde_json",
- "strum",
+ "strum 0.24.1",
"syn 1.0.109",
]
@@ -3863,7 +4070,7 @@ dependencies = [
"serde",
"serde_json",
"serde_path_to_error",
- "strum",
+ "strum 0.24.1",
"time 0.3.22",
"tokio",
"tracing",
@@ -3875,6 +4082,15 @@ dependencies = [
"vergen",
]
+[[package]]
+name = "roxmltree"
+version = "0.18.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d8f595a457b6b8c6cda66a48503e92ee8d19342f905948f29c383200ec9eb1d8"
+dependencies = [
+ "xmlparser",
+]
+
[[package]]
name = "rust-embed"
version = "6.7.0"
@@ -3896,7 +4112,7 @@ dependencies = [
"quote",
"rust-embed-utils",
"shellexpand",
- "syn 2.0.18",
+ "syn 2.0.29",
"walkdir",
]
@@ -4033,6 +4249,12 @@ dependencies = [
"parking_lot",
]
+[[package]]
+name = "scoped_threadpool"
+version = "0.1.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1d51f5df5af43ab3f1360b429fa5e0152ac5ce8c0bd6485cae490332e96846a8"
+
[[package]]
name = "scopeguard"
version = "1.1.0"
@@ -4098,7 +4320,7 @@ checksum = "d9735b638ccc51c28bf6914d90a2e9725b377144fc612c49a611fddd1b631d68"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -4161,7 +4383,7 @@ checksum = "bcec881020c684085e55a25f7fd888954d56609ef363479dc5a1305eb0d40cab"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -4210,7 +4432,7 @@ dependencies = [
"darling 0.20.1",
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -4235,7 +4457,7 @@ checksum = "91d129178576168c589c9ec973feedf7d3126c01ac2bf08795109aa35b69fb8f"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -4379,24 +4601,27 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d"
[[package]]
-name = "storage_models"
+name = "storage_impl"
version = "0.1.0"
dependencies = [
+ "api_models",
"async-bb8-diesel",
- "common_enums",
+ "async-trait",
+ "bb8",
"common_utils",
+ "crc32fast",
+ "data_models",
"diesel",
+ "diesel_models",
+ "dyn-clone",
"error-stack",
- "frunk",
- "frunk_core",
+ "futures",
"masking",
- "router_derive",
+ "moka",
+ "once_cell",
+ "redis_interface",
"router_env",
- "serde",
- "serde_json",
- "strum",
- "thiserror",
- "time 0.3.22",
+ "tokio",
]
[[package]]
@@ -4420,7 +4645,16 @@ version = "0.24.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "063e6045c0e62079840579a7e47a355ae92f60eb74daaf156fb1e84ba164e63f"
dependencies = [
- "strum_macros",
+ "strum_macros 0.24.3",
+]
+
+[[package]]
+name = "strum"
+version = "0.25.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "290d54ea6f91c969195bdbcd7442c8c2a2ba87da8bf60a7ee86a235d4bc1e125"
+dependencies = [
+ "strum_macros 0.25.2",
]
[[package]]
@@ -4436,6 +4670,19 @@ dependencies = [
"syn 1.0.109",
]
+[[package]]
+name = "strum_macros"
+version = "0.25.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ad8d03b598d3d0fff69bf533ee3ef19b8eeb342729596df84bcc7e1f96ec4059"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "rustversion",
+ "syn 2.0.29",
+]
+
[[package]]
name = "subtle"
version = "2.4.1"
@@ -4455,9 +4702,9 @@ dependencies = [
[[package]]
name = "syn"
-version = "2.0.18"
+version = "2.0.29"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "32d41677bcbe24c20c52e7c70b0d8db04134c5d1066bf98662e2871ad200ea3e"
+checksum = "c324c494eba9d92503e6f1ef2e6df781e78f6a7705a0202d9801b198807d518a"
dependencies = [
"proc-macro2",
"quote",
@@ -4538,14 +4785,27 @@ dependencies = [
name = "test_utils"
version = "0.1.0"
dependencies = [
+ "actix-http",
+ "actix-web",
"api_models",
+ "async-trait",
+ "awc",
+ "base64 0.21.2",
"clap",
+ "derive_deref",
"masking",
- "router",
+ "rand 0.8.5",
+ "reqwest",
"serde",
"serde_json",
"serde_path_to_error",
+ "serde_urlencoded",
+ "serial_test",
+ "thirtyfour",
+ "time 0.3.22",
+ "tokio",
"toml 0.7.4",
+ "uuid",
]
[[package]]
@@ -4603,7 +4863,7 @@ checksum = "f9456a42c5b0d803c8cd86e73dd7cc9edd429499f37a3550d286d5e86720569f"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -4616,6 +4876,17 @@ dependencies = [
"once_cell",
]
+[[package]]
+name = "tiff"
+version = "0.6.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a53f4706d65497df0c4349241deddf35f84cee19c87ed86ea8ca590f4464437"
+dependencies = [
+ "jpeg-decoder",
+ "miniz_oxide 0.4.4",
+ "weezl",
+]
+
[[package]]
name = "time"
version = "0.1.45"
@@ -4706,7 +4977,7 @@ checksum = "630bdcf245f78637c13ec01ffae6187cca34625e8c63150d424b59e55af2675e"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -5110,7 +5381,7 @@ dependencies = [
"proc-macro-error",
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
]
[[package]]
@@ -5249,7 +5520,7 @@ dependencies = [
"once_cell",
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
"wasm-bindgen-shared",
]
@@ -5283,7 +5554,7 @@ checksum = "54681b18a46765f095758388f2d0cf16eb8d4169b639ab575a8f5693af210c7b"
dependencies = [
"proc-macro2",
"quote",
- "syn 2.0.18",
+ "syn 2.0.29",
"wasm-bindgen-backend",
"wasm-bindgen-shared",
]
@@ -5342,6 +5613,12 @@ dependencies = [
"webpki",
]
+[[package]]
+name = "weezl"
+version = "0.1.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9193164d4de03a926d909d3bc7c30543cecb35400c02114792c2cae20d5e2dbb"
+
[[package]]
name = "winapi"
version = "0.3.9"
diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs
index 74ed722ba23..a96e2f1bd46 100644
--- a/crates/router/src/core/payment_methods/cards.rs
+++ b/crates/router/src/core/payment_methods/cards.rs
@@ -1860,11 +1860,7 @@ pub async fn list_customer_payment_method(
consts::TOKEN_TTL - time_elapsed.whole_seconds(),
)
.await
- .map_err(|error| {
- logger::error!(connector_payment_method_token_kv_error=?error);
- errors::StorageError::KVError
- })
- .into_report()
+ .change_context(errors::StorageError::KVError)
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to add data in redis")?;
}
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index 5fe34c33851..99a04b80b88 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -1203,7 +1203,7 @@ pub async fn make_pm_data<'a, F: Clone, R>(
.attach_printable("Failed to fetch the token from redis")?
.ok_or(error_stack::Report::new(
errors::ApiErrorResponse::UnprocessableEntity {
- message: token + " is invalid or expired",
+ message: "Token is invalid or expired".to_owned(),
},
))?;
diff --git a/crates/router/src/db/merchant_connector_account.rs b/crates/router/src/db/merchant_connector_account.rs
index 9863d93eea5..bfde360c4a1 100644
--- a/crates/router/src/db/merchant_connector_account.rs
+++ b/crates/router/src/db/merchant_connector_account.rs
@@ -11,7 +11,6 @@ use super::{MockDb, Store};
use crate::{
connection,
core::errors::{self, CustomResult},
- services::logger,
types::{
self,
domain::{
@@ -80,11 +79,7 @@ impl ConnectorAccessToken for Store {
.map_err(Into::<errors::StorageError>::into)?
.set_key_with_expiry(&key, serialized_access_token, access_token.expires)
.await
- .map_err(|error| {
- logger::error!(access_token_kv_error=?error);
- errors::StorageError::KVError
- })
- .into_report()
+ .change_context(errors::StorageError::KVError)
}
}
diff --git a/crates/router/src/routes/payment_methods.rs b/crates/router/src/routes/payment_methods.rs
index 589ae7d73d8..6e7a2c15da8 100644
--- a/crates/router/src/routes/payment_methods.rs
+++ b/crates/router/src/routes/payment_methods.rs
@@ -1,6 +1,6 @@
use actix_web::{web, HttpRequest, HttpResponse};
use common_utils::{consts::TOKEN_TTL, errors::CustomResult};
-use error_stack::{IntoReport, ResultExt};
+use error_stack::ResultExt;
use router_env::{instrument, logger, tracing, Flow};
use time::PrimitiveDateTime;
@@ -397,13 +397,9 @@ impl ParentPaymentMethodToken {
TOKEN_TTL - time_elapsed.whole_seconds(),
)
.await
- .map_err(|error| {
- logger::error!(hyperswitch_token_kv_error=?error);
- errors::StorageError::KVError
- })
- .into_report()
+ .change_context(errors::StorageError::KVError)
.change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Failed to add data in redis")?;
+ .attach_printable("Failed to add token in redis")?;
Ok(())
}
|
refactor
|
return generic message for UnprocessableEntity in make_pm_data (#2050)
|
397d2212405d63dab17272f8c26e4b3a5fc47aa8
|
2024-06-19 16:01:42
|
DEEPANSHU BANSAL
|
feat(core): Add logger for sessions call failure (#5036)
| false
|
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index d459fef935e..8935c3ac0ee 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -1740,7 +1740,7 @@ where
if let Ok(router_types::PaymentsResponseData::SessionResponse {
session_token,
..
- }) = connector_response.response
+ }) = connector_response.response.clone()
{
// If session token is NoSessionTokenReceived, it is not pushed into the sessions_token as there is no response or there can be some error
// In case of error, that error is already logged
@@ -1751,13 +1751,16 @@ where
payment_data.sessions_token.push(session_token);
}
}
+ if let Err(connector_error_response) = connector_response.response {
+ logger::error!(
+ "sessions_connector_error {} {:?}",
+ connector_name,
+ connector_error_response
+ );
+ }
}
- Err(connector_error) => {
- logger::error!(
- "sessions_connector_error {} {:?}",
- connector_name,
- connector_error
- );
+ Err(api_error) => {
+ logger::error!("sessions_api_error {} {:?}", connector_name, api_error);
}
}
}
diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs
index 518d1aa1a79..0c6ce07e51a 100644
--- a/crates/router/src/services/api.rs
+++ b/crates/router/src/services/api.rs
@@ -332,6 +332,7 @@ where
if let Some(status) = error_res.attempt_status {
router_data.status = status;
};
+ state.event_handler().log_event(&connector_event);
error_res
}
};
|
feat
|
Add logger for sessions call failure (#5036)
|
cd9030506c6843c0331bc93d67590d12e280ecca
|
2023-10-18 23:34:07
|
Gnanasundari24
|
ci(postman): Add Customer list endpoint (#2623)
| false
|
diff --git a/postman/collection-dir/stripe/Customers/.meta.json b/postman/collection-dir/stripe/Customers/.meta.json
index db26627bb97..3b7497b1ea1 100644
--- a/postman/collection-dir/stripe/Customers/.meta.json
+++ b/postman/collection-dir/stripe/Customers/.meta.json
@@ -1,6 +1,7 @@
{
"childrenOrder": [
"Create Customer",
+ "List Customer",
"Retrieve Customer",
"Update Customer",
"Ephemeral Key",
diff --git a/postman/collection-dir/stripe/Customers/List Customer/.event.meta.json b/postman/collection-dir/stripe/Customers/List Customer/.event.meta.json
new file mode 100644
index 00000000000..688c85746ef
--- /dev/null
+++ b/postman/collection-dir/stripe/Customers/List Customer/.event.meta.json
@@ -0,0 +1,5 @@
+{
+ "eventOrder": [
+ "event.test.js"
+ ]
+}
diff --git a/postman/collection-dir/stripe/Customers/List Customer/event.test.js b/postman/collection-dir/stripe/Customers/List Customer/event.test.js
new file mode 100644
index 00000000000..2d1ce4bd2f2
--- /dev/null
+++ b/postman/collection-dir/stripe/Customers/List Customer/event.test.js
@@ -0,0 +1,64 @@
+// Validate status 2xx
+pm.test("[POST]::/customers - Status code is 2xx", function () {
+ pm.response.to.be.success;
+});
+
+// Validate if response header has matching content-type
+pm.test("[POST]::/customers - Content-Type is application/json", function () {
+ pm.expect(pm.response.headers.get("Content-Type")).to.include(
+ "application/json",
+ );
+});
+
+// Validate if response has JSON Body
+pm.test("[POST]::/customers - Response has JSON Body", function () {
+ pm.response.to.have.jsonBody();
+});
+
+// Set response object as internal variable
+let jsonData = {};
+try {
+ jsonData = pm.response.json();
+} catch (e) {}
+
+
+// Response body should have a minimum length of "1" for "customer_id"
+if (jsonData?.customer_id) {
+ pm.test(
+ "[POST]::/customers - Content check if value of 'customer_id' has a minimum length of '2'",
+ function () {
+ pm.expect(jsonData.customer_id.length).is.at.least(2);
+ },
+ );
+}
+
+
+// Define the regular expression pattern to match customer_id
+var customerIdPattern = /^[a-zA-Z0-9_]+$/;
+
+// Define an array to store the validation results
+var validationResults = [];
+
+// Iterate through the JSON array
+jsonData.forEach(function(item, index) {
+ if (item.hasOwnProperty("customer_id")) {
+ if (customerIdPattern.test(item.customer_id)) {
+ validationResults.push("customer_id " + item.customer_id + " is valid.");
+ } else {
+ validationResults.push("customer_id " + item.customer_id + " is not valid.");
+ }
+ } else {
+ validationResults.push("customer_id is missing for item at index " + index);
+ }
+});
+
+// Check if any customer_id is not valid and fail the test if necessary
+if (validationResults.some(result => !result.includes("is valid"))) {
+ pm.test("Customer IDs validation failed: " + validationResults.join(", "), function() {
+ pm.expect(false).to.be.true;
+ });
+} else {
+ pm.test("All customer IDs are valid: " + validationResults.join(", "), function() {
+ pm.expect(true).to.be.true;
+ });
+}
diff --git a/postman/collection-dir/stripe/Customers/List Customer/request.json b/postman/collection-dir/stripe/Customers/List Customer/request.json
new file mode 100644
index 00000000000..40d39448bbe
--- /dev/null
+++ b/postman/collection-dir/stripe/Customers/List Customer/request.json
@@ -0,0 +1,19 @@
+{
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/list",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ "list"
+ ]
+ }
+}
diff --git a/postman/collection-dir/stripe/Customers/List Customer/response.json b/postman/collection-dir/stripe/Customers/List Customer/response.json
new file mode 100644
index 00000000000..fe51488c706
--- /dev/null
+++ b/postman/collection-dir/stripe/Customers/List Customer/response.json
@@ -0,0 +1 @@
+[]
|
ci
|
Add Customer list endpoint (#2623)
|
8fc68adc7fb6a23d4a2970a05f5739db6010a53d
|
2024-01-10 10:51:39
|
Sanchith Hegde
|
chore(postman): update Postman collection files
| false
|
diff --git a/postman/collection-json/adyen_uk.postman_collection.json b/postman/collection-json/adyen_uk.postman_collection.json
index 8ac059b0d7a..26963aa8abb 100644
--- a/postman/collection-json/adyen_uk.postman_collection.json
+++ b/postman/collection-json/adyen_uk.postman_collection.json
@@ -1,15246 +1,14786 @@
{
- "info": {
- "_postman_id": "03d0a2d2-c07d-45a8-a8f3-e259de3ae319",
- "name": "adyen_uk",
- "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [[email protected]](mailto:[email protected])",
- "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
- "_exporter_id": "27028646"
- },
- "item": [
- {
- "name": "Health check",
- "item": [
- {
- "name": "New Request",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "x-feature",
- "value": "router-custom",
- "type": "text",
- "disabled": true
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/health",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "health"
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "Flow Testcases",
- "item": [
- {
- "name": "QuickStart",
- "item": [
- {
- "name": "Merchant Account - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
- "if (jsonData?.merchant_id) {",
- " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
- " console.log(",
- " \"- use {{merchant_id}} as collection variable for value\",",
- " jsonData.merchant_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"},{\"country\":\"GB\",\"business\":\"payouts\"}],\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/accounts",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts"
- ]
- },
- "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
- },
- "response": []
- },
- {
- "name": "API Key - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
- },
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Payment Connector - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set profile_id as variable for jsonData.payment_profile_id",
- "if (jsonData?.profile_id) {",
- " pm.collectionVariables.set(\"payment_profile_id\", jsonData.profile_id);",
- " console.log(",
- " \"- use {{payment_profile_id}} as collection variable for value\",",
- " jsonData.profile_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_profile_id}}, as jsonData.profile_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"adyen\",\"connector_account_details\":{\"auth_type\":\"BodyKey\",\"api_key\":\"{{connector_api_key}}\",\"key1\":\"{{connector_key1}}\",\"api_secret\":\"{{connector_api_secret}}\"},\"test_mode\":false,\"disabled\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"AmericanExpress\",\"Discover\",\"Interac\",\"JCB\",\"Mastercard\",\"Visa\",\"DinersClub\",\"UnionPay\",\"RuPay\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"AmericanExpress\",\"Discover\",\"Interac\",\"JCB\",\"Mastercard\",\"Visa\",\"DinersClub\",\"UnionPay\",\"RuPay\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"pay_bright\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"walley\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"paypal\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mobile_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"ali_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"we_chat_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mb_way\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"gift_card\",\"payment_method_types\":[{\"payment_method_type\":\"givex\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"giropay\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"recurring_enabled\":false,\"installment_payment_enabled\":false},{\"payment_method_type\":\"ideal\",\"recurring_enabled\":false,\"installment_payment_enabled\":false},{\"payment_method_type\":\"sofort\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"blik\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"trustly\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_czech_republic\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_finland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_poland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_slovakia\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bancontact_card\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"google_pay\":{\"allowed_payment_methods\":[{\"type\":\"CARD\",\"parameters\":{\"allowed_auth_methods\":[\"PAN_ONLY\",\"CRYPTOGRAM_3DS\"],\"allowed_card_networks\":[\"AMEX\",\"DISCOVER\",\"INTERAC\",\"JCB\",\"MASTERCARD\",\"VISA\"]},\"tokenization_specification\":{\"type\":\"PAYMENT_GATEWAY\"}}],\"merchant_info\":{\"merchant_name\":\"Narayan Bhat\"}},\"apple_pay\":{\"session_token_data\":{\"initiative\":\"web\",\"certificate\":\"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUdKakNDQlE2Z0F3SUJBZ0lRRENzRmFrVkNLU01uc2JacTc1YTI0ekFOQmdrcWhraUc5dzBCQVFzRkFEQjEKTVVRd1FnWURWUVFERER0QmNIQnNaU0JYYjNKc1pIZHBaR1VnUkdWMlpXeHZjR1Z5SUZKbGJHRjBhVzl1Y3lCRApaWEowYVdacFkyRjBhVzl1SUVGMWRHaHZjbWwwZVRFTE1Ba0dBMVVFQ3d3Q1J6TXhFekFSQmdOVkJBb01Da0Z3CmNHeGxJRWx1WXk0eEN6QUpCZ05WQkFZVEFsVlRNQjRYRFRJeU1USXdPREE1TVRJeE1Wb1hEVEkxTURFd05qQTUKTVRJeE1Gb3dnYWd4SmpBa0Jnb0praWFKay9Jc1pBRUJEQlp0WlhKamFHRnVkQzVqYjIwdVlXUjVaVzR1YzJGdQpNVHN3T1FZRFZRUUREREpCY0hCc1pTQlFZWGtnVFdWeVkyaGhiblFnU1dSbGJuUnBkSGs2YldWeVkyaGhiblF1ClkyOXRMbUZrZVdWdUxuTmhiakVUTUJFR0ExVUVDd3dLV1UwNVZUY3pXakpLVFRFc01Db0dBMVVFQ2d3alNsVlQKVUVGWklGUkZRMGhPVDB4UFIwbEZVeUJRVWtsV1FWUkZJRXhKVFVsVVJVUXdnZ0VpTUEwR0NTcUdTSWIzRFFFQgpBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRRDhIUy81ZmJZNVJLaElYU3pySEpoeTVrNmY0YUdMaEltYklLaXFYRUlUCnVSQ2RHcGcyMExZM1VhTlBlYXZXTVRIUTBpK3d1RzlZWFVhYzV5eGE0cHg5eHlmQlVIejhzeU9pMjdYNVZaVG8KTlFhd2F6dGM5aGpZc1B2K0s2UW9oaWRTQWZ3cDhMdThkQ0lVZlhQWHBjdjFqVVRyRCtlc1RJTFZUb1FUTmhDcwplQlJtUS9nK05WdTB5c3BqeUYxU2l6VG9BK1BML3NrMlJEYWNaWC9vWTB1R040VWd4c0JYWHdZM0dKbTFSQ3B1CjM0Y2d0UC9kaHNBM1Ixb1VOb0gyQkZBSm9xK3pyUnl3U1RCSEhNMGpEQ2lncVU1RktwL1pBbHdzYmg1WVZOU00KWksrQ0pTK1BPTzlVNGVkeHJmTGlBVkhnQTgzRG43Z2U4K29nV1Y0Z0hUNmhBZ01CQUFHamdnSjhNSUlDZURBTQpCZ05WSFJNQkFmOEVBakFBTUI4R0ExVWRJd1FZTUJhQUZBbit3QldRK2E5a0NwSVN1U1lvWXd5WDdLZXlNSEFHCkNDc0dBUVVGQndFQkJHUXdZakF0QmdnckJnRUZCUWN3QW9ZaGFIUjBjRG92TDJObGNuUnpMbUZ3Y0d4bExtTnYKYlM5M2QyUnlaek11WkdWeU1ERUdDQ3NHQVFVRkJ6QUJoaVZvZEhSd09pOHZiMk56Y0M1aGNIQnNaUzVqYjIwdgpiMk56Y0RBekxYZDNaSEpuTXpBNU1JSUJMUVlEVlIwZ0JJSUJKRENDQVNBd2dnRWNCZ2txaGtpRzkyTmtCUUV3CmdnRU5NSUhSQmdnckJnRUZCUWNDQWpDQnhBeUJ3VkpsYkdsaGJtTmxJRzl1SUhSb2FYTWdRMlZ5ZEdsbWFXTmgKZEdVZ1lua2dZVzU1SUhCaGNuUjVJRzkwYUdWeUlIUm9ZVzRnUVhCd2JHVWdhWE1nY0hKdmFHbGlhWFJsWkM0ZwpVbVZtWlhJZ2RHOGdkR2hsSUdGd2NHeHBZMkZpYkdVZ2MzUmhibVJoY21RZ2RHVnliWE1nWVc1a0lHTnZibVJwCmRHbHZibk1nYjJZZ2RYTmxMQ0JqWlhKMGFXWnBZMkYwWlNCd2IyeHBZM2tnWVc1a0lHTmxjblJwWm1sallYUnAKYjI0Z2NISmhZM1JwWTJVZ2MzUmhkR1Z0Wlc1MGN5NHdOd1lJS3dZQkJRVUhBZ0VXSzJoMGRIQnpPaTh2ZDNkMwpMbUZ3Y0d4bExtTnZiUzlqWlhKMGFXWnBZMkYwWldGMWRHaHZjbWwwZVM4d0V3WURWUjBsQkF3d0NnWUlLd1lCCkJRVUhBd0l3SFFZRFZSME9CQllFRk5RSysxcUNHbDRTQ1p6SzFSUmpnb05nM0hmdk1BNEdBMVVkRHdFQi93UUUKQXdJSGdEQlBCZ2txaGtpRzkyTmtCaUFFUWd4QVFVUkNRemxDTmtGRE5USkVRems0TnpCRk5qYzJNVFpFUkRJdwpPVUkwTWtReE1UVXlSVVpFTURVeFFVRXhRekV6T0ROR00wUkROa1V5TkVNelFqRkVSVEFQQmdrcWhraUc5Mk5rCkJpNEVBZ1VBTUEwR0NTcUdTSWIzRFFFQkN3VUFBNElCQVFBSFR6NTU2RUs5VVp6R0RVd2cvcmFibmYrUXFSYkgKcllVS0ZNcWQwUDhFTHZGMmYrTzN0ZXlDWHNBckF4TmVMY2hRSGVTNUFJOHd2azdMQ0xLUmJCdWJQQy9NVmtBKwpCZ3h5STg2ejJOVUNDWml4QVM1d2JFQWJYOStVMFp2RHp5Y01BbUNrdVVHZjNwWXR5TDNDaEplSGRvOEwwdmdvCnJQWElUSzc4ZjQzenNzYjBTNE5xbTE0eS9LNCs1ZkUzcFUxdEJqME5tUmdKUVJLRnB6MENpV2RPd1BRTk5BYUMKYUNNU2NiYXdwUTBjWEhaZDJWVjNtem4xdUlITEVtaU5GTWVxeEprbjZhUXFFQnNndDUzaUFxcmZMNjEzWStScAppd0tENXVmeU0wYzBweTYyZmkvWEwwS2c4ajEwWU1VdWJpd2dHajAzZThQWTB6bWUvcGZCZ3p6VQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==\",\"display_name\":\"applepay\",\"certificate_keys\":\"LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2Z0lCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktnd2dnU2tBZ0VBQW9JQkFRRDhIUy81ZmJZNVJLaEkKWFN6ckhKaHk1azZmNGFHTGhJbWJJS2lxWEVJVHVSQ2RHcGcyMExZM1VhTlBlYXZXTVRIUTBpK3d1RzlZWFVhYwo1eXhhNHB4OXh5ZkJVSHo4c3lPaTI3WDVWWlRvTlFhd2F6dGM5aGpZc1B2K0s2UW9oaWRTQWZ3cDhMdThkQ0lVCmZYUFhwY3YxalVUckQrZXNUSUxWVG9RVE5oQ3NlQlJtUS9nK05WdTB5c3BqeUYxU2l6VG9BK1BML3NrMlJEYWMKWlgvb1kwdUdONFVneHNCWFh3WTNHSm0xUkNwdTM0Y2d0UC9kaHNBM1Ixb1VOb0gyQkZBSm9xK3pyUnl3U1RCSApITTBqRENpZ3FVNUZLcC9aQWx3c2JoNVlWTlNNWksrQ0pTK1BPTzlVNGVkeHJmTGlBVkhnQTgzRG43Z2U4K29nCldWNGdIVDZoQWdNQkFBRUNnZ0VBZFNaRzVhTFJxdmpKVFo3bVFYWHZMT3p4dWY5SlpxQTJwUHZmQkJLTXJjZC8KL2RDZXpGSGRhZ1VvWXNUQjRXekluaVVjL2Z3bDJTUzJyREFMZjB2dnRjNTJIYkQ5OHhwMnc3VmVjTGFnMCtuWAo2dUJaSEZCS3FWNU1LZ1l6YUpVMTdqaDM2VEV3dTFnbmdlZnRqVlpBV1NERTFvbDBlSzZ3Mk5kOExjVWdxRkxUCjVHYUlBV01nd0NKL3pzQmwydUV1Y0Q4S21WL1Z2MkVCQVJLWGZtci92UU1NelZrNkhhalprVGZqbWY2cWFVQVMKQWlFblROcHBic2ZrdTk2VGdIa2owWm10VWc0SFkzSU9qWFlpaGJsSjJzQ1JjS3p6cXkxa3B3WlpHcHo1NXEzbgphSXEwenJ3RjlpTUZubEhCa04yK3FjSnhzcDNTalhRdFRLTTY4WHRrVlFLQmdRRC8wemtCVlExR2Q1U0Mzb2czCnM3QWRCZ243dnVMdUZHZFFZY3c0OUppRGw1a1BZRXlKdGQvTVpNOEpFdk1nbVVTeUZmczNZcGtmQ2VGbUp0S3QKMnNNNEdCRWxqTVBQNjI3Q0QrV3c4L3JpWmlOZEg3OUhPRjRneTRGbjBycDNqanlLSWF1OHJISDQwRUUvSkVyOQpxWFQ1SGdWMmJQOGhMcW5sSjFmSDhpY2Zkd0tCZ1FEOFNWQ3ZDV2txQkh2SzE5ZDVTNlArdm5hcXhnTWo0U0srCnJ6L1I1c3pTaW5lS045VEhyeVkxYUZJbVFJZjJYOUdaQXBocUhrckxtQ3BIcURHOWQ3WDVQdUxxQzhmc09kVTYKRzhWaFRXeXdaSVNjdGRSYkk5S2xKUFk2V2ZDQjk0ODNVaDJGbW1xV2JuNWcwZUJxZWZzamVVdEtHekNRaGJDYworR1dBREVRSXB3S0JnUURmaWYvN3pBZm5sVUh1QU9saVV0OEczV29IMGtxVTRydE1IOGpGMCtVWXgzVDFYSjVFCmp1blp2aFN5eHg0dlUvNFU1dVEzQnk3cFVrYmtiZlFWK2x3dlBjaHQyVXlZK0E0MkFKSWlSMjdvT1h1Wk9jNTQKT3liMDNSNWNUR1NuWjJBN0N5VDNubStRak5rV2hXNEpyUE1MWTFJK293dGtRVlF2YW10bnlZNnFEUUtCZ0ZYWgpLT0IzSmxjSzhZa0R5Nm5WeUhkZUhvbGNHaU55YjkxTlN6MUUrWHZIYklnWEdZdmRtUFhoaXRyRGFNQzR1RjBGCjJoRjZQMTlxWnpDOUZqZnY3WGRrSTlrYXF5eENQY0dwUTVBcHhZdDhtUGV1bEJWemFqR1NFMHVsNFVhSWxDNXgKL2VQQnVQVjVvZjJXVFhST0Q5eHhZT0pWd0QvZGprekw1ZFlkMW1UUEFvR0JBTWVwY3diVEphZ3BoZk5zOHY0WAprclNoWXplbVpxY2EwQzRFc2QwNGYwTUxHSlVNS3Zpck4zN0g1OUFjT2IvNWtZcTU5WFRwRmJPWjdmYlpHdDZnCkxnM2hWSHRacElOVGJ5Ni9GOTBUZ09Za3RxUnhNVmc3UFBxbjFqdEFiVU15eVpVZFdHcFNNMmI0bXQ5dGhlUDEKblhMR09NWUtnS2JYbjZXWWN5K2U5eW9ICi0tLS0tRU5EIFBSSVZBVEUgS0VZLS0tLS0KCg==\",\"initiative_context\":\"hyperswitch-sdk-test.netlify.app\",\"merchant_identifier\":\"merchant.com.adyen.san\"},\"payment_request_data\":{\"label\":\"applepay pvt.ltd\",\"supported_networks\":[\"visa\",\"masterCard\",\"amex\",\"discover\"],\"merchant_capabilities\":[\"supports3DS\"]}}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
- },
- "response": []
- },
- {
- "name": "Payout Connector - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set profile_id as variable for jsonData.payout_profile_id",
- "if (jsonData?.profile_id) {",
- " pm.collectionVariables.set(\"payout_profile_id\", jsonData.profile_id);",
- " console.log(",
- " \"- use {{payout_profile_id}} as collection variable for value\",",
- " jsonData.profile_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payout_profile_id}}, as jsonData.profile_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"connector_type\":\"payout_processor\",\"connector_name\":\"adyen\",\"connector_account_details\":{\"auth_type\":\"SignatureKey\",\"api_key\":\"{{connector_api_key}}\",\"key1\":\"{{connector_key1}}\",\"api_secret\":\"{{connector_api_secret}}\"},\"test_mode\":false,\"disabled\":false,\"business_country\":\"GB\",\"business_label\":\"payouts\",\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"pay_bright\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"walley\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"paypal\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mobile_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"ali_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"we_chat_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mb_way\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"giropay\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"blik\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"trustly\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_czech_republic\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_finland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_poland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_slovakia\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bancontact_card\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}]}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
- },
- "response": []
- },
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"routing\":{\"type\":\"single\",\"data\":\"adyen\"},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Payouts - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payouts/create - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payouts/create - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Validate if status is successful",
- "// if (jsonData?.status) {",
- "// pm.test(\"[POST]::/payouts/create - Content check if value for 'status' matches 'success'\",",
- "// function () {",
- "// pm.expect(jsonData.status).to.eql(\"success\");",
- "// },",
- "// );",
- "// }",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) { }",
- "",
- "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
- "if (jsonData?.payout_id) {",
- " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
- " console.log(",
- " \"- use {{payout_id}} as collection variable for value\",",
- " jsonData.payout_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1,\"currency\":\"EUR\",\"customer_id\":\"payout_customer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payout request\",\"connector\":[\"adyen\"],\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"iban\":\"NL46TEST0136169112\",\"bic\":\"ABNANL2A\",\"bank_name\":\"Deutsche Bank\",\"bank_country_code\":\"NL\",\"bank_city\":\"Amsterdam\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"entity_type\":\"Individual\",\"recurring\":true,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payouts/create",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payouts",
- "create"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payouts - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payouts/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payouts/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payouts/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
- "if (jsonData?.payout_id) {",
- " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
- " console.log(",
- " \"- use {{payout_id}} as collection variable for value\",",
- " jsonData.payout_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payouts/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payouts",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payout_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Happy Cases",
- "item": [
- {
- "name": "Scenario22-Create Gift Card payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1100,\"currency\":\"EUR\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1100,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"gift_card\",\"payment_method_type\":\"givex\",\"payment_method_data\":{\"gift_card\":{\"givex\":{\"number\":\"6364530000000000\",\"cvc\":\"122222\"}}},\"routing\":{\"type\":\"single\",\"data\":\"adyen\"},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario1-Create payment with confirm true",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2-Create payment with confirm false",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario3-Create payment without PMD",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario4-Create payment with Manual capture",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6000);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario5-Void the payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Cancel",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"cancelled\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/cancel - Content check if value for 'status' matches 'cancelled'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"cancelled\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"cancellation_reason\":\"requested_by_customer\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/cancel",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "cancel"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"cancelled\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'cancelled'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"cancelled\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario6-Create 3DS payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4917610000000000\",\"card_exp_month\":\"03\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario7-Create 3DS payment with confrm false",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4917610000000000\",\"card_exp_month\":\"03\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario9-Refund full payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"DUPLICATE\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario10-Create a mandate and recurring payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Recurring Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"payment_method_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario11-Partial refund",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"RETURN\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"1000\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(1000);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":1000,\"reason\":\"FRAUD\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(1000);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"refunds\"",
- "pm.test(\"[POST]::/payments - Content check if 'refunds' exists\", function () {",
- " pm.expect(typeof jsonData.refunds !== \"undefined\").to.be.true;",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario12-Bank Redirect-sofort",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"sofort\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'sofort'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"sofort\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"sofort\",\"payment_method_data\":{\"bank_redirect\":{\"sofort\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario13-Bank Redirect-eps",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"eps\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'eps'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"eps\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"eps\",\"payment_method_data\":{\"bank_redirect\":{\"eps\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"AT\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario14-Refund recurring payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Recurring Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"payment_method_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6570,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6570,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create Copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"DUPLICATE\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve Copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario15-Bank Redirect-giropay",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"giropay\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'giropay'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"giropay\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"giropay\",\"payment_method_data\":{\"bank_redirect\":{\"giropay\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario16-Bank debit-ach",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":10000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"off_session\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"ach\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ach'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"ach\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_debit\",\"payment_method_type\":\"ach\",\"payment_method_data\":{\"bank_debit\":{\"ach_bank_debit\":{\"account_number\":\"40308669\",\"routing_number\":\"121000358\",\"sort_code\":\"560036\",\"shopper_email\":\"[email protected]\",\"card_holder_name\":\"joseph Doe\",\"bank_account_holder_name\":\"David Archer\",\"billing_details\":{\"houseNumberOrName\":\"50\",\"street\":\"Test Street\",\"city\":\"Amsterdam\",\"stateOrProvince\":\"NY\",\"postalCode\":\"12010\",\"country\":\"US\",\"name\":\"A. Klaassen\",\"email\":\"[email protected]\"},\"reference\":\"daslvcgbaieh\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario17-Bank debit-Bacs",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":100,\"currency\":\"GBP\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"off_session\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"GB\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"processing\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"bacs\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'bacs'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"bacs\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_debit\",\"payment_method_type\":\"bacs\",\"payment_method_data\":{\"bank_debit\":{\"bacs_bank_debit\":{\"account_number\":\"40308669\",\"routing_number\":\"121000358\",\"sort_code\":\"560036\",\"shopper_email\":\"[email protected]\",\"card_holder_name\":\"joseph Doe\",\"bank_account_holder_name\":\"David Archer\",\"billing_details\":{\"houseNumberOrName\":\"50\",\"street\":\"Test Street\",\"city\":\"Amsterdam\",\"stateOrProvince\":\"NY\",\"postalCode\":\"12010\",\"country\":\"GB\",\"name\":\"A. Klaassen\",\"email\":\"[email protected]\"},\"reference\":\"daslvcgbaieh\"}}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"processing\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario18-Bank Redirect-Trustly",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"FI\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"giropay\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'trustly'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"trustly\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"trustly\",\"payment_method_data\":{\"bank_redirect\":{\"trustly\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"FI\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario19-Add card flow",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for a Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
- " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":customer_id",
- "payment_methods"
- ],
- "query": [
- {
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
- {
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
- },
- "response": []
- },
- {
- "name": "Save card payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Save card payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"7373\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve Copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- "});",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
- " function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"FRAUD\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"pending\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario20-Pass Invalid CVV for save card flow and verify failed payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for a Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
- " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":customer_id",
- "payment_methods"
- ],
- "query": [
- {
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
- {
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
- },
- "response": []
- },
- {
- "name": "Save card payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Save card payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"failed\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"24\" for \"error_code\"",
- "if (jsonData?.error_code) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches '24'\",",
- " function () {",
- " pm.expect(jsonData.error_code).to.eql(\"24\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"24\" for \"error_message\"",
- "if (jsonData?.error_message) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'CVC Declined'\",",
- " function () {",
- " pm.expect(jsonData.error_message).to.eql(\"CVC Declined\");",
- " },",
- " );",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"737\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- "});",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
- " function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario23-Create PM list for eps dynamic fields",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for Merchants",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "pm.test(",
- " \"[GET]::/payments/:id - EPS required field contains 'payment_method_data.bank_redirect.eps.bank_name'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"eps\" &&",
- " type.required_fields &&",
- " type.required_fields[\"payment_method_data.bank_redirect.eps.bank_name\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- "payment_methods"
- ],
- "query": [
- {
- "key": "client_secret",
- "value": "{{client_secret}}"
- }
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario24-Create PM list for ideal dynamic fields",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"NL\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"NL\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for Merchants",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "",
- "pm.test(",
- " \"[GET]::/payments/:id - EPS required field contains 'payment_method_data.bank_redirect.ideal.bank_name'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"ideal\" &&",
- " type.required_fields &&",
- " type.required_fields[\"payment_method_data.bank_redirect.ideal.bank_name\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "",
- "",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- "payment_methods"
- ],
- "query": [
- {
- "key": "client_secret",
- "value": "{{client_secret}}"
- }
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for a Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
- " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":customer_id",
- "payment_methods"
- ],
- "query": [
- {
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
- {
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
- },
- "response": []
- },
- {
- "name": "Save card payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Save card payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"failed\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"24\" for \"error_code\"",
- "if (jsonData?.error_code) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches '24'\",",
- " function () {",
- " pm.expect(jsonData.error_code).to.eql(\"24\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"24\" for \"error_message\"",
- "if (jsonData?.error_message) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'CVC Declined'\",",
- " function () {",
- " pm.expect(jsonData.error_message).to.eql(\"CVC Declined\");",
- " },",
- " );",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"adyen\");",
- "});",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
- " function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- }
- ]
- },
- {
- "name": "Variation Cases",
- "item": [
- {
- "name": "Scenario10-Create Gift Card payment where it fails due to insufficient balance",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"failed\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have error message as \"Insufficient balance in the payment method\"",
- "if (jsonData?.error_message) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error_message' matches 'Insufficient balance in the payment method'\",",
- " function () {",
- " pm.expect(jsonData.error_message).to.eql(\"Insufficient balance in the payment method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":14100,\"currency\":\"EUR\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":14100,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"gift_card\",\"payment_method_type\":\"givex\",\"payment_method_data\":{\"gift_card\":{\"givex\":{\"number\":\"6364530000000000\",\"cvc\":\"122222\"}}},\"routing\":{\"type\":\"single\",\"data\":\"adyen\"},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Failed\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario1-Create payment with Invalid card details",
- "item": [
- {
- "name": "Payments - Create(Invalid card number)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'connector_error'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"connector_error\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"123456\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"united states\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"united states\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Create(Invalid Exp month)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.message) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.message' matches 'Card Expired'\",",
- " function () {",
- " pm.expect(jsonData.error.message).to.eql(\"Card Expired\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"01\",\"card_exp_year\":\"2023\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Create(Invalid Exp Year)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.message) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.message' matches 'Invalid Expiry Year'\",",
- " function () {",
- " pm.expect(jsonData.error.message).to.eql(\"Invalid Expiry Year\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"10\",\"card_exp_year\":\"2022\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Create(invalid CVV)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.message) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.message' matches 'Invalid card_cvc length'\",",
- " function () {",
- " pm.expect(jsonData.error.message).to.eql(\"Invalid card_cvc length\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"12345\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2-Confirming the payment without PMD",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario3-Capture greater amount",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario4-Capture the succeeded payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario5-Void the success_slash_failure payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Cancel",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments/:id/cancel - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"cancellation_reason\":\"requested_by_customer\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/cancel",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "cancel"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario6-Create 3DS payment with greater capture",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":7540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario7-Refund exceeds amount",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.message) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.message' matches 'The refund amount exceeds the amount captured'\",",
- " function () {",
- " pm.expect(jsonData.error.message).to.eql(",
- " \"The refund amount exceeds the amount captured\",",
- " );",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":7000,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario8-Refund for unsuccessful payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.message) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.message' matches 'This Payment could not be refund because it has a status of requires_confirmation. The expected state is succeeded, partially_captured'\",",
- " function () {",
- " pm.expect(jsonData.error.message).to.eql(",
- " \"This Payment could not be refund because it has a status of requires_confirmation. The expected state is succeeded, partially_captured\",",
- " );",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario9-Create a recurring payment with greater mandate amount",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Recurring Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.message) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.message' matches 'Mandate Validation Failed'\",",
- " function () {",
- " pm.expect(jsonData.error.message).to.eql(\"Mandate Validation Failed\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":8040,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":8040,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario10-Create payouts using unsupported methods",
- "item": [
- {
- "name": "ACH Payouts - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payouts/create - Status code is 4xx\", function () {",
- " pm.response.to.be.clientError;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
- "if (jsonData?.payout_id) {",
- " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
- " console.log(",
- " \"- use {{payout_id}} as collection variable for value\",",
- " jsonData.payout_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":10000,\"currency\":\"USD\",\"customer_id\":\"payout_customer\",\"email\":\"[email protected]\",\"name\":\"Doest John\",\"phone\":\"6168205366\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payout request\",\"connector\":[\"adyen\"],\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"bank_routing_number\":\"110000000\",\"bank_account_number\":\"000123456789\",\"bank_name\":\"Stripe Test Bank\",\"bank_country_code\":\"US\",\"bank_city\":\"California\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"Doest\",\"last_name\":\"John\"},\"phone\":{\"number\":\"6168205366\",\"country_code\":\"1\"}},\"entity_type\":\"Individual\",\"recurring\":false,\"metadata\":{\"ref\":\"123\",\"vendor_details\":{\"account_type\":\"custom\",\"business_type\":\"individual\",\"business_profile_mcc\":5045,\"business_profile_url\":\"https://www.pastebin.com\",\"business_profile_name\":\"pT\",\"company_address_line1\":\"address_full_match\",\"company_address_line2\":\"Kimberly Way\",\"company_address_postal_code\":\"31062\",\"company_address_city\":\"Milledgeville\",\"company_address_state\":\"GA\",\"company_phone\":\"+16168205366\",\"company_tax_id\":\"000000000\",\"company_owners_provided\":false,\"capabilities_card_payments\":true,\"capabilities_transfers\":true},\"individual_details\":{\"tos_acceptance_date\":1680581051,\"tos_acceptance_ip\":\"103.159.11.202\",\"individual_dob_day\":\"01\",\"individual_dob_month\":\"01\",\"individual_dob_year\":\"1901\",\"individual_id_number\":\"000000000\",\"individual_ssn_last_4\":\"0000\",\"external_account_account_holder_type\":\"individual\"}},\"confirm\":true,\"auto_fulfill\":true}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payouts/create",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payouts",
- "create"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Bacs Payouts - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payouts/create - Status code is 4xx\", function () {",
- " pm.response.to.be.clientError;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
- "if (jsonData?.payout_id) {",
- " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
- " console.log(",
- " \"- use {{payout_id}} as collection variable for value\",",
- " jsonData.payout_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1,\"currency\":\"GBP\",\"customer_id\":\"payout_customer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payout request\",\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"bank_sort_code\":\"231470\",\"bank_account_number\":\"28821822\",\"bank_name\":\"Deutsche Bank\",\"bank_country_code\":\"NL\",\"bank_city\":\"Amsterdam\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"entity_type\":\"Individual\",\"recurring\":true,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true,\"connector\":[\"adyen\"],\"business_label\":\"abcd\",\"business_country\":\"US\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payouts/create",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payouts",
- "create"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- }
- ]
- }
- ]
- }
- ]
- }
- ],
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "type": "text/javascript",
- "exec": [
- "// Add appropriate profile_id for relevant requests",
- "const path = pm.request.url.toString();",
- "const isPostRequest = pm.request.method.toString() === \"POST\";",
- "const isPaymentCreation = path.match(/\\/payments$/) && isPostRequest;",
- "const isPayoutCreation = path.match(/\\/payouts\\/create$/) && isPostRequest;",
- "",
- "if (isPaymentCreation || isPayoutCreation) {",
- " try {",
- " const request = JSON.parse(pm.request.body.toJSON().raw);",
- "",
- " // Attach profile_id",
- " const profile_id = isPaymentCreation",
- " ? pm.collectionVariables.get(\"payment_profile_id\")",
- " : pm.collectionVariables.get(\"payout_profile_id\");",
- " request[\"profile_id\"] = profile_id;",
- "",
- " // Attach routing",
- " const routing = { type: \"single\", data: \"adyen\" };",
- " request[\"routing\"] = routing;",
- "",
- " let updatedRequest = {",
- " mode: \"raw\",",
- " raw: JSON.stringify(request),",
- " options: {",
- " raw: {",
- " language: \"json\",",
- " },",
- " },",
- " };",
- " pm.request.body.update(updatedRequest);",
- " } catch (error) {",
- " console.error(\"Failed to inject profile_id in the request\");",
- " console.error(error);",
- " }",
- "}",
- ""
- ]
- }
- },
- {
- "listen": "test",
- "script": {
- "type": "text/javascript",
- "exec": [
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);",
- "}",
- "",
- "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));",
- ""
- ]
- }
- }
- ],
- "variable": [
- {
- "key": "baseUrl",
- "value": "https://integ.hyperswitch.io",
- "type": "string"
- },
- {
- "key": "admin_api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "merchant_id",
- "value": ""
- },
- {
- "key": "payment_id",
- "value": ""
- },
- {
- "key": "customer_id",
- "value": ""
- },
- {
- "key": "mandate_id",
- "value": ""
- },
- {
- "key": "payment_method_id",
- "value": ""
- },
- {
- "key": "refund_id",
- "value": ""
- },
- {
- "key": "payout_id",
- "value": "",
- "type": "string"
- },
- {
- "key": "merchant_connector_id",
- "value": ""
- },
- {
- "key": "client_secret",
- "value": "",
- "type": "string"
- },
- {
- "key": "connector_api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "connector_key1",
- "value": ""
- },
- {
- "key": "publishable_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "payment_token",
- "value": "",
- "type": "string"
- },
- {
- "key": "gateway_merchant_id",
- "value": "",
- "type": "string"
- },
- {
- "key": "certificate",
- "value": "",
- "type": "string"
- },
- {
- "key": "certificate_keys",
- "value": "",
- "type": "string"
- },
- {
- "key": "api_key_id",
- "value": ""
- },
- {
- "key": "connector_api_secret",
- "value": "",
- "type": "string"
- },
- {
- "key": "payment_profile_id",
- "value": "",
- "type": "string"
- },
- {
- "key": "payout_profile_id",
- "value": "",
- "type": "string"
- }
- ]
-}
\ No newline at end of file
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ "// Add appropriate profile_id for relevant requests",
+ "const path = pm.request.url.toString();",
+ "const isPostRequest = pm.request.method.toString() === \"POST\";",
+ "const isPaymentCreation = path.match(/\\/payments$/) && isPostRequest;",
+ "const isPayoutCreation = path.match(/\\/payouts\\/create$/) && isPostRequest;",
+ "",
+ "if (isPaymentCreation || isPayoutCreation) {",
+ " try {",
+ " const request = JSON.parse(pm.request.body.toJSON().raw);",
+ "",
+ " // Attach profile_id",
+ " const profile_id = isPaymentCreation",
+ " ? pm.collectionVariables.get(\"payment_profile_id\")",
+ " : pm.collectionVariables.get(\"payout_profile_id\");",
+ " request[\"profile_id\"] = profile_id;",
+ "",
+ " // Attach routing",
+ " const routing = { type: \"single\", data: \"adyen\" };",
+ " request[\"routing\"] = routing;",
+ "",
+ " let updatedRequest = {",
+ " mode: \"raw\",",
+ " raw: JSON.stringify(request),",
+ " options: {",
+ " raw: {",
+ " language: \"json\",",
+ " },",
+ " },",
+ " };",
+ " pm.request.body.update(updatedRequest);",
+ " } catch (error) {",
+ " console.error(\"Failed to inject profile_id in the request\");",
+ " console.error(error);",
+ " }",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);",
+ "}",
+ "",
+ "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "item": [
+ {
+ "name": "Health check",
+ "item": [
+ {
+ "name": "New Request",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "x-feature",
+ "value": "router-custom",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/health",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "health"
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Flow Testcases",
+ "item": [
+ {
+ "name": "QuickStart",
+ "item": [
+ {
+ "name": "Merchant Account - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
+ " console.log(",
+ " \"- use {{merchant_id}} as collection variable for value\",",
+ " jsonData.merchant_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"},{\"country\":\"GB\",\"business\":\"payouts\"}],\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts"
+ ]
+ },
+ "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
+ },
+ "response": []
+ },
+ {
+ "name": "API Key - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set profile_id as variable for jsonData.payment_profile_id",
+ "if (jsonData?.profile_id) {",
+ " pm.collectionVariables.set(\"payment_profile_id\", jsonData.profile_id);",
+ " console.log(",
+ " \"- use {{payment_profile_id}} as collection variable for value\",",
+ " jsonData.profile_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_profile_id}}, as jsonData.profile_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"adyen\",\"connector_account_details\":{\"auth_type\":\"BodyKey\",\"api_key\":\"{{connector_api_key}}\",\"key1\":\"{{connector_key1}}\",\"api_secret\":\"{{connector_api_secret}}\"},\"test_mode\":false,\"disabled\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"AmericanExpress\",\"Discover\",\"Interac\",\"JCB\",\"Mastercard\",\"Visa\",\"DinersClub\",\"UnionPay\",\"RuPay\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"AmericanExpress\",\"Discover\",\"Interac\",\"JCB\",\"Mastercard\",\"Visa\",\"DinersClub\",\"UnionPay\",\"RuPay\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"pay_bright\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"walley\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"paypal\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mobile_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"ali_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"we_chat_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mb_way\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"gift_card\",\"payment_method_types\":[{\"payment_method_type\":\"givex\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"giropay\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"blik\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"trustly\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_czech_republic\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_finland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_poland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_slovakia\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bancontact_card\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"google_pay\":{\"allowed_payment_methods\":[{\"type\":\"CARD\",\"parameters\":{\"allowed_auth_methods\":[\"PAN_ONLY\",\"CRYPTOGRAM_3DS\"],\"allowed_card_networks\":[\"AMEX\",\"DISCOVER\",\"INTERAC\",\"JCB\",\"MASTERCARD\",\"VISA\"]},\"tokenization_specification\":{\"type\":\"PAYMENT_GATEWAY\"}}],\"merchant_info\":{\"merchant_name\":\"Narayan Bhat\"}},\"apple_pay\":{\"session_token_data\":{\"initiative\":\"web\",\"certificate\":\"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUdKakNDQlE2Z0F3SUJBZ0lRRENzRmFrVkNLU01uc2JacTc1YTI0ekFOQmdrcWhraUc5dzBCQVFzRkFEQjEKTVVRd1FnWURWUVFERER0QmNIQnNaU0JYYjNKc1pIZHBaR1VnUkdWMlpXeHZjR1Z5SUZKbGJHRjBhVzl1Y3lCRApaWEowYVdacFkyRjBhVzl1SUVGMWRHaHZjbWwwZVRFTE1Ba0dBMVVFQ3d3Q1J6TXhFekFSQmdOVkJBb01Da0Z3CmNHeGxJRWx1WXk0eEN6QUpCZ05WQkFZVEFsVlRNQjRYRFRJeU1USXdPREE1TVRJeE1Wb1hEVEkxTURFd05qQTUKTVRJeE1Gb3dnYWd4SmpBa0Jnb0praWFKay9Jc1pBRUJEQlp0WlhKamFHRnVkQzVqYjIwdVlXUjVaVzR1YzJGdQpNVHN3T1FZRFZRUUREREpCY0hCc1pTQlFZWGtnVFdWeVkyaGhiblFnU1dSbGJuUnBkSGs2YldWeVkyaGhiblF1ClkyOXRMbUZrZVdWdUxuTmhiakVUTUJFR0ExVUVDd3dLV1UwNVZUY3pXakpLVFRFc01Db0dBMVVFQ2d3alNsVlQKVUVGWklGUkZRMGhPVDB4UFIwbEZVeUJRVWtsV1FWUkZJRXhKVFVsVVJVUXdnZ0VpTUEwR0NTcUdTSWIzRFFFQgpBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRRDhIUy81ZmJZNVJLaElYU3pySEpoeTVrNmY0YUdMaEltYklLaXFYRUlUCnVSQ2RHcGcyMExZM1VhTlBlYXZXTVRIUTBpK3d1RzlZWFVhYzV5eGE0cHg5eHlmQlVIejhzeU9pMjdYNVZaVG8KTlFhd2F6dGM5aGpZc1B2K0s2UW9oaWRTQWZ3cDhMdThkQ0lVZlhQWHBjdjFqVVRyRCtlc1RJTFZUb1FUTmhDcwplQlJtUS9nK05WdTB5c3BqeUYxU2l6VG9BK1BML3NrMlJEYWNaWC9vWTB1R040VWd4c0JYWHdZM0dKbTFSQ3B1CjM0Y2d0UC9kaHNBM1Ixb1VOb0gyQkZBSm9xK3pyUnl3U1RCSEhNMGpEQ2lncVU1RktwL1pBbHdzYmg1WVZOU00KWksrQ0pTK1BPTzlVNGVkeHJmTGlBVkhnQTgzRG43Z2U4K29nV1Y0Z0hUNmhBZ01CQUFHamdnSjhNSUlDZURBTQpCZ05WSFJNQkFmOEVBakFBTUI4R0ExVWRJd1FZTUJhQUZBbit3QldRK2E5a0NwSVN1U1lvWXd5WDdLZXlNSEFHCkNDc0dBUVVGQndFQkJHUXdZakF0QmdnckJnRUZCUWN3QW9ZaGFIUjBjRG92TDJObGNuUnpMbUZ3Y0d4bExtTnYKYlM5M2QyUnlaek11WkdWeU1ERUdDQ3NHQVFVRkJ6QUJoaVZvZEhSd09pOHZiMk56Y0M1aGNIQnNaUzVqYjIwdgpiMk56Y0RBekxYZDNaSEpuTXpBNU1JSUJMUVlEVlIwZ0JJSUJKRENDQVNBd2dnRWNCZ2txaGtpRzkyTmtCUUV3CmdnRU5NSUhSQmdnckJnRUZCUWNDQWpDQnhBeUJ3VkpsYkdsaGJtTmxJRzl1SUhSb2FYTWdRMlZ5ZEdsbWFXTmgKZEdVZ1lua2dZVzU1SUhCaGNuUjVJRzkwYUdWeUlIUm9ZVzRnUVhCd2JHVWdhWE1nY0hKdmFHbGlhWFJsWkM0ZwpVbVZtWlhJZ2RHOGdkR2hsSUdGd2NHeHBZMkZpYkdVZ2MzUmhibVJoY21RZ2RHVnliWE1nWVc1a0lHTnZibVJwCmRHbHZibk1nYjJZZ2RYTmxMQ0JqWlhKMGFXWnBZMkYwWlNCd2IyeHBZM2tnWVc1a0lHTmxjblJwWm1sallYUnAKYjI0Z2NISmhZM1JwWTJVZ2MzUmhkR1Z0Wlc1MGN5NHdOd1lJS3dZQkJRVUhBZ0VXSzJoMGRIQnpPaTh2ZDNkMwpMbUZ3Y0d4bExtTnZiUzlqWlhKMGFXWnBZMkYwWldGMWRHaHZjbWwwZVM4d0V3WURWUjBsQkF3d0NnWUlLd1lCCkJRVUhBd0l3SFFZRFZSME9CQllFRk5RSysxcUNHbDRTQ1p6SzFSUmpnb05nM0hmdk1BNEdBMVVkRHdFQi93UUUKQXdJSGdEQlBCZ2txaGtpRzkyTmtCaUFFUWd4QVFVUkNRemxDTmtGRE5USkVRems0TnpCRk5qYzJNVFpFUkRJdwpPVUkwTWtReE1UVXlSVVpFTURVeFFVRXhRekV6T0ROR00wUkROa1V5TkVNelFqRkVSVEFQQmdrcWhraUc5Mk5rCkJpNEVBZ1VBTUEwR0NTcUdTSWIzRFFFQkN3VUFBNElCQVFBSFR6NTU2RUs5VVp6R0RVd2cvcmFibmYrUXFSYkgKcllVS0ZNcWQwUDhFTHZGMmYrTzN0ZXlDWHNBckF4TmVMY2hRSGVTNUFJOHd2azdMQ0xLUmJCdWJQQy9NVmtBKwpCZ3h5STg2ejJOVUNDWml4QVM1d2JFQWJYOStVMFp2RHp5Y01BbUNrdVVHZjNwWXR5TDNDaEplSGRvOEwwdmdvCnJQWElUSzc4ZjQzenNzYjBTNE5xbTE0eS9LNCs1ZkUzcFUxdEJqME5tUmdKUVJLRnB6MENpV2RPd1BRTk5BYUMKYUNNU2NiYXdwUTBjWEhaZDJWVjNtem4xdUlITEVtaU5GTWVxeEprbjZhUXFFQnNndDUzaUFxcmZMNjEzWStScAppd0tENXVmeU0wYzBweTYyZmkvWEwwS2c4ajEwWU1VdWJpd2dHajAzZThQWTB6bWUvcGZCZ3p6VQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==\",\"display_name\":\"applepay\",\"certificate_keys\":\"LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JSUV2Z0lCQURBTkJna3Foa2lHOXcwQkFRRUZBQVNDQktnd2dnU2tBZ0VBQW9JQkFRRDhIUy81ZmJZNVJLaEkKWFN6ckhKaHk1azZmNGFHTGhJbWJJS2lxWEVJVHVSQ2RHcGcyMExZM1VhTlBlYXZXTVRIUTBpK3d1RzlZWFVhYwo1eXhhNHB4OXh5ZkJVSHo4c3lPaTI3WDVWWlRvTlFhd2F6dGM5aGpZc1B2K0s2UW9oaWRTQWZ3cDhMdThkQ0lVCmZYUFhwY3YxalVUckQrZXNUSUxWVG9RVE5oQ3NlQlJtUS9nK05WdTB5c3BqeUYxU2l6VG9BK1BML3NrMlJEYWMKWlgvb1kwdUdONFVneHNCWFh3WTNHSm0xUkNwdTM0Y2d0UC9kaHNBM1Ixb1VOb0gyQkZBSm9xK3pyUnl3U1RCSApITTBqRENpZ3FVNUZLcC9aQWx3c2JoNVlWTlNNWksrQ0pTK1BPTzlVNGVkeHJmTGlBVkhnQTgzRG43Z2U4K29nCldWNGdIVDZoQWdNQkFBRUNnZ0VBZFNaRzVhTFJxdmpKVFo3bVFYWHZMT3p4dWY5SlpxQTJwUHZmQkJLTXJjZC8KL2RDZXpGSGRhZ1VvWXNUQjRXekluaVVjL2Z3bDJTUzJyREFMZjB2dnRjNTJIYkQ5OHhwMnc3VmVjTGFnMCtuWAo2dUJaSEZCS3FWNU1LZ1l6YUpVMTdqaDM2VEV3dTFnbmdlZnRqVlpBV1NERTFvbDBlSzZ3Mk5kOExjVWdxRkxUCjVHYUlBV01nd0NKL3pzQmwydUV1Y0Q4S21WL1Z2MkVCQVJLWGZtci92UU1NelZrNkhhalprVGZqbWY2cWFVQVMKQWlFblROcHBic2ZrdTk2VGdIa2owWm10VWc0SFkzSU9qWFlpaGJsSjJzQ1JjS3p6cXkxa3B3WlpHcHo1NXEzbgphSXEwenJ3RjlpTUZubEhCa04yK3FjSnhzcDNTalhRdFRLTTY4WHRrVlFLQmdRRC8wemtCVlExR2Q1U0Mzb2czCnM3QWRCZ243dnVMdUZHZFFZY3c0OUppRGw1a1BZRXlKdGQvTVpNOEpFdk1nbVVTeUZmczNZcGtmQ2VGbUp0S3QKMnNNNEdCRWxqTVBQNjI3Q0QrV3c4L3JpWmlOZEg3OUhPRjRneTRGbjBycDNqanlLSWF1OHJISDQwRUUvSkVyOQpxWFQ1SGdWMmJQOGhMcW5sSjFmSDhpY2Zkd0tCZ1FEOFNWQ3ZDV2txQkh2SzE5ZDVTNlArdm5hcXhnTWo0U0srCnJ6L1I1c3pTaW5lS045VEhyeVkxYUZJbVFJZjJYOUdaQXBocUhrckxtQ3BIcURHOWQ3WDVQdUxxQzhmc09kVTYKRzhWaFRXeXdaSVNjdGRSYkk5S2xKUFk2V2ZDQjk0ODNVaDJGbW1xV2JuNWcwZUJxZWZzamVVdEtHekNRaGJDYworR1dBREVRSXB3S0JnUURmaWYvN3pBZm5sVUh1QU9saVV0OEczV29IMGtxVTRydE1IOGpGMCtVWXgzVDFYSjVFCmp1blp2aFN5eHg0dlUvNFU1dVEzQnk3cFVrYmtiZlFWK2x3dlBjaHQyVXlZK0E0MkFKSWlSMjdvT1h1Wk9jNTQKT3liMDNSNWNUR1NuWjJBN0N5VDNubStRak5rV2hXNEpyUE1MWTFJK293dGtRVlF2YW10bnlZNnFEUUtCZ0ZYWgpLT0IzSmxjSzhZa0R5Nm5WeUhkZUhvbGNHaU55YjkxTlN6MUUrWHZIYklnWEdZdmRtUFhoaXRyRGFNQzR1RjBGCjJoRjZQMTlxWnpDOUZqZnY3WGRrSTlrYXF5eENQY0dwUTVBcHhZdDhtUGV1bEJWemFqR1NFMHVsNFVhSWxDNXgKL2VQQnVQVjVvZjJXVFhST0Q5eHhZT0pWd0QvZGprekw1ZFlkMW1UUEFvR0JBTWVwY3diVEphZ3BoZk5zOHY0WAprclNoWXplbVpxY2EwQzRFc2QwNGYwTUxHSlVNS3Zpck4zN0g1OUFjT2IvNWtZcTU5WFRwRmJPWjdmYlpHdDZnCkxnM2hWSHRacElOVGJ5Ni9GOTBUZ09Za3RxUnhNVmc3UFBxbjFqdEFiVU15eVpVZFdHcFNNMmI0bXQ5dGhlUDEKblhMR09NWUtnS2JYbjZXWWN5K2U5eW9ICi0tLS0tRU5EIFBSSVZBVEUgS0VZLS0tLS0KCg==\",\"initiative_context\":\"hyperswitch-sdk-test.netlify.app\",\"merchant_identifier\":\"merchant.com.adyen.san\"},\"payment_request_data\":{\"label\":\"applepay pvt.ltd\",\"supported_networks\":[\"visa\",\"masterCard\",\"amex\",\"discover\"],\"merchant_capabilities\":[\"supports3DS\"]}}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
+ {
+ "name": "Payout Connector - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set profile_id as variable for jsonData.payout_profile_id",
+ "if (jsonData?.profile_id) {",
+ " pm.collectionVariables.set(\"payout_profile_id\", jsonData.profile_id);",
+ " console.log(",
+ " \"- use {{payout_profile_id}} as collection variable for value\",",
+ " jsonData.profile_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_profile_id}}, as jsonData.profile_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"payout_processor\",\"connector_name\":\"adyen\",\"connector_account_details\":{\"auth_type\":\"SignatureKey\",\"api_key\":\"{{connector_api_key}}\",\"key1\":\"{{connector_key1}}\",\"api_secret\":\"{{connector_api_secret}}\"},\"test_mode\":false,\"disabled\":false,\"business_country\":\"GB\",\"business_label\":\"payouts\",\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"pay_bright\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"walley\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"paypal\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mobile_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"ali_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"we_chat_pay\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"mb_way\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"giropay\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"blik\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"trustly\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_czech_republic\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_finland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_poland\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"online_banking_slovakia\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bancontact_card\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}]}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"routing\":{\"type\":\"single\",\"data\":\"adyen\"},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payouts - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payouts/create - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Validate if status is successful",
+ "// if (jsonData?.status) {",
+ "// pm.test(\"[POST]::/payouts/create - Content check if value for 'status' matches 'success'\",",
+ "// function () {",
+ "// pm.expect(jsonData.status).to.eql(\"success\");",
+ "// },",
+ "// );",
+ "// }",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1,\"currency\":\"EUR\",\"customer_id\":\"payout_customer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payout request\",\"connector\":[\"adyen\"],\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"iban\":\"NL46TEST0136169112\",\"bic\":\"ABNANL2A\",\"bank_name\":\"Deutsche Bank\",\"bank_country_code\":\"NL\",\"bank_city\":\"Amsterdam\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"entity_type\":\"Individual\",\"recurring\":true,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payouts - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payouts/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payouts/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payouts/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payouts/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payout_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Happy Cases",
+ "item": [
+ {
+ "name": "Scenario22-Create Gift Card payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1100,\"currency\":\"EUR\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1100,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"gift_card\",\"payment_method_type\":\"givex\",\"payment_method_data\":{\"gift_card\":{\"givex\":{\"number\":\"6364530000000000\",\"cvc\":\"122222\"}}},\"routing\":{\"type\":\"single\",\"data\":\"adyen\"},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario1-Create payment with confirm true",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2-Create payment with confirm false",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario3-Create payment without PMD",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario4-Create payment with Manual capture",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6000);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario5-Void the payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Cancel",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"cancelled\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content check if value for 'status' matches 'cancelled'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"cancelled\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"cancellation_reason\":\"requested_by_customer\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/cancel",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "cancel"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"cancelled\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'cancelled'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"cancelled\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario6-Create 3DS payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4917610000000000\",\"card_exp_month\":\"03\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario7-Create 3DS payment with confrm false",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4917610000000000\",\"card_exp_month\":\"03\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario9-Refund full payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"DUPLICATE\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario10-Create a mandate and recurring payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Recurring Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"payment_method_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario11-Partial refund",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"RETURN\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"1000\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(1000);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":1000,\"reason\":\"FRAUD\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(1000);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"refunds\"",
+ "pm.test(\"[POST]::/payments - Content check if 'refunds' exists\", function () {",
+ " pm.expect(typeof jsonData.refunds !== \"undefined\").to.be.true;",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario12-Bank Redirect-sofort",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"sofort\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'sofort'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"sofort\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"sofort\",\"payment_method_data\":{\"bank_redirect\":{\"sofort\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario13-Bank Redirect-eps",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"eps\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'eps'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"eps\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"eps\",\"payment_method_data\":{\"bank_redirect\":{\"eps\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"AT\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario14-Refund recurring payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Recurring Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"payment_method_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6570,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6570,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create Copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"DUPLICATE\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve Copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario15-Bank Redirect-giropay",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"giropay\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'giropay'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"giropay\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"giropay\",\"payment_method_data\":{\"bank_redirect\":{\"giropay\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario16-Bank debit-ach",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":10000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"off_session\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"ach\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ach'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"ach\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_debit\",\"payment_method_type\":\"ach\",\"payment_method_data\":{\"bank_debit\":{\"ach_bank_debit\":{\"account_number\":\"40308669\",\"routing_number\":\"121000358\",\"sort_code\":\"560036\",\"shopper_email\":\"[email protected]\",\"card_holder_name\":\"joseph Doe\",\"bank_account_holder_name\":\"David Archer\",\"billing_details\":{\"houseNumberOrName\":\"50\",\"street\":\"Test Street\",\"city\":\"Amsterdam\",\"stateOrProvince\":\"NY\",\"postalCode\":\"12010\",\"country\":\"US\",\"name\":\"A. Klaassen\",\"email\":\"[email protected]\"},\"reference\":\"daslvcgbaieh\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario17-Bank debit-Bacs",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":100,\"currency\":\"GBP\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"off_session\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"GB\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"processing\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"bacs\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'bacs'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"bacs\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_debit\",\"payment_method_type\":\"bacs\",\"payment_method_data\":{\"bank_debit\":{\"bacs_bank_debit\":{\"account_number\":\"40308669\",\"routing_number\":\"121000358\",\"sort_code\":\"560036\",\"shopper_email\":\"[email protected]\",\"card_holder_name\":\"joseph Doe\",\"bank_account_holder_name\":\"David Archer\",\"billing_details\":{\"houseNumberOrName\":\"50\",\"street\":\"Test Street\",\"city\":\"Amsterdam\",\"stateOrProvince\":\"NY\",\"postalCode\":\"12010\",\"country\":\"GB\",\"name\":\"A. Klaassen\",\"email\":\"[email protected]\"},\"reference\":\"daslvcgbaieh\"}}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"processing\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario18-Bank Redirect-Trustly",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"FI\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"giropay\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'trustly'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"trustly\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"trustly\",\"payment_method_data\":{\"bank_redirect\":{\"trustly\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"FI\"}}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario19-Add card flow",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "List payment methods for a Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
+ " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":customer_id",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "",
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"7373\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve Copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ "});",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"FRAUD\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'pending'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"pending\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario20-Pass Invalid CVV for save card flow and verify failed payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "List payment methods for a Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
+ " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":customer_id",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"failed\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'failed'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"24\" for \"error_code\"",
+ "if (jsonData?.error_code) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches '24'\",",
+ " function () {",
+ " pm.expect(jsonData.error_code).to.eql(\"24\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"24\" for \"error_message\"",
+ "if (jsonData?.error_message) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'CVC Declined'\",",
+ " function () {",
+ " pm.expect(jsonData.error_message).to.eql(\"CVC Declined\");",
+ " },",
+ " );",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"737\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ "});",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "List payment methods for a Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
+ " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":customer_id",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"failed\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'failed'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'adyen'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"24\" for \"error_code\"",
+ "if (jsonData?.error_code) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches '24'\",",
+ " function () {",
+ " pm.expect(jsonData.error_code).to.eql(\"24\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"24\" for \"error_message\"",
+ "if (jsonData?.error_message) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'CVC Declined'\",",
+ " function () {",
+ " pm.expect(jsonData.error_message).to.eql(\"CVC Declined\");",
+ " },",
+ " );",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"adyen\");",
+ "});",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "name": "Variation Cases",
+ "item": [
+ {
+ "name": "Scenario10-Create Gift Card payment where it fails due to insufficient balance",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"failed\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'failed'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have error message as \"Insufficient balance in the payment method\"",
+ "if (jsonData?.error_message) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error_message' matches 'Insufficient balance in the payment method'\",",
+ " function () {",
+ " pm.expect(jsonData.error_message).to.eql(\"Insufficient balance in the payment method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":14100,\"currency\":\"EUR\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":14100,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"gift_card\",\"payment_method_type\":\"givex\",\"payment_method_data\":{\"gift_card\":{\"givex\":{\"number\":\"6364530000000000\",\"cvc\":\"122222\"}}},\"routing\":{\"type\":\"single\",\"data\":\"adyen\"},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Failed\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario1-Create payment with Invalid card details",
+ "item": [
+ {
+ "name": "Payments - Create(Invalid card number)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'connector_error'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"connector_error\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"123456\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"united states\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"united states\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create(Invalid Exp month)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"01\",\"card_exp_year\":\"2023\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create(Invalid Exp Year)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.message) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.message' matches 'Invalid Expiry Year'\",",
+ " function () {",
+ " pm.expect(jsonData.error.message).to.eql(\"Invalid Expiry Year\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"10\",\"card_exp_year\":\"2022\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create(invalid CVV)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.message) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.message' matches 'Invalid card_cvc length'\",",
+ " function () {",
+ " pm.expect(jsonData.error.message).to.eql(\"Invalid card_cvc length\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"12345\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2-Confirming the payment without PMD",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario3-Capture greater amount",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario4-Capture the succeeded payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario5-Void the success_slash_failure payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Cancel",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments/:id/cancel - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"cancellation_reason\":\"requested_by_customer\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/cancel",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "cancel"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario6-Create 3DS payment with greater capture",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":7540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario7-Refund exceeds amount",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.message) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.message' matches 'The refund amount exceeds the amount captured'\",",
+ " function () {",
+ " pm.expect(jsonData.error.message).to.eql(",
+ " \"The refund amount exceeds the amount captured\",",
+ " );",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":7000,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario8-Refund for unsuccessful payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.message) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.message' matches 'This Payment could not be refund because it has a status of requires_confirmation. The expected state is succeeded, partially_captured'\",",
+ " function () {",
+ " pm.expect(jsonData.error.message).to.eql(",
+ " \"This Payment could not be refund because it has a status of requires_confirmation. The expected state is succeeded, partially_captured\",",
+ " );",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario9-Create a recurring payment with greater mandate amount",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Recurring Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.message) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.message' matches 'Mandate Validation Failed'\",",
+ " function () {",
+ " pm.expect(jsonData.error.message).to.eql(\"Mandate Validation Failed\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":8040,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":8040,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario10-Create payouts using unsupported methods",
+ "item": [
+ {
+ "name": "ACH Payouts - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 4xx\", function () {",
+ " pm.response.to.be.clientError;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":10000,\"currency\":\"USD\",\"customer_id\":\"payout_customer\",\"email\":\"[email protected]\",\"name\":\"Doest John\",\"phone\":\"6168205366\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payout request\",\"connector\":[\"adyen\"],\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"bank_routing_number\":\"110000000\",\"bank_account_number\":\"000123456789\",\"bank_name\":\"Stripe Test Bank\",\"bank_country_code\":\"US\",\"bank_city\":\"California\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"Doest\",\"last_name\":\"John\"},\"phone\":{\"number\":\"6168205366\",\"country_code\":\"1\"}},\"entity_type\":\"Individual\",\"recurring\":false,\"metadata\":{\"ref\":\"123\",\"vendor_details\":{\"account_type\":\"custom\",\"business_type\":\"individual\",\"business_profile_mcc\":5045,\"business_profile_url\":\"https://www.pastebin.com\",\"business_profile_name\":\"pT\",\"company_address_line1\":\"address_full_match\",\"company_address_line2\":\"Kimberly Way\",\"company_address_postal_code\":\"31062\",\"company_address_city\":\"Milledgeville\",\"company_address_state\":\"GA\",\"company_phone\":\"+16168205366\",\"company_tax_id\":\"000000000\",\"company_owners_provided\":false,\"capabilities_card_payments\":true,\"capabilities_transfers\":true},\"individual_details\":{\"tos_acceptance_date\":1680581051,\"tos_acceptance_ip\":\"103.159.11.202\",\"individual_dob_day\":\"01\",\"individual_dob_month\":\"01\",\"individual_dob_year\":\"1901\",\"individual_id_number\":\"000000000\",\"individual_ssn_last_4\":\"0000\",\"external_account_account_holder_type\":\"individual\"}},\"confirm\":true,\"auto_fulfill\":true}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Bacs Payouts - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payouts/create - Status code is 4xx\", function () {",
+ " pm.response.to.be.clientError;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payouts/create - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payouts/create - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payout_id as variable for jsonData.payout_id",
+ "if (jsonData?.payout_id) {",
+ " pm.collectionVariables.set(\"payout_id\", jsonData.payout_id);",
+ " console.log(",
+ " \"- use {{payout_id}} as collection variable for value\",",
+ " jsonData.payout_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payout_id}}, as jsonData.payout_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1,\"currency\":\"GBP\",\"customer_id\":\"payout_customer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payout request\",\"payout_type\":\"bank\",\"payout_method_data\":{\"bank\":{\"bank_sort_code\":\"231470\",\"bank_account_number\":\"28821822\",\"bank_name\":\"Deutsche Bank\",\"bank_country_code\":\"NL\",\"bank_city\":\"Amsterdam\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"CA\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"entity_type\":\"Individual\",\"recurring\":true,\"metadata\":{\"ref\":\"123\"},\"confirm\":true,\"auto_fulfill\":true,\"connector\":[\"adyen\"],\"business_label\":\"abcd\",\"business_country\":\"US\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payouts/create",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payouts",
+ "create"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "info": {
+ "_postman_id": "de5a144d-d247-4751-a8f3-ecfa9832641c",
+ "name": "adyen_uk",
+ "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [[email protected]](mailto:[email protected])",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+ },
+ "variable": [
+ {
+ "key": "baseUrl",
+ "value": "https://integ.hyperswitch.io",
+ "type": "string"
+ },
+ {
+ "key": "admin_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "merchant_id",
+ "value": ""
+ },
+ {
+ "key": "payment_id",
+ "value": ""
+ },
+ {
+ "key": "customer_id",
+ "value": ""
+ },
+ {
+ "key": "mandate_id",
+ "value": ""
+ },
+ {
+ "key": "payment_method_id",
+ "value": ""
+ },
+ {
+ "key": "refund_id",
+ "value": ""
+ },
+ {
+ "key": "payout_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "merchant_connector_id",
+ "value": ""
+ },
+ {
+ "key": "client_secret",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_key1",
+ "value": ""
+ },
+ {
+ "key": "publishable_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "payment_token",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "gateway_merchant_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate_keys",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key_id",
+ "value": ""
+ },
+ {
+ "key": "connector_api_secret",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "payment_profile_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "payout_profile_id",
+ "value": "",
+ "type": "string"
+ }
+ ]
+}
diff --git a/postman/collection-json/stripe.postman_collection.json b/postman/collection-json/stripe.postman_collection.json
index 8a68413cc03..e158ccd1a5e 100644
--- a/postman/collection-json/stripe.postman_collection.json
+++ b/postman/collection-json/stripe.postman_collection.json
@@ -1,24566 +1,24072 @@
{
- "info": {
- "_postman_id": "680eadff-6c51-4656-956f-1439b3b9d469",
- "name": "Stripe Postman Collection",
- "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [[email protected]](mailto:[email protected])",
- "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
- "_exporter_id": "27028646"
- },
- "item": [
- {
- "name": "Health check",
- "item": [
- {
- "name": "New Request",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "x-feature",
- "value": "router-custom",
- "type": "text",
- "disabled": true
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/health",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "health"
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "MerchantAccounts",
- "item": [
- {
- "name": "Merchant Account - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) { }",
- "",
- "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
- "if (jsonData?.merchant_id) {",
- " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
- " console.log(",
- " \"- use {{merchant_id}} as collection variable for value\",",
- " jsonData.merchant_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
- "if (jsonData?.merchant_id) {",
- " pm.collectionVariables.set(\"organization_id\", jsonData.organization_id);",
- " console.log(",
- " \"- use {{organization_id}} as collection variable for value\",",
- " jsonData.organization_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{organization_id}}, as jsonData.organization_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/accounts - Organization id is generated\",",
- " function () {",
- " pm.expect(typeof jsonData.organization_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com/success\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"},\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}]}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/accounts",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts"
- ]
- },
- "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
- },
- "response": []
- },
- {
- "name": "Merchant Account - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/accounts/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/accounts/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/accounts/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Retrieve a merchant account details."
- },
- "response": []
- },
- {
- "name": "Merchant Account - List",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/accounts/list - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/accounts/list - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) { }",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/accounts/list?organization_id={{organization_id}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts",
- "list"
- ],
- "query": [
- {
- "key": "organization_id",
- "value": "{{organization_id}}"
- }
- ],
- "variable": [
- {
- "key": "organization_id",
- "value": "{{organization_id}}",
- "description": "(Required) - Organization id"
- }
- ]
- },
- "description": "List merchant accounts for an organization"
- },
- "response": []
- },
- {
- "name": "Merchant Account - Update",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/accounts/:id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"merchant_id\":\"{{merchant_id}}\",\"merchant_name\":\"NewAge Retailer\",\"locker_id\":\"m0010\",\"merchant_details\":{\"primary_contact_person\":\"joseph Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"veniam aute officia ullamco esse\",\"secondary_contact_person\":\"joseph Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"proident adipisicing officia nulla\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"parent_merchant_id\":\"xkkdf909012sdjki2dkh5sdf\",\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/accounts/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "To update an existing merchant account. Helpful in updating merchant details such as email, contact deteails, or other configuration details like webhook, routing algorithm etc"
- },
- "response": []
- }
- ]
- },
- {
- "name": "API Key",
- "item": [
- {
- "name": "Create API Key",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
- },
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Update API Key",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id/:api_key_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id/:api_key_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"name\":null,\"description\":\"My very awesome API key\",\"expiration\":null}"
- },
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id/:api_key_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id",
- ":api_key_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "api_key_id",
- "value": "{{api_key_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Retrieve API Key",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[GET]::/api_keys/:merchant_id/:api_key_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/api_keys/:merchant_id/:api_key_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id/:api_key_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id",
- ":api_key_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "api_key_id",
- "value": "{{api_key_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "List API Keys",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/api_keys/:merchant_id/list - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/api_keys/:merchant_id/list - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id/list",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id",
- "list"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Delete API Key",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[DELETE]::/api_keys/:merchant_id/:api-key - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[DELETE]::/api_keys/:merchant_id/:api-key - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "DELETE",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id/:api-key",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id",
- ":api-key"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "api-key",
- "value": "{{api_key_id}}"
- }
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "PaymentConnectors",
- "item": [
- {
- "name": "Payment Connector - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/accounts/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/accounts/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) { }",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- "",
- "// Validate if the connector label is the one that is passed in the request",
- "pm.test(",
- " \"[POST]::/accounts/:account_id/connectors - connector_label is not autogenerated\",",
- " function () {",
- " pm.expect(jsonData.connector_label).to.eql(\"first_stripe_connector\")",
- " },",
- ");"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"stripe\",\"business_country\":\"US\",\"business_label\":\"default\",\"connector_label\":\"first_stripe_connector\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
- },
- "response": []
- },
- {
- "name": "Payment Connector - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[GET]::/accounts/:account_id/connectors/:connector_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/accounts/:account_id/connectors/:connector_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors",
- ":connector_id"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- },
- {
- "key": "connector_id",
- "value": "{{merchant_connector_id}}",
- "description": "(Required) The unique identifier for the payment connector"
- }
- ]
- },
- "description": "Retrieve Payment Connector details."
- },
- "response": []
- },
- {
- "name": "Payment Connector - Update",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) { }",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- "",
- "// Validate if the connector label is the one that is passed in the request",
- "pm.test(",
- " \"[POST]::/accounts/:account_id/connectors - connector_label is not autogenerated\",",
- " function () {",
- " pm.expect(jsonData.connector_label).to.eql(\"updated_stripe_connector\")",
- " },",
- ");"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"connector_type\":\"fiz_operations\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}\"},\"connector_label\":\"updated_stripe_connector\",\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors",
- ":connector_id"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "connector_id",
- "value": "{{merchant_connector_id}}"
- }
- ]
- },
- "description": "To update an existing Payment Connector. Helpful in enabling / disabling different payment methods and other settings for the connector etc"
- },
- "response": []
- },
- {
- "name": "List Connectors by MID",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[GET]::/account/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/account/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Payment Connector - Delete",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[DELETE]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[DELETE]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "DELETE",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors",
- ":connector_id"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "connector_id",
- "value": "{{merchant_connector_id}}"
- }
- ]
- },
- "description": "Delete or Detach a Payment Connector from Merchant Account"
- },
- "response": []
- },
- {
- "name": "Merchant Account - Delete",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[DELETE]::/accounts/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[DELETE]::/accounts/:id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Response Validation",
- "const schema = {",
- " type: \"object\",",
- " description: \"Merchant Account\",",
- " required: [\"merchant_id\", \"deleted\"],",
- " properties: {",
- " merchant_id: {",
- " type: \"string\",",
- " description: \"The identifier for the MerchantAccount object.\",",
- " maxLength: 255,",
- " example: \"y3oqhf46pyzuxjbcn2giaqnb44\",",
- " },",
- " deleted: {",
- " type: \"boolean\",",
- " description:",
- " \"Indicates the deletion status of the Merchant Account object.\",",
- " example: true,",
- " },",
- " },",
- "};",
- "",
- "// Validate if response matches JSON schema",
- "pm.test(\"[DELETE]::/accounts/:id - Schema is valid\", function () {",
- " pm.response.to.have.jsonSchema(schema, {",
- " unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"],",
- " });",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "DELETE",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/accounts/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Delete a Merchant Account"
- },
- "response": []
- }
- ]
- },
- {
- "name": "QuickStart",
- "item": [
- {
- "name": "Merchant Account - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
- "if (jsonData?.merchant_id) {",
- " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
- " console.log(",
- " \"- use {{merchant_id}} as collection variable for value\",",
- " jsonData.merchant_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
- " );",
- "}",
- "",
- "/*",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(\"- use {{api_key}} as collection variable for value\",jsonData.api_key);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.');",
- "};",
- "*/",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com/success\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"},\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}]}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/accounts",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts"
- ]
- },
- "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
- },
- "response": []
- },
- {
- "name": "API Key - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
- },
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Payment Connector - Create",
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"stripe\",\"business_country\":\"US\",\"business_label\":\"default\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}_invalid_values\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"affirm\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"afterpay_clearpay\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"invoke_sdk_client\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"ideal\",\"payment_experience\":\"redirect_to_url\",\"card_networks\":null,\"accepted_currencies\":{\"type\":\"enable_only\",\"list\":[\"EUR\"]},\"accepted_countries\":{\"type\":\"enable_only\",\"list\":[\"NL\"]},\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"giropay\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"becs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_transfer\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"debit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"google_pay\":{\"allowed_payment_methods\":[{\"type\":\"CARD\",\"parameters\":{\"allowed_auth_methods\":[\"PAN_ONLY\",\"CRYPTOGRAM_3DS\"],\"allowed_card_networks\":[\"AMEX\",\"DISCOVER\",\"INTERAC\",\"JCB\",\"MASTERCARD\",\"VISA\"]},\"tokenization_specification\":{\"type\":\"PAYMENT_GATEWAY\",\"parameters\":{\"gateway\":\"example\",\"gateway_merchant_id\":\"{{gateway_merchant_id}}\"}}}],\"merchant_info\":{\"merchant_name\":\"Narayan Bhat\"}}\n,\"apple_pay\":{\"session_token_data\":{\"initiative\":\"web\",\"certificate\":\"{{certificate}}\",\"display_name\":\"applepay\",\"certificate_keys\":\"{{certificate_keys}}\",\"initiative_context\":\"hyperswitch-sdk-test.netlify.app\",\"merchant_identifier\":\"merchant.com.stripe.sang\"},\"payment_request_data\":{\"label\":\"applepay pvt.ltd\",\"supported_networks\":[\"visa\",\"masterCard\",\"amex\",\"discover\"],\"merchant_capabilities\":[\"supports3DS\"]}}\n}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
- },
- "response": []
- },
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"failed\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have an error message",
- "if (jsonData?.error_message) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error_message' is not 'null'\",",
- " function () {",
- " pm.expect(jsonData.error_message).is.not.null;",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payment Connector - Update",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"connector_type\":\"fiz_operations\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"affirm\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"afterpay_clearpay\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"invoke_sdk_client\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"ideal\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"giropay\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"becs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_transfer\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"debit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"google_pay\":{\"allowed_payment_methods\":[{\"type\":\"CARD\",\"parameters\":{\"allowed_auth_methods\":[\"PAN_ONLY\",\"CRYPTOGRAM_3DS\"],\"allowed_card_networks\":[\"AMEX\",\"DISCOVER\",\"INTERAC\",\"JCB\",\"MASTERCARD\",\"VISA\"]},\"tokenization_specification\":{\"type\":\"PAYMENT_GATEWAY\",\"parameters\":{\"gateway\":\"example\",\"gateway_merchant_id\":\"{{gateway_merchant_id}}\"}}}],\"merchant_info\":{\"merchant_name\":\"Narayan Bhat\"}},\"apple_pay\":{\"session_token_data\":{\"initiative\":\"web\",\"certificate\":\"{{certificate}}\",\"display_name\":\"applepay\",\"certificate_keys\":\"{{certificate_keys}}\",\"initiative_context\":\"hyperswitch-sdk-test.netlify.app\",\"merchant_identifier\":\"merchant.com.stripe.sang\"},\"payment_request_data\":{\"label\":\"applepay pvt.ltd\",\"supported_networks\":[\"visa\",\"masterCard\",\"amex\",\"discover\"],\"merchant_capabilities\":[\"supports3DS\"]}}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors",
- ":connector_id"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "connector_id",
- "value": "{{merchant_connector_id}}"
- }
- ]
- },
- "description": "To update an existing Payment Connector. Helpful in enabling / disabling different payment methods and other settings for the connector etc"
- },
- "response": []
- },
- {
- "name": "Payments - Create-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "",
- "// Response body should have \"profile_id\" and not \"null\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'profile_id' exists and is not 'null'\",",
- " function () {",
- " pm.expect(typeof jsonData.profile_id !== \"undefined\").to.be.true;",
- " pm.expect(jsonData.profile_id).is.not.null;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Customers",
- "item": [
- {
- "name": "Create Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/customers - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/customers - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/customers - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// Response body should have \"customer_id\"",
- "pm.test(",
- " \"[POST]::/customers - Content check if 'customer_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.customer_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have a minimum length of \"1\" for \"customer_id\"",
- "if (jsonData?.customer_id) {",
- " pm.test(",
- " \"[POST]::/customers - Content check if value of 'customer_id' has a minimum length of '1'\",",
- " function () {",
- " pm.expect(jsonData.customer_id.length).is.at.least(1);",
- " },",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set customer_id as variable for jsonData.customer_id",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(",
- " \"- use {{customer_id}} as collection variable for value\",",
- " jsonData.customer_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"First customer\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/customers",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers"
- ]
- },
- "description": "Create a customer object and store the customer details to be reused for future payments. Incase the customer already exists in the system, this API will respond with the customer details."
- },
- "response": []
- },
- {
- "name": "List Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/customers - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/customers - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/customers - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "",
- "// Response body should have a minimum length of \"1\" for \"customer_id\"",
- "if (jsonData?.customer_id) {",
- " pm.test(",
- " \"[POST]::/customers - Content check if value of 'customer_id' has a minimum length of '2'\",",
- " function () {",
- " pm.expect(jsonData.customer_id.length).is.at.least(2);",
- " },",
- " );",
- "}",
- "",
- "",
- "// Define the regular expression pattern to match customer_id",
- "var customerIdPattern = /^[a-zA-Z0-9_]+$/;",
- "",
- "// Define an array to store the validation results",
- "var validationResults = [];",
- "",
- "// Iterate through the JSON array",
- "jsonData.forEach(function(item, index) {",
- " if (item.hasOwnProperty(\"customer_id\")) {",
- " if (customerIdPattern.test(item.customer_id)) {",
- " validationResults.push(\"customer_id \" + item.customer_id + \" is valid.\");",
- " } else {",
- " validationResults.push(\"customer_id \" + item.customer_id + \" is not valid.\");",
- " }",
- " } else {",
- " validationResults.push(\"customer_id is missing for item at index \" + index);",
- " }",
- "});",
- "",
- "// Check if any customer_id is not valid and fail the test if necessary",
- "if (validationResults.some(result => !result.includes(\"is valid\"))) {",
- " pm.test(\"Customer IDs validation failed: \" + validationResults.join(\", \"), function() {",
- " pm.expect(false).to.be.true;",
- " });",
- "} else {",
- " pm.test(\"All customer IDs are valid: \" + validationResults.join(\", \"), function() {",
- " pm.expect(true).to.be.true;",
- " });",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/list",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- "list"
- ]
- }
- },
- "response": []
- },
- {
- "name": "Retrieve Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/customers/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/customers/:id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/customers/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{customer_id}}",
- "description": "(Required) unique customer id"
- }
- ]
- },
- "description": "Retrieve a customer's details."
- },
- "response": []
- },
- {
- "name": "Update Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/customers/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/customers/:id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/customers/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"email\":\"[email protected]\",\"name\":\"John Test\",\"phone_country_code\":\"+65\",\"phone\":\"888888888\",\"description\":\"First customer\",\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/customers/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{customer_id}}",
- "description": "(Required) unique customer id"
- }
- ]
- },
- "description": "Updates the customer's details in a customer object."
- },
- "response": []
- },
- {
- "name": "Ephemeral Key",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/ephemeral_keys - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/ephemeral_keys - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"customer_id\":\"{{customer_id}}\"}"
- },
- "url": {
- "raw": "{{baseUrl}}/ephemeral_keys",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "ephemeral_keys"
- ]
- }
- },
- "response": []
- },
- {
- "name": "Delete Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[DELETE]::/customers/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[DELETE]::/customers/:id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[DELETE]::/customers/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "DELETE",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{customer_id}}",
- "description": "(Required) unique customer id"
- }
- ]
- },
- "description": "Delete a customer record."
- },
- "response": []
- }
- ],
- "description": "Create a Customer entity which you can use to store and retrieve specific customers' data and payment methods."
- },
- {
- "name": "Payments",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Session Token",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/session_tokens - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/session_tokens - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "const responseJson = pm.response.json();",
- "",
- "// Verify if the wallet_name in the response matches 'apple_pay'",
- "pm.test(",
- " \"[POST]::/payments/session_tokens - Verify wallet_name is 'apple_pay'\",",
- " function () {",
- " pm.expect(responseJson.session_token[0].wallet_name).to.eql(\"apple_pay\");",
- " },",
- ");",
- "",
- "// Verify if the wallet_name in the response matches 'google_pay'",
- "pm.test(",
- " \"[POST]::/payments/session_tokens - Verify wallet_name is 'google_pay'\",",
- " function () {",
- " pm.expect(responseJson.session_token[1].wallet_name).to.eql(\"google_pay\");",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"wallets\":[],\"client_secret\":\"{{client_secret}}\"}"
- },
- "url": {
- "raw": "{{baseUrl}}/payments/session_tokens",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- "session_tokens"
- ]
- }
- },
- "response": []
- },
- {
- "name": "Payments - Update",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":20000,\"currency\":\"SGD\",\"confirm\":false,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"email\":\"[email protected]\",\"name\":\"joseph Doe\",\"phone\":\"8888888888\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"payment_method\":\"card\",\"return_url\":\"https://duck.com\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To update the properties of a PaymentIntent object. This may include attaching a payment method, or attaching customer object or metadata fields after the Payment is created "
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm (Through Client Secret)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":6540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- },
- {
- "name": "Payments - Create Again",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm Again (Through API Key)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Create Yet Again",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Cancel",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"cancellation_reason\":\"requested_by_customer\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/cancel",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "cancel"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
- },
- "response": []
- },
- {
- "name": "Payment-List",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/list - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/payments/list - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "api-key",
- "value": "snd_0b8e1deb82f241eca47617afb1398858"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/list",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- "list"
- ],
- "query": [
- {
- "key": "customer_id",
- "value": "",
- "disabled": true
- },
- {
- "key": "starting_after",
- "value": "",
- "disabled": true
- },
- {
- "key": "ending_before",
- "value": "",
- "disabled": true
- },
- {
- "key": "limit",
- "value": "100",
- "disabled": true
- },
- {
- "key": "created",
- "value": "",
- "disabled": true
- },
- {
- "key": "created.lt",
- "value": "",
- "disabled": true
- },
- {
- "key": "created.gt",
- "value": "",
- "disabled": true
- },
- {
- "key": "created.lte",
- "value": "",
- "disabled": true
- },
- {
- "key": "created_gte",
- "value": "",
- "disabled": true
- }
- ]
- }
- },
- "response": []
- }
- ],
- "description": "Process and manage payments across wide range of payment processors using the Unified Payments API."
- },
- {
- "name": "Refunds",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Update",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"reason\":\"Paid by mistake\",\"metadata\":{\"udf1\":\"value2\",\"new_customer\":\"false\",\"login_date\":\"2019-09-1T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To update the properties of a Refund object. This may include attaching a reason for the refund or metadata fields"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "PaymentMethods",
- "item": [
- {
- "name": "P_Create Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/customers - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/customers - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/customers - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// Response body should have \"customer_id\"",
- "pm.test(",
- " \"[POST]::/customers - Content check if 'customer_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.customer_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have a minimum length of \"1\" for \"customer_id\"",
- "if (jsonData?.customer_id) {",
- " pm.test(",
- " \"[POST]::/customers - Content check if value of 'customer_id' has a minimum length of '1'\",",
- " function () {",
- " pm.expect(jsonData.customer_id.length).is.at.least(1);",
- " },",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set customer_id as variable for jsonData.customer_id",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(",
- " \"- use {{customer_id}} as collection variable for value\",",
- " jsonData.customer_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"First customer\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/customers",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers"
- ]
- },
- "description": "Create a customer object and store the customer details to be reused for future payments. Incase the customer already exists in the system, this API will respond with the customer details."
- },
- "response": []
- },
- {
- "name": "PaymentMethods - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payment_methods - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payment_methods - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_method_id as variable for jsonData.payment_method_id",
- "if (jsonData?.payment_method_id) {",
- " pm.collectionVariables.set(\"payment_method_id\", jsonData.payment_method_id);",
- " console.log(",
- " \"- use {{payment_method_id}} as collection variable for value\",",
- " jsonData.payment_method_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_method_id}}, as jsonData.payment_method_id is undefined.\",",
- " );",
- "}",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(",
- " \"- use {{customer_id}} as collection variable for value\",",
- " jsonData.customer_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_issuer\":\"Visa\",\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"John Doe\"},\"customer_id\":\"{{customer_id}}\",\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payment_methods"
- ]
- },
- "description": "To create a payment method against a customer object. In case of cards, this API could be used only by PCI compliant merchants"
- },
- "response": []
- },
- {
- "name": "List payment methods for a Merchant",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[GET]::/payment_methods/:merchant_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/payment_methods/:merchant_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- "payment_methods"
- ],
- "query": [
- {
- "key": "client_secret",
- "value": "{{client_secret}}"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular merchant id."
- },
- "response": []
- },
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(",
- " \"- use {{customer_id}} as collection variable for value\",",
- " jsonData.customer_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for a Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[GET]::/payment_methods/:customer_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/payment_methods/:customer_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(",
- " \"payment_token\",",
- " jsonData.customer_payment_methods[0].payment_token,",
- " );",
- " console.log(",
- " \"- use {{payment_token}} as collection variable for value\",",
- " jsonData.customer_payment_methods[0].payment_token,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":customer_id",
- "payment_methods"
- ],
- "query": [
- {
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
- {
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Flow Testcases",
- "item": [
- {
- "name": "QuickStart",
- "item": [
- {
- "name": "Merchant Account - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
- "if (jsonData?.merchant_id) {",
- " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
- " console.log(",
- " \"- use {{merchant_id}} as collection variable for value\",",
- " jsonData.merchant_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"},\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}]}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/accounts",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts"
- ]
- },
- "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
- },
- "response": []
- },
- {
- "name": "API Key - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
- },
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Payment Connector - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"stripe\",\"business_country\":\"US\",\"business_label\":\"default\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"affirm\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"afterpay_clearpay\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"invoke_sdk_client\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"ideal\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"giropay\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"becs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_transfer\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"card_networks\":[\"AmericanExpress\",\"Discover\",\"Interac\",\"JCB\",\"Mastercard\",\"Visa\",\"DinersClub\",\"UnionPay\",\"RuPay\"]}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"debit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"card_networks\":[\"AmericanExpress\",\"Discover\",\"Interac\",\"JCB\",\"Mastercard\",\"Visa\",\"DinersClub\",\"UnionPay\",\"RuPay\"]}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"we_chat_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"google_pay\":{\"allowed_payment_methods\":[{\"type\":\"CARD\",\"parameters\":{\"allowed_auth_methods\":[\"PAN_ONLY\",\"CRYPTOGRAM_3DS\"],\"allowed_card_networks\":[\"AMEX\",\"DISCOVER\",\"INTERAC\",\"JCB\",\"MASTERCARD\",\"VISA\"]},\"tokenization_specification\":{\"type\":\"PAYMENT_GATEWAY\",\"parameters\":{\"gateway\":\"example\",\"gateway_merchant_id\":\"{{gateway_merchant_id}}\"}}}],\"merchant_info\":{\"merchant_name\":\"Narayan Bhat\"}},\"apple_pay\":{\"session_token_data\":{\"initiative\":\"web\",\"certificate\":\"{{certificate}}\",\"display_name\":\"applepay\",\"certificate_keys\":\"{{certificate_keys}}\",\"initiative_context\":\"hyperswitch-sdk-test.netlify.app\",\"merchant_identifier\":\"merchant.com.stripe.sang\"},\"payment_request_data\":{\"label\":\"applepay pvt.ltd\",\"supported_networks\":[\"visa\",\"masterCard\",\"amex\",\"discover\"],\"merchant_capabilities\":[\"supports3DS\"]}}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
- },
- "response": []
- },
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Happy Cases",
- "item": [
- {
- "name": "Scenario1-Create payment with confirm true",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2-Create payment with confirm false",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"Joseph Doe\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2a-Create payment with confirm false card holder name null",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":null,\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2b-Create payment with confirm false card holder name empty",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}"
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario3-Create payment without PMD",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario4-Create payment with Manual capture",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":6540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario4a-Create payment with manual_multiple capture",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'partially_captured'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"partially_captured\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6000);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'partially_captured'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"partially_captured\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario5-Void the payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Cancel",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"cancelled\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/cancel - Content check if value for 'status' matches 'cancelled'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"cancelled\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"cancellation_reason\":\"requested_by_customer\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/cancel",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "cancel"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"cancelled\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'cancelled'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"cancelled\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario6-Create 3DS payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"business_country\":\"US\",\"business_label\":\"default\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4000000000003063\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario7-Create 3DS payment with confrm false",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4000000000003063\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario8-Create a failure card payment with confirm true",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"card_declined\" for \"error_code\"",
- "if (jsonData?.error_code) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches 'card_declined'\",",
- " function () {",
- " pm.expect(jsonData.error_code).to.eql(\"card_declined\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"message - Your card has insufficient funds., decline_code - insufficient_funds\" for \"error_message\"",
- "if (jsonData?.error_message) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'message - Your card has insufficient funds., decline_code - insufficient_funds'\",",
- " function () {",
- " pm.expect(jsonData.error_message).to.eql(\"message - Your card has insufficient funds., decline_code - insufficient_funds\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4000000000009995\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"failed\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"card_declined\" for \"error_code\"",
- "if (jsonData?.error_code) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches 'card_declined'\",",
- " function () {",
- " pm.expect(jsonData.error_code).to.eql(\"card_declined\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"message - Your card has insufficient funds., decline_code - insufficient_funds\" for \"error_message\"",
- "if (jsonData?.error_message) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'message - Your card has insufficient funds., decline_code - insufficient_funds'\",",
- " function () {",
- " pm.expect(jsonData.error_message).to.eql(\"message - Your card has insufficient funds., decline_code - insufficient_funds\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario9-Refund full payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario9a-Partial refund",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"1000\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(1000);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":1000,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(1000);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"refunds\"",
- "pm.test(\"[POST]::/payments - Content check if 'refunds' exists\", function () {",
- " pm.expect(typeof jsonData.refunds !== \"undefined\").to.be.true;",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario10-Create a mandate and recurring payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Recurring Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"payment_method_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario11-Refund recurring payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Recurring Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"payment_method_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6570,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6570,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create Copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve Copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario12-BNPL-klarna",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":8000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":8000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"klarna\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'klarna'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"klarna\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"pay_later\",\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"payment_method_data\":{\"pay_later\":{\"klarna_redirect\":{\"issuer_name\":\"stripe\",\"billing_email\":\"[email protected]\",\"billing_country\":\"US\"}}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario13-BNPL-afterpay",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":7000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"country\":\"SE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"SE\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"order_details\":{\"product_name\":\"Socks\",\"amount\":7000,\"quantity\":1}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"afterpay_clearpay\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'afterpay_clearpay'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"afterpay_clearpay\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"pay_later\",\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"payment_method_data\":{\"pay_later\":{\"afterpay_clearpay_redirect\":{\"billing_name\":\"Akshaya\",\"billing_email\":\"[email protected]\"}}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario14-BNPL-affirm",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":7000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"country\":\"US\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"order_details\":{\"product_name\":\"Socks\",\"amount\":7000,\"quantity\":1}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"affirm\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'affirm'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"affirm\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"pay_later\",\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"payment_method_data\":{\"pay_later\":{\"affirm_redirect\":{\"issuer_name\":\"affirm\",\"billing_email\":\"[email protected]\",\"billing_country\":\"US\"}}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario15-Bank Redirect-Ideal",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"ideal\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ideal'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"ideal\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"ideal\",\"payment_method_data\":{\"bank_redirect\":{\"ideal\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario16-Bank Redirect-sofort",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"sofort\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'sofort'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"sofort\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"sofort\",\"payment_method_data\":{\"bank_redirect\":{\"sofort\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"hypo_noe_lb_fur_niederosterreich_u_wien\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario17-Bank Redirect-eps",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"eps\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'eps'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"eps\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"eps\",\"payment_method_data\":{\"bank_redirect\":{\"eps\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"hypo_oberosterreich_salzburg_steiermark\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario18-Bank Redirect-giropay",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"giropay\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'giropay'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"giropay\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"giropay\",\"payment_method_data\":{\"bank_redirect\":{\"giropay\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario19-Bank Transfer-ach",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":800,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":800,\"customer_id\":\"poll\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://hs-payments-test.netlify.app/payments\",\"statement_descriptor_name\":\"Juspay\",\"statement_descriptor_suffix\":\"Router\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.type\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.type' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.type !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"ach\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ach'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"ach\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"display_bank_transfer_information\" for \"next_action.type\"",
- "if (jsonData?.next_action.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'display_bank_transfer_information'\",",
- " function () {",
- " pm.expect(jsonData.next_action.type).to.eql(",
- " \"display_bank_transfer_information\",",
- " );",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"bank_transfer\",\"payment_method_type\":\"ach\",\"payment_method_data\":{\"bank_transfer\":{\"ach_bank_transfer\":{\"billing_details\":{\"email\":\"[email protected]\"}}}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario20-Bank Debit-ach",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1800,\"currency\":\"USD\",\"confirm\":true,\"business_label\":\"default\",\"capture_method\":\"automatic\",\"connector\":[\"stripe\"],\"customer_id\":\"klarna\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"authentication_type\":\"three_ds\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"return_url\":\"https://google.com\",\"statement_descriptor_name\":\"Juspay\",\"statement_descriptor_suffix\":\"Router\",\"setup_future_usage\":\"off_session\",\"business_country\":\"US\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"online\",\"accepted_at\":\"2022-09-10T10:11:12Z\",\"online\":{\"ip_address\":\"123.32.25.123\",\"user_agent\":\"Mozilla/5.0 (Linux; Android 12; SM-S906N Build/QP1A.190711.020; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.119 Mobile Safari/537.36\"}},\"mandate_type\":{\"single_use\":{\"amount\":6540,\"currency\":\"USD\"}}},\"payment_method\":\"bank_debit\",\"payment_method_type\":\"ach\",\"payment_method_data\":{\"bank_debit\":{\"ach_bank_debit\":{\"billing_details\":{\"name\":\"John Doe\",\"email\":\"[email protected]\"},\"account_number\":\"000123456789\",\"routing_number\":\"110000000\"}}},\"metadata\":{\"order_details\":{\"product_name\":\"Apple iphone 15\",\"quantity\":1,\"amount\":1800,\"account_name\":\"transaction_processing\"}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario21-Wallet-Wechatpay",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":800,\"currency\":\"USD\",\"confirm\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":800,\"customer_id\":\"poll\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"statement_descriptor_name\":\"Juspay\",\"statement_descriptor_suffix\":\"Router\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.type\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.type' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.type !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"ach\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'we_chat_pay'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"we_chat_pay\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"qr_code_information\" for \"next_action.type\"",
- "if (jsonData?.next_action.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'qr_code_information'\",",
- " function () {",
- " pm.expect(jsonData.next_action.type).to.eql(\"qr_code_information\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"wallet\",\"payment_method_type\":\"we_chat_pay\",\"payment_method_data\":{\"wallet\":{\"we_chat_pay_qr\":{}}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario22- Update address and List Payment method",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set customer_id as variable for jsonData.customer_id",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\", function() {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- "})};",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List Payment Methods for a Merchant",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:merchant_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:merchant_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Parse the response body as JSON",
- "var responseBody = pm.response.json();",
- "",
- "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"card\"",
- "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'card'\", function () {",
- " var paymentMethods = responseBody.payment_methods;",
- " var cardPaymentMethod = paymentMethods.find(function (method) {",
- " return method.payment_method == \"card\";",
- " });",
- "});",
- "",
- "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"pay_later\"",
- "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'pay_later'\", function () {",
- " var paymentMethods = responseBody.payment_methods;",
- " var cardPaymentMethod = paymentMethods.find(function (method) {",
- " return method.payment_method == \"pay_later\";",
- " });",
- "});",
- "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"wallet\"",
- "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'wallet'\", function () {",
- " var paymentMethods = responseBody.payment_methods;",
- " var cardPaymentMethod = paymentMethods.find(function (method) {",
- " return method.payment_method == \"wallet\";",
- " });",
- "});",
- "",
- "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"bank_debit\"",
- "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'bank_debit'\", function () {",
- " var paymentMethods = responseBody.payment_methods;",
- " var cardPaymentMethod = paymentMethods.find(function (method) {",
- " return method.payment_method == \"bank_debit\";",
- " });",
- "});",
- "",
- "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"bank_transfer\"",
- "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'bank_transfer'\", function () {",
- " var paymentMethods = responseBody.payment_methods;",
- " var cardPaymentMethod = paymentMethods.find(function (method) {",
- " return method.payment_method == \"bank_transfer\";",
- " });",
- "});"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- },
- {
- "key": "x-feature",
- "value": "router-custom",
- "type": "text",
- "disabled": true
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- "payment_methods"
- ],
- "query": [
- {
- "key": "client_secret",
- "value": "{{client_secret}}"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular merchant id."
- },
- "response": []
- },
- {
- "name": "Payments - Update",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "",
- "// Parse the JSON response",
- "var jsonData = pm.response.json();",
- "",
- "// Check if the 'currency' is equal to \"EUR\"",
- "pm.test(\"[POST]::/payments/:id -Content Check if 'currency' matches 'EUR' \", function () {",
- " pm.expect(jsonData.currency).to.eql(\"EUR\");",
- "});",
- "",
- "// Extract the \"country\" field from the JSON data",
- "var country = jsonData.billing.address.country;",
- "",
- "// Check if the country is \"NL\"",
- "pm.test(\"[POST]::/payments/:id -Content Check if billing 'Country' matches NL (Netherlands)\", function () {",
- " pm.expect(country).to.equal(\"NL\");",
- "});",
- "",
- "var country1 = jsonData.shipping.address.country;",
- "",
- "// Check if the country is \"NL\"",
- "pm.test(\"[POST]::/payments/:id -Content Check if shipping 'Country' matches NL (Netherlands)\", function () {",
- " pm.expect(country1).to.equal(\"NL\");",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"currency\":\"EUR\",\"shipping\":{\"address\":{\"line1\":\"1468\",\"line2\":\"Koramangala \",\"line3\":\"Koramangala \",\"city\":\"Bangalore\",\"state\":\"Karnataka\",\"zip\":\"560065\",\"country\":\"NL\",\"first_name\":\"Preeetam\",\"last_name\":\"Rev\"},\"phone\":{\"number\":\"8796455689\",\"country_code\":\"+91\"}},\"billing\":{\"address\":{\"line1\":\"1468\",\"line2\":\"Koramangala \",\"line3\":\"Koramangala \",\"city\":\"Bangalore\",\"state\":\"Karnataka\",\"zip\":\"560065\",\"country\":\"NL\",\"first_name\":\"Preeetam\",\"last_name\":\"Rev\"},\"phone\":{\"number\":\"8796455689\",\"country_code\":\"+91\"}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}"
- }
- ]
- },
- "description": "To update the properties of a PaymentIntent object. This may include attaching a payment method, or attaching customer object or metadata fields after the Payment is created "
- },
- "response": []
- },
- {
- "name": "List Payment Methods for a Merchant-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:merchant_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:merchant_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "",
- "// Parse the response body as JSON",
- "var responseBody = pm.response.json();",
- "",
- "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"card\"",
- "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'card'\", function () {",
- " var paymentMethods = responseBody.payment_methods;",
- " var cardPaymentMethod = paymentMethods.find(function (method) {",
- " return method.payment_method == \"card\";",
- " });",
- "});",
- "",
- "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"ideal\"",
- "pm.test(\"[GET]::/payment_methods/:merchant_id - Content Check if payment_method matches 'ideal'\", function () {",
- " var paymentMethods = responseBody.payment_methods;",
- " var cardPaymentMethod = paymentMethods.find(function (method) {",
- " return method.payment_method == \"ideal\";",
- " });",
- "});",
- "",
- "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"bank_redirect\"",
- "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'bank_redirect'\", function () {",
- " var paymentMethods = responseBody.payment_methods;",
- " var cardPaymentMethod = paymentMethods.find(function (method) {",
- " return method.payment_method == \"bank_redirect\";",
- " });",
- "});"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- },
- {
- "key": "x-feature",
- "value": "router-custom",
- "type": "text",
- "disabled": true
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- "payment_methods"
- ],
- "query": [
- {
- "key": "client_secret",
- "value": "{{client_secret}}"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular merchant id."
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments/:id/confirm - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "//// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\", function() {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- "})};",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"ideal\",\"payment_method_data\":{\"bank_redirect\":{\"ideal\":{\"billing_details\":{\"billing_name\":\"Example\",\"email\":\"[email protected]\"},\"bank_name\":\"ing\"}}},\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"125.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"multi_use\":{\"amount\":7000,\"currency\":\"USD\",\"start_date\":\"2023-04-21T00:00:00Z\",\"end_date\":\"2023-05-21T00:00:00Z\",\"metadata\":{\"frequency\":\"13\"}}}},\"setup_future_usage\":\"off_session\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"128.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- "pm.test(\"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\", function() {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- "})};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario23- Update Amount",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set customer_id as variable for jsonData.customer_id",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\", function() {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- "})};",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Update",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "",
- "// Parse the JSON response",
- "var jsonData = pm.response.json();",
- "",
- "// Check if the 'amount' is equal to \"1000\"",
- "pm.test(\"[POST]::/payments/:id -Content Check if 'amount' matches '1000' \", function () {",
- " pm.expect(jsonData.amount).to.eql(1000);",
- "});",
- "",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}"
- }
- ]
- },
- "description": "To update the properties of a PaymentIntent object. This may include attaching a payment method, or attaching customer object or metadata fields after the Payment is created "
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments/:id/confirm - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "//// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\", function() {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- "})};",
- "",
- "",
- "// Check if the 'amount' is equal to \"1000\"",
- "pm.test(\"[POST]::/payments/:id -Content Check if 'amount' matches '1000' \", function () {",
- " pm.expect(jsonData.amount).to.eql(1000);",
- "});",
- "",
- "//// Response body should have value \"amount_received\" for \"1000\"",
- "if (jsonData?.amount_received) {",
- "pm.test(\"[POST]::/payments - Content check if value for 'amount_received' matches '1000'\", function() {",
- " pm.expect(jsonData.amount_received).to.eql(1000);",
- "})};",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- },
- {
- "key": "x-feature",
- "value": "router-custom",
- "type": "text",
- "disabled": true
- },
- {
- "key": "publishable_key",
- "value": "",
- "type": "text",
- "disabled": true
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"setup_future_usage\":\"off_session\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"128.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "//// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\", function() {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- "})};",
- "",
- "",
- "// Check if the 'amount' is equal to \"1000\"",
- "pm.test(\"[POST]::/payments/:id -Content Check if 'amount' matches '1000' \", function () {",
- " pm.expect(jsonData.amount).to.eql(1000);",
- "});",
- "",
- "//// Response body should have value \"amount_received\" for \"1000\"",
- "if (jsonData?.amount_received) {",
- "pm.test(\"[POST]::/payments - Content check if value for 'amount_received' matches '1000'\", function() {",
- " pm.expect(jsonData.amount_received).to.eql(1000);",
- "})};",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario24-Add card flow",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(\"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\", function() {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " })};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"stripesavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4111111111111111\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for a Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
- " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":customer_id",
- "payment_methods"
- ],
- "query": [
- {
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
- {
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
- },
- "response": []
- },
- {
- "name": "Save card payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Save card payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"737\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create Copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario25-Don't Pass CVV for save card flow and verifysuccess payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"stripesavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for a Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
- " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":customer_id",
- "payment_methods"
- ],
- "query": [
- {
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
- {
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
- },
- "response": []
- },
- {
- "name": "Save card payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Save card payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"adyen\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(\"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\", function() {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " })};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario26-Save card payment with manual capture",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- "});",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
- " function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "List payment methods for a Customer",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
- " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
- " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "customers",
- ":customer_id",
- "payment_methods"
- ],
- "query": [
- {
- "key": "accepted_country",
- "value": "co",
- "disabled": true
- },
- {
- "key": "accepted_country",
- "value": "pa",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "voluptate ea",
- "disabled": true
- },
- {
- "key": "accepted_currency",
- "value": "exercitation",
- "disabled": true
- },
- {
- "key": "minimum_amount",
- "value": "100",
- "disabled": true
- },
- {
- "key": "maximum_amount",
- "value": "10000000",
- "disabled": true
- },
- {
- "key": "recurring_payment_enabled",
- "value": "true",
- "disabled": true
- },
- {
- "key": "installment_payment_enabled",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "customer_id",
- "value": "{{customer_id}}",
- "description": "//Pass the customer id"
- }
- ]
- },
- "description": "To filter and list the applicable payment methods for a particular Customer ID"
- },
- "response": []
- },
- {
- "name": "Save card payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx ",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
- "});",
- "",
- "// Validate if response has JSON Body ",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {jsonData = pm.response.json();}catch(e){}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
- "};",
- "",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
- "};",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
- "};",
- "",
- "if (jsonData?.customer_id) {",
- " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
- " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
- "};"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Save card payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- "",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"7373\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- "});",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount_capturable) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
- " function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":6540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve-copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- "});",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
- " function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create Copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
- " },",
- " );",
- "}",
- "",
- "// Validate the connector",
- "pm.test(\"[POST]::/payments - connector\", function () {",
- " pm.expect(jsonData.connector).to.eql(\"stripe\");",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve Copy",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario28-Create PM list for eps required fields",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for Merchants",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- " ",
- "pm.test(",
- " \"[GET]::/payments/:id - EPS required field contains 'payment_method_data.bank_redirect.eps.billing_details.billing_name'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"eps\" &&",
- " type.required_fields &&",
- " type.required_fields[\"payment_method_data.bank_redirect.eps.billing_details.billing_name\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- "payment_methods"
- ],
- "query": [
- {
- "key": "client_secret",
- "value": "{{client_secret}}"
- }
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario27-Create PM list for ideal mandate required fields",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"NL\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"NL\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}, \"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":6540,\"currency\":\"EUR\"}}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for Merchants",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- " ",
- "pm.test(",
- " \"[GET]::/payments/:id - Ideal required field contains 'payment_method_data.bank_redirect.ideal.billing_details.billing_name'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"ideal\" &&",
- " type.required_fields &&",
- " type.required_fields[\"payment_method_data.bank_redirect.ideal.billing_details.billing_name\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "",
- "pm.test(",
- " \"[GET]::/payments/:id - Ideal required field contains 'payment_method_data.bank_redirect.ideal.billing_details.email'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"ideal\" &&",
- " type.required_fields &&",
- " type.required_fields[\"payment_method_data.bank_redirect.ideal.billing_details.email\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- "payment_methods"
- ],
- "query": [
- {
- "key": "client_secret",
- "value": "{{client_secret}}"
- }
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario27-Create payment without customer_id and with billing address and shipping address",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- }
- ]
- },
- {
- "name": "Variation Cases",
- "item": [
- {
- "name": "Scenario10-Refund exceeds amount captured",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'partially_captured'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"partially_captured\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6000);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'partially_captured'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"partially_captured\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"The refund amount exceeds the amount captured\" for \"error message\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.message' matches 'The refund amount exceeds the amount captured'\",",
- " function () {",
- " pm.expect(jsonData.error.message).to.eql(\"The refund amount exceeds the amount captured\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario1-Create payment with Invalid card details",
- "item": [
- {
- "name": "Payments - Create(Invalid card number)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'connector_error'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"connector_error\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"123456\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"united states\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"united states\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Create(Invalid Exp month)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"2023\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Create(Invalid Exp Year)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"connector error\" for \"error message\"",
- "if (jsonData?.error?.message) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.message' matches 'Invalid Expiry Year'\",",
- " function () {",
- " pm.expect(jsonData.error.message).to.eql(\"Invalid Expiry Year\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"2022\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Create(invalid CVV)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'connector'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"connector\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"123456\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"12345\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2-Confirming the payment without PMD",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario3-Capture greater amount",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario4-Capture the succeeded payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario5-Void the success_slash_failure payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Cancel",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments/:id/cancel - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"cancellation_reason\":\"requested_by_customer\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/cancel",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "cancel"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario6-Create 3DS payment with greater capture",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4000000000003063\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":7540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario7-Refund exceeds amount",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":7000,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario8-Refund for unsuccessful payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario9-Create a recurring payment with greater mandate amount",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have \"mandate_data\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Recurring Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":8040,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- }
- ]
- }
- ]
- }
- ]
- }
- ],
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "type": "text/javascript",
- "exec": [
- ""
- ]
- }
- },
- {
- "listen": "test",
- "script": {
- "type": "text/javascript",
- "exec": [
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);",
- "}",
- "",
- "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));",
- ""
- ]
- }
- }
- ],
- "variable": [
- {
- "key": "baseUrl",
- "value": "",
- "type": "string"
- },
- {
- "key": "admin_api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "merchant_id",
- "value": ""
- },
- {
- "key": "payment_id",
- "value": ""
- },
- {
- "key": "customer_id",
- "value": ""
- },
- {
- "key": "mandate_id",
- "value": ""
- },
- {
- "key": "payment_method_id",
- "value": ""
- },
- {
- "key": "refund_id",
- "value": ""
- },
- {
- "key": "merchant_connector_id",
- "value": ""
- },
- {
- "key": "client_secret",
- "value": "",
- "type": "string"
- },
- {
- "key": "connector_api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "publishable_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "api_key_id",
- "value": "",
- "type": "string"
- },
- {
- "key": "payment_token",
- "value": ""
- },
- {
- "key": "gateway_merchant_id",
- "value": "",
- "type": "string"
- },
- {
- "key": "certificate",
- "value": "",
- "type": "string"
- },
- {
- "key": "certificate_keys",
- "value": "",
- "type": "string"
- }
- ]
-}
\ No newline at end of file
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);",
+ "}",
+ "",
+ "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "item": [
+ {
+ "name": "Health check",
+ "item": [
+ {
+ "name": "New Request",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "x-feature",
+ "value": "router-custom",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/health",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "health"
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "MerchantAccounts",
+ "item": [
+ {
+ "name": "Merchant Account - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
+ " console.log(",
+ " \"- use {{merchant_id}} as collection variable for value\",",
+ " jsonData.merchant_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"organization_id\", jsonData.organization_id);",
+ " console.log(",
+ " \"- use {{organization_id}} as collection variable for value\",",
+ " jsonData.organization_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{organization_id}}, as jsonData.organization_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/accounts - Organization id is generated\",",
+ " function () {",
+ " pm.expect(typeof jsonData.organization_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com/success\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"},\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}]}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts"
+ ]
+ },
+ "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
+ },
+ "response": []
+ },
+ {
+ "name": "Merchant Account - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/accounts/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/accounts/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/accounts/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Retrieve a merchant account details."
+ },
+ "response": []
+ },
+ {
+ "name": "Merchant Account - List",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/accounts/list - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/accounts/list - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/accounts/list?organization_id={{organization_id}}",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts",
+ "list"
+ ],
+ "query": [
+ {
+ "key": "organization_id",
+ "value": "{{organization_id}}"
+ }
+ ],
+ "variable": [
+ {
+ "key": "organization_id",
+ "value": "{{organization_id}}",
+ "description": "(Required) - Organization id"
+ }
+ ]
+ },
+ "description": "List merchant accounts for an organization"
+ },
+ "response": []
+ },
+ {
+ "name": "Merchant Account - Update",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/accounts/:id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"{{merchant_id}}\",\"merchant_name\":\"NewAge Retailer\",\"locker_id\":\"m0010\",\"merchant_details\":{\"primary_contact_person\":\"joseph Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"veniam aute officia ullamco esse\",\"secondary_contact_person\":\"joseph Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"proident adipisicing officia nulla\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"parent_merchant_id\":\"xkkdf909012sdjki2dkh5sdf\",\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "To update an existing merchant account. Helpful in updating merchant details such as email, contact deteails, or other configuration details like webhook, routing algorithm etc"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "API Key",
+ "item": [
+ {
+ "name": "Create API Key",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Update API Key",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id/:api_key_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id/:api_key_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":null,\"description\":\"My very awesome API key\",\"expiration\":null}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id/:api_key_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id",
+ ":api_key_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "api_key_id",
+ "value": "{{api_key_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Retrieve API Key",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[GET]::/api_keys/:merchant_id/:api_key_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/api_keys/:merchant_id/:api_key_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id/:api_key_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id",
+ ":api_key_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "api_key_id",
+ "value": "{{api_key_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "List API Keys",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/api_keys/:merchant_id/list - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/api_keys/:merchant_id/list - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id/list",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id",
+ "list"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Delete API Key",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[DELETE]::/api_keys/:merchant_id/:api-key - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[DELETE]::/api_keys/:merchant_id/:api-key - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "DELETE",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id/:api-key",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id",
+ ":api-key"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "api-key",
+ "value": "{{api_key_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "PaymentConnectors",
+ "item": [
+ {
+ "name": "Payment Connector - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/accounts/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/accounts/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Validate if the connector label is the one that is passed in the request",
+ "pm.test(",
+ " \"[POST]::/accounts/:account_id/connectors - connector_label is not autogenerated\",",
+ " function () {",
+ " pm.expect(jsonData.connector_label).to.eql(\"first_stripe_connector\")",
+ " },",
+ ");"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"stripe\",\"business_country\":\"US\",\"business_label\":\"default\",\"connector_label\":\"first_stripe_connector\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[GET]::/accounts/:account_id/connectors/:connector_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/accounts/:account_id/connectors/:connector_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors",
+ ":connector_id"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ },
+ {
+ "key": "connector_id",
+ "value": "{{merchant_connector_id}}",
+ "description": "(Required) The unique identifier for the payment connector"
+ }
+ ]
+ },
+ "description": "Retrieve Payment Connector details."
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Update",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Validate if the connector label is the one that is passed in the request",
+ "pm.test(",
+ " \"[POST]::/accounts/:account_id/connectors - connector_label is not autogenerated\",",
+ " function () {",
+ " pm.expect(jsonData.connector_label).to.eql(\"updated_stripe_connector\")",
+ " },",
+ ");"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"fiz_operations\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}\"},\"connector_label\":\"updated_stripe_connector\",\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors",
+ ":connector_id"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "connector_id",
+ "value": "{{merchant_connector_id}}"
+ }
+ ]
+ },
+ "description": "To update an existing Payment Connector. Helpful in enabling / disabling different payment methods and other settings for the connector etc"
+ },
+ "response": []
+ },
+ {
+ "name": "List Connectors by MID",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[GET]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Delete",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[DELETE]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[DELETE]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "DELETE",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors",
+ ":connector_id"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "connector_id",
+ "value": "{{merchant_connector_id}}"
+ }
+ ]
+ },
+ "description": "Delete or Detach a Payment Connector from Merchant Account"
+ },
+ "response": []
+ },
+ {
+ "name": "Merchant Account - Delete",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[DELETE]::/accounts/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[DELETE]::/accounts/:id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Response Validation",
+ "const schema = {",
+ " type: \"object\",",
+ " description: \"Merchant Account\",",
+ " required: [\"merchant_id\", \"deleted\"],",
+ " properties: {",
+ " merchant_id: {",
+ " type: \"string\",",
+ " description: \"The identifier for the MerchantAccount object.\",",
+ " maxLength: 255,",
+ " example: \"y3oqhf46pyzuxjbcn2giaqnb44\",",
+ " },",
+ " deleted: {",
+ " type: \"boolean\",",
+ " description:",
+ " \"Indicates the deletion status of the Merchant Account object.\",",
+ " example: true,",
+ " },",
+ " },",
+ "};",
+ "",
+ "// Validate if response matches JSON schema",
+ "pm.test(\"[DELETE]::/accounts/:id - Schema is valid\", function () {",
+ " pm.response.to.have.jsonSchema(schema, {",
+ " unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"],",
+ " });",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "DELETE",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/accounts/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Delete a Merchant Account"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "QuickStart",
+ "item": [
+ {
+ "name": "Merchant Account - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
+ " console.log(",
+ " \"- use {{merchant_id}} as collection variable for value\",",
+ " jsonData.merchant_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "/*",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(\"- use {{api_key}} as collection variable for value\",jsonData.api_key);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.');",
+ "};",
+ "*/",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com/success\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"},\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}]}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts"
+ ]
+ },
+ "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
+ },
+ "response": []
+ },
+ {
+ "name": "API Key - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Create",
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"stripe\",\"business_country\":\"US\",\"business_label\":\"default\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}_invalid_values\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"affirm\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"afterpay_clearpay\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"invoke_sdk_client\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"ideal\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"giropay\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"becs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_transfer\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"debit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"google_pay\":{\"allowed_payment_methods\":[{\"type\":\"CARD\",\"parameters\":{\"allowed_auth_methods\":[\"PAN_ONLY\",\"CRYPTOGRAM_3DS\"],\"allowed_card_networks\":[\"AMEX\",\"DISCOVER\",\"INTERAC\",\"JCB\",\"MASTERCARD\",\"VISA\"]},\"tokenization_specification\":{\"type\":\"PAYMENT_GATEWAY\",\"parameters\":{\"gateway\":\"example\",\"gateway_merchant_id\":\"{{gateway_merchant_id}}\"}}}],\"merchant_info\":{\"merchant_name\":\"Narayan Bhat\"}},\"apple_pay\":{\"session_token_data\":{\"initiative\":\"web\",\"certificate\":\"{{certificate}}\",\"display_name\":\"applepay\",\"certificate_keys\":\"{{certificate_keys}}\",\"initiative_context\":\"hyperswitch-sdk-test.netlify.app\",\"merchant_identifier\":\"merchant.com.stripe.sang\"},\"payment_request_data\":{\"label\":\"applepay pvt.ltd\",\"supported_networks\":[\"visa\",\"masterCard\",\"amex\",\"discover\"],\"merchant_capabilities\":[\"supports3DS\"]}}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"failed\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'failed'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have an error message",
+ "if (jsonData?.error_message) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error_message' is not 'null'\",",
+ " function () {",
+ " pm.expect(jsonData.error_message).is.not.null;",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Update",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"fiz_operations\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"affirm\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"afterpay_clearpay\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"invoke_sdk_client\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"ideal\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"giropay\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"becs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_transfer\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"debit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"google_pay\":{\"allowed_payment_methods\":[{\"type\":\"CARD\",\"parameters\":{\"allowed_auth_methods\":[\"PAN_ONLY\",\"CRYPTOGRAM_3DS\"],\"allowed_card_networks\":[\"AMEX\",\"DISCOVER\",\"INTERAC\",\"JCB\",\"MASTERCARD\",\"VISA\"]},\"tokenization_specification\":{\"type\":\"PAYMENT_GATEWAY\",\"parameters\":{\"gateway\":\"example\",\"gateway_merchant_id\":\"{{gateway_merchant_id}}\"}}}],\"merchant_info\":{\"merchant_name\":\"Narayan Bhat\"}},\"apple_pay\":{\"session_token_data\":{\"initiative\":\"web\",\"certificate\":\"{{certificate}}\",\"display_name\":\"applepay\",\"certificate_keys\":\"{{certificate_keys}}\",\"initiative_context\":\"hyperswitch-sdk-test.netlify.app\",\"merchant_identifier\":\"merchant.com.stripe.sang\"},\"payment_request_data\":{\"label\":\"applepay pvt.ltd\",\"supported_networks\":[\"visa\",\"masterCard\",\"amex\",\"discover\"],\"merchant_capabilities\":[\"supports3DS\"]}}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors",
+ ":connector_id"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "connector_id",
+ "value": "{{merchant_connector_id}}"
+ }
+ ]
+ },
+ "description": "To update an existing Payment Connector. Helpful in enabling / disabling different payment methods and other settings for the connector etc"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "",
+ "// Response body should have \"profile_id\" and not \"null\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'profile_id' exists and is not 'null'\",",
+ " function () {",
+ " pm.expect(typeof jsonData.profile_id !== \"undefined\").to.be.true;",
+ " pm.expect(jsonData.profile_id).is.not.null;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Customers",
+ "description": "Create a Customer entity which you can use to store and retrieve specific customers' data and payment methods.",
+ "item": [
+ {
+ "name": "Create Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/customers - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/customers - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/customers - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Response body should have \"customer_id\"",
+ "pm.test(",
+ " \"[POST]::/customers - Content check if 'customer_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.customer_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have a minimum length of \"1\" for \"customer_id\"",
+ "if (jsonData?.customer_id) {",
+ " pm.test(",
+ " \"[POST]::/customers - Content check if value of 'customer_id' has a minimum length of '1'\",",
+ " function () {",
+ " pm.expect(jsonData.customer_id.length).is.at.least(1);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set customer_id as variable for jsonData.customer_id",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(",
+ " \"- use {{customer_id}} as collection variable for value\",",
+ " jsonData.customer_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"First customer\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/customers",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers"
+ ]
+ },
+ "description": "Create a customer object and store the customer details to be reused for future payments. Incase the customer already exists in the system, this API will respond with the customer details."
+ },
+ "response": []
+ },
+ {
+ "name": "List Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/customers - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/customers - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/customers - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "",
+ "// Response body should have a minimum length of \"1\" for \"customer_id\"",
+ "if (jsonData?.customer_id) {",
+ " pm.test(",
+ " \"[POST]::/customers - Content check if value of 'customer_id' has a minimum length of '2'\",",
+ " function () {",
+ " pm.expect(jsonData.customer_id.length).is.at.least(2);",
+ " },",
+ " );",
+ "}",
+ "",
+ "",
+ "// Define the regular expression pattern to match customer_id",
+ "var customerIdPattern = /^[a-zA-Z0-9_]+$/;",
+ "",
+ "// Define an array to store the validation results",
+ "var validationResults = [];",
+ "",
+ "// Iterate through the JSON array",
+ "jsonData.forEach(function(item, index) {",
+ " if (item.hasOwnProperty(\"customer_id\")) {",
+ " if (customerIdPattern.test(item.customer_id)) {",
+ " validationResults.push(\"customer_id \" + item.customer_id + \" is valid.\");",
+ " } else {",
+ " validationResults.push(\"customer_id \" + item.customer_id + \" is not valid.\");",
+ " }",
+ " } else {",
+ " validationResults.push(\"customer_id is missing for item at index \" + index);",
+ " }",
+ "});",
+ "",
+ "// Check if any customer_id is not valid and fail the test if necessary",
+ "if (validationResults.some(result => !result.includes(\"is valid\"))) {",
+ " pm.test(\"Customer IDs validation failed: \" + validationResults.join(\", \"), function() {",
+ " pm.expect(false).to.be.true;",
+ " });",
+ "} else {",
+ " pm.test(\"All customer IDs are valid: \" + validationResults.join(\", \"), function() {",
+ " pm.expect(true).to.be.true;",
+ " });",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/list",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ "list"
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Retrieve Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/customers/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/customers/:id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/customers/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{customer_id}}",
+ "description": "(Required) unique customer id"
+ }
+ ]
+ },
+ "description": "Retrieve a customer's details."
+ },
+ "response": []
+ },
+ {
+ "name": "Update Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/customers/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/customers/:id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/customers/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"email\":\"[email protected]\",\"name\":\"John Test\",\"phone_country_code\":\"+65\",\"phone\":\"888888888\",\"description\":\"First customer\",\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/customers/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{customer_id}}",
+ "description": "(Required) unique customer id"
+ }
+ ]
+ },
+ "description": "Updates the customer's details in a customer object."
+ },
+ "response": []
+ },
+ {
+ "name": "Ephemeral Key",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/ephemeral_keys - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/ephemeral_keys - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"customer_id\":\"{{customer_id}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/ephemeral_keys",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "ephemeral_keys"
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Delete Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[DELETE]::/customers/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[DELETE]::/customers/:id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[DELETE]::/customers/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "DELETE",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{customer_id}}",
+ "description": "(Required) unique customer id"
+ }
+ ]
+ },
+ "description": "Delete a customer record."
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Payments",
+ "description": "Process and manage payments across wide range of payment processors using the Unified Payments API.",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Session Token",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/session_tokens - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/session_tokens - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "const responseJson = pm.response.json();",
+ "",
+ "// Verify if the wallet_name in the response matches 'apple_pay'",
+ "pm.test(",
+ " \"[POST]::/payments/session_tokens - Verify wallet_name is 'apple_pay'\",",
+ " function () {",
+ " pm.expect(responseJson.session_token[0].wallet_name).to.eql(\"apple_pay\");",
+ " },",
+ ");",
+ "",
+ "// Verify if the wallet_name in the response matches 'google_pay'",
+ "pm.test(",
+ " \"[POST]::/payments/session_tokens - Verify wallet_name is 'google_pay'\",",
+ " function () {",
+ " pm.expect(responseJson.session_token[1].wallet_name).to.eql(\"google_pay\");",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"wallets\":[],\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/session_tokens",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ "session_tokens"
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Update",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":20000,\"currency\":\"SGD\",\"confirm\":false,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"email\":\"[email protected]\",\"name\":\"joseph Doe\",\"phone\":\"8888888888\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"payment_method\":\"card\",\"return_url\":\"https://duck.com\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To update the properties of a PaymentIntent object. This may include attaching a payment method, or attaching customer object or metadata fields after the Payment is created "
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm (Through Client Secret)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":6540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create Again",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm Again (Through API Key)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create Yet Again",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Cancel",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"cancellation_reason\":\"requested_by_customer\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/cancel",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "cancel"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
+ },
+ "response": []
+ },
+ {
+ "name": "Payment-List",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/list - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/payments/list - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "api-key",
+ "value": "snd_0b8e1deb82f241eca47617afb1398858"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/list",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ "list"
+ ],
+ "query": [
+ {
+ "key": "customer_id",
+ "value": "",
+ "disabled": true
+ },
+ {
+ "key": "starting_after",
+ "value": "",
+ "disabled": true
+ },
+ {
+ "key": "ending_before",
+ "value": "",
+ "disabled": true
+ },
+ {
+ "key": "limit",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "created",
+ "value": "",
+ "disabled": true
+ },
+ {
+ "key": "created.lt",
+ "value": "",
+ "disabled": true
+ },
+ {
+ "key": "created.gt",
+ "value": "",
+ "disabled": true
+ },
+ {
+ "key": "created.lte",
+ "value": "",
+ "disabled": true
+ },
+ {
+ "key": "created_gte",
+ "value": "",
+ "disabled": true
+ }
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Refunds",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Update",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"reason\":\"Paid by mistake\",\"metadata\":{\"udf1\":\"value2\",\"new_customer\":\"false\",\"login_date\":\"2019-09-1T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To update the properties of a Refund object. This may include attaching a reason for the refund or metadata fields"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "PaymentMethods",
+ "item": [
+ {
+ "name": "P_Create Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/customers - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/customers - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/customers - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Response body should have \"customer_id\"",
+ "pm.test(",
+ " \"[POST]::/customers - Content check if 'customer_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.customer_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have a minimum length of \"1\" for \"customer_id\"",
+ "if (jsonData?.customer_id) {",
+ " pm.test(",
+ " \"[POST]::/customers - Content check if value of 'customer_id' has a minimum length of '1'\",",
+ " function () {",
+ " pm.expect(jsonData.customer_id.length).is.at.least(1);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set customer_id as variable for jsonData.customer_id",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(",
+ " \"- use {{customer_id}} as collection variable for value\",",
+ " jsonData.customer_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"First customer\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/customers",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers"
+ ]
+ },
+ "description": "Create a customer object and store the customer details to be reused for future payments. Incase the customer already exists in the system, this API will respond with the customer details."
+ },
+ "response": []
+ },
+ {
+ "name": "PaymentMethods - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payment_methods - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payment_methods - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_method_id as variable for jsonData.payment_method_id",
+ "if (jsonData?.payment_method_id) {",
+ " pm.collectionVariables.set(\"payment_method_id\", jsonData.payment_method_id);",
+ " console.log(",
+ " \"- use {{payment_method_id}} as collection variable for value\",",
+ " jsonData.payment_method_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_method_id}}, as jsonData.payment_method_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(",
+ " \"- use {{customer_id}} as collection variable for value\",",
+ " jsonData.customer_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_issuer\":\"Visa\",\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"John Doe\"},\"customer_id\":\"{{customer_id}}\",\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payment_methods",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payment_methods"
+ ]
+ },
+ "description": "To create a payment method against a customer object. In case of cards, this API could be used only by PCI compliant merchants"
+ },
+ "response": []
+ },
+ {
+ "name": "List payment methods for a Merchant",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[GET]::/payment_methods/:merchant_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/payment_methods/:merchant_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "client_secret",
+ "value": "{{client_secret}}"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular merchant id."
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(",
+ " \"- use {{customer_id}} as collection variable for value\",",
+ " jsonData.customer_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "List payment methods for a Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[GET]::/payment_methods/:customer_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/payment_methods/:customer_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(",
+ " \"payment_token\",",
+ " jsonData.customer_payment_methods[0].payment_token,",
+ " );",
+ " console.log(",
+ " \"- use {{payment_token}} as collection variable for value\",",
+ " jsonData.customer_payment_methods[0].payment_token,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":customer_id",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Flow Testcases",
+ "item": [
+ {
+ "name": "QuickStart",
+ "item": [
+ {
+ "name": "Merchant Account - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
+ " console.log(",
+ " \"- use {{merchant_id}} as collection variable for value\",",
+ " jsonData.merchant_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"},\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}]}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts"
+ ]
+ },
+ "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
+ },
+ "response": []
+ },
+ {
+ "name": "API Key - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"stripe\",\"business_country\":\"US\",\"business_label\":\"default\",\"connector_account_details\":{\"auth_type\":\"HeaderKey\",\"api_key\":\"{{connector_api_key}}\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"affirm\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"afterpay_clearpay\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"redirect_to_url\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"pay_later\",\"payment_method_types\":[{\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"payment_experience\":\"invoke_sdk_client\",\"payment_method_type\":\"klarna\"}]},{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"ideal\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"giropay\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_debit\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"becs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"bank_transfer\",\"payment_method_types\":[{\"payment_method_type\":\"ach\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"bacs\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sepa\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"card_networks\":[\"AmericanExpress\",\"Discover\",\"Interac\",\"JCB\",\"Mastercard\",\"Visa\",\"DinersClub\",\"UnionPay\",\"RuPay\"]}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"debit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true,\"card_networks\":[\"AmericanExpress\",\"Discover\",\"Interac\",\"JCB\",\"Mastercard\",\"Visa\",\"DinersClub\",\"UnionPay\",\"RuPay\"]}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"google_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"we_chat_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"google_pay\":{\"allowed_payment_methods\":[{\"type\":\"CARD\",\"parameters\":{\"allowed_auth_methods\":[\"PAN_ONLY\",\"CRYPTOGRAM_3DS\"],\"allowed_card_networks\":[\"AMEX\",\"DISCOVER\",\"INTERAC\",\"JCB\",\"MASTERCARD\",\"VISA\"]},\"tokenization_specification\":{\"type\":\"PAYMENT_GATEWAY\",\"parameters\":{\"gateway\":\"example\",\"gateway_merchant_id\":\"{{gateway_merchant_id}}\"}}}],\"merchant_info\":{\"merchant_name\":\"Narayan Bhat\"}},\"apple_pay\":{\"session_token_data\":{\"initiative\":\"web\",\"certificate\":\"{{certificate}}\",\"display_name\":\"applepay\",\"certificate_keys\":\"{{certificate_keys}}\",\"initiative_context\":\"hyperswitch-sdk-test.netlify.app\",\"merchant_identifier\":\"merchant.com.stripe.sang\"},\"payment_request_data\":{\"label\":\"applepay pvt.ltd\",\"supported_networks\":[\"visa\",\"masterCard\",\"amex\",\"discover\"],\"merchant_capabilities\":[\"supports3DS\"]}}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Happy Cases",
+ "item": [
+ {
+ "name": "Scenario1-Create payment with confirm true",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2-Create payment with confirm false",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"Joseph Doe\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2a-Create payment with confirm false card holder name null",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":null,\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2b-Create payment with confirm false card holder name empty",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario3-Create payment without PMD",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario4-Create payment with Manual capture",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":6540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario4a-Create payment with manual_multiple capture",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'partially_captured'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"partially_captured\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6000);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'partially_captured'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"partially_captured\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario5-Void the payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Cancel",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"cancelled\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content check if value for 'status' matches 'cancelled'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"cancelled\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"cancellation_reason\":\"requested_by_customer\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/cancel",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "cancel"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"cancelled\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'cancelled'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"cancelled\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario6-Create 3DS payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"business_country\":\"US\",\"business_label\":\"default\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4000000000003063\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario7-Create 3DS payment with confrm false",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4000000000003063\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario8-Create a failure card payment with confirm true",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'failed'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"card_declined\" for \"error_code\"",
+ "if (jsonData?.error_code) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches 'card_declined'\",",
+ " function () {",
+ " pm.expect(jsonData.error_code).to.eql(\"card_declined\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"message - Your card has insufficient funds., decline_code - insufficient_funds\" for \"error_message\"",
+ "if (jsonData?.error_message) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'message - Your card has insufficient funds., decline_code - insufficient_funds'\",",
+ " function () {",
+ " pm.expect(jsonData.error_message).to.eql(\"message - Your card has insufficient funds., decline_code - insufficient_funds\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4000000000009995\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'failed'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"failed\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"card_declined\" for \"error_code\"",
+ "if (jsonData?.error_code) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_code' matches 'card_declined'\",",
+ " function () {",
+ " pm.expect(jsonData.error_code).to.eql(\"card_declined\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"message - Your card has insufficient funds., decline_code - insufficient_funds\" for \"error_message\"",
+ "if (jsonData?.error_message) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error_message' matches 'message - Your card has insufficient funds., decline_code - insufficient_funds'\",",
+ " function () {",
+ " pm.expect(jsonData.error_message).to.eql(\"message - Your card has insufficient funds., decline_code - insufficient_funds\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario9-Refund full payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario9a-Partial refund",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"1000\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(1000);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":1000,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '1000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(1000);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"refunds\"",
+ "pm.test(\"[POST]::/payments - Content check if 'refunds' exists\", function () {",
+ " pm.expect(typeof jsonData.refunds !== \"undefined\").to.be.true;",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario10-Create a mandate and recurring payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Recurring Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"payment_method_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario11-Refund recurring payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Recurring Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"payment_method_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'payment_method_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.payment_method_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6570,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6570,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create Copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve Copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario12-BNPL-klarna",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":8000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":8000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"klarna\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'klarna'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"klarna\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"pay_later\",\"payment_method_type\":\"klarna\",\"payment_experience\":\"redirect_to_url\",\"payment_method_data\":{\"pay_later\":{\"klarna_redirect\":{\"issuer_name\":\"stripe\",\"billing_email\":\"[email protected]\",\"billing_country\":\"US\"}}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario13-BNPL-afterpay",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":7000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"country\":\"SE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"SE\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"order_details\":{\"product_name\":\"Socks\",\"amount\":7000,\"quantity\":1}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"afterpay_clearpay\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'afterpay_clearpay'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"afterpay_clearpay\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"pay_later\",\"payment_method_type\":\"afterpay_clearpay\",\"payment_experience\":\"redirect_to_url\",\"payment_method_data\":{\"pay_later\":{\"afterpay_clearpay_redirect\":{\"billing_name\":\"Akshaya\",\"billing_email\":\"[email protected]\"}}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario14-BNPL-affirm",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":7000,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"country\":\"US\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"order_details\":{\"product_name\":\"Socks\",\"amount\":7000,\"quantity\":1}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"affirm\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'affirm'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"affirm\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"pay_later\",\"payment_method_type\":\"affirm\",\"payment_experience\":\"redirect_to_url\",\"payment_method_data\":{\"pay_later\":{\"affirm_redirect\":{\"issuer_name\":\"affirm\",\"billing_email\":\"[email protected]\",\"billing_country\":\"US\"}}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario15-Bank Redirect-Ideal",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"ideal\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ideal'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"ideal\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"ideal\",\"payment_method_data\":{\"bank_redirect\":{\"ideal\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario16-Bank Redirect-sofort",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"sofort\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'sofort'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"sofort\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"sofort\",\"payment_method_data\":{\"bank_redirect\":{\"sofort\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"hypo_noe_lb_fur_niederosterreich_u_wien\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario17-Bank Redirect-eps",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"eps\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'eps'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"eps\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"eps\",\"payment_method_data\":{\"bank_redirect\":{\"eps\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"hypo_oberosterreich_salzburg_steiermark\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario18-Bank Redirect-giropay",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"giropay\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'giropay'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"giropay\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"giropay\",\"payment_method_data\":{\"bank_redirect\":{\"giropay\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"\",\"preferred_language\":\"en\",\"country\":\"DE\"}}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario19-Bank Transfer-ach",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":800,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":800,\"customer_id\":\"poll\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://hs-payments-test.netlify.app/payments\",\"statement_descriptor_name\":\"Juspay\",\"statement_descriptor_suffix\":\"Router\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.type\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.type' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.type !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"ach\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ach'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"ach\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"display_bank_transfer_information\" for \"next_action.type\"",
+ "if (jsonData?.next_action.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'display_bank_transfer_information'\",",
+ " function () {",
+ " pm.expect(jsonData.next_action.type).to.eql(",
+ " \"display_bank_transfer_information\",",
+ " );",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"bank_transfer\",\"payment_method_type\":\"ach\",\"payment_method_data\":{\"bank_transfer\":{\"ach_bank_transfer\":{\"billing_details\":{\"email\":\"[email protected]\"}}}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario20-Bank Debit-ach",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1800,\"currency\":\"USD\",\"confirm\":true,\"business_label\":\"default\",\"capture_method\":\"automatic\",\"connector\":[\"stripe\"],\"customer_id\":\"klarna\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"authentication_type\":\"three_ds\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"return_url\":\"https://google.com\",\"statement_descriptor_name\":\"Juspay\",\"statement_descriptor_suffix\":\"Router\",\"setup_future_usage\":\"off_session\",\"business_country\":\"US\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"online\",\"accepted_at\":\"2022-09-10T10:11:12Z\",\"online\":{\"ip_address\":\"123.32.25.123\",\"user_agent\":\"Mozilla/5.0 (Linux; Android 12; SM-S906N Build/QP1A.190711.020; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.119 Mobile Safari/537.36\"}},\"mandate_type\":{\"single_use\":{\"amount\":6540,\"currency\":\"USD\"}}},\"payment_method\":\"bank_debit\",\"payment_method_type\":\"ach\",\"payment_method_data\":{\"bank_debit\":{\"ach_bank_debit\":{\"billing_details\":{\"name\":\"John Doe\",\"email\":\"[email protected]\"},\"account_number\":\"000123456789\",\"routing_number\":\"110000000\"}}},\"metadata\":{\"order_details\":{\"product_name\":\"Apple iphone 15\",\"quantity\":1,\"amount\":1800,\"account_name\":\"transaction_processing\"}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario21-Wallet-Wechatpay",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":800,\"currency\":\"USD\",\"confirm\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":800,\"customer_id\":\"poll\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"statement_descriptor_name\":\"Juspay\",\"statement_descriptor_suffix\":\"Router\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.type\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.type' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.type !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"ach\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'we_chat_pay'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"we_chat_pay\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"qr_code_information\" for \"next_action.type\"",
+ "if (jsonData?.next_action.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'qr_code_information'\",",
+ " function () {",
+ " pm.expect(jsonData.next_action.type).to.eql(\"qr_code_information\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"wallet\",\"payment_method_type\":\"we_chat_pay\",\"payment_method_data\":{\"wallet\":{\"we_chat_pay_qr\":{}}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario22- Update address and List Payment method",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set customer_id as variable for jsonData.customer_id",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\", function() {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ "})};",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "List Payment Methods for a Merchant",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Parse the response body as JSON",
+ "var responseBody = pm.response.json();",
+ "",
+ "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"card\"",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'card'\", function () {",
+ " var paymentMethods = responseBody.payment_methods;",
+ " var cardPaymentMethod = paymentMethods.find(function (method) {",
+ " return method.payment_method == \"card\";",
+ " });",
+ "});",
+ "",
+ "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"pay_later\"",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'pay_later'\", function () {",
+ " var paymentMethods = responseBody.payment_methods;",
+ " var cardPaymentMethod = paymentMethods.find(function (method) {",
+ " return method.payment_method == \"pay_later\";",
+ " });",
+ "});",
+ "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"wallet\"",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'wallet'\", function () {",
+ " var paymentMethods = responseBody.payment_methods;",
+ " var cardPaymentMethod = paymentMethods.find(function (method) {",
+ " return method.payment_method == \"wallet\";",
+ " });",
+ "});",
+ "",
+ "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"bank_debit\"",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'bank_debit'\", function () {",
+ " var paymentMethods = responseBody.payment_methods;",
+ " var cardPaymentMethod = paymentMethods.find(function (method) {",
+ " return method.payment_method == \"bank_debit\";",
+ " });",
+ "});",
+ "",
+ "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"bank_transfer\"",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'bank_transfer'\", function () {",
+ " var paymentMethods = responseBody.payment_methods;",
+ " var cardPaymentMethod = paymentMethods.find(function (method) {",
+ " return method.payment_method == \"bank_transfer\";",
+ " });",
+ "});"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ },
+ {
+ "key": "x-feature",
+ "value": "router-custom",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "client_secret",
+ "value": "{{client_secret}}"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular merchant id."
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Update",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "",
+ "// Parse the JSON response",
+ "var jsonData = pm.response.json();",
+ "",
+ "// Check if the 'currency' is equal to \"EUR\"",
+ "pm.test(\"[POST]::/payments/:id -Content Check if 'currency' matches 'EUR' \", function () {",
+ " pm.expect(jsonData.currency).to.eql(\"EUR\");",
+ "});",
+ "",
+ "// Extract the \"country\" field from the JSON data",
+ "var country = jsonData.billing.address.country;",
+ "",
+ "// Check if the country is \"NL\"",
+ "pm.test(\"[POST]::/payments/:id -Content Check if billing 'Country' matches NL (Netherlands)\", function () {",
+ " pm.expect(country).to.equal(\"NL\");",
+ "});",
+ "",
+ "var country1 = jsonData.shipping.address.country;",
+ "",
+ "// Check if the country is \"NL\"",
+ "pm.test(\"[POST]::/payments/:id -Content Check if shipping 'Country' matches NL (Netherlands)\", function () {",
+ " pm.expect(country1).to.equal(\"NL\");",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"currency\":\"EUR\",\"shipping\":{\"address\":{\"line1\":\"1468\",\"line2\":\"Koramangala \",\"line3\":\"Koramangala \",\"city\":\"Bangalore\",\"state\":\"Karnataka\",\"zip\":\"560065\",\"country\":\"NL\",\"first_name\":\"Preeetam\",\"last_name\":\"Rev\"},\"phone\":{\"number\":\"8796455689\",\"country_code\":\"+91\"}},\"billing\":{\"address\":{\"line1\":\"1468\",\"line2\":\"Koramangala \",\"line3\":\"Koramangala \",\"city\":\"Bangalore\",\"state\":\"Karnataka\",\"zip\":\"560065\",\"country\":\"NL\",\"first_name\":\"Preeetam\",\"last_name\":\"Rev\"},\"phone\":{\"number\":\"8796455689\",\"country_code\":\"+91\"}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}"
+ }
+ ]
+ },
+ "description": "To update the properties of a PaymentIntent object. This may include attaching a payment method, or attaching customer object or metadata fields after the Payment is created "
+ },
+ "response": []
+ },
+ {
+ "name": "List Payment Methods for a Merchant-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "",
+ "// Parse the response body as JSON",
+ "var responseBody = pm.response.json();",
+ "",
+ "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"card\"",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'card'\", function () {",
+ " var paymentMethods = responseBody.payment_methods;",
+ " var cardPaymentMethod = paymentMethods.find(function (method) {",
+ " return method.payment_method == \"card\";",
+ " });",
+ "});",
+ "",
+ "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"ideal\"",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id - Content Check if payment_method matches 'ideal'\", function () {",
+ " var paymentMethods = responseBody.payment_methods;",
+ " var cardPaymentMethod = paymentMethods.find(function (method) {",
+ " return method.payment_method == \"ideal\";",
+ " });",
+ "});",
+ "",
+ "// Check if \"payment_methods\" array contains a \"payment_method\" with the value \"bank_redirect\"",
+ "pm.test(\"[GET]::/payment_methods/:merchant_id -Content Check if payment_method matches 'bank_redirect'\", function () {",
+ " var paymentMethods = responseBody.payment_methods;",
+ " var cardPaymentMethod = paymentMethods.find(function (method) {",
+ " return method.payment_method == \"bank_redirect\";",
+ " });",
+ "});"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ },
+ {
+ "key": "x-feature",
+ "value": "router-custom",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "client_secret",
+ "value": "{{client_secret}}"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular merchant id."
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments/:id/confirm - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "//// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\", function() {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ "})};",
+ "",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"ideal\",\"payment_method_data\":{\"bank_redirect\":{\"ideal\":{\"billing_details\":{\"billing_name\":\"Example\",\"email\":\"[email protected]\"},\"bank_name\":\"ing\"}}},\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"125.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"multi_use\":{\"amount\":7000,\"currency\":\"USD\",\"start_date\":\"2023-04-21T00:00:00Z\",\"end_date\":\"2023-05-21T00:00:00Z\",\"metadata\":{\"frequency\":\"13\"}}}},\"setup_future_usage\":\"off_session\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"128.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ "pm.test(\"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\", function() {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ "})};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario23- Update Amount",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set customer_id as variable for jsonData.customer_id",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\", function() {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ "})};",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Update",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "",
+ "// Parse the JSON response",
+ "var jsonData = pm.response.json();",
+ "",
+ "// Check if the 'amount' is equal to \"1000\"",
+ "pm.test(\"[POST]::/payments/:id -Content Check if 'amount' matches '1000' \", function () {",
+ " pm.expect(jsonData.amount).to.eql(1000);",
+ "});",
+ "",
+ "",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}"
+ }
+ ]
+ },
+ "description": "To update the properties of a PaymentIntent object. This may include attaching a payment method, or attaching customer object or metadata fields after the Payment is created "
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments/:id/confirm - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "//// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\", function() {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ "})};",
+ "",
+ "",
+ "// Check if the 'amount' is equal to \"1000\"",
+ "pm.test(\"[POST]::/payments/:id -Content Check if 'amount' matches '1000' \", function () {",
+ " pm.expect(jsonData.amount).to.eql(1000);",
+ "});",
+ "",
+ "//// Response body should have value \"amount_received\" for \"1000\"",
+ "if (jsonData?.amount_received) {",
+ "pm.test(\"[POST]::/payments - Content check if value for 'amount_received' matches '1000'\", function() {",
+ " pm.expect(jsonData.amount_received).to.eql(1000);",
+ "})};",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ },
+ {
+ "key": "x-feature",
+ "value": "router-custom",
+ "type": "text",
+ "disabled": true
+ },
+ {
+ "key": "publishable_key",
+ "value": "",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"setup_future_usage\":\"off_session\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"128.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "//// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ "pm.test(\"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\", function() {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ "})};",
+ "",
+ "",
+ "// Check if the 'amount' is equal to \"1000\"",
+ "pm.test(\"[POST]::/payments/:id -Content Check if 'amount' matches '1000' \", function () {",
+ " pm.expect(jsonData.amount).to.eql(1000);",
+ "});",
+ "",
+ "//// Response body should have value \"amount_received\" for \"1000\"",
+ "if (jsonData?.amount_received) {",
+ "pm.test(\"[POST]::/payments - Content check if value for 'amount_received' matches '1000'\", function() {",
+ " pm.expect(jsonData.amount_received).to.eql(1000);",
+ "})};",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario24-Add card flow",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(\"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\", function() {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " })};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"stripesavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4111111111111111\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"737\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "List payment methods for a Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
+ " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":customer_id",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"737\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create Copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario25-Don't Pass CVV for save card flow and verifysuccess payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"stripesavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "List payment methods for a Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
+ " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":customer_id",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"adyen\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(\"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\", function() {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " })};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario26-Save card payment with manual capture",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"adyensavecard_{{random_number}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"371449635398431\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"7373\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ "});",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "List payment methods for a Customer",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payment_methods/:customer_id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "if (jsonData?.customer_payment_methods[0]?.payment_token) {",
+ " pm.collectionVariables.set(\"payment_token\", jsonData.customer_payment_methods[0].payment_token);",
+ " console.log(\"- use {{payment_token}} as collection variable for value\", jsonData.customer_payment_methods[0].payment_token);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_token}}, as jsonData.customer_payment_methods[0].payment_token is undefined.');",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/customers/:customer_id/payment_methods",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "customers",
+ ":customer_id",
+ "payment_methods"
+ ],
+ "query": [
+ {
+ "key": "accepted_country",
+ "value": "co",
+ "disabled": true
+ },
+ {
+ "key": "accepted_country",
+ "value": "pa",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "voluptate ea",
+ "disabled": true
+ },
+ {
+ "key": "accepted_currency",
+ "value": "exercitation",
+ "disabled": true
+ },
+ {
+ "key": "minimum_amount",
+ "value": "100",
+ "disabled": true
+ },
+ {
+ "key": "maximum_amount",
+ "value": "10000000",
+ "disabled": true
+ },
+ {
+ "key": "recurring_payment_enabled",
+ "value": "true",
+ "disabled": true
+ },
+ {
+ "key": "installment_payment_enabled",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "customer_id",
+ "value": "{{customer_id}}",
+ "description": "//Pass the customer id"
+ }
+ ]
+ },
+ "description": "To filter and list the applicable payment methods for a particular Customer ID"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx ",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");",
+ "});",
+ "",
+ "// Validate if response has JSON Body ",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {jsonData = pm.response.json();}catch(e){}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"- use {{payment_id}} as collection variable for value\",jsonData.payment_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.');",
+ "};",
+ "",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(\"- use {{mandate_id}} as collection variable for value\",jsonData.mandate_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.');",
+ "};",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(\"- use {{client_secret}} as collection variable for value\",jsonData.client_secret);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.');",
+ "};",
+ "",
+ "if (jsonData?.customer_id) {",
+ " pm.collectionVariables.set(\"customer_id\", jsonData.customer_id);",
+ " console.log(\"- use {{customer_id}} as collection variable for value\",jsonData.customer_id);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{customer_id}}, as jsonData.customer_id is undefined.');",
+ "};"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"{{customer_id}}\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://google.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Save card payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'stripe'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"card\",\"payment_token\":\"{{payment_token}}\",\"card_cvc\":\"7373\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ "});",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount_capturable) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":6540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve-copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ "});",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create Copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Validate the connector",
+ "pm.test(\"[POST]::/payments - connector\", function () {",
+ " pm.expect(jsonData.connector).to.eql(\"stripe\");",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve Copy",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario27-Create payment without customer_id and with billing address and shipping address",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "name": "Variation Cases",
+ "item": [
+ {
+ "name": "Scenario10-Refund exceeds amount captured",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'partially_captured'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"partially_captured\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6000);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'partially_captured'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"partially_captured\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"The refund amount exceeds the amount captured\" for \"error message\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.message' matches 'The refund amount exceeds the amount captured'\",",
+ " function () {",
+ " pm.expect(jsonData.error.message).to.eql(\"The refund amount exceeds the amount captured\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario1-Create payment with Invalid card details",
+ "item": [
+ {
+ "name": "Payments - Create(Invalid card number)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'connector_error'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"connector_error\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"123456\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"united states\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"united states\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create(Invalid Exp month)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"2023\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create(Invalid Exp Year)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"connector error\" for \"error message\"",
+ "if (jsonData?.error?.message) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.message' matches 'Invalid Expiry Year'\",",
+ " function () {",
+ " pm.expect(jsonData.error.message).to.eql(\"Invalid Expiry Year\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"2022\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create(invalid CVV)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'connector'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"connector\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"123456\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"12345\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2-Confirming the payment without PMD",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario3-Capture greater amount",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario4-Capture the succeeded payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario5-Void the success_slash_failure payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Cancel",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments/:id/cancel - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"cancellation_reason\":\"requested_by_customer\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/cancel",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "cancel"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario6-Create 3DS payment with greater capture",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4000000000003063\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":7540,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario7-Refund exceeds amount",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":7000,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario8-Refund for unsuccessful payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario9-Create a recurring payment with greater mandate amount",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"setup_future_usage\":\"off_session\",\"mandate_data\":{\"customer_acceptance\":{\"acceptance_type\":\"offline\",\"accepted_at\":\"1963-05-03T04:07:52.723Z\",\"online\":{\"ip_address\":\"127.0.0.1\",\"user_agent\":\"amet irure esse\"}},\"mandate_type\":{\"single_use\":{\"amount\":7000,\"currency\":\"USD\"}}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have \"mandate_data\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'mandate_data' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.mandate_data !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Recurring Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":8040,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"mandate_id\":\"{{mandate_id}}\",\"off_session\":true,\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "info": {
+ "_postman_id": "a553df38-fa33-4522-b029-1cd32821730e",
+ "name": "Stripe Postman Collection",
+ "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [[email protected]](mailto:[email protected])",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
+ "_exporter_id": "24206034"
+ },
+ "variable": [
+ {
+ "key": "baseUrl",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "admin_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "merchant_id",
+ "value": ""
+ },
+ {
+ "key": "payment_id",
+ "value": ""
+ },
+ {
+ "key": "customer_id",
+ "value": ""
+ },
+ {
+ "key": "mandate_id",
+ "value": ""
+ },
+ {
+ "key": "payment_method_id",
+ "value": ""
+ },
+ {
+ "key": "refund_id",
+ "value": ""
+ },
+ {
+ "key": "merchant_connector_id",
+ "value": ""
+ },
+ {
+ "key": "client_secret",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "publishable_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "payment_token",
+ "value": ""
+ },
+ {
+ "key": "gateway_merchant_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate_keys",
+ "value": "",
+ "type": "string"
+ }
+ ]
+}
diff --git a/postman/collection-json/trustpay.postman_collection.json b/postman/collection-json/trustpay.postman_collection.json
index f1895e3f2ce..cacc015851d 100644
--- a/postman/collection-json/trustpay.postman_collection.json
+++ b/postman/collection-json/trustpay.postman_collection.json
@@ -1,7053 +1,6420 @@
{
- "info": {
- "_postman_id": "f68d69cc-3a9d-4da4-9a00-a7f5ce185737",
- "name": "trustpay",
- "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [[email protected]](mailto:[email protected])",
- "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
- "_exporter_id": "27028646"
- },
- "item": [
- {
- "name": "Health check",
- "item": [
- {
- "name": "New Request",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "x-feature",
- "value": "router-custom",
- "type": "text",
- "disabled": true
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/health",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "health"
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "Flow Testcases",
- "item": [
- {
- "name": "QuickStart",
- "item": [
- {
- "name": "Merchant Account - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
- "if (jsonData?.merchant_id) {",
- " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
- " console.log(",
- " \"- use {{merchant_id}} as collection variable for value\",",
- " jsonData.merchant_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
- " );",
- "}",
- "",
- "/*",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(\"- use {{api_key}} as collection variable for value\",jsonData.api_key);",
- "} else {",
- " console.log('INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.');",
- "};",
- "*/",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}],\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com/success\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/accounts",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts"
- ]
- },
- "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
- },
- "response": []
- },
- {
- "name": "API Key - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
- },
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Payment Connector - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"connector_type\":\"payment_processor\",\"connector_name\":\"trustpay\",\"connector_account_details\":{\"auth_type\":\"SignatureKey\",\"api_key\":\"{{connector_api_key}}\",\"key1\":\"{{connector_key1}}\",\"api_secret\":\"{{connector_api_secret}}\"},\"test_mode\":false,\"disabled\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"payment_methods_enabled\":[{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"ideal\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"giropay\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"debit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}]}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
- },
- "response": []
- },
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5200000000001005\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Happy Cases",
- "item": [
- {
- "name": "Scenario2a-Create payment with confirm false card holder name empty",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2b-Create payment with confirm false card holder name null",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":null,\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario3-Create payment without PMD",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario4-Create 3DS payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"EUR\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"5200000000000015\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"something\",\"card_cvc\":\"737\",\"card_issuer\":\"\",\"card_network\":\"Visa\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36\",\"accept_header\":\"text\\\\/html,application\\\\/xhtml+xml,application\\\\/xml;q=0.9,image\\\\/webp,image\\\\/apng,*\\\\/*;q=0.8\",\"language\":\"en-GB\",\"color_depth\":30,\"screen_height\":1117,\"screen_width\":1728,\"time_zone\":-330,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"65.1.52.138\"},\"return_url\":\"https://integ.hyperswitch.io\",\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario5-Create 3DS payment with confrm false",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":65400,\"currency\":\"USD\",\"capture_method\":\"automatic\",\"confirm\":false,\"amount_to_capture\":65400,\"customer_id\":\"hyperswitchCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://github.com/pixincreate\",\"business_country\":\"US\",\"business_label\":\"default\",\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"1234567890\",\"country_code\":\"+1\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"945122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"1234567890\",\"country_code\":\"+1\"}},\"metadata\":{\"order_details\":{\"product_name\":\"Apple iphone 15\",\"quantity\":1,\"amount\":65400}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"return_url\":\"https://integ.hyperswitch.io/home\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"5200000000000015\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"John Doe\",\"card_cvc\":\"737\",\"card_issuer\":\"\",\"card_network\":\"Visa\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36\",\"accept_header\":\"text\\\\/html,application\\\\/xhtml+xml,application\\\\/xml;q=0.9,image\\\\/webp,image\\\\/apng,*\\\\/*;q=0.8\",\"language\":\"en-GB\",\"color_depth\":30,\"ip_address\":\"65.1.52.138\",\"screen_height\":1117,\"screen_width\":1728,\"time_zone\":-330,\"java_enabled\":true,\"java_script_enabled\":true}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario6-Refund full payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/refunds/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{refund_id}}",
- "description": "(Required) unique refund id"
- }
- ]
- },
- "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario7-Bank Redirect-Ideal",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"ideal\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ideal'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"ideal\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'trustpay'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"trustpay\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"ideal\",\"payment_method_data\":{\"bank_redirect\":{\"ideal\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario8-Bank Redirect-giropay",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- "",
- "// Response body should have value \"giropay\" for \"payment_method_type\"",
- "if (jsonData?.payment_method_type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'giropay'\",",
- " function () {",
- " pm.expect(jsonData.payment_method_type).to.eql(\"giropay\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"stripe\" for \"connector\"",
- "if (jsonData?.connector) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'trustpay'\",",
- " function () {",
- " pm.expect(jsonData.connector).to.eql(\"trustpay\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"giropay\",\"payment_method_data\":{\"bank_redirect\":{\"giropay\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"\",\"preferred_language\":\"en\",\"country\":\"DE\"}}}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_customer_action\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true",
- "disabled": true
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario1-Create payment with confirm true",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2-Create payment with confirm false",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"Joseph Doe\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario9-Create PM list for eps dynamic fields",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"AT\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for Merchants",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- " ",
- "pm.test(",
- " \"[GET]::/payments/:id - EPS required field contains 'billing.address.first_name'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"eps\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.first_name\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "pm.test(",
- " \"[GET]::/payments/:id - EPS required field contains 'billing.address.country'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"eps\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.country\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "pm.test(",
- " \"[GET]::/payments/:id - EPS required field contains 'billing.address.zip'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"eps\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.zip\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "pm.test(",
- " \"[GET]::/payments/:id - EPS required field contains 'billing.address.city'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"eps\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.city\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- " pm.test(",
- " \"[GET]::/payments/:id - EPS required field contains 'billing.address.line1'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"eps\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.line1\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- "payment_methods"
- ],
- "query": [
- {
- "key": "client_secret",
- "value": "{{client_secret}}"
- }
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario9-Create PM list for ideal dynamic fields",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"NL\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"NL\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "List payment methods for Merchants",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- " ",
- "pm.test(",
- " \"[GET]::/payments/:id - Ideal required field contains 'billing.address.first_name'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"ideal\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.first_name\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "pm.test(",
- " \"[GET]::/payments/:id - Ideal required field contains 'billing.address.country'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"ideal\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.country\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "pm.test(",
- " \"[GET]::/payments/:id - Ideal required field contains 'billing.address.zip'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"ideal\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.zip\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- "pm.test(",
- " \"[GET]::/payments/:id - Ideal required field contains 'billing.address.city'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"ideal\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.city\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- " pm.test(",
- " \"[GET]::/payments/:id - Ideal required field contains 'billing.address.line1'\",",
- " function () {",
- " pm.expect(",
- " jsonData?.payment_methods &&",
- " jsonData.payment_methods.some(",
- " (method) =>",
- " method.payment_method === \"bank_redirect\" &&",
- " method.payment_method_types &&",
- " method.payment_method_types.some(",
- " (type) =>",
- " type.payment_method_type === \"ideal\" &&",
- " type.required_fields &&",
- " type.required_fields[\"billing.address.line1\"]",
- " )",
- " )",
- ").to.eql(true);",
- " }",
- " );",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- "payment_methods"
- ],
- "query": [
- {
- "key": "client_secret",
- "value": "{{client_secret}}"
- }
- ]
- }
- },
- "response": []
- }
- ]
- }
- ]
- },
- {
- "name": "Variation Cases",
- "item": [
- {
- "name": "Scenario5-Refund for unsuccessful payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"invalid_request\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario1-Create payment with Invalid card details",
- "item": [
- {
- "name": "Payments - Create(Invalid card number)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'connector_error'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"connector_error\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"12345\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Create(Invalid Exp month)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"19\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Create(Invalid",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"next_action.redirect_to_url\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"12\",\"card_exp_year\":\"2022\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Create(invalid CVV)",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- "});",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"12\",\"card_exp_year\":\"2022\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"1234\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2-Confirming the payment without PMD",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario3-Capture the succeeded payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario4-Refund exceeds amount",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"Succeeded\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"succeeded\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- },
- {
- "name": "Refunds - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 4xx",
- "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
- " pm.response.to.be.error;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
- "if (jsonData?.refund_id) {",
- " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
- " console.log(",
- " \"- use {{refund_id}} as collection variable for value\",",
- " jsonData.refund_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"error\"",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
- " },",
- ");",
- "",
- "// Response body should have value \"connector error\" for \"error type\"",
- "if (jsonData?.error?.type) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
- " function () {",
- " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":7000,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/refunds",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "refunds"
- ]
- },
- "description": "To create a refund against an already processed payment"
- },
- "response": []
- }
- ]
- }
- ]
- }
- ]
- }
- ],
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "type": "text/javascript",
- "exec": [
- ""
- ]
- }
- },
- {
- "listen": "test",
- "script": {
- "type": "text/javascript",
- "exec": [
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);",
- "}",
- "",
- "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));",
- ""
- ]
- }
- }
- ],
- "variable": [
- {
- "key": "baseUrl",
- "value": "",
- "type": "string"
- },
- {
- "key": "admin_api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "merchant_id",
- "value": ""
- },
- {
- "key": "payment_id",
- "value": ""
- },
- {
- "key": "customer_id",
- "value": ""
- },
- {
- "key": "mandate_id",
- "value": ""
- },
- {
- "key": "payment_method_id",
- "value": ""
- },
- {
- "key": "refund_id",
- "value": ""
- },
- {
- "key": "merchant_connector_id",
- "value": ""
- },
- {
- "key": "client_secret",
- "value": "",
- "type": "string"
- },
- {
- "key": "connector_api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "publishable_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "api_key_id",
- "value": "",
- "type": "string"
- },
- {
- "key": "payment_token",
- "value": ""
- },
- {
- "key": "gateway_merchant_id",
- "value": "",
- "type": "string"
- },
- {
- "key": "certificate",
- "value": "",
- "type": "string"
- },
- {
- "key": "certificate_keys",
- "value": "",
- "type": "string"
- },
- {
- "key": "connector_key1",
- "value": "",
- "type": "string"
- },
- {
- "key": "connector_api_secret",
- "value": "",
- "type": "string"
- }
- ]
-}
\ No newline at end of file
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);",
+ "}",
+ "",
+ "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "item": [
+ {
+ "name": "Health check",
+ "item": [
+ {
+ "name": "New Request",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "x-feature",
+ "value": "router-custom",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/health",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "health"
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Flow Testcases",
+ "item": [
+ {
+ "name": "QuickStart",
+ "item": [
+ {
+ "name": "Merchant Account - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
+ " console.log(",
+ " \"- use {{merchant_id}} as collection variable for value\",",
+ " jsonData.merchant_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "/*",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(\"- use {{api_key}} as collection variable for value\",jsonData.api_key);",
+ "} else {",
+ " console.log('INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.');",
+ "};",
+ "*/",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}],\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com/success\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts"
+ ]
+ },
+ "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
+ },
+ "response": []
+ },
+ {
+ "name": "API Key - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"payment_processor\",\"connector_name\":\"trustpay\",\"connector_account_details\":{\"auth_type\":\"SignatureKey\",\"api_key\":\"{{connector_api_key}}\",\"key1\":\"{{connector_key1}}\",\"api_secret\":\"{{connector_api_secret}}\"},\"test_mode\":false,\"disabled\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"payment_methods_enabled\":[{\"payment_method\":\"bank_redirect\",\"payment_method_types\":[{\"payment_method_type\":\"ideal\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"giropay\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"sofort\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"eps\",\"payment_experience\":null,\"card_networks\":null,\"accepted_currencies\":null,\"accepted_countries\":null,\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"debit\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]},{\"payment_method\":\"wallet\",\"payment_method_types\":[{\"payment_method_type\":\"apple_pay\",\"payment_experience\":\"invoke_sdk_client\",\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}]}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5200000000001005\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":600,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Happy Cases",
+ "item": [
+ {
+ "name": "Scenario2a-Create payment with confirm false card holder name empty",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2b-Create payment with confirm false card holder name null",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":null,\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario3-Create payment without PMD",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario4-Create 3DS payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"EUR\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"5200000000000015\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"something\",\"card_cvc\":\"737\",\"card_issuer\":\"\",\"card_network\":\"Visa\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36\",\"accept_header\":\"text\\\\/html,application\\\\/xhtml+xml,application\\\\/xml;q=0.9,image\\\\/webp,image\\\\/apng,*\\\\/*;q=0.8\",\"language\":\"en-GB\",\"color_depth\":30,\"screen_height\":1117,\"screen_width\":1728,\"time_zone\":-330,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"65.1.52.138\"},\"return_url\":\"https://integ.hyperswitch.io\",\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario5-Create 3DS payment with confrm false",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":65400,\"currency\":\"USD\",\"capture_method\":\"automatic\",\"confirm\":false,\"amount_to_capture\":65400,\"customer_id\":\"hyperswitchCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://github.com/pixincreate\",\"business_country\":\"US\",\"business_label\":\"default\",\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"1234567890\",\"country_code\":\"+1\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"945122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"1234567890\",\"country_code\":\"+1\"}},\"metadata\":{\"order_details\":{\"product_name\":\"Apple iphone 15\",\"quantity\":1,\"amount\":65400}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"return_url\":\"https://integ.hyperswitch.io/home\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"5200000000000015\",\"card_exp_month\":\"03\",\"card_exp_year\":\"2030\",\"card_holder_name\":\"John Doe\",\"card_cvc\":\"737\",\"card_issuer\":\"\",\"card_network\":\"Visa\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36\",\"accept_header\":\"text\\\\/html,application\\\\/xhtml+xml,application\\\\/xml;q=0.9,image\\\\/webp,image\\\\/apng,*\\\\/*;q=0.8\",\"language\":\"en-GB\",\"color_depth\":30,\"ip_address\":\"65.1.52.138\",\"screen_height\":1117,\"screen_width\":1728,\"time_zone\":-330,\"java_enabled\":true,\"java_script_enabled\":true}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario6-Refund full payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/refunds - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":6540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/refunds/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/refunds/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/refunds - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/refunds/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{refund_id}}",
+ "description": "(Required) unique refund id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Refund. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario7-Bank Redirect-Ideal",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"ideal\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'ideal'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"ideal\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'trustpay'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"trustpay\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"ideal\",\"payment_method_data\":{\"bank_redirect\":{\"ideal\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"ing\",\"preferred_language\":\"en\",\"country\":\"DE\"}}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario8-Bank Redirect-giropay",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":1000,\"currency\":\"EUR\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1000,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"first_name\":\"John\",\"last_name\":\"Doe\",\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"DE\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"127.0.0.1\"},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"John\",\"last_name\":\"Doe\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'next_action.redirect_to_url' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.next_action.redirect_to_url !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"giropay\" for \"payment_method_type\"",
+ "if (jsonData?.payment_method_type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'payment_method_type' matches 'giropay'\",",
+ " function () {",
+ " pm.expect(jsonData.payment_method_type).to.eql(\"giropay\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"stripe\" for \"connector\"",
+ "if (jsonData?.connector) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'connector' matches 'trustpay'\",",
+ " function () {",
+ " pm.expect(jsonData.connector).to.eql(\"trustpay\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\",\"payment_method\":\"bank_redirect\",\"payment_method_type\":\"giropay\",\"payment_method_data\":{\"bank_redirect\":{\"giropay\":{\"billing_details\":{\"billing_name\":\"John Doe\"},\"bank_name\":\"\",\"preferred_language\":\"en\",\"country\":\"DE\"}}}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_customer_action\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'requires_customer_action'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_customer_action\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true",
+ "disabled": true
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario1-Create payment with confirm true",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2-Create payment with confirm false",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"Joseph Doe\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\",\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "name": "Variation Cases",
+ "item": [
+ {
+ "name": "Scenario5-Refund for unsuccessful payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"invalid_request\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":540,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario1-Create payment with Invalid card details",
+ "item": [
+ {
+ "name": "Payments - Create(Invalid card number)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'connector_error'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"connector_error\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"12345\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create(Invalid Exp month)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"19\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create(Invalid",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"next_action.redirect_to_url\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"12\",\"card_exp_year\":\"2022\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create(invalid CVV)",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(\"[POST]::/payments - Content check if 'error' exists\", function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ "});",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"12\",\"card_exp_year\":\"2022\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"1234\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2-Confirming the payment without PMD",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario3-Capture the succeeded payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":7000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario4-Refund exceeds amount",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"5100000000000511\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"PiX\"}},\"browser_info\":{\"user_agent\":\"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36\",\"accept_header\":\"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8\",\"language\":\"nl-NL\",\"color_depth\":24,\"screen_height\":723,\"screen_width\":1536,\"time_zone\":0,\"java_enabled\":true,\"java_script_enabled\":true,\"ip_address\":\"125.0.0.1\"},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"Succeeded\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'succeeded'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"succeeded\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Refunds - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 4xx",
+ "pm.test(\"[POST]::/refunds - Status code is 4xx\", function () {",
+ " pm.response.to.be.error;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/refunds - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set refund_id as variable for jsonData.payment_id",
+ "if (jsonData?.refund_id) {",
+ " pm.collectionVariables.set(\"refund_id\", jsonData.refund_id);",
+ " console.log(",
+ " \"- use {{refund_id}} as collection variable for value\",",
+ " jsonData.refund_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{refund_id}}, as jsonData.refund_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"error\"",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if 'error' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.error !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ "",
+ "// Response body should have value \"connector error\" for \"error type\"",
+ "if (jsonData?.error?.type) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'error.type' matches 'invalid_request'\",",
+ " function () {",
+ " pm.expect(jsonData.error.type).to.eql(\"invalid_request\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_id\":\"{{payment_id}}\",\"amount\":7000,\"reason\":\"Customer returned product\",\"refund_type\":\"instant\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/refunds",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "refunds"
+ ]
+ },
+ "description": "To create a refund against an already processed payment"
+ },
+ "response": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "info": {
+ "_postman_id": "79d4c0d8-454e-45a4-a4ae-749bd9bccb22",
+ "name": "trustpay",
+ "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [[email protected]](mailto:[email protected])",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+ },
+ "variable": [
+ {
+ "key": "baseUrl",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "admin_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "merchant_id",
+ "value": ""
+ },
+ {
+ "key": "payment_id",
+ "value": ""
+ },
+ {
+ "key": "customer_id",
+ "value": ""
+ },
+ {
+ "key": "mandate_id",
+ "value": ""
+ },
+ {
+ "key": "payment_method_id",
+ "value": ""
+ },
+ {
+ "key": "refund_id",
+ "value": ""
+ },
+ {
+ "key": "merchant_connector_id",
+ "value": ""
+ },
+ {
+ "key": "client_secret",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "publishable_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "payment_token",
+ "value": ""
+ },
+ {
+ "key": "gateway_merchant_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate_keys",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_key1",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_api_secret",
+ "value": "",
+ "type": "string"
+ }
+ ]
+}
|
chore
|
update Postman collection files
|
7375b866a2a2767df2f213bc9eb61268392fb60d
|
2024-03-07 13:37:18
|
Mani Chandra
|
fix(users): revert using mget in authorization (#3999)
| false
|
diff --git a/crates/router/src/services/authentication/blacklist.rs b/crates/router/src/services/authentication/blacklist.rs
index b5cdcaf0840..2ee8302be63 100644
--- a/crates/router/src/services/authentication/blacklist.rs
+++ b/crates/router/src/services/authentication/blacklist.rs
@@ -80,25 +80,19 @@ pub async fn check_user_in_blacklist<A: AppStateInfo>(
.map(|timestamp| timestamp.map_or(false, |timestamp| timestamp > token_issued_at))
}
-pub async fn check_user_and_role_in_blacklist<A: AppStateInfo>(
+pub async fn check_role_in_blacklist<A: AppStateInfo>(
state: &A,
- user_id: &str,
role_id: &str,
token_expiry: u64,
) -> RouterResult<bool> {
- let user_token = format!("{}{}", USER_BLACKLIST_PREFIX, user_id);
- let role_token = format!("{}{}", ROLE_BLACKLIST_PREFIX, role_id);
+ let token = format!("{}{}", ROLE_BLACKLIST_PREFIX, role_id);
let token_issued_at = expiry_to_i64(token_expiry - JWT_TOKEN_TIME_IN_SECS)?;
let redis_conn = get_redis_connection(state)?;
-
- Ok(redis_conn
- .get_multiple_keys::<Vec<&str>, i64>(vec![user_token.as_str(), role_token.as_str()])
+ redis_conn
+ .get_key::<Option<i64>>(token.as_str())
.await
- .change_context(ApiErrorResponse::InternalServerError)?
- .into_iter()
- .max()
- .flatten()
- .map_or(false, |timestamp| timestamp > token_issued_at))
+ .change_context(ApiErrorResponse::InternalServerError)
+ .map(|timestamp| timestamp.map_or(false, |timestamp| timestamp > token_issued_at))
}
#[cfg(feature = "email")]
@@ -156,7 +150,10 @@ impl BlackList for AuthToken {
where
A: AppStateInfo + Sync,
{
- check_user_and_role_in_blacklist(state, &self.user_id, &self.role_id, self.exp).await
+ Ok(
+ check_user_in_blacklist(state, &self.user_id, self.exp).await?
+ || check_role_in_blacklist(state, &self.role_id, self.exp).await?,
+ )
}
}
|
fix
|
revert using mget in authorization (#3999)
|
b90ae90c668d4134d526f05d2cc7f988a11ed496
|
2024-08-27 11:37:23
|
Mudit Bhutani
|
feat(user): business email update (#5674)
| false
|
diff --git a/crates/router/src/consts/user.rs b/crates/router/src/consts/user.rs
index 18fdf0dcbe6..1a2b2ef60a4 100644
--- a/crates/router/src/consts/user.rs
+++ b/crates/router/src/consts/user.rs
@@ -5,7 +5,7 @@ pub const MAX_NAME_LENGTH: usize = 70;
/// The max length of company name and merchant should be same
/// because we are deriving the merchant name from company name
pub const MAX_COMPANY_NAME_LENGTH: usize = MAX_ALLOWED_MERCHANT_NAME_LENGTH;
-pub const BUSINESS_EMAIL: &str = "[email protected]";
+pub const BUSINESS_EMAIL: &str = "[email protected]";
pub const RECOVERY_CODES_COUNT: usize = 8;
pub const RECOVERY_CODE_LENGTH: usize = 8; // This is without counting the hyphen in between
|
feat
|
business email update (#5674)
|
0ab0aa1a94fe98719d51ff89d27935a30cb33721
|
2024-08-13 22:18:56
|
Sagnik Mitra
|
feat(connector): create Taxjar connector (#5597)
| false
|
diff --git a/config/config.example.toml b/config/config.example.toml
index cd315a542de..ebadc9edae7 100644
--- a/config/config.example.toml
+++ b/config/config.example.toml
@@ -246,6 +246,7 @@ square.base_url = "https://connect.squareupsandbox.com/"
square.secondary_base_url = "https://pci-connect.squareupsandbox.com/"
stax.base_url = "https://apiprod.fattlabs.com/"
stripe.base_url = "https://api.stripe.com/"
+taxjar.base_url = "https://api.sandbox.taxjar.com/v2/"
threedsecureio.base_url = "https://service.sandbox.3dsecure.io"
stripe.base_url_file_upload = "https://files.stripe.com/"
trustpay.base_url = "https://test-tpgw.trustpay.eu/"
diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml
index 1e829e81cfe..84652e11b0a 100644
--- a/config/deployments/integration_test.toml
+++ b/config/deployments/integration_test.toml
@@ -86,6 +86,7 @@ square.secondary_base_url = "https://pci-connect.squareupsandbox.com/"
stax.base_url = "https://apiprod.fattlabs.com/"
stripe.base_url = "https://api.stripe.com/"
stripe.base_url_file_upload = "https://files.stripe.com/"
+taxjar.base_url = "https://api.sandbox.taxjar.com/v2/"
trustpay.base_url = "https://test-tpgw.trustpay.eu/"
trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/"
tsys.base_url = "https://stagegw.transnox.com/"
diff --git a/config/deployments/production.toml b/config/deployments/production.toml
index 762ecdc96cd..b27f3696e30 100644
--- a/config/deployments/production.toml
+++ b/config/deployments/production.toml
@@ -90,6 +90,7 @@ square.secondary_base_url = "https://pci-connect.squareupsandbox.com/"
stax.base_url = "https://apiprod.fattlabs.com/"
stripe.base_url = "https://api.stripe.com/"
stripe.base_url_file_upload = "https://files.stripe.com/"
+taxjar.base_url = "https://api.taxjar.com/v2/"
trustpay.base_url = "https://tpgw.trustpay.eu/"
trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/"
tsys.base_url = "https://gateway.transit-pass.com/"
diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml
index 8b1335b0c55..669daa10162 100644
--- a/config/deployments/sandbox.toml
+++ b/config/deployments/sandbox.toml
@@ -90,6 +90,7 @@ square.secondary_base_url = "https://pci-connect.squareupsandbox.com/"
stax.base_url = "https://apiprod.fattlabs.com/"
stripe.base_url = "https://api.stripe.com/"
stripe.base_url_file_upload = "https://files.stripe.com/"
+taxjar.base_url = "https://api.sandbox.taxjar.com/v2/"
trustpay.base_url = "https://test-tpgw.trustpay.eu/"
trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/"
tsys.base_url = "https://stagegw.transnox.com/"
diff --git a/config/development.toml b/config/development.toml
index dcb627d7e91..8facb9e803b 100644
--- a/config/development.toml
+++ b/config/development.toml
@@ -150,6 +150,7 @@ cards = [
"square",
"stax",
"stripe",
+ "taxjar",
"threedsecureio",
"trustpay",
"tsys",
@@ -249,6 +250,7 @@ square.base_url = "https://connect.squareupsandbox.com/"
square.secondary_base_url = "https://pci-connect.squareupsandbox.com/"
stax.base_url = "https://apiprod.fattlabs.com/"
stripe.base_url = "https://api.stripe.com/"
+taxjar.base_url = "https://api.sandbox.taxjar.com/v2/"
threedsecureio.base_url = "https://service.sandbox.3dsecure.io"
stripe.base_url_file_upload = "https://files.stripe.com/"
wise.base_url = "https://api.sandbox.transferwise.tech/"
diff --git a/config/docker_compose.toml b/config/docker_compose.toml
index 8ba38fcf8e0..41f9cf6cfaf 100644
--- a/config/docker_compose.toml
+++ b/config/docker_compose.toml
@@ -175,6 +175,7 @@ square.base_url = "https://connect.squareupsandbox.com/"
square.secondary_base_url = "https://pci-connect.squareupsandbox.com/"
stax.base_url = "https://apiprod.fattlabs.com/"
stripe.base_url = "https://api.stripe.com/"
+taxjar.base_url = "https://api.sandbox.taxjar.com/v2/"
threedsecureio.base_url = "https://service.sandbox.3dsecure.io"
stripe.base_url_file_upload = "https://files.stripe.com/"
trustpay.base_url = "https://test-tpgw.trustpay.eu/"
@@ -252,6 +253,7 @@ cards = [
"square",
"stax",
"stripe",
+ "taxjar",
"threedsecureio",
"trustpay",
"tsys",
diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs
index 0b2d88ee296..06ac98f59d3 100644
--- a/crates/api_models/src/enums.rs
+++ b/crates/api_models/src/enums.rs
@@ -131,6 +131,7 @@ pub enum Connector {
Square,
Stax,
Stripe,
+ // Taxjar,
Threedsecureio,
Trustpay,
Tsys,
@@ -208,6 +209,7 @@ impl Connector {
| Self::DummyConnector7 => false,
Self::Aci
// Add Separate authentication support for connectors
+ // | Self::Taxjar
// | Self::Fiservemea
| Self::Adyen
| Self::Adyenplatform
diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs
index 2fd8b8447f3..015bf2d6c68 100644
--- a/crates/common_enums/src/enums.rs
+++ b/crates/common_enums/src/enums.rs
@@ -245,6 +245,7 @@ pub enum RoutableConnectors {
Square,
Stax,
Stripe,
+ // Taxjar,
Trustpay,
// Tsys,
Tsys,
diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs
index 5f94c780b94..ae0fa945799 100644
--- a/crates/hyperswitch_connectors/src/connectors.rs
+++ b/crates/hyperswitch_connectors/src/connectors.rs
@@ -4,8 +4,9 @@ pub mod fiserv;
pub mod fiservemea;
pub mod helcim;
pub mod stax;
+pub mod taxjar;
pub use self::{
bambora::Bambora, bitpay::Bitpay, fiserv::Fiserv, fiservemea::Fiservemea, helcim::Helcim,
- stax::Stax,
+ stax::Stax, taxjar::Taxjar,
};
diff --git a/crates/hyperswitch_connectors/src/connectors/taxjar.rs b/crates/hyperswitch_connectors/src/connectors/taxjar.rs
new file mode 100644
index 00000000000..3ea453e5285
--- /dev/null
+++ b/crates/hyperswitch_connectors/src/connectors/taxjar.rs
@@ -0,0 +1,563 @@
+pub mod transformers;
+
+use common_utils::{
+ errors::CustomResult,
+ ext_traits::BytesExt,
+ request::{Method, Request, RequestBuilder, RequestContent},
+ types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector},
+};
+use error_stack::{report, ResultExt};
+use hyperswitch_domain_models::{
+ router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData},
+ router_flow_types::{
+ access_token_auth::AccessTokenAuth,
+ payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void},
+ refunds::{Execute, RSync},
+ },
+ router_request_types::{
+ AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData,
+ PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData,
+ RefundsData, SetupMandateRequestData,
+ },
+ router_response_types::{PaymentsResponseData, RefundsResponseData},
+ types::{
+ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData,
+ RefundSyncRouterData, RefundsRouterData,
+ },
+};
+use hyperswitch_interfaces::{
+ api::{self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorValidation},
+ configs::Connectors,
+ errors,
+ events::connector_api_logs::ConnectorEvent,
+ types::{self, Response},
+ webhooks,
+};
+use masking::{ExposeInterface, Mask};
+use transformers as taxjar;
+
+use crate::{constants::headers, types::ResponseRouterData, utils};
+
+#[derive(Clone)]
+pub struct Taxjar {
+ amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync),
+}
+
+impl Taxjar {
+ pub fn new() -> &'static Self {
+ &Self {
+ amount_converter: &StringMinorUnitForConnector,
+ }
+ }
+}
+
+impl api::Payment for Taxjar {}
+impl api::PaymentSession for Taxjar {}
+impl api::ConnectorAccessToken for Taxjar {}
+impl api::MandateSetup for Taxjar {}
+impl api::PaymentAuthorize for Taxjar {}
+impl api::PaymentSync for Taxjar {}
+impl api::PaymentCapture for Taxjar {}
+impl api::PaymentVoid for Taxjar {}
+impl api::Refund for Taxjar {}
+impl api::RefundExecute for Taxjar {}
+impl api::RefundSync for Taxjar {}
+impl api::PaymentToken for Taxjar {}
+
+impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>
+ for Taxjar
+{
+ // Not Implemented (R)
+}
+
+impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Taxjar
+where
+ Self: ConnectorIntegration<Flow, Request, Response>,
+{
+ fn build_headers(
+ &self,
+ req: &RouterData<Flow, Request, Response>,
+ _connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
+ let mut header = vec![(
+ headers::CONTENT_TYPE.to_string(),
+ self.get_content_type().to_string().into(),
+ )];
+ let mut api_key = self.get_auth_header(&req.connector_auth_type)?;
+ header.append(&mut api_key);
+ Ok(header)
+ }
+}
+
+impl ConnectorCommon for Taxjar {
+ fn id(&self) -> &'static str {
+ "taxjar"
+ }
+
+ fn get_currency_unit(&self) -> api::CurrencyUnit {
+ api::CurrencyUnit::Base
+ // TODO! Check connector documentation, on which unit they are processing the currency.
+ // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor,
+ // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base
+ }
+
+ fn common_get_content_type(&self) -> &'static str {
+ "application/json"
+ }
+
+ fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str {
+ connectors.taxjar.base_url.as_ref()
+ }
+
+ fn get_auth_header(
+ &self,
+ auth_type: &ConnectorAuthType,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
+ let auth = taxjar::TaxjarAuthType::try_from(auth_type)
+ .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+ Ok(vec![(
+ headers::AUTHORIZATION.to_string(),
+ auth.api_key.expose().into_masked(),
+ )])
+ }
+
+ fn build_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ let response: taxjar::TaxjarErrorResponse = res
+ .response
+ .parse_struct("TaxjarErrorResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+
+ Ok(ErrorResponse {
+ status_code: res.status_code,
+ code: response.code,
+ message: response.message,
+ reason: response.reason,
+ attempt_status: None,
+ connector_transaction_id: None,
+ })
+ }
+}
+
+impl ConnectorValidation for Taxjar {
+ //TODO: implement functions when support enabled
+}
+
+impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Taxjar {
+ //TODO: implement sessions flow
+}
+
+impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Taxjar {}
+
+impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Taxjar {}
+
+impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Taxjar {
+ fn get_headers(
+ &self,
+ req: &PaymentsAuthorizeRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &PaymentsAuthorizeRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn get_request_body(
+ &self,
+ req: &PaymentsAuthorizeRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<RequestContent, errors::ConnectorError> {
+ let amount = utils::convert_amount(
+ self.amount_converter,
+ req.request.minor_amount,
+ req.request.currency,
+ )?;
+
+ let connector_router_data = taxjar::TaxjarRouterData::from((amount, req));
+ let connector_req = taxjar::TaxjarPaymentsRequest::try_from(&connector_router_data)?;
+ Ok(RequestContent::Json(Box::new(connector_req)))
+ }
+
+ fn build_request(
+ &self,
+ req: &PaymentsAuthorizeRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ Ok(Some(
+ RequestBuilder::new()
+ .method(Method::Post)
+ .url(&types::PaymentsAuthorizeType::get_url(
+ self, req, connectors,
+ )?)
+ .attach_default_headers()
+ .headers(types::PaymentsAuthorizeType::get_headers(
+ self, req, connectors,
+ )?)
+ .set_body(types::PaymentsAuthorizeType::get_request_body(
+ self, req, connectors,
+ )?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &PaymentsAuthorizeRouterData,
+ event_builder: Option<&mut ConnectorEvent>,
+ res: Response,
+ ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> {
+ let response: taxjar::TaxjarPaymentsResponse = res
+ .response
+ .parse_struct("Taxjar PaymentsAuthorizeResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+ RouterData::try_from(ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res, event_builder)
+ }
+}
+
+impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Taxjar {
+ fn get_headers(
+ &self,
+ req: &PaymentsSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &PaymentsSyncRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn build_request(
+ &self,
+ req: &PaymentsSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ Ok(Some(
+ RequestBuilder::new()
+ .method(Method::Get)
+ .url(&types::PaymentsSyncType::get_url(self, req, connectors)?)
+ .attach_default_headers()
+ .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &PaymentsSyncRouterData,
+ event_builder: Option<&mut ConnectorEvent>,
+ res: Response,
+ ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> {
+ let response: taxjar::TaxjarPaymentsResponse = res
+ .response
+ .parse_struct("taxjar PaymentsSyncResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+ RouterData::try_from(ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res, event_builder)
+ }
+}
+
+impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Taxjar {
+ fn get_headers(
+ &self,
+ req: &PaymentsCaptureRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &PaymentsCaptureRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn get_request_body(
+ &self,
+ _req: &PaymentsCaptureRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<RequestContent, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into())
+ }
+
+ fn build_request(
+ &self,
+ req: &PaymentsCaptureRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ Ok(Some(
+ RequestBuilder::new()
+ .method(Method::Post)
+ .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?)
+ .attach_default_headers()
+ .headers(types::PaymentsCaptureType::get_headers(
+ self, req, connectors,
+ )?)
+ .set_body(types::PaymentsCaptureType::get_request_body(
+ self, req, connectors,
+ )?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &PaymentsCaptureRouterData,
+ event_builder: Option<&mut ConnectorEvent>,
+ res: Response,
+ ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> {
+ let response: taxjar::TaxjarPaymentsResponse = res
+ .response
+ .parse_struct("Taxjar PaymentsCaptureResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+ RouterData::try_from(ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res, event_builder)
+ }
+}
+
+impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Taxjar {}
+
+impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Taxjar {
+ fn get_headers(
+ &self,
+ req: &RefundsRouterData<Execute>,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &RefundsRouterData<Execute>,
+ _connectors: &Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn get_request_body(
+ &self,
+ req: &RefundsRouterData<Execute>,
+ _connectors: &Connectors,
+ ) -> CustomResult<RequestContent, errors::ConnectorError> {
+ let refund_amount = utils::convert_amount(
+ self.amount_converter,
+ req.request.minor_refund_amount,
+ req.request.currency,
+ )?;
+
+ let connector_router_data = taxjar::TaxjarRouterData::from((refund_amount, req));
+ let connector_req = taxjar::TaxjarRefundRequest::try_from(&connector_router_data)?;
+ Ok(RequestContent::Json(Box::new(connector_req)))
+ }
+
+ fn build_request(
+ &self,
+ req: &RefundsRouterData<Execute>,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ let request = RequestBuilder::new()
+ .method(Method::Post)
+ .url(&types::RefundExecuteType::get_url(self, req, connectors)?)
+ .attach_default_headers()
+ .headers(types::RefundExecuteType::get_headers(
+ self, req, connectors,
+ )?)
+ .set_body(types::RefundExecuteType::get_request_body(
+ self, req, connectors,
+ )?)
+ .build();
+ Ok(Some(request))
+ }
+
+ fn handle_response(
+ &self,
+ data: &RefundsRouterData<Execute>,
+ event_builder: Option<&mut ConnectorEvent>,
+ res: Response,
+ ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> {
+ let response: taxjar::RefundResponse =
+ res.response
+ .parse_struct("taxjar RefundResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+ RouterData::try_from(ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res, event_builder)
+ }
+}
+
+impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Taxjar {
+ fn get_headers(
+ &self,
+ req: &RefundSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &RefundSyncRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ }
+
+ fn build_request(
+ &self,
+ req: &RefundSyncRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ Ok(Some(
+ RequestBuilder::new()
+ .method(Method::Get)
+ .url(&types::RefundSyncType::get_url(self, req, connectors)?)
+ .attach_default_headers()
+ .headers(types::RefundSyncType::get_headers(self, req, connectors)?)
+ .set_body(types::RefundSyncType::get_request_body(
+ self, req, connectors,
+ )?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &RefundSyncRouterData,
+ event_builder: Option<&mut ConnectorEvent>,
+ res: Response,
+ ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> {
+ let response: taxjar::RefundResponse = res
+ .response
+ .parse_struct("taxjar RefundSyncResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+ RouterData::try_from(ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res, event_builder)
+ }
+}
+
+#[async_trait::async_trait]
+impl webhooks::IncomingWebhook for Taxjar {
+ fn get_webhook_object_reference_id(
+ &self,
+ _request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> {
+ Err(report!(errors::ConnectorError::WebhooksNotImplemented))
+ }
+
+ fn get_webhook_event_type(
+ &self,
+ _request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> {
+ Err(report!(errors::ConnectorError::WebhooksNotImplemented))
+ }
+
+ fn get_webhook_resource_object(
+ &self,
+ _request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> {
+ Err(report!(errors::ConnectorError::WebhooksNotImplemented))
+ }
+}
diff --git a/crates/hyperswitch_connectors/src/connectors/taxjar/transformers.rs b/crates/hyperswitch_connectors/src/connectors/taxjar/transformers.rs
new file mode 100644
index 00000000000..81493c8f5d9
--- /dev/null
+++ b/crates/hyperswitch_connectors/src/connectors/taxjar/transformers.rs
@@ -0,0 +1,228 @@
+use common_enums::enums;
+use common_utils::types::StringMinorUnit;
+use hyperswitch_domain_models::{
+ payment_method_data::PaymentMethodData,
+ router_data::{ConnectorAuthType, RouterData},
+ router_flow_types::refunds::{Execute, RSync},
+ router_request_types::ResponseId,
+ router_response_types::{PaymentsResponseData, RefundsResponseData},
+ types::{PaymentsAuthorizeRouterData, RefundsRouterData},
+};
+use hyperswitch_interfaces::errors;
+use masking::Secret;
+use serde::{Deserialize, Serialize};
+
+use crate::{
+ types::{RefundsResponseRouterData, ResponseRouterData},
+ utils::PaymentsAuthorizeRequestData,
+};
+
+//TODO: Fill the struct with respective fields
+pub struct TaxjarRouterData<T> {
+ pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc.
+ pub router_data: T,
+}
+
+impl<T> From<(StringMinorUnit, T)> for TaxjarRouterData<T> {
+ fn from((amount, item): (StringMinorUnit, T)) -> Self {
+ //Todo : use utils to convert the amount to the type of amount that a connector accepts
+ Self {
+ amount,
+ router_data: item,
+ }
+ }
+}
+
+//TODO: Fill the struct with respective fields
+#[derive(Default, Debug, Serialize, PartialEq)]
+pub struct TaxjarPaymentsRequest {
+ amount: StringMinorUnit,
+ card: TaxjarCard,
+}
+
+#[derive(Default, Debug, Serialize, Eq, PartialEq)]
+pub struct TaxjarCard {
+ number: cards::CardNumber,
+ expiry_month: Secret<String>,
+ expiry_year: Secret<String>,
+ cvc: Secret<String>,
+ complete: bool,
+}
+
+impl TryFrom<&TaxjarRouterData<&PaymentsAuthorizeRouterData>> for TaxjarPaymentsRequest {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: &TaxjarRouterData<&PaymentsAuthorizeRouterData>,
+ ) -> Result<Self, Self::Error> {
+ match item.router_data.request.payment_method_data.clone() {
+ PaymentMethodData::Card(req_card) => {
+ let card = TaxjarCard {
+ number: req_card.card_number,
+ expiry_month: req_card.card_exp_month,
+ expiry_year: req_card.card_exp_year,
+ cvc: req_card.card_cvc,
+ complete: item.router_data.request.is_auto_capture()?,
+ };
+ Ok(Self {
+ amount: item.amount.clone(),
+ card,
+ })
+ }
+ _ => Err(errors::ConnectorError::NotImplemented("Payment methods".to_string()).into()),
+ }
+ }
+}
+
+//TODO: Fill the struct with respective fields
+// Auth Struct
+pub struct TaxjarAuthType {
+ pub(super) api_key: Secret<String>,
+}
+
+impl TryFrom<&ConnectorAuthType> for TaxjarAuthType {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> {
+ match auth_type {
+ ConnectorAuthType::HeaderKey { api_key } => Ok(Self {
+ api_key: api_key.to_owned(),
+ }),
+ _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()),
+ }
+ }
+}
+// PaymentsResponse
+//TODO: Append the remaining status flags
+#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "lowercase")]
+pub enum TaxjarPaymentStatus {
+ Succeeded,
+ Failed,
+ #[default]
+ Processing,
+}
+
+impl From<TaxjarPaymentStatus> for common_enums::AttemptStatus {
+ fn from(item: TaxjarPaymentStatus) -> Self {
+ match item {
+ TaxjarPaymentStatus::Succeeded => Self::Charged,
+ TaxjarPaymentStatus::Failed => Self::Failure,
+ TaxjarPaymentStatus::Processing => Self::Authorizing,
+ }
+ }
+}
+
+//TODO: Fill the struct with respective fields
+#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
+pub struct TaxjarPaymentsResponse {
+ status: TaxjarPaymentStatus,
+ id: String,
+}
+
+impl<F, T> TryFrom<ResponseRouterData<F, TaxjarPaymentsResponse, T, PaymentsResponseData>>
+ for RouterData<F, T, PaymentsResponseData>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: ResponseRouterData<F, TaxjarPaymentsResponse, T, PaymentsResponseData>,
+ ) -> Result<Self, Self::Error> {
+ Ok(Self {
+ status: common_enums::AttemptStatus::from(item.response.status),
+ response: Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(item.response.id),
+ redirection_data: None,
+ mandate_reference: None,
+ connector_metadata: None,
+ network_txn_id: None,
+ connector_response_reference_id: None,
+ incremental_authorization_allowed: None,
+ charge_id: None,
+ }),
+ ..item.data
+ })
+ }
+}
+
+//TODO: Fill the struct with respective fields
+// REFUND :
+// Type definition for RefundRequest
+#[derive(Default, Debug, Serialize)]
+pub struct TaxjarRefundRequest {
+ pub amount: StringMinorUnit,
+}
+
+impl<F> TryFrom<&TaxjarRouterData<&RefundsRouterData<F>>> for TaxjarRefundRequest {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(item: &TaxjarRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> {
+ Ok(Self {
+ amount: item.amount.to_owned(),
+ })
+ }
+}
+
+// Type definition for Refund Response
+
+#[allow(dead_code)]
+#[derive(Debug, Serialize, Default, Deserialize, Clone)]
+pub enum RefundStatus {
+ Succeeded,
+ Failed,
+ #[default]
+ Processing,
+}
+
+impl From<RefundStatus> for enums::RefundStatus {
+ fn from(item: RefundStatus) -> Self {
+ match item {
+ RefundStatus::Succeeded => Self::Success,
+ RefundStatus::Failed => Self::Failure,
+ RefundStatus::Processing => Self::Pending,
+ //TODO: Review mapping
+ }
+ }
+}
+
+//TODO: Fill the struct with respective fields
+#[derive(Default, Debug, Clone, Serialize, Deserialize)]
+pub struct RefundResponse {
+ id: String,
+ status: RefundStatus,
+}
+
+impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: RefundsResponseRouterData<Execute, RefundResponse>,
+ ) -> Result<Self, Self::Error> {
+ Ok(Self {
+ response: Ok(RefundsResponseData {
+ connector_refund_id: item.response.id.to_string(),
+ refund_status: enums::RefundStatus::from(item.response.status),
+ }),
+ ..item.data
+ })
+ }
+}
+
+impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: RefundsResponseRouterData<RSync, RefundResponse>,
+ ) -> Result<Self, Self::Error> {
+ Ok(Self {
+ response: Ok(RefundsResponseData {
+ connector_refund_id: item.response.id.to_string(),
+ refund_status: enums::RefundStatus::from(item.response.status),
+ }),
+ ..item.data
+ })
+ }
+}
+
+//TODO: Fill the struct with respective fields
+#[derive(Default, Debug, Serialize, Deserialize, PartialEq)]
+pub struct TaxjarErrorResponse {
+ pub status_code: u16,
+ pub code: String,
+ pub message: String,
+ pub reason: Option<String>,
+}
diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs
index 5851443a2c4..9165a1cba53 100644
--- a/crates/hyperswitch_connectors/src/default_implementations.rs
+++ b/crates/hyperswitch_connectors/src/default_implementations.rs
@@ -91,7 +91,8 @@ default_imp_for_authorize_session_token!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
use crate::connectors;
@@ -115,7 +116,8 @@ default_imp_for_complete_authorize!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_incremental_authorization {
@@ -139,7 +141,8 @@ default_imp_for_incremental_authorization!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_create_customer {
@@ -162,7 +165,8 @@ default_imp_for_create_customer!(
connectors::Bitpay,
connectors::Fiserv,
connectors::Fiservemea,
- connectors::Helcim
+ connectors::Helcim,
+ connectors::Taxjar
);
macro_rules! default_imp_for_connector_redirect_response {
@@ -187,7 +191,8 @@ default_imp_for_connector_redirect_response!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_pre_processing_steps{
@@ -211,7 +216,8 @@ default_imp_for_pre_processing_steps!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_post_processing_steps{
@@ -235,7 +241,8 @@ default_imp_for_post_processing_steps!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_approve {
@@ -259,7 +266,8 @@ default_imp_for_approve!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_reject {
@@ -283,7 +291,8 @@ default_imp_for_reject!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_webhook_source_verification {
@@ -307,7 +316,8 @@ default_imp_for_webhook_source_verification!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_accept_dispute {
@@ -332,7 +342,8 @@ default_imp_for_accept_dispute!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_submit_evidence {
@@ -356,7 +367,8 @@ default_imp_for_submit_evidence!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_defend_dispute {
@@ -380,7 +392,8 @@ default_imp_for_defend_dispute!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_file_upload {
@@ -413,7 +426,8 @@ default_imp_for_file_upload!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -439,7 +453,8 @@ default_imp_for_payouts_create!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -465,7 +480,8 @@ default_imp_for_payouts_retrieve!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -491,7 +507,8 @@ default_imp_for_payouts_eligibility!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -517,7 +534,8 @@ default_imp_for_payouts_fulfill!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -543,7 +561,8 @@ default_imp_for_payouts_cancel!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -569,7 +588,8 @@ default_imp_for_payouts_quote!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -595,7 +615,8 @@ default_imp_for_payouts_recipient!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -621,7 +642,8 @@ default_imp_for_payouts_recipient_account!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -647,7 +669,8 @@ default_imp_for_frm_sale!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -673,7 +696,8 @@ default_imp_for_frm_checkout!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -699,7 +723,8 @@ default_imp_for_frm_transaction!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -725,7 +750,8 @@ default_imp_for_frm_fulfillment!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -751,7 +777,8 @@ default_imp_for_frm_record_return!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_revoking_mandates {
@@ -774,5 +801,6 @@ default_imp_for_revoking_mandates!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs
index 32e89b3f8bb..c9a1cfde745 100644
--- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs
+++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs
@@ -186,7 +186,8 @@ default_imp_for_new_connector_integration_payment!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_new_connector_integration_refund {
@@ -211,7 +212,8 @@ default_imp_for_new_connector_integration_refund!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_new_connector_integration_connector_access_token {
@@ -231,7 +233,8 @@ default_imp_for_new_connector_integration_connector_access_token!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_new_connector_integration_accept_dispute {
@@ -257,7 +260,8 @@ default_imp_for_new_connector_integration_accept_dispute!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_new_connector_integration_submit_evidence {
@@ -282,7 +286,8 @@ default_imp_for_new_connector_integration_submit_evidence!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_new_connector_integration_defend_dispute {
@@ -307,7 +312,8 @@ default_imp_for_new_connector_integration_defend_dispute!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_new_connector_integration_file_upload {
@@ -342,7 +348,8 @@ default_imp_for_new_connector_integration_file_upload!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -369,7 +376,8 @@ default_imp_for_new_connector_integration_payouts_create!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -396,7 +404,8 @@ default_imp_for_new_connector_integration_payouts_eligibility!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -423,7 +432,8 @@ default_imp_for_new_connector_integration_payouts_fulfill!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -450,7 +460,8 @@ default_imp_for_new_connector_integration_payouts_cancel!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -477,7 +488,8 @@ default_imp_for_new_connector_integration_payouts_quote!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -504,7 +516,8 @@ default_imp_for_new_connector_integration_payouts_recipient!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -531,7 +544,8 @@ default_imp_for_new_connector_integration_payouts_sync!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "payouts")]
@@ -558,7 +572,8 @@ default_imp_for_new_connector_integration_payouts_recipient_account!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_new_connector_integration_webhook_source_verification {
@@ -583,7 +598,8 @@ default_imp_for_new_connector_integration_webhook_source_verification!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -610,7 +626,8 @@ default_imp_for_new_connector_integration_frm_sale!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -637,7 +654,8 @@ default_imp_for_new_connector_integration_frm_checkout!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -664,7 +682,8 @@ default_imp_for_new_connector_integration_frm_transaction!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -691,7 +710,8 @@ default_imp_for_new_connector_integration_frm_fulfillment!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
#[cfg(feature = "frm")]
@@ -718,7 +738,8 @@ default_imp_for_new_connector_integration_frm_record_return!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
macro_rules! default_imp_for_new_connector_integration_revoking_mandates {
@@ -742,5 +763,6 @@ default_imp_for_new_connector_integration_revoking_mandates!(
connectors::Fiserv,
connectors::Fiservemea,
connectors::Helcim,
- connectors::Stax
+ connectors::Stax,
+ connectors::Taxjar
);
diff --git a/crates/hyperswitch_interfaces/src/configs.rs b/crates/hyperswitch_interfaces/src/configs.rs
index a2dd4675c8c..2a30df3b2cb 100644
--- a/crates/hyperswitch_interfaces/src/configs.rs
+++ b/crates/hyperswitch_interfaces/src/configs.rs
@@ -75,6 +75,7 @@ pub struct Connectors {
pub square: ConnectorParams,
pub stax: ConnectorParams,
pub stripe: ConnectorParamsWithFileUploadUrl,
+ pub taxjar: ConnectorParams,
pub threedsecureio: ConnectorParams,
pub trustpay: ConnectorParamsWithMoreUrls,
pub tsys: ConnectorParams,
diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs
index 7ca10f75855..eb83e2c4ba6 100644
--- a/crates/router/src/connector.rs
+++ b/crates/router/src/connector.rs
@@ -69,7 +69,7 @@ pub mod zsl;
pub use hyperswitch_connectors::connectors::{
bambora, bambora::Bambora, bitpay, bitpay::Bitpay, fiserv, fiserv::Fiserv, fiservemea,
- fiservemea::Fiservemea, helcim, helcim::Helcim, stax, stax::Stax,
+ fiservemea::Fiservemea, helcim, helcim::Helcim, stax, stax::Stax, taxjar, taxjar::Taxjar,
};
#[cfg(feature = "dummy_connector")]
diff --git a/crates/router/src/core/payments/connector_integration_v2_impls.rs b/crates/router/src/core/payments/connector_integration_v2_impls.rs
index b79e62d11ba..3ccd5f2577a 100644
--- a/crates/router/src/core/payments/connector_integration_v2_impls.rs
+++ b/crates/router/src/core/payments/connector_integration_v2_impls.rs
@@ -1271,6 +1271,7 @@ default_imp_for_new_connector_integration_payouts!(
connector::Stax,
connector::Stripe,
connector::Shift4,
+ connector::Taxjar,
connector::Trustpay,
connector::Threedsecureio,
connector::Tsys,
@@ -2115,6 +2116,7 @@ default_imp_for_new_connector_integration_frm!(
connector::Stax,
connector::Stripe,
connector::Shift4,
+ connector::Taxjar,
connector::Trustpay,
connector::Threedsecureio,
connector::Tsys,
@@ -2738,6 +2740,7 @@ default_imp_for_new_connector_integration_connector_authentication!(
connector::Stax,
connector::Stripe,
connector::Shift4,
+ connector::Taxjar,
connector::Trustpay,
connector::Threedsecureio,
connector::Tsys,
diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs
index 7b531aa09e9..228c7e208cc 100644
--- a/crates/router/src/core/payments/flows.rs
+++ b/crates/router/src/core/payments/flows.rs
@@ -577,6 +577,7 @@ default_imp_for_connector_request_id!(
connector::Square,
connector::Stax,
connector::Stripe,
+ connector::Taxjar,
connector::Threedsecureio,
connector::Trustpay,
connector::Tsys,
@@ -1231,6 +1232,7 @@ default_imp_for_payouts!(
connector::Square,
connector::Stax,
connector::Shift4,
+ connector::Taxjar,
connector::Threedsecureio,
connector::Trustpay,
connector::Tsys,
@@ -2250,6 +2252,7 @@ default_imp_for_fraud_check!(
connector::Stax,
connector::Stripe,
connector::Shift4,
+ connector::Taxjar,
connector::Threedsecureio,
connector::Trustpay,
connector::Tsys,
@@ -3065,6 +3068,7 @@ default_imp_for_connector_authentication!(
connector::Stax,
connector::Stripe,
connector::Shift4,
+ connector::Taxjar,
connector::Trustpay,
connector::Tsys,
connector::Volt,
diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs
index 32eed060153..776e44e82e1 100644
--- a/crates/router/src/types/api.rs
+++ b/crates/router/src/types/api.rs
@@ -444,6 +444,7 @@ impl ConnectorData {
enums::Connector::Stripe => {
Ok(ConnectorEnum::Old(Box::new(connector::Stripe::new())))
}
+ // enums::Connector::Taxjar => Ok(ConnectorEnum::Old(Box::new(connector::Taxjar))),
enums::Connector::Wise => Ok(ConnectorEnum::Old(Box::new(&connector::Wise))),
enums::Connector::Worldline => {
Ok(ConnectorEnum::Old(Box::new(&connector::Worldline)))
diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs
index ebfd4b099ba..cc8d947738b 100644
--- a/crates/router/src/types/transformers.rs
+++ b/crates/router/src/types/transformers.rs
@@ -296,6 +296,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors {
api_enums::Connector::Square => Self::Square,
api_enums::Connector::Stax => Self::Stax,
api_enums::Connector::Stripe => Self::Stripe,
+ // api_enums::Connector::Taxjar => Self::Taxjar,
api_enums::Connector::Trustpay => Self::Trustpay,
api_enums::Connector::Tsys => Self::Tsys,
api_enums::Connector::Volt => Self::Volt,
diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs
index 7fdccfaadeb..e0fa3964b27 100644
--- a/crates/router/tests/connectors/main.rs
+++ b/crates/router/tests/connectors/main.rs
@@ -69,6 +69,7 @@ mod shift4;
mod square;
mod stax;
mod stripe;
+mod taxjar;
mod trustpay;
mod tsys;
mod utils;
diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml
index 891f5991c66..0bf4d96d19f 100644
--- a/crates/router/tests/connectors/sample_auth.toml
+++ b/crates/router/tests/connectors/sample_auth.toml
@@ -264,4 +264,7 @@ api_key="API Key"
[wellsfargopayout]
api_key = "Consumer Key"
key1 = "Gateway Entity Id"
-api_secret = "Consumer Secret"
\ No newline at end of file
+api_secret = "Consumer Secret"
+
+[taxjar]
+api_key = "API Key"
\ No newline at end of file
diff --git a/crates/router/tests/connectors/taxjar.rs b/crates/router/tests/connectors/taxjar.rs
new file mode 100644
index 00000000000..6bb044777f6
--- /dev/null
+++ b/crates/router/tests/connectors/taxjar.rs
@@ -0,0 +1,420 @@
+use masking::Secret;
+use router::types::{self, api, domain, storage::enums};
+use test_utils::connector_auth;
+
+use crate::utils::{self, ConnectorActions};
+
+#[derive(Clone, Copy)]
+struct TaxjarTest;
+impl ConnectorActions for TaxjarTest {}
+impl utils::Connector for TaxjarTest {
+ fn get_data(&self) -> api::ConnectorData {
+ use router::connector::Taxjar;
+ utils::construct_connector_data_old(
+ Box::new(Taxjar::new()),
+ types::Connector::Adyen,
+ api::GetToken::Connector,
+ None,
+ )
+ }
+
+ fn get_auth_token(&self) -> types::ConnectorAuthType {
+ utils::to_connector_auth_type(
+ connector_auth::ConnectorAuthentication::new()
+ .taxjar
+ .expect("Missing connector authentication configuration")
+ .into(),
+ )
+ }
+
+ fn get_name(&self) -> String {
+ "taxjar".to_string()
+ }
+}
+
+static CONNECTOR: TaxjarTest = TaxjarTest {};
+
+fn get_default_payment_info() -> Option<utils::PaymentInfo> {
+ None
+}
+
+fn payment_method_details() -> Option<types::PaymentsAuthorizeData> {
+ None
+}
+
+// Cards Positive Tests
+// Creates a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_only_authorize_payment() {
+ let response = CONNECTOR
+ .authorize_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .expect("Authorize payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Authorized);
+}
+
+// Captures a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_capture_authorized_payment() {
+ let response = CONNECTOR
+ .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info())
+ .await
+ .expect("Capture payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Charged);
+}
+
+// Partially captures a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_partially_capture_authorized_payment() {
+ let response = CONNECTOR
+ .authorize_and_capture_payment(
+ payment_method_details(),
+ Some(types::PaymentsCaptureData {
+ amount_to_capture: 50,
+ ..utils::PaymentCaptureType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .expect("Capture payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Charged);
+}
+
+// Synchronizes a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_authorized_payment() {
+ let authorize_response = CONNECTOR
+ .authorize_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .expect("Authorize payment response");
+ let txn_id = utils::get_connector_transaction_id(authorize_response.response);
+ let response = CONNECTOR
+ .psync_retry_till_status_matches(
+ enums::AttemptStatus::Authorized,
+ Some(types::PaymentsSyncData {
+ connector_transaction_id: types::ResponseId::ConnectorTransactionId(
+ txn_id.unwrap(),
+ ),
+ ..Default::default()
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .expect("PSync response");
+ assert_eq!(response.status, enums::AttemptStatus::Authorized,);
+}
+
+// Voids a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_void_authorized_payment() {
+ let response = CONNECTOR
+ .authorize_and_void_payment(
+ payment_method_details(),
+ Some(types::PaymentsCancelData {
+ connector_transaction_id: String::from(""),
+ cancellation_reason: Some("requested_by_customer".to_string()),
+ ..Default::default()
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .expect("Void payment response");
+ assert_eq!(response.status, enums::AttemptStatus::Voided);
+}
+
+// Refunds a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_refund_manually_captured_payment() {
+ let response = CONNECTOR
+ .capture_payment_and_refund(
+ payment_method_details(),
+ None,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Partially refunds a payment using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_partially_refund_manually_captured_payment() {
+ let response = CONNECTOR
+ .capture_payment_and_refund(
+ payment_method_details(),
+ None,
+ Some(types::RefundsData {
+ refund_amount: 50,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Synchronizes a refund using the manual capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_manually_captured_refund() {
+ let refund_response = CONNECTOR
+ .capture_payment_and_refund(
+ payment_method_details(),
+ None,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ let response = CONNECTOR
+ .rsync_retry_till_status_matches(
+ enums::RefundStatus::Success,
+ refund_response.response.unwrap().connector_refund_id,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Creates a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_make_payment() {
+ let authorize_response = CONNECTOR
+ .make_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(authorize_response.status, enums::AttemptStatus::Charged);
+}
+
+// Synchronizes a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_auto_captured_payment() {
+ let authorize_response = CONNECTOR
+ .make_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(authorize_response.status, enums::AttemptStatus::Charged);
+ let txn_id = utils::get_connector_transaction_id(authorize_response.response);
+ assert_ne!(txn_id, None, "Empty connector transaction id");
+ let response = CONNECTOR
+ .psync_retry_till_status_matches(
+ enums::AttemptStatus::Charged,
+ Some(types::PaymentsSyncData {
+ connector_transaction_id: types::ResponseId::ConnectorTransactionId(
+ txn_id.unwrap(),
+ ),
+ capture_method: Some(enums::CaptureMethod::Automatic),
+ ..Default::default()
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(response.status, enums::AttemptStatus::Charged,);
+}
+
+// Refunds a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_refund_auto_captured_payment() {
+ let response = CONNECTOR
+ .make_payment_and_refund(payment_method_details(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Partially refunds a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_partially_refund_succeeded_payment() {
+ let refund_response = CONNECTOR
+ .make_payment_and_refund(
+ payment_method_details(),
+ Some(types::RefundsData {
+ refund_amount: 50,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ refund_response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_refund_succeeded_payment_multiple_times() {
+ CONNECTOR
+ .make_payment_and_multiple_refund(
+ payment_method_details(),
+ Some(types::RefundsData {
+ refund_amount: 50,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await;
+}
+
+// Synchronizes a refund using the automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_sync_refund() {
+ let refund_response = CONNECTOR
+ .make_payment_and_refund(payment_method_details(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ let response = CONNECTOR
+ .rsync_retry_till_status_matches(
+ enums::RefundStatus::Success,
+ refund_response.response.unwrap().connector_refund_id,
+ None,
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap().refund_status,
+ enums::RefundStatus::Success,
+ );
+}
+
+// Cards Negative scenarios
+// Creates a payment with incorrect CVC.
+#[actix_web::test]
+async fn should_fail_payment_for_incorrect_cvc() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: domain::PaymentMethodData::Card(domain::Card {
+ card_cvc: Secret::new("12345".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card's security code is invalid.".to_string(),
+ );
+}
+
+// Creates a payment with incorrect expiry month.
+#[actix_web::test]
+async fn should_fail_payment_for_invalid_exp_month() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: domain::PaymentMethodData::Card(domain::Card {
+ card_exp_month: Secret::new("20".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card's expiration month is invalid.".to_string(),
+ );
+}
+
+// Creates a payment with incorrect expiry year.
+#[actix_web::test]
+async fn should_fail_payment_for_incorrect_expiry_year() {
+ let response = CONNECTOR
+ .make_payment(
+ Some(types::PaymentsAuthorizeData {
+ payment_method_data: domain::PaymentMethodData::Card(domain::Card {
+ card_exp_year: Secret::new("2000".to_string()),
+ ..utils::CCardType::default().0
+ }),
+ ..utils::PaymentAuthorizeType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Your card's expiration year is invalid.".to_string(),
+ );
+}
+
+// Voids a payment using automatic capture flow (Non 3DS).
+#[actix_web::test]
+async fn should_fail_void_payment_for_auto_capture() {
+ let authorize_response = CONNECTOR
+ .make_payment(payment_method_details(), get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(authorize_response.status, enums::AttemptStatus::Charged);
+ let txn_id = utils::get_connector_transaction_id(authorize_response.response);
+ assert_ne!(txn_id, None, "Empty connector transaction id");
+ let void_response = CONNECTOR
+ .void_payment(txn_id.unwrap(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(
+ void_response.response.unwrap_err().message,
+ "You cannot cancel this PaymentIntent because it has a status of succeeded."
+ );
+}
+
+// Captures a payment using invalid connector payment id.
+#[actix_web::test]
+async fn should_fail_capture_for_invalid_payment() {
+ let capture_response = CONNECTOR
+ .capture_payment("123456789".to_string(), None, get_default_payment_info())
+ .await
+ .unwrap();
+ assert_eq!(
+ capture_response.response.unwrap_err().message,
+ String::from("No such payment_intent: '123456789'")
+ );
+}
+
+// Refunds a payment with refund amount higher than payment amount.
+#[actix_web::test]
+async fn should_fail_for_refund_amount_higher_than_payment_amount() {
+ let response = CONNECTOR
+ .make_payment_and_refund(
+ payment_method_details(),
+ Some(types::RefundsData {
+ refund_amount: 150,
+ ..utils::PaymentRefundType::default().0
+ }),
+ get_default_payment_info(),
+ )
+ .await
+ .unwrap();
+ assert_eq!(
+ response.response.unwrap_err().message,
+ "Refund amount (₹1.50) is greater than charge amount (₹1.00)",
+ );
+}
+
+// Connector dependent test cases goes here
+
+// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests
diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs
index 66384a2d92f..b13be3075aa 100644
--- a/crates/test_utils/src/connector_auth.rs
+++ b/crates/test_utils/src/connector_auth.rs
@@ -71,6 +71,7 @@ pub struct ConnectorAuthentication {
pub square: Option<BodyKey>,
pub stax: Option<HeaderKey>,
pub stripe: Option<HeaderKey>,
+ pub taxjar: Option<HeaderKey>,
pub threedsecureio: Option<HeaderKey>,
pub stripe_au: Option<HeaderKey>,
pub stripe_uk: Option<HeaderKey>,
diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml
index c74a1151416..9e5c8a3f0ce 100644
--- a/loadtest/config/development.toml
+++ b/loadtest/config/development.toml
@@ -140,6 +140,7 @@ square.base_url = "https://connect.squareupsandbox.com/"
square.secondary_base_url = "https://pci-connect.squareupsandbox.com/"
stax.base_url = "https://apiprod.fattlabs.com/"
stripe.base_url = "https://api.stripe.com/"
+taxjar.base_url = "https://api.sandbox.taxjar.com/v2/"
threedsecureio.base_url = "https://service.sandbox.3dsecure.io"
stripe.base_url_file_upload = "https://files.stripe.com/"
trustpay.base_url = "https://test-tpgw.trustpay.eu/"
@@ -217,6 +218,7 @@ cards = [
"square",
"stax",
"stripe",
+ "taxjar",
"threedsecureio",
"trustpay",
"tsys",
diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh
index 49160492a68..3e5fc1c3d9d 100755
--- a/scripts/add_connector.sh
+++ b/scripts/add_connector.sh
@@ -6,7 +6,7 @@ function find_prev_connector() {
git checkout $self
cp $self $self.tmp
# Add new connector to existing list and sort it
- connectors=(aci adyen adyenplatform airwallex applepay authorizedotnet bambora bamboraapac bankofamerica billwerk bitpay bluesnap boku braintree cashtocode checkout coinbase cryptopay cybersource datatrans dlocal dummyconnector ebanx fiserv fiservemea forte globalpay globepay gocardless gpayments helcim iatapay itaubank klarna mifinity mollie multisafepay netcetera nexinets noon nuvei opayo opennode paybox payeezy payme payone paypal payu placetopay plaid powertranz prophetpay rapyd razorpay shift4 square stax stripe threedsecureio trustpay tsys volt wellsfargo wellsfargopayout wise worldline worldpay zsl "$1")
+ connectors=(aci adyen adyenplatform airwallex applepay authorizedotnet bambora bamboraapac bankofamerica billwerk bitpay bluesnap boku braintree cashtocode checkout coinbase cryptopay cybersource datatrans dlocal dummyconnector ebanx fiserv fiservemea forte globalpay globepay gocardless gpayments helcim iatapay itaubank klarna mifinity mollie multisafepay netcetera nexinets noon nuvei opayo opennode paybox payeezy payme payone paypal payu placetopay plaid powertranz prophetpay rapyd razorpay shift4 square stax stripe taxjar threedsecureio trustpay tsys volt wellsfargo wellsfargopayout wise worldline worldpay zsl "$1")
IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS
res=`echo ${sorted[@]}`
sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp
|
feat
|
create Taxjar connector (#5597)
|
d98551d80a14e2878fbac93e4ba0ecb537018802
|
2024-04-26 11:42:41
|
Narayan Bhat
|
refactor(access_token): use `merchant_connector_id` for storing access token (#4462)
| false
|
diff --git a/crates/common_utils/src/access_token.rs b/crates/common_utils/src/access_token.rs
new file mode 100644
index 00000000000..20bac0dafbb
--- /dev/null
+++ b/crates/common_utils/src/access_token.rs
@@ -0,0 +1,11 @@
+//! Commonly used utilities for access token
+
+use std::fmt::Display;
+
+/// Create a key for fetching the access token from redis
+pub fn create_access_token_key(
+ merchant_id: impl Display,
+ merchant_connector_id: impl Display,
+) -> String {
+ format!("access_token_{merchant_id}_{merchant_connector_id}")
+}
diff --git a/crates/common_utils/src/lib.rs b/crates/common_utils/src/lib.rs
index e30d596d9a7..f24b67fde1b 100644
--- a/crates/common_utils/src/lib.rs
+++ b/crates/common_utils/src/lib.rs
@@ -2,6 +2,7 @@
#![warn(missing_docs, missing_debug_implementations)]
#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR" ), "/", "README.md"))]
+pub mod access_token;
pub mod consts;
pub mod crypto;
pub mod custom_serde;
diff --git a/crates/router/src/core/payments/access_token.rs b/crates/router/src/core/payments/access_token.rs
index 47f6b7e2ae4..49d27d81509 100644
--- a/crates/router/src/core/payments/access_token.rs
+++ b/crates/router/src/core/payments/access_token.rs
@@ -10,7 +10,7 @@ use crate::{
payments,
},
routes::{metrics, AppState},
- services,
+ services::{self, logger},
types::{self, api as api_types, domain},
};
@@ -64,8 +64,14 @@ pub async fn add_access_token<
{
let merchant_id = &merchant_account.merchant_id;
let store = &*state.store;
+ let merchant_connector_id = connector
+ .merchant_connector_id
+ .as_ref()
+ .ok_or(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Missing merchant_connector_id in ConnectorData")?;
+
let old_access_token = store
- .get_access_token(merchant_id, connector.connector.id())
+ .get_access_token(merchant_id, merchant_connector_id)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("DB error when accessing the access token")?;
@@ -103,19 +109,24 @@ pub async fn add_access_token<
)
.await?
.async_map(|access_token| async {
- //Store the access token in db
+ // Store the access token in redis with expiry
+ // The expiry should be adjusted for network delays from the connector
let store = &*state.store;
- // This error should not be propagated, we don't want payments to fail once we have
- // the access token, the next request will create new access token
- let _ = store
+ if let Err(access_token_set_error) = store
.set_access_token(
merchant_id,
- connector.connector.id(),
+ merchant_connector_id.as_str(),
access_token.clone(),
)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("DB error when setting the access token");
+ .attach_printable("DB error when setting the access token")
+ {
+ // If we are not able to set the access token in redis, the error should just be logged and proceed with the payment
+ // Payments should not fail, once the access token is successfully created
+ // The next request will create new access token, if required
+ logger::error!(access_token_set_error=?access_token_set_error);
+ }
Some(access_token)
})
.await
diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs
index cc9c98be833..34bf7552a48 100644
--- a/crates/router/src/db/kafka_store.rs
+++ b/crates/router/src/db/kafka_store.rs
@@ -859,21 +859,21 @@ impl ConnectorAccessToken for KafkaStore {
async fn get_access_token(
&self,
merchant_id: &str,
- connector_name: &str,
+ merchant_connector_id: &str,
) -> CustomResult<Option<AccessToken>, errors::StorageError> {
self.diesel_store
- .get_access_token(merchant_id, connector_name)
+ .get_access_token(merchant_id, merchant_connector_id)
.await
}
async fn set_access_token(
&self,
merchant_id: &str,
- connector_name: &str,
+ merchant_connector_id: &str,
access_token: AccessToken,
) -> CustomResult<(), errors::StorageError> {
self.diesel_store
- .set_access_token(merchant_id, connector_name, access_token)
+ .set_access_token(merchant_id, merchant_connector_id, access_token)
.await
}
}
diff --git a/crates/router/src/db/merchant_connector_account.rs b/crates/router/src/db/merchant_connector_account.rs
index b7c85560804..06d1e505c6b 100644
--- a/crates/router/src/db/merchant_connector_account.rs
+++ b/crates/router/src/db/merchant_connector_account.rs
@@ -24,13 +24,13 @@ pub trait ConnectorAccessToken {
async fn get_access_token(
&self,
merchant_id: &str,
- connector_name: &str,
+ merchant_connector_id: &str,
) -> CustomResult<Option<types::AccessToken>, errors::StorageError>;
async fn set_access_token(
&self,
merchant_id: &str,
- connector_name: &str,
+ merchant_connector_id: &str,
access_token: types::AccessToken,
) -> CustomResult<(), errors::StorageError>;
}
@@ -41,12 +41,14 @@ impl ConnectorAccessToken for Store {
async fn get_access_token(
&self,
merchant_id: &str,
- connector_name: &str,
+ merchant_connector_id: &str,
) -> CustomResult<Option<types::AccessToken>, errors::StorageError> {
//TODO: Handle race condition
// This function should acquire a global lock on some resource, if access token is already
// being refreshed by other request then wait till it finishes and use the same access token
- let key = format!("access_token_{merchant_id}_{connector_name}");
+ let key =
+ common_utils::access_token::create_access_token_key(merchant_id, merchant_connector_id);
+
let maybe_token = self
.get_redis_conn()
.map_err(Into::<errors::StorageError>::into)?
@@ -55,10 +57,9 @@ impl ConnectorAccessToken for Store {
.change_context(errors::StorageError::KVError)
.attach_printable("DB error when getting access token")?;
- let access_token: Option<types::AccessToken> = maybe_token
- .map(|token| token.parse_struct("AccessToken"))
+ let access_token = maybe_token
+ .map(|token| token.parse_struct::<types::AccessToken>("AccessToken"))
.transpose()
- .change_context(errors::ParsingError::UnknownError)
.change_context(errors::StorageError::DeserializationFailed)?;
Ok(access_token)
@@ -68,10 +69,11 @@ impl ConnectorAccessToken for Store {
async fn set_access_token(
&self,
merchant_id: &str,
- connector_name: &str,
+ merchant_connector_id: &str,
access_token: types::AccessToken,
) -> CustomResult<(), errors::StorageError> {
- let key = format!("access_token_{merchant_id}_{connector_name}");
+ let key =
+ common_utils::access_token::create_access_token_key(merchant_id, merchant_connector_id);
let serialized_access_token = access_token
.encode_to_string_of_json()
.change_context(errors::StorageError::SerializationFailed)?;
@@ -88,7 +90,7 @@ impl ConnectorAccessToken for MockDb {
async fn get_access_token(
&self,
_merchant_id: &str,
- _connector_name: &str,
+ _merchant_connector_id: &str,
) -> CustomResult<Option<types::AccessToken>, errors::StorageError> {
Ok(None)
}
@@ -96,7 +98,7 @@ impl ConnectorAccessToken for MockDb {
async fn set_access_token(
&self,
_merchant_id: &str,
- _connector_name: &str,
+ _merchant_connector_id: &str,
_access_token: types::AccessToken,
) -> CustomResult<(), errors::StorageError> {
Ok(())
|
refactor
|
use `merchant_connector_id` for storing access token (#4462)
|
379d1d1375783f2c35edbf4dda6bbb0eb9351a3c
|
2023-06-29 03:02:59
|
Kartikeya Hegde
|
fix: add config create route back (#1559)
| false
|
diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs
index a2219f77a30..507cdc3469e 100644
--- a/crates/router/src/routes/app.rs
+++ b/crates/router/src/routes/app.rs
@@ -425,6 +425,7 @@ impl Configs {
pub fn server(config: AppState) -> Scope {
web::scope("/configs")
.app_data(web::Data::new(config))
+ .service(web::resource("/").route(web::post().to(config_key_create)))
.service(
web::resource("/{key}")
.route(web::get().to(config_key_retrieve))
|
fix
|
add config create route back (#1559)
|
6e103cef50fea31d2508880985f80f0fd65cd536
|
2024-02-13 13:14:18
|
Kartikeya Hegde
|
fix(healthcheck): do not return true as response if the check if not applicable (#3551)
| false
|
diff --git a/crates/api_models/src/health_check.rs b/crates/api_models/src/health_check.rs
index 6b0297b655f..29a59df397e 100644
--- a/crates/api_models/src/health_check.rs
+++ b/crates/api_models/src/health_check.rs
@@ -2,7 +2,8 @@
pub struct RouterHealthCheckResponse {
pub database: bool,
pub redis: bool,
- pub locker: bool,
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub vault: Option<bool>,
#[cfg(feature = "olap")]
pub analytics: bool,
pub outgoing_request: bool,
@@ -17,4 +18,28 @@ pub struct SchedulerHealthCheckResponse {
pub outgoing_request: bool,
}
+pub enum HealthState {
+ Running,
+ Error,
+ NotApplicable,
+}
+
+impl From<HealthState> for bool {
+ fn from(value: HealthState) -> Self {
+ match value {
+ HealthState::Running => true,
+ HealthState::Error | HealthState::NotApplicable => false,
+ }
+ }
+}
+impl From<HealthState> for Option<bool> {
+ fn from(value: HealthState) -> Self {
+ match value {
+ HealthState::Running => Some(true),
+ HealthState::Error => Some(false),
+ HealthState::NotApplicable => None,
+ }
+ }
+}
+
impl common_utils::events::ApiEventMetric for SchedulerHealthCheckResponse {}
diff --git a/crates/router/src/core/health_check.rs b/crates/router/src/core/health_check.rs
index bc523b4fba6..3be764ef66b 100644
--- a/crates/router/src/core/health_check.rs
+++ b/crates/router/src/core/health_check.rs
@@ -1,5 +1,6 @@
#[cfg(feature = "olap")]
use analytics::health_check::HealthCheck;
+use api_models::health_check::HealthState;
use error_stack::ResultExt;
use router_env::logger;
@@ -12,23 +13,27 @@ use crate::{
#[async_trait::async_trait]
pub trait HealthCheckInterface {
- async fn health_check_db(&self) -> CustomResult<(), errors::HealthCheckDBError>;
- async fn health_check_redis(&self) -> CustomResult<(), errors::HealthCheckRedisError>;
- async fn health_check_locker(&self) -> CustomResult<(), errors::HealthCheckLockerError>;
- async fn health_check_outgoing(&self) -> CustomResult<(), errors::HealthCheckOutGoing>;
+ async fn health_check_db(&self) -> CustomResult<HealthState, errors::HealthCheckDBError>;
+ async fn health_check_redis(&self) -> CustomResult<HealthState, errors::HealthCheckRedisError>;
+ async fn health_check_locker(
+ &self,
+ ) -> CustomResult<HealthState, errors::HealthCheckLockerError>;
+ async fn health_check_outgoing(&self)
+ -> CustomResult<HealthState, errors::HealthCheckOutGoing>;
#[cfg(feature = "olap")]
- async fn health_check_analytics(&self) -> CustomResult<(), errors::HealthCheckDBError>;
+ async fn health_check_analytics(&self)
+ -> CustomResult<HealthState, errors::HealthCheckDBError>;
}
#[async_trait::async_trait]
impl HealthCheckInterface for app::AppState {
- async fn health_check_db(&self) -> CustomResult<(), errors::HealthCheckDBError> {
+ async fn health_check_db(&self) -> CustomResult<HealthState, errors::HealthCheckDBError> {
let db = &*self.store;
db.health_check_db().await?;
- Ok(())
+ Ok(HealthState::Running)
}
- async fn health_check_redis(&self) -> CustomResult<(), errors::HealthCheckRedisError> {
+ async fn health_check_redis(&self) -> CustomResult<HealthState, errors::HealthCheckRedisError> {
let db = &*self.store;
let redis_conn = db
.get_redis_conn()
@@ -55,10 +60,12 @@ impl HealthCheckInterface for app::AppState {
logger::debug!("Redis delete_key was successful");
- Ok(())
+ Ok(HealthState::Running)
}
- async fn health_check_locker(&self) -> CustomResult<(), errors::HealthCheckLockerError> {
+ async fn health_check_locker(
+ &self,
+ ) -> CustomResult<HealthState, errors::HealthCheckLockerError> {
let locker = &self.conf.locker;
if !locker.mock_locker {
let mut url = locker.host_rs.to_owned();
@@ -67,16 +74,19 @@ impl HealthCheckInterface for app::AppState {
services::call_connector_api(self, request)
.await
.change_context(errors::HealthCheckLockerError::FailedToCallLocker)?
- .ok();
+ .map_err(|_| {
+ error_stack::report!(errors::HealthCheckLockerError::FailedToCallLocker)
+ })?;
+ Ok(HealthState::Running)
+ } else {
+ Ok(HealthState::NotApplicable)
}
-
- logger::debug!("Locker call was successful");
-
- Ok(())
}
#[cfg(feature = "olap")]
- async fn health_check_analytics(&self) -> CustomResult<(), errors::HealthCheckDBError> {
+ async fn health_check_analytics(
+ &self,
+ ) -> CustomResult<HealthState, errors::HealthCheckDBError> {
let analytics = &self.pool;
match analytics {
analytics::AnalyticsProvider::Sqlx(client) => client
@@ -107,10 +117,14 @@ impl HealthCheckInterface for app::AppState {
.await
.change_context(errors::HealthCheckDBError::ClickhouseAnalyticsError)
}
- }
+ }?;
+
+ Ok(HealthState::Running)
}
- async fn health_check_outgoing(&self) -> CustomResult<(), errors::HealthCheckOutGoing> {
+ async fn health_check_outgoing(
+ &self,
+ ) -> CustomResult<HealthState, errors::HealthCheckOutGoing> {
let request = services::Request::new(services::Method::Get, consts::OUTGOING_CALL_URL);
services::call_connector_api(self, request)
.await
@@ -125,6 +139,6 @@ impl HealthCheckInterface for app::AppState {
})?;
logger::debug!("Outgoing request successful");
- Ok(())
+ Ok(HealthState::Running)
}
}
diff --git a/crates/router/src/routes/health.rs b/crates/router/src/routes/health.rs
index 2183ab07fed..a00ba011bff 100644
--- a/crates/router/src/routes/health.rs
+++ b/crates/router/src/routes/health.rs
@@ -45,7 +45,7 @@ async fn deep_health_check_func(state: app::AppState) -> RouterResponse<RouterHe
logger::debug!("Database health check begin");
- let db_status = state.health_check_db().await.map(|_| true).map_err(|err| {
+ let db_status = state.health_check_db().await.map_err(|err| {
error_stack::report!(errors::ApiErrorResponse::HealthCheckError {
component: "Database",
message: err.to_string()
@@ -56,64 +56,48 @@ async fn deep_health_check_func(state: app::AppState) -> RouterResponse<RouterHe
logger::debug!("Redis health check begin");
- let redis_status = state
- .health_check_redis()
- .await
- .map(|_| true)
- .map_err(|err| {
- error_stack::report!(errors::ApiErrorResponse::HealthCheckError {
- component: "Redis",
- message: err.to_string()
- })
- })?;
+ let redis_status = state.health_check_redis().await.map_err(|err| {
+ error_stack::report!(errors::ApiErrorResponse::HealthCheckError {
+ component: "Redis",
+ message: err.to_string()
+ })
+ })?;
logger::debug!("Redis health check end");
logger::debug!("Locker health check begin");
- let locker_status = state
- .health_check_locker()
- .await
- .map(|_| true)
- .map_err(|err| {
- error_stack::report!(errors::ApiErrorResponse::HealthCheckError {
- component: "Locker",
- message: err.to_string()
- })
- })?;
+ let locker_status = state.health_check_locker().await.map_err(|err| {
+ error_stack::report!(errors::ApiErrorResponse::HealthCheckError {
+ component: "Locker",
+ message: err.to_string()
+ })
+ })?;
#[cfg(feature = "olap")]
- let analytics_status = state
- .health_check_analytics()
- .await
- .map(|_| true)
- .map_err(|err| {
- error_stack::report!(errors::ApiErrorResponse::HealthCheckError {
- component: "Analytics",
- message: err.to_string()
- })
- })?;
-
- let outgoing_check = state
- .health_check_outgoing()
- .await
- .map(|_| true)
- .map_err(|err| {
- error_stack::report!(errors::ApiErrorResponse::HealthCheckError {
- component: "Outgoing Request",
- message: err.to_string()
- })
- })?;
+ let analytics_status = state.health_check_analytics().await.map_err(|err| {
+ error_stack::report!(errors::ApiErrorResponse::HealthCheckError {
+ component: "Analytics",
+ message: err.to_string()
+ })
+ })?;
+
+ let outgoing_check = state.health_check_outgoing().await.map_err(|err| {
+ error_stack::report!(errors::ApiErrorResponse::HealthCheckError {
+ component: "Outgoing Request",
+ message: err.to_string()
+ })
+ })?;
logger::debug!("Locker health check end");
let response = RouterHealthCheckResponse {
- database: db_status,
- redis: redis_status,
- locker: locker_status,
+ database: db_status.into(),
+ redis: redis_status.into(),
+ vault: locker_status.into(),
#[cfg(feature = "olap")]
- analytics: analytics_status,
- outgoing_request: outgoing_check,
+ analytics: analytics_status.into(),
+ outgoing_request: outgoing_check.into(),
};
Ok(api::ApplicationResponse::Json(response))
|
fix
|
do not return true as response if the check if not applicable (#3551)
|
817d06c7faa14493674931ba51ab6c32769602d1
|
2024-07-18 19:44:51
|
Sakil Mostak
|
fix(core): [payouts] failure of payout retrieve when token is expired (#5362)
| false
|
diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs
index 4365519aecc..b2c883c381b 100644
--- a/crates/router/src/core/payouts.rs
+++ b/crates/router/src/core/payouts.rs
@@ -2373,8 +2373,7 @@ pub async fn make_payout_data(
validate_and_get_business_profile(state, &profile_id, merchant_id).await?;
let payout_method_data = match req {
payouts::PayoutRequest::PayoutCreateRequest(r) => r.payout_method_data.to_owned(),
- payouts::PayoutRequest::PayoutRetrieveRequest(_)
- | payouts::PayoutRequest::PayoutActionRequest(_) => {
+ payouts::PayoutRequest::PayoutActionRequest(_) => {
match payout_attempt.payout_token.to_owned() {
Some(payout_token) => {
let customer_id = customer_details
@@ -2397,6 +2396,7 @@ pub async fn make_payout_data(
None => None,
}
}
+ payouts::PayoutRequest::PayoutRetrieveRequest(_) => None,
};
let payout_link = payouts
|
fix
|
[payouts] failure of payout retrieve when token is expired (#5362)
|
d346d38faf3858ec1e3360fb9e3a2a82e7d330fb
|
2025-03-17 19:55:52
|
sweta-sharma
|
feat(connector): [GETNET] Add cards payment flow (#7256)
| false
|
diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json
index d93208fb665..53af0100c4f 100644
--- a/api-reference-v2/openapi_spec.json
+++ b/api-reference-v2/openapi_spec.json
@@ -7629,6 +7629,7 @@
"fiservemea",
"fiuu",
"forte",
+ "getnet",
"globalpay",
"globepay",
"gocardless",
@@ -9757,6 +9758,12 @@
"user_card_cvc"
]
},
+ {
+ "type": "string",
+ "enum": [
+ "user_card_network"
+ ]
+ },
{
"type": "string",
"enum": [
@@ -20297,6 +20304,7 @@
"fiservemea",
"fiuu",
"forte",
+ "getnet",
"globalpay",
"globepay",
"gocardless",
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
index c2fe52010f0..cc1207d4779 100644
--- a/api-reference/openapi_spec.json
+++ b/api-reference/openapi_spec.json
@@ -9728,6 +9728,7 @@
"fiservemea",
"fiuu",
"forte",
+ "getnet",
"globalpay",
"globepay",
"gocardless",
@@ -11971,6 +11972,12 @@
"user_card_cvc"
]
},
+ {
+ "type": "string",
+ "enum": [
+ "user_card_network"
+ ]
+ },
{
"type": "string",
"enum": [
@@ -24783,6 +24790,7 @@
"fiservemea",
"fiuu",
"forte",
+ "getnet",
"globalpay",
"globepay",
"gocardless",
diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs
index 6ae46a5ede0..bd328c75a09 100644
--- a/crates/api_models/src/enums.rs
+++ b/crates/api_models/src/enums.rs
@@ -211,6 +211,7 @@ pub enum FieldType {
UserCardExpiryMonth,
UserCardExpiryYear,
UserCardCvc,
+ UserCardNetwork,
UserFullName,
UserEmailAddress,
UserPhoneNumber,
diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs
index cc86e6897f8..5def313fd1e 100644
--- a/crates/common_enums/src/connector_enums.rs
+++ b/crates/common_enums/src/connector_enums.rs
@@ -81,7 +81,7 @@ pub enum RoutableConnectors {
Fiservemea,
Fiuu,
Forte,
- // Getnet,
+ Getnet,
Globalpay,
Globepay,
Gocardless,
@@ -224,7 +224,7 @@ pub enum Connector {
Fiservemea,
Fiuu,
Forte,
- // Getnet,
+ Getnet,
Globalpay,
Globepay,
Gocardless,
@@ -382,7 +382,7 @@ impl Connector {
| Self::Fiservemea
| Self::Fiuu
| Self::Forte
- // | Self::Getnet
+ | Self::Getnet
| Self::Globalpay
| Self::Globepay
| Self::Gocardless
@@ -521,6 +521,7 @@ impl From<RoutableConnectors> for Connector {
RoutableConnectors::Fiservemea => Self::Fiservemea,
RoutableConnectors::Fiuu => Self::Fiuu,
RoutableConnectors::Forte => Self::Forte,
+ RoutableConnectors::Getnet => Self::Getnet,
RoutableConnectors::Globalpay => Self::Globalpay,
RoutableConnectors::Globepay => Self::Globepay,
RoutableConnectors::Gocardless => Self::Gocardless,
diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs
index baa9dd13198..ae617c59302 100644
--- a/crates/connector_configs/src/connector.rs
+++ b/crates/connector_configs/src/connector.rs
@@ -195,7 +195,7 @@ pub struct ConnectorConfig {
pub fiservemea: Option<ConnectorTomlConfig>,
pub fiuu: Option<ConnectorTomlConfig>,
pub forte: Option<ConnectorTomlConfig>,
- // pub getnet: Option<ConnectorTomlConfig>,
+ pub getnet: Option<ConnectorTomlConfig>,
pub globalpay: Option<ConnectorTomlConfig>,
pub globepay: Option<ConnectorTomlConfig>,
pub gocardless: Option<ConnectorTomlConfig>,
@@ -367,7 +367,7 @@ impl ConnectorConfig {
Connector::Fiservemea => Ok(connector_data.fiservemea),
Connector::Fiuu => Ok(connector_data.fiuu),
Connector::Forte => Ok(connector_data.forte),
- // Connector::Getnet => Ok(connector_data.getnet),
+ Connector::Getnet => Ok(connector_data.getnet),
Connector::Globalpay => Ok(connector_data.globalpay),
Connector::Globepay => Ok(connector_data.globepay),
Connector::Gocardless => Ok(connector_data.gocardless),
diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml
index a1dd0cac476..e166e2795c6 100644
--- a/crates/connector_configs/toml/development.toml
+++ b/crates/connector_configs/toml/development.toml
@@ -1667,6 +1667,30 @@ key2="Location ID"
[forte.connector_webhook_details]
merchant_secret="Source verification key"
+[getnet]
+[[getnet.credit]]
+ payment_method_type = "Mastercard"
+[[getnet.credit]]
+ payment_method_type = "Visa"
+[[getnet.credit]]
+ payment_method_type = "Interac"
+[[getnet.credit]]
+ payment_method_type = "AmericanExpress"
+[[getnet.credit]]
+ payment_method_type = "JCB"
+[[getnet.credit]]
+ payment_method_type = "DinersClub"
+[[getnet.credit]]
+ payment_method_type = "Discover"
+[[getnet.credit]]
+ payment_method_type = "CartesBancaires"
+[[getnet.credit]]
+ payment_method_type = "UnionPay"
+[[getnet.credit]]
+ payment_method_type = "Rupay"
+[[getnet.credit]]
+ payment_method_type = "Maestro"
+
[globalpay]
[[globalpay.credit]]
payment_method_type = "Mastercard"
diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml
index aada50faa61..1555814a5ee 100644
--- a/crates/connector_configs/toml/production.toml
+++ b/crates/connector_configs/toml/production.toml
@@ -1385,6 +1385,30 @@ key2="Location ID"
merchant_secret="Source verification key"
+[getnet]
+[[getnet.credit]]
+ payment_method_type = "Mastercard"
+[[getnet.credit]]
+ payment_method_type = "Visa"
+[[getnet.credit]]
+ payment_method_type = "Interac"
+[[getnet.credit]]
+ payment_method_type = "AmericanExpress"
+[[getnet.credit]]
+ payment_method_type = "JCB"
+[[getnet.credit]]
+ payment_method_type = "DinersClub"
+[[getnet.credit]]
+ payment_method_type = "Discover"
+[[getnet.credit]]
+ payment_method_type = "CartesBancaires"
+[[getnet.credit]]
+ payment_method_type = "UnionPay"
+[[getnet.credit]]
+ payment_method_type = "Rupay"
+[[getnet.credit]]
+ payment_method_type = "Maestro"
+
[globalpay]
[[globalpay.credit]]
payment_method_type = "Mastercard"
diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml
index 6bf33b902fd..45fc6d51eef 100644
--- a/crates/connector_configs/toml/sandbox.toml
+++ b/crates/connector_configs/toml/sandbox.toml
@@ -1617,6 +1617,30 @@ key2="Location ID"
[forte.connector_webhook_details]
merchant_secret="Source verification key"
+[getnet]
+[[getnet.credit]]
+ payment_method_type = "Mastercard"
+[[getnet.credit]]
+ payment_method_type = "Visa"
+[[getnet.credit]]
+ payment_method_type = "Interac"
+[[getnet.credit]]
+ payment_method_type = "AmericanExpress"
+[[getnet.credit]]
+ payment_method_type = "JCB"
+[[getnet.credit]]
+ payment_method_type = "DinersClub"
+[[getnet.credit]]
+ payment_method_type = "Discover"
+[[getnet.credit]]
+ payment_method_type = "CartesBancaires"
+[[getnet.credit]]
+ payment_method_type = "UnionPay"
+[[getnet.credit]]
+ payment_method_type = "Rupay"
+[[getnet.credit]]
+ payment_method_type = "Maestro"
+
[globalpay]
[[globalpay.credit]]
payment_method_type = "Mastercard"
diff --git a/crates/hyperswitch_connectors/src/connectors/getnet.rs b/crates/hyperswitch_connectors/src/connectors/getnet.rs
index 557dfbeaca3..263b1ad5b46 100644
--- a/crates/hyperswitch_connectors/src/connectors/getnet.rs
+++ b/crates/hyperswitch_connectors/src/connectors/getnet.rs
@@ -1,12 +1,16 @@
pub mod transformers;
-
+use api_models::webhooks::IncomingWebhookEvent;
+use base64::{self, Engine};
+use common_enums::enums;
use common_utils::{
+ consts::BASE64_ENGINE,
+ crypto,
errors::CustomResult,
ext_traits::BytesExt,
request::{Method, Request, RequestBuilder, RequestContent},
- types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector},
+ types::{AmountConvertor, FloatMajorUnit, FloatMajorUnitForConnector},
};
-use error_stack::{report, ResultExt};
+use error_stack::ResultExt;
use hyperswitch_domain_models::{
router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData},
router_flow_types::{
@@ -21,8 +25,8 @@ use hyperswitch_domain_models::{
},
router_response_types::{PaymentsResponseData, RefundsResponseData},
types::{
- PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData,
- RefundSyncRouterData, RefundsRouterData,
+ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData,
+ PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData,
},
};
use hyperswitch_interfaces::{
@@ -31,25 +35,26 @@ use hyperswitch_interfaces::{
ConnectorValidation,
},
configs::Connectors,
- errors,
+ errors::{self},
events::connector_api_logs::ConnectorEvent,
types::{self, Response},
- webhooks,
+ webhooks::{self},
};
-use masking::{ExposeInterface, Mask};
+use masking::{Mask, PeekInterface, Secret};
+use ring::hmac;
use transformers as getnet;
use crate::{constants::headers, types::ResponseRouterData, utils};
#[derive(Clone)]
pub struct Getnet {
- amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync),
+ amount_converter: &'static (dyn AmountConvertor<Output = FloatMajorUnit> + Sync),
}
impl Getnet {
pub fn new() -> &'static Self {
&Self {
- amount_converter: &StringMinorUnitForConnector,
+ amount_converter: &FloatMajorUnitForConnector,
}
}
}
@@ -82,10 +87,16 @@ where
req: &RouterData<Flow, Request, Response>,
_connectors: &Connectors,
) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
- let mut header = vec![(
- headers::CONTENT_TYPE.to_string(),
- self.get_content_type().to_string().into(),
- )];
+ let mut header = vec![
+ (
+ headers::CONTENT_TYPE.to_string(),
+ self.get_content_type().to_string().into(),
+ ),
+ (
+ headers::ACCEPT.to_string(),
+ self.get_accept_type().to_string().into(),
+ ),
+ ];
let mut api_key = self.get_auth_header(&req.connector_auth_type)?;
header.append(&mut api_key);
Ok(header)
@@ -99,9 +110,6 @@ impl ConnectorCommon for Getnet {
fn get_currency_unit(&self) -> api::CurrencyUnit {
api::CurrencyUnit::Base
- // TODO! Check connector documentation, on which unit they are processing the currency.
- // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor,
- // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base
}
fn common_get_content_type(&self) -> &'static str {
@@ -118,9 +126,12 @@ impl ConnectorCommon for Getnet {
) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
let auth = getnet::GetnetAuthType::try_from(auth_type)
.change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+ let encoded_api_key =
+ BASE64_ENGINE.encode(format!("{}:{}", auth.username.peek(), auth.password.peek()));
+
Ok(vec![(
headers::AUTHORIZATION.to_string(),
- auth.api_key.expose().into_masked(),
+ format!("Basic {encoded_api_key}").into_masked(),
)])
}
@@ -149,16 +160,60 @@ impl ConnectorCommon for Getnet {
}
impl ConnectorValidation for Getnet {
- //TODO: implement functions when support enabled
-}
+ fn validate_connector_against_payment_request(
+ &self,
+ capture_method: Option<enums::CaptureMethod>,
+ _payment_method: enums::PaymentMethod,
+ _pmt: Option<enums::PaymentMethodType>,
+ ) -> CustomResult<(), errors::ConnectorError> {
+ let capture_method = capture_method.unwrap_or_default();
+ match capture_method {
+ enums::CaptureMethod::Automatic
+ | enums::CaptureMethod::Manual
+ | enums::CaptureMethod::SequentialAutomatic => Ok(()),
+ enums::CaptureMethod::Scheduled | enums::CaptureMethod::ManualMultiple => Err(
+ utils::construct_not_implemented_error_report(capture_method, self.id()),
+ ),
+ }
+ }
-impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Getnet {
- //TODO: implement sessions flow
+ fn validate_psync_reference_id(
+ &self,
+ data: &PaymentsSyncData,
+ _is_three_ds: bool,
+ _status: enums::AttemptStatus,
+ _connector_meta_data: Option<common_utils::pii::SecretSerdeValue>,
+ ) -> CustomResult<(), errors::ConnectorError> {
+ if data.encoded_data.is_some()
+ || data
+ .connector_transaction_id
+ .get_connector_transaction_id()
+ .is_ok()
+ {
+ return Ok(());
+ }
+
+ Err(errors::ConnectorError::MissingConnectorTransactionID.into())
+ }
}
+impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Getnet {}
+
impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Getnet {}
-impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Getnet {}
+impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Getnet {
+ // Not Implemented (R)
+ fn build_request(
+ &self,
+ _req: &RouterData<SetupMandate, SetupMandateRequestData, PaymentsResponseData>,
+ _connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ Err(
+ errors::ConnectorError::NotImplemented("Setup Mandate flow for Getnet".to_string())
+ .into(),
+ )
+ }
+}
impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Getnet {
fn get_headers(
@@ -176,9 +231,10 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData
fn get_url(
&self,
_req: &PaymentsAuthorizeRouterData,
- _connectors: &Connectors,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
- Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ let endpoint = self.base_url(connectors);
+ Ok(format!("{endpoint}/payments/"))
}
fn get_request_body(
@@ -191,10 +247,11 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData
req.request.minor_amount,
req.request.currency,
)?;
-
let connector_router_data = getnet::GetnetRouterData::from((amount, req));
let connector_req = getnet::GetnetPaymentsRequest::try_from(&connector_router_data)?;
- Ok(RequestContent::Json(Box::new(connector_req)))
+ let res = RequestContent::Json(Box::new(connector_req));
+
+ Ok(res)
}
fn build_request(
@@ -262,10 +319,24 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Get
fn get_url(
&self,
- _req: &PaymentsSyncRouterData,
- _connectors: &Connectors,
+ req: &PaymentsSyncRouterData,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
- Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ let auth = getnet::GetnetAuthType::try_from(&req.connector_auth_type)
+ .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+ let merchant_id = auth.merchant_id.peek();
+
+ let endpoint = self.base_url(connectors);
+ let transaction_id = req
+ .request
+ .connector_transaction_id
+ .get_connector_transaction_id()
+ .change_context(errors::ConnectorError::MissingConnectorTransactionID)?;
+
+ Ok(format!(
+ "{}/merchants/{}/payments/{}",
+ endpoint, merchant_id, transaction_id
+ ))
}
fn build_request(
@@ -327,17 +398,26 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo
fn get_url(
&self,
_req: &PaymentsCaptureRouterData,
- _connectors: &Connectors,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
- Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ let endpoint = self.base_url(connectors);
+ Ok(format!("{endpoint}/payments/"))
}
fn get_request_body(
&self,
- _req: &PaymentsCaptureRouterData,
+ req: &PaymentsCaptureRouterData,
_connectors: &Connectors,
) -> CustomResult<RequestContent, errors::ConnectorError> {
- Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into())
+ let amount = utils::convert_amount(
+ self.amount_converter,
+ req.request.minor_amount_to_capture,
+ req.request.currency,
+ )?;
+
+ let connector_router_data = getnet::GetnetRouterData::from((amount, req));
+ let connector_req = getnet::GetnetCaptureRequest::try_from(&connector_router_data)?;
+ Ok(RequestContent::Json(Box::new(connector_req)))
}
fn build_request(
@@ -366,7 +446,7 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo
event_builder: Option<&mut ConnectorEvent>,
res: Response,
) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> {
- let response: getnet::GetnetPaymentsResponse = res
+ let response: getnet::GetnetCaptureResponse = res
.response
.parse_struct("Getnet PaymentsCaptureResponse")
.change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
@@ -377,6 +457,7 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo
data: data.clone(),
http_code: res.status_code,
})
+ .change_context(errors::ConnectorError::ResponseHandlingFailed)
}
fn get_error_response(
@@ -388,7 +469,84 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo
}
}
-impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Getnet {}
+impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Getnet {
+ fn get_headers(
+ &self,
+ req: &PaymentsCancelRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+
+ fn get_url(
+ &self,
+ _req: &PaymentsCancelRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ let endpoint = self.base_url(connectors);
+ Ok(format!("{endpoint}/payments/"))
+ }
+
+ fn get_request_body(
+ &self,
+ req: &PaymentsCancelRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<RequestContent, errors::ConnectorError> {
+ let connector_req = getnet::GetnetCancelRequest::try_from(req)?;
+ Ok(RequestContent::Json(Box::new(connector_req)))
+ }
+
+ fn build_request(
+ &self,
+ req: &PaymentsCancelRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ Ok(Some(
+ RequestBuilder::new()
+ .method(Method::Post)
+ .url(&types::PaymentsVoidType::get_url(self, req, connectors)?)
+ .attach_default_headers()
+ .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?)
+ .set_body(types::PaymentsVoidType::get_request_body(
+ self, req, connectors,
+ )?)
+ .build(),
+ ))
+ }
+
+ fn handle_response(
+ &self,
+ data: &PaymentsCancelRouterData,
+ event_builder: Option<&mut ConnectorEvent>,
+ res: Response,
+ ) -> CustomResult<PaymentsCancelRouterData, errors::ConnectorError> {
+ let response: getnet::GetnetCancelResponse = res
+ .response
+ .parse_struct("GetnetPaymentsVoidResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+
+ RouterData::try_from(ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res, event_builder)
+ }
+}
impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Getnet {
fn get_headers(
@@ -406,9 +564,10 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Getnet
fn get_url(
&self,
_req: &RefundsRouterData<Execute>,
- _connectors: &Connectors,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
- Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ let endpoint = self.base_url(connectors);
+ Ok(format!("{endpoint}/payments/"))
}
fn get_request_body(
@@ -489,10 +648,19 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Getnet {
fn get_url(
&self,
- _req: &RefundSyncRouterData,
- _connectors: &Connectors,
+ req: &RefundSyncRouterData,
+ connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
- Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+ let auth = getnet::GetnetAuthType::try_from(&req.connector_auth_type)
+ .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+ let merchant_id = auth.merchant_id.peek();
+ let endpoint = self.base_url(connectors);
+ let transaction_id = req.request.connector_transaction_id.clone();
+
+ Ok(format!(
+ "{}/merchants/{}/payments/{}",
+ endpoint, merchant_id, transaction_id
+ ))
}
fn build_request(
@@ -543,25 +711,118 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Getnet {
#[async_trait::async_trait]
impl webhooks::IncomingWebhook for Getnet {
- fn get_webhook_object_reference_id(
+ fn get_webhook_source_verification_algorithm(
&self,
_request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<Box<dyn crypto::VerifySignature + Send>, errors::ConnectorError> {
+ Ok(Box::new(crypto::HmacSha256))
+ }
+
+ fn get_webhook_source_verification_signature(
+ &self,
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ _connector_webhook_secrets: &api_models::webhooks::ConnectorWebhookSecrets,
+ ) -> CustomResult<Vec<u8>, errors::ConnectorError> {
+ let notif_item = getnet::get_webhook_response(request.body)
+ .change_context(errors::ConnectorError::WebhookSourceVerificationFailed)?;
+ let response_base64 = ¬if_item.response_base64.peek().clone();
+ BASE64_ENGINE
+ .decode(response_base64)
+ .change_context(errors::ConnectorError::WebhookSourceVerificationFailed)
+ }
+
+ fn get_webhook_source_verification_message(
+ &self,
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ _merchant_id: &common_utils::id_type::MerchantId,
+ _connector_webhook_secrets: &api_models::webhooks::ConnectorWebhookSecrets,
+ ) -> CustomResult<Vec<u8>, errors::ConnectorError> {
+ let notif = getnet::get_webhook_response(request.body)
+ .change_context(errors::ConnectorError::WebhookSourceVerificationFailed)?;
+
+ Ok(notif.response_base64.peek().clone().into_bytes())
+ }
+
+ fn get_webhook_object_reference_id(
+ &self,
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> {
- Err(report!(errors::ConnectorError::WebhooksNotImplemented))
+ let notif = getnet::get_webhook_object_from_body(request.body)
+ .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?;
+ let transaction_type = ¬if.payment.transaction_type;
+ if getnet::is_refund_event(transaction_type) {
+ Ok(api_models::webhooks::ObjectReferenceId::RefundId(
+ api_models::webhooks::RefundIdType::ConnectorRefundId(
+ notif.payment.transaction_id.to_string(),
+ ),
+ ))
+ } else {
+ Ok(api_models::webhooks::ObjectReferenceId::PaymentId(
+ api_models::payments::PaymentIdType::ConnectorTransactionId(
+ notif.payment.transaction_id.to_string(),
+ ),
+ ))
+ }
}
fn get_webhook_event_type(
&self,
- _request: &webhooks::IncomingWebhookRequestDetails<'_>,
- ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> {
- Err(report!(errors::ConnectorError::WebhooksNotImplemented))
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ ) -> CustomResult<IncomingWebhookEvent, errors::ConnectorError> {
+ let notif = getnet::get_webhook_object_from_body(request.body)
+ .change_context(errors::ConnectorError::WebhookEventTypeNotFound)?;
+ let incoming_webhook_event = getnet::get_incoming_webhook_event(
+ notif.payment.transaction_type,
+ notif.payment.transaction_state,
+ );
+ Ok(incoming_webhook_event)
}
fn get_webhook_resource_object(
&self,
- _request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> {
- Err(report!(errors::ConnectorError::WebhooksNotImplemented))
+ let notif = getnet::get_webhook_object_from_body(request.body)
+ .change_context(errors::ConnectorError::WebhookResourceObjectNotFound)?;
+ Ok(Box::new(notif))
+ }
+
+ async fn verify_webhook_source(
+ &self,
+ request: &webhooks::IncomingWebhookRequestDetails<'_>,
+ merchant_id: &common_utils::id_type::MerchantId,
+ connector_webhook_details: Option<common_utils::pii::SecretSerdeValue>,
+ _connector_account_details: crypto::Encryptable<Secret<serde_json::Value>>,
+ connector_name: &str,
+ ) -> CustomResult<bool, errors::ConnectorError> {
+ let notif_item = getnet::get_webhook_response(request.body)
+ .change_context(errors::ConnectorError::WebhookSourceVerificationFailed)?;
+
+ let connector_webhook_secrets = self
+ .get_webhook_source_verification_merchant_secret(
+ merchant_id,
+ connector_name,
+ connector_webhook_details,
+ )
+ .await?;
+
+ let signature = notif_item.response_signature_base64.peek().clone();
+
+ let message = self.get_webhook_source_verification_message(
+ request,
+ merchant_id,
+ &connector_webhook_secrets,
+ )?;
+
+ let secret = connector_webhook_secrets.secret;
+
+ let key = hmac::Key::new(hmac::HMAC_SHA256, &secret);
+ let result = hmac::sign(&key, &message);
+
+ let computed_signature = BASE64_ENGINE.encode(result.as_ref());
+
+ let normalized_computed_signature = computed_signature.replace("+", " ");
+ Ok(signature == normalized_computed_signature)
}
}
diff --git a/crates/hyperswitch_connectors/src/connectors/getnet/transformers.rs b/crates/hyperswitch_connectors/src/connectors/getnet/transformers.rs
index a6dd52d83f5..31aef0a4b1e 100644
--- a/crates/hyperswitch_connectors/src/connectors/getnet/transformers.rs
+++ b/crates/hyperswitch_connectors/src/connectors/getnet/transformers.rs
@@ -1,31 +1,47 @@
-use common_enums::enums;
-use common_utils::types::StringMinorUnit;
+use api_models::webhooks::IncomingWebhookEvent;
+use base64::Engine;
+use cards::CardNumber;
+use common_enums::{enums, AttemptStatus, CaptureMethod, CountryAlpha2};
+use common_utils::{
+ consts::BASE64_ENGINE,
+ errors::CustomResult,
+ pii::{Email, IpAddress},
+ types::FloatMajorUnit,
+};
+use error_stack::ResultExt;
use hyperswitch_domain_models::{
payment_method_data::PaymentMethodData,
router_data::{ConnectorAuthType, RouterData},
router_flow_types::refunds::{Execute, RSync},
- router_request_types::ResponseId,
+ router_request_types::{
+ PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, ResponseId,
+ },
router_response_types::{PaymentsResponseData, RefundsResponseData},
- types::{PaymentsAuthorizeRouterData, RefundsRouterData},
+ types::{
+ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData,
+ PaymentsSyncRouterData, RefundsRouterData,
+ },
};
use hyperswitch_interfaces::errors;
-use masking::Secret;
+use masking::{PeekInterface, Secret};
use serde::{Deserialize, Serialize};
use crate::{
- types::{RefundsResponseRouterData, ResponseRouterData},
- utils::PaymentsAuthorizeRequestData,
+ connectors::paybox::transformers::parse_url_encoded_to_struct,
+ types::{PaymentsSyncResponseRouterData, RefundsResponseRouterData, ResponseRouterData},
+ utils::{
+ BrowserInformationData, PaymentsAuthorizeRequestData, PaymentsSyncRequestData,
+ RouterData as _,
+ },
};
-//TODO: Fill the struct with respective fields
pub struct GetnetRouterData<T> {
- pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc.
+ pub amount: FloatMajorUnit,
pub router_data: T,
}
-impl<T> From<(StringMinorUnit, T)> for GetnetRouterData<T> {
- fn from((amount, item): (StringMinorUnit, T)) -> Self {
- //Todo : use utils to convert the amount to the type of amount that a connector accepts
+impl<T> From<(FloatMajorUnit, T)> for GetnetRouterData<T> {
+ fn from((amount, item): (FloatMajorUnit, T)) -> Self {
Self {
amount,
router_data: item,
@@ -33,39 +49,226 @@ impl<T> From<(StringMinorUnit, T)> for GetnetRouterData<T> {
}
}
-//TODO: Fill the struct with respective fields
+#[derive(Default, Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct Amount {
+ pub value: FloatMajorUnit,
+ pub currency: enums::Currency,
+}
+#[derive(Default, Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct Address {
+ #[serde(rename = "street1")]
+ pub street1: Option<Secret<String>>,
+ pub city: Option<String>,
+ pub state: Option<Secret<String>>,
+ pub country: Option<CountryAlpha2>,
+}
+
+#[derive(Default, Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct AccountHolder {
+ #[serde(rename = "first-name")]
+ pub first_name: Option<Secret<String>>,
+ #[serde(rename = "last-name")]
+ pub last_name: Option<Secret<String>>,
+ pub email: Option<Email>,
+ pub phone: Option<Secret<String>>,
+ pub address: Option<Address>,
+}
+
#[derive(Default, Debug, Serialize, PartialEq)]
+pub struct Card {
+ #[serde(rename = "account-number")]
+ pub account_number: CardNumber,
+ #[serde(rename = "expiration-month")]
+ pub expiration_month: Secret<String>,
+ #[serde(rename = "expiration-year")]
+ pub expiration_year: Secret<String>,
+ #[serde(rename = "card-security-code")]
+ pub card_security_code: Secret<String>,
+ #[serde(rename = "card-type")]
+ pub card_type: String,
+}
+
+#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
+#[serde(rename_all = "lowercase")]
+pub enum GetnetPaymentMethods {
+ CreditCard,
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct PaymentMethod {
+ pub name: GetnetPaymentMethods,
+}
+
+#[derive(Default, Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct Notification {
+ pub url: Option<String>,
+}
+
+#[derive(Default, Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct PaymentMethodContainer {
+ #[serde(rename = "payment-method")]
+ pub payment_method: Vec<PaymentMethod>,
+}
+
+#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
+#[serde(rename_all = "lowercase")]
+pub enum NotificationFormat {
+ #[serde(rename = "application/json-signed")]
+ JsonSigned,
+ #[serde(rename = "application/json")]
+ Json,
+ #[serde(rename = "application/xml")]
+ Xml,
+ #[serde(rename = "application/html")]
+ Html,
+ #[serde(rename = "application/x-www-form-urlencoded")]
+ Urlencoded,
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct NotificationContainer {
+ pub notification: Vec<Notification>,
+ pub format: NotificationFormat,
+}
+
+#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
+pub struct MerchantAccountId {
+ pub value: Secret<String>,
+}
+
+#[derive(Debug, Serialize, PartialEq)]
+pub struct PaymentData {
+ #[serde(rename = "merchant-account-id")]
+ pub merchant_account_id: MerchantAccountId,
+ #[serde(rename = "request-id")]
+ pub request_id: String,
+ #[serde(rename = "transaction-type")]
+ pub transaction_type: GetnetTransactionType,
+ #[serde(rename = "requested-amount")]
+ pub requested_amount: Amount,
+ #[serde(rename = "account-holder")]
+ pub account_holder: Option<AccountHolder>,
+ pub card: Card,
+ #[serde(rename = "ip-address")]
+ pub ip_address: Option<Secret<String, IpAddress>>,
+ #[serde(rename = "payment-methods")]
+ pub payment_methods: PaymentMethodContainer,
+ pub notifications: Option<NotificationContainer>,
+}
+
+#[derive(Debug, Serialize)]
pub struct GetnetPaymentsRequest {
- amount: StringMinorUnit,
- card: GetnetCard,
+ payment: PaymentData,
}
#[derive(Default, Debug, Serialize, Eq, PartialEq)]
pub struct GetnetCard {
- number: cards::CardNumber,
+ number: CardNumber,
expiry_month: Secret<String>,
expiry_year: Secret<String>,
cvc: Secret<String>,
complete: bool,
}
+impl TryFrom<enums::PaymentMethodType> for PaymentMethodContainer {
+ type Error = error_stack::Report<errors::ConnectorError>;
+
+ fn try_from(payment_method_type: enums::PaymentMethodType) -> Result<Self, Self::Error> {
+ match payment_method_type {
+ enums::PaymentMethodType::Credit => Ok(Self {
+ payment_method: vec![PaymentMethod {
+ name: GetnetPaymentMethods::CreditCard,
+ }],
+ }),
+ _ => Err(errors::ConnectorError::NotSupported {
+ message: "Payment method type not supported".to_string(),
+ connector: "Getnet",
+ }
+ .into()),
+ }
+ }
+}
+
impl TryFrom<&GetnetRouterData<&PaymentsAuthorizeRouterData>> for GetnetPaymentsRequest {
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(
item: &GetnetRouterData<&PaymentsAuthorizeRouterData>,
) -> Result<Self, Self::Error> {
match item.router_data.request.payment_method_data.clone() {
- PaymentMethodData::Card(req_card) => {
- let card = GetnetCard {
- number: req_card.card_number,
- expiry_month: req_card.card_exp_month,
- expiry_year: req_card.card_exp_year,
- cvc: req_card.card_cvc,
- complete: item.router_data.request.is_auto_capture()?,
+ PaymentMethodData::Card(ref req_card) => {
+ if item.router_data.is_three_ds() {
+ return Err(errors::ConnectorError::NotSupported {
+ message: "3DS payments".to_string(),
+ connector: "Getnet",
+ }
+ .into());
+ }
+ let request = &item.router_data.request;
+ let auth_type = GetnetAuthType::try_from(&item.router_data.connector_auth_type)
+ .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+ let merchant_account_id = MerchantAccountId {
+ value: auth_type.merchant_id,
};
- Ok(Self {
- amount: item.amount.clone(),
+
+ let requested_amount = Amount {
+ value: item.amount,
+ currency: request.currency,
+ };
+
+ let account_holder = AccountHolder {
+ first_name: item.router_data.get_optional_billing_first_name(),
+ last_name: item.router_data.get_optional_billing_last_name(),
+ email: item.router_data.request.get_optional_email(),
+ phone: item.router_data.get_optional_billing_phone_number(),
+ address: Some(Address {
+ street1: item.router_data.get_optional_billing_line2(),
+ city: item.router_data.get_optional_billing_city(),
+ state: item.router_data.get_optional_billing_state(),
+ country: item.router_data.get_optional_billing_country(),
+ }),
+ };
+
+ let card = Card {
+ account_number: req_card.card_number.clone(),
+ expiration_month: req_card.card_exp_month.clone(),
+ expiration_year: req_card.card_exp_year.clone(),
+ card_security_code: req_card.card_cvc.clone(),
+ card_type: req_card
+ .card_network
+ .as_ref()
+ .map(|network| network.to_string().to_lowercase())
+ .unwrap_or_default(),
+ };
+
+ let pmt = item.router_data.request.get_payment_method_type()?;
+ let payment_method = PaymentMethodContainer::try_from(pmt)?;
+
+ let notifications: NotificationContainer = NotificationContainer {
+ format: NotificationFormat::JsonSigned,
+
+ notification: vec![Notification {
+ url: Some(item.router_data.request.get_webhook_url()?),
+ }],
+ };
+ let transaction_type = if request.is_auto_capture()? {
+ GetnetTransactionType::Purchase
+ } else {
+ GetnetTransactionType::Authorization
+ };
+ let payment_data = PaymentData {
+ merchant_account_id,
+ request_id: item.router_data.payment_id.clone(),
+ transaction_type,
+ requested_amount,
+ account_holder: Some(account_holder),
card,
+ ip_address: Some(request.get_browser_info()?.get_ip_address()?),
+ payment_methods: payment_method,
+ notifications: Some(notifications),
+ };
+
+ Ok(Self {
+ payment: payment_data,
})
}
_ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()),
@@ -73,62 +276,382 @@ impl TryFrom<&GetnetRouterData<&PaymentsAuthorizeRouterData>> for GetnetPayments
}
}
-//TODO: Fill the struct with respective fields
-// Auth Struct
pub struct GetnetAuthType {
- pub(super) api_key: Secret<String>,
+ pub username: Secret<String>,
+ pub password: Secret<String>,
+ pub merchant_id: Secret<String>,
}
impl TryFrom<&ConnectorAuthType> for GetnetAuthType {
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> {
match auth_type {
- ConnectorAuthType::HeaderKey { api_key } => Ok(Self {
- api_key: api_key.to_owned(),
+ ConnectorAuthType::SignatureKey {
+ api_key,
+ key1,
+ api_secret,
+ } => Ok(Self {
+ username: key1.to_owned(),
+ password: api_key.to_owned(),
+ merchant_id: api_secret.to_owned(),
}),
_ => Err(errors::ConnectorError::FailedToObtainAuthType.into()),
}
}
}
-// PaymentsResponse
-//TODO: Append the remaining status flags
+
#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum GetnetPaymentStatus {
- Succeeded,
+ Success,
Failed,
#[default]
- Processing,
+ InProgress,
}
-impl From<GetnetPaymentStatus> for common_enums::AttemptStatus {
+impl From<GetnetPaymentStatus> for AttemptStatus {
fn from(item: GetnetPaymentStatus) -> Self {
match item {
- GetnetPaymentStatus::Succeeded => Self::Charged,
+ GetnetPaymentStatus::Success => Self::Charged,
GetnetPaymentStatus::Failed => Self::Failure,
- GetnetPaymentStatus::Processing => Self::Authorizing,
+ GetnetPaymentStatus::InProgress => Self::Pending,
+ }
+ }
+}
+
+#[derive(Default, Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct Status {
+ pub code: String,
+ pub description: String,
+ pub severity: String,
+}
+
+#[derive(Default, Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct Statuses {
+ pub status: Vec<Status>,
+}
+
+#[derive(Default, Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct CardToken {
+ #[serde(rename = "token-id")]
+ pub token_id: Secret<String>,
+ #[serde(rename = "masked-account-number")]
+ pub masked_account_number: Secret<String>,
+}
+
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+pub struct PaymentResponseData {
+ pub statuses: Statuses,
+ pub descriptor: Option<String>,
+ pub notifications: NotificationContainer,
+ #[serde(rename = "merchant-account-id")]
+ pub merchant_account_id: MerchantAccountId,
+ #[serde(rename = "transaction-id")]
+ pub transaction_id: String,
+ #[serde(rename = "request-id")]
+ pub request_id: String,
+ #[serde(rename = "transaction-type")]
+ pub transaction_type: GetnetTransactionType,
+ #[serde(rename = "transaction-state")]
+ pub transaction_state: GetnetPaymentStatus,
+ #[serde(rename = "completion-time-stamp")]
+ pub completion_time_stamp: Option<i64>,
+ #[serde(rename = "requested-amount")]
+ pub requested_amount: Amount,
+ #[serde(rename = "account-holder")]
+ pub account_holder: Option<AccountHolder>,
+ #[serde(rename = "card-token")]
+ pub card_token: CardToken,
+ #[serde(rename = "ip-address")]
+ pub ip_address: Option<Secret<String, IpAddress>>,
+ #[serde(rename = "payment-methods")]
+ pub payment_methods: PaymentMethodContainer,
+ #[serde(rename = "api-id")]
+ pub api_id: String,
+ #[serde(rename = "self")]
+ pub self_url: String,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct PaymentsResponse {
+ payment: PaymentResponseData,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(untagged)]
+pub enum GetnetPaymentsResponse {
+ PaymentsResponse(Box<PaymentsResponse>),
+ GetnetWebhookNotificationResponse(Box<GetnetWebhookNotificationResponseBody>),
+}
+
+pub fn authorization_attempt_status_from_transaction_state(
+ getnet_status: GetnetPaymentStatus,
+ is_auto_capture: bool,
+) -> AttemptStatus {
+ match getnet_status {
+ GetnetPaymentStatus::Success => {
+ if is_auto_capture {
+ AttemptStatus::Charged
+ } else {
+ AttemptStatus::Authorized
+ }
+ }
+ GetnetPaymentStatus::InProgress => AttemptStatus::Pending,
+ GetnetPaymentStatus::Failed => AttemptStatus::Failure,
+ }
+}
+
+impl<F>
+ TryFrom<
+ ResponseRouterData<F, GetnetPaymentsResponse, PaymentsAuthorizeData, PaymentsResponseData>,
+ > for RouterData<F, PaymentsAuthorizeData, PaymentsResponseData>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: ResponseRouterData<
+ F,
+ GetnetPaymentsResponse,
+ PaymentsAuthorizeData,
+ PaymentsResponseData,
+ >,
+ ) -> Result<Self, Self::Error> {
+ match item.response {
+ GetnetPaymentsResponse::PaymentsResponse(ref payment_response) => Ok(Self {
+ status: authorization_attempt_status_from_transaction_state(
+ payment_response.payment.transaction_state.clone(),
+ item.data.request.is_auto_capture()?,
+ ),
+ response: Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(
+ payment_response.payment.transaction_id.clone(),
+ ),
+ redirection_data: Box::new(None),
+ mandate_reference: Box::new(None),
+ connector_metadata: None,
+ network_txn_id: None,
+ connector_response_reference_id: None,
+ incremental_authorization_allowed: None,
+ charges: None,
+ }),
+ ..item.data
+ }),
+
+ _ => Err(error_stack::Report::new(
+ errors::ConnectorError::ResponseHandlingFailed,
+ )),
+ }
+ }
+}
+
+pub fn psync_attempt_status_from_transaction_state(
+ getnet_status: GetnetPaymentStatus,
+ is_auto_capture: bool,
+ transaction_type: GetnetTransactionType,
+) -> AttemptStatus {
+ match getnet_status {
+ GetnetPaymentStatus::Success => {
+ if is_auto_capture && transaction_type == GetnetTransactionType::CaptureAuthorization {
+ AttemptStatus::Charged
+ } else {
+ AttemptStatus::Authorized
+ }
+ }
+ GetnetPaymentStatus::InProgress => AttemptStatus::Pending,
+ GetnetPaymentStatus::Failed => AttemptStatus::Failure,
+ }
+}
+
+impl TryFrom<PaymentsSyncResponseRouterData<GetnetPaymentsResponse>> for PaymentsSyncRouterData {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: PaymentsSyncResponseRouterData<GetnetPaymentsResponse>,
+ ) -> Result<Self, Self::Error> {
+ match item.response {
+ GetnetPaymentsResponse::PaymentsResponse(ref payment_response) => Ok(Self {
+ status: authorization_attempt_status_from_transaction_state(
+ payment_response.payment.transaction_state.clone(),
+ item.data.request.is_auto_capture()?,
+ ),
+ response: Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(
+ payment_response.payment.transaction_id.clone(),
+ ),
+ redirection_data: Box::new(None),
+ mandate_reference: Box::new(None),
+ connector_metadata: None,
+ network_txn_id: None,
+ connector_response_reference_id: None,
+ incremental_authorization_allowed: None,
+ charges: None,
+ }),
+ ..item.data
+ }),
+
+ GetnetPaymentsResponse::GetnetWebhookNotificationResponse(ref webhook_response) => {
+ Ok(Self {
+ status: psync_attempt_status_from_transaction_state(
+ webhook_response.payment.transaction_state.clone(),
+ item.data.request.is_auto_capture()?,
+ webhook_response.payment.transaction_type.clone(),
+ ),
+ response: Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(
+ webhook_response.payment.transaction_id.clone(),
+ ),
+ redirection_data: Box::new(None),
+ mandate_reference: Box::new(None),
+ connector_metadata: None,
+ network_txn_id: None,
+ connector_response_reference_id: None,
+ incremental_authorization_allowed: None,
+ charges: None,
+ }),
+ ..item.data
+ })
+ }
}
}
}
-//TODO: Fill the struct with respective fields
-#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
-pub struct GetnetPaymentsResponse {
- status: GetnetPaymentStatus,
- id: String,
+#[derive(Debug, Serialize, PartialEq)]
+pub struct CapturePaymentData {
+ #[serde(rename = "merchant-account-id")]
+ pub merchant_account_id: MerchantAccountId,
+ #[serde(rename = "request-id")]
+ pub request_id: String,
+ #[serde(rename = "transaction-type")]
+ pub transaction_type: GetnetTransactionType,
+ #[serde(rename = "parent-transaction-id")]
+ pub parent_transaction_id: String,
+ #[serde(rename = "requested-amount")]
+ pub requested_amount: Amount,
+ pub notifications: NotificationContainer,
+ #[serde(rename = "ip-address")]
+ pub ip_address: Option<Secret<String, IpAddress>>,
+}
+
+#[derive(Debug, Serialize)]
+pub struct GetnetCaptureRequest {
+ pub payment: CapturePaymentData,
+}
+impl TryFrom<&GetnetRouterData<&PaymentsCaptureRouterData>> for GetnetCaptureRequest {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(item: &GetnetRouterData<&PaymentsCaptureRouterData>) -> Result<Self, Self::Error> {
+ let request = &item.router_data.request;
+ let auth_type = GetnetAuthType::try_from(&item.router_data.connector_auth_type)
+ .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+ let merchant_account_id = MerchantAccountId {
+ value: auth_type.merchant_id,
+ };
+
+ let requested_amount = Amount {
+ value: item.amount,
+ currency: request.currency,
+ };
+ let req = &item.router_data.request;
+ let webhook_url = &req.webhook_url;
+ let notifications = NotificationContainer {
+ format: NotificationFormat::JsonSigned,
+
+ notification: vec![Notification {
+ url: webhook_url.clone(),
+ }],
+ };
+ let transaction_type = GetnetTransactionType::CaptureAuthorization;
+ let ip_address = req
+ .browser_info
+ .as_ref()
+ .and_then(|info| info.ip_address.as_ref())
+ .map(|ip| Secret::new(ip.to_string()));
+ let request_id = item.router_data.connector_request_reference_id.clone();
+ let parent_transaction_id = item.router_data.request.connector_transaction_id.clone();
+ let capture_payment_data = CapturePaymentData {
+ merchant_account_id,
+ request_id,
+ transaction_type,
+ parent_transaction_id,
+ requested_amount,
+ notifications,
+ ip_address,
+ };
+
+ Ok(Self {
+ payment: capture_payment_data,
+ })
+ }
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+pub struct CaptureResponseData {
+ pub statuses: Statuses,
+ pub descriptor: String,
+ pub notifications: NotificationContainer,
+ #[serde(rename = "merchant-account-id")]
+ pub merchant_account_id: MerchantAccountId,
+ #[serde(rename = "transaction-id")]
+ pub transaction_id: String,
+ #[serde(rename = "request-id")]
+ pub request_id: String,
+ #[serde(rename = "transaction-type")]
+ pub transaction_type: GetnetTransactionType,
+ #[serde(rename = "transaction-state")]
+ pub transaction_state: GetnetPaymentStatus,
+ #[serde(rename = "completion-time-stamp")]
+ pub completion_time_stamp: Option<i64>,
+ #[serde(rename = "requested-amount")]
+ pub requested_amount: Amount,
+ #[serde(rename = "parent-transaction-id")]
+ pub parent_transaction_id: String,
+ #[serde(rename = "account-holder")]
+ pub account_holder: Option<AccountHolder>,
+ #[serde(rename = "card-token")]
+ pub card_token: CardToken,
+ #[serde(rename = "ip-address")]
+ pub ip_address: Option<Secret<String, IpAddress>>,
+ #[serde(rename = "payment-methods")]
+ pub payment_methods: PaymentMethodContainer,
+ #[serde(rename = "parent-transaction-amount")]
+ pub parent_transaction_amount: Amount,
+ #[serde(rename = "authorization-code")]
+ pub authorization_code: String,
+ #[serde(rename = "api-id")]
+ pub api_id: String,
+ #[serde(rename = "self")]
+ pub self_url: String,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct GetnetCaptureResponse {
+ payment: CaptureResponseData,
+}
+
+pub fn capture_status_from_transaction_state(getnet_status: GetnetPaymentStatus) -> AttemptStatus {
+ match getnet_status {
+ GetnetPaymentStatus::Success => AttemptStatus::Charged,
+ GetnetPaymentStatus::InProgress => AttemptStatus::Pending,
+ GetnetPaymentStatus::Failed => AttemptStatus::Authorized,
+ }
}
-impl<F, T> TryFrom<ResponseRouterData<F, GetnetPaymentsResponse, T, PaymentsResponseData>>
- for RouterData<F, T, PaymentsResponseData>
+impl<F>
+ TryFrom<ResponseRouterData<F, GetnetCaptureResponse, PaymentsCaptureData, PaymentsResponseData>>
+ for RouterData<F, PaymentsCaptureData, PaymentsResponseData>
{
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(
- item: ResponseRouterData<F, GetnetPaymentsResponse, T, PaymentsResponseData>,
+ item: ResponseRouterData<
+ F,
+ GetnetCaptureResponse,
+ PaymentsCaptureData,
+ PaymentsResponseData,
+ >,
) -> Result<Self, Self::Error> {
Ok(Self {
- status: common_enums::AttemptStatus::from(item.response.status),
+ status: capture_status_from_transaction_state(item.response.payment.transaction_state),
response: Ok(PaymentsResponseData::TransactionResponse {
- resource_id: ResponseId::ConnectorTransactionId(item.response.id),
+ resource_id: ResponseId::ConnectorTransactionId(
+ item.response.payment.transaction_id,
+ ),
redirection_data: Box::new(None),
mandate_reference: Box::new(None),
connector_metadata: None,
@@ -142,50 +665,140 @@ impl<F, T> TryFrom<ResponseRouterData<F, GetnetPaymentsResponse, T, PaymentsResp
}
}
-//TODO: Fill the struct with respective fields
-// REFUND :
-// Type definition for RefundRequest
-#[derive(Default, Debug, Serialize)]
+#[derive(Debug, Serialize, PartialEq)]
+pub struct RefundPaymentData {
+ #[serde(rename = "merchant-account-id")]
+ pub merchant_account_id: MerchantAccountId,
+ #[serde(rename = "request-id")]
+ pub request_id: String,
+ #[serde(rename = "transaction-type")]
+ pub transaction_type: GetnetTransactionType,
+ #[serde(rename = "parent-transaction-id")]
+ pub parent_transaction_id: String,
+ pub notifications: NotificationContainer,
+ #[serde(rename = "ip-address")]
+ pub ip_address: Option<Secret<String, IpAddress>>,
+}
+#[derive(Debug, Serialize)]
pub struct GetnetRefundRequest {
- pub amount: StringMinorUnit,
+ pub payment: RefundPaymentData,
}
impl<F> TryFrom<&GetnetRouterData<&RefundsRouterData<F>>> for GetnetRefundRequest {
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(item: &GetnetRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> {
+ let request = &item.router_data.request;
+ let auth_type = GetnetAuthType::try_from(&item.router_data.connector_auth_type)
+ .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+ let url = request.webhook_url.clone();
+
+ let merchant_account_id = MerchantAccountId {
+ value: auth_type.merchant_id,
+ };
+ let notifications = NotificationContainer {
+ format: NotificationFormat::JsonSigned,
+ notification: vec![Notification { url }],
+ };
+ let capture_method = request.capture_method;
+ let transaction_type = match capture_method {
+ Some(CaptureMethod::Automatic) => GetnetTransactionType::RefundPurchase,
+ Some(CaptureMethod::Manual) => GetnetTransactionType::RefundCapture,
+ Some(CaptureMethod::ManualMultiple)
+ | Some(CaptureMethod::Scheduled)
+ | Some(CaptureMethod::SequentialAutomatic)
+ | None => {
+ return Err(errors::ConnectorError::CaptureMethodNotSupported {}.into());
+ }
+ };
+ let ip_address = request
+ .browser_info
+ .as_ref()
+ .and_then(|browser_info| browser_info.ip_address.as_ref())
+ .map(|ip| Secret::new(ip.to_string()));
+ let request_id = item
+ .router_data
+ .refund_id
+ .clone()
+ .ok_or(errors::ConnectorError::MissingConnectorRefundID)?;
+
+ let parent_transaction_id = item.router_data.request.connector_transaction_id.clone();
+ let refund_payment_data = RefundPaymentData {
+ merchant_account_id,
+ request_id,
+ transaction_type,
+ parent_transaction_id,
+ notifications,
+ ip_address,
+ };
+
Ok(Self {
- amount: item.amount.to_owned(),
+ payment: refund_payment_data,
})
}
}
-// Type definition for Refund Response
-
#[allow(dead_code)]
-#[derive(Debug, Serialize, Default, Deserialize, Clone)]
+#[derive(Debug, Serialize, Default, Deserialize, Clone, PartialEq)]
+#[serde(rename_all = "lowercase")]
pub enum RefundStatus {
- Succeeded,
+ Success,
Failed,
#[default]
- Processing,
+ InProgress,
}
impl From<RefundStatus> for enums::RefundStatus {
fn from(item: RefundStatus) -> Self {
match item {
- RefundStatus::Succeeded => Self::Success,
+ RefundStatus::Success => Self::Success,
RefundStatus::Failed => Self::Failure,
- RefundStatus::Processing => Self::Pending,
- //TODO: Review mapping
+ RefundStatus::InProgress => Self::Pending,
}
}
}
-//TODO: Fill the struct with respective fields
-#[derive(Default, Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+pub struct RefundResponseData {
+ pub statuses: Statuses,
+ pub descriptor: String,
+ pub notifications: NotificationContainer,
+ #[serde(rename = "merchant-account-id")]
+ pub merchant_account_id: MerchantAccountId,
+ #[serde(rename = "transaction-id")]
+ pub transaction_id: String,
+ #[serde(rename = "request-id")]
+ pub request_id: String,
+ #[serde(rename = "transaction-type")]
+ pub transaction_type: GetnetTransactionType,
+ #[serde(rename = "transaction-state")]
+ pub transaction_state: RefundStatus,
+ #[serde(rename = "completion-time-stamp")]
+ pub completion_time_stamp: Option<i64>,
+ #[serde(rename = "requested-amount")]
+ pub requested_amount: Amount,
+ #[serde(rename = "parent-transaction-id")]
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub parent_transaction_id: Option<String>,
+ #[serde(rename = "account-holder")]
+ pub account_holder: Option<AccountHolder>,
+ #[serde(rename = "card-token")]
+ pub card_token: CardToken,
+ #[serde(rename = "ip-address")]
+ pub ip_address: Option<Secret<String, IpAddress>>,
+ #[serde(rename = "payment-methods")]
+ pub payment_methods: PaymentMethodContainer,
+ #[serde(rename = "parent-transaction-amount")]
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub parent_transaction_amount: Option<Amount>,
+ #[serde(rename = "api-id")]
+ pub api_id: String,
+ #[serde(rename = "self")]
+ pub self_url: String,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RefundResponse {
- id: String,
- status: RefundStatus,
+ payment: RefundResponseData,
}
impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> {
@@ -195,8 +808,8 @@ impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRout
) -> Result<Self, Self::Error> {
Ok(Self {
response: Ok(RefundsResponseData {
- connector_refund_id: item.response.id.to_string(),
- refund_status: enums::RefundStatus::from(item.response.status),
+ connector_refund_id: item.response.payment.transaction_id,
+ refund_status: enums::RefundStatus::from(item.response.payment.transaction_state),
}),
..item.data
})
@@ -210,15 +823,181 @@ impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouter
) -> Result<Self, Self::Error> {
Ok(Self {
response: Ok(RefundsResponseData {
- connector_refund_id: item.response.id.to_string(),
- refund_status: enums::RefundStatus::from(item.response.status),
+ connector_refund_id: item.response.payment.transaction_id,
+ refund_status: enums::RefundStatus::from(item.response.payment.transaction_state),
+ }),
+ ..item.data
+ })
+ }
+}
+
+#[derive(Debug, Serialize, PartialEq)]
+pub struct CancelPaymentData {
+ #[serde(rename = "merchant-account-id")]
+ pub merchant_account_id: MerchantAccountId,
+ #[serde(rename = "request-id")]
+ pub request_id: String,
+ #[serde(rename = "transaction-type")]
+ pub transaction_type: GetnetTransactionType,
+ #[serde(rename = "parent-transaction-id")]
+ pub parent_transaction_id: String,
+ pub notifications: NotificationContainer,
+ #[serde(rename = "ip-address")]
+ pub ip_address: Option<Secret<String, IpAddress>>,
+}
+
+#[derive(Debug, Serialize)]
+pub struct GetnetCancelRequest {
+ pub payment: CancelPaymentData,
+}
+
+impl TryFrom<&PaymentsCancelRouterData> for GetnetCancelRequest {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(item: &PaymentsCancelRouterData) -> Result<Self, Self::Error> {
+ let request = &item.request;
+ let auth_type = GetnetAuthType::try_from(&item.connector_auth_type)
+ .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+
+ let merchant_account_id = MerchantAccountId {
+ value: auth_type.merchant_id,
+ };
+ let webhook_url = &item.request.webhook_url;
+ let notifications = NotificationContainer {
+ format: NotificationFormat::JsonSigned,
+
+ notification: vec![Notification {
+ url: webhook_url.clone(),
+ }],
+ };
+ let capture_method = &item.request.capture_method;
+ let transaction_type = match capture_method {
+ Some(CaptureMethod::Automatic) => GetnetTransactionType::VoidPurchase,
+ Some(CaptureMethod::Manual) => GetnetTransactionType::VoidAuthorization,
+ Some(CaptureMethod::ManualMultiple)
+ | Some(CaptureMethod::Scheduled)
+ | Some(CaptureMethod::SequentialAutomatic) => {
+ return Err(errors::ConnectorError::CaptureMethodNotSupported {}.into());
+ }
+ None => {
+ return Err(errors::ConnectorError::CaptureMethodNotSupported {}.into());
+ }
+ };
+ let ip_address = request
+ .browser_info
+ .as_ref()
+ .and_then(|browser_info| browser_info.ip_address.as_ref())
+ .map(|ip| Secret::new(ip.to_string()));
+ let request_id = &item.connector_request_reference_id.clone();
+ let parent_transaction_id = item.request.connector_transaction_id.clone();
+ let cancel_payment_data = CancelPaymentData {
+ merchant_account_id,
+ request_id: request_id.to_string(),
+ transaction_type,
+ parent_transaction_id,
+ notifications,
+ ip_address,
+ };
+ Ok(Self {
+ payment: cancel_payment_data,
+ })
+ }
+}
+
+#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
+#[serde(rename_all = "lowercase")]
+pub enum GetnetTransactionType {
+ Purchase,
+ #[serde(rename = "capture-authorization")]
+ CaptureAuthorization,
+ #[serde(rename = "refund-purchase")]
+ RefundPurchase,
+ #[serde(rename = "refund-capture")]
+ RefundCapture,
+ #[serde(rename = "void-authorization")]
+ VoidAuthorization,
+ #[serde(rename = "void-purchase")]
+ VoidPurchase,
+ Authorization,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "lowercase")]
+pub struct CancelResponseData {
+ pub statuses: Statuses,
+ pub descriptor: String,
+ pub notifications: NotificationContainer,
+ #[serde(rename = "merchant-account-id")]
+ pub merchant_account_id: MerchantAccountId,
+ #[serde(rename = "transaction-id")]
+ pub transaction_id: String,
+ #[serde(rename = "request-id")]
+ pub request_id: String,
+ #[serde(rename = "transaction-type")]
+ pub transaction_type: GetnetTransactionType,
+ #[serde(rename = "transaction-state")]
+ pub transaction_state: GetnetPaymentStatus,
+ #[serde(rename = "completion-time-stamp")]
+ pub completion_time_stamp: Option<i64>,
+ #[serde(rename = "requested-amount")]
+ pub requested_amount: Amount,
+ #[serde(rename = "parent-transaction-id")]
+ pub parent_transaction_id: String,
+ #[serde(rename = "account-holder")]
+ pub account_holder: Option<AccountHolder>,
+ #[serde(rename = "card-token")]
+ pub card_token: CardToken,
+ #[serde(rename = "ip-address")]
+ pub ip_address: Option<Secret<String, IpAddress>>,
+ #[serde(rename = "payment-methods")]
+ pub payment_methods: PaymentMethodContainer,
+ #[serde(rename = "parent-transaction-amount")]
+ pub parent_transaction_amount: Amount,
+ #[serde(rename = "api-id")]
+ pub api_id: String,
+ #[serde(rename = "self")]
+ pub self_url: String,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct GetnetCancelResponse {
+ payment: CancelResponseData,
+}
+
+pub fn cancel_status_from_transaction_state(getnet_status: GetnetPaymentStatus) -> AttemptStatus {
+ match getnet_status {
+ GetnetPaymentStatus::Success => AttemptStatus::Voided,
+ GetnetPaymentStatus::InProgress => AttemptStatus::Pending,
+ GetnetPaymentStatus::Failed => AttemptStatus::VoidFailed,
+ }
+}
+
+impl<F>
+ TryFrom<ResponseRouterData<F, GetnetCancelResponse, PaymentsCancelData, PaymentsResponseData>>
+ for RouterData<F, PaymentsCancelData, PaymentsResponseData>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: ResponseRouterData<F, GetnetCancelResponse, PaymentsCancelData, PaymentsResponseData>,
+ ) -> Result<Self, Self::Error> {
+ Ok(Self {
+ status: cancel_status_from_transaction_state(item.response.payment.transaction_state),
+ response: Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(
+ item.response.payment.transaction_id,
+ ),
+ redirection_data: Box::new(None),
+ mandate_reference: Box::new(None),
+ connector_metadata: None,
+ network_txn_id: None,
+ connector_response_reference_id: None,
+ incremental_authorization_allowed: None,
+ charges: None,
}),
..item.data
})
}
}
-//TODO: Fill the struct with respective fields
#[derive(Default, Debug, Serialize, Deserialize, PartialEq)]
pub struct GetnetErrorResponse {
pub status_code: u16,
@@ -226,3 +1005,150 @@ pub struct GetnetErrorResponse {
pub message: String,
pub reason: Option<String>,
}
+
+#[derive(Serialize, Deserialize, Debug)]
+pub struct GetnetWebhookNotificationResponse {
+ #[serde(rename = "response-signature-base64")]
+ pub response_signature_base64: Secret<String>,
+ #[serde(rename = "response-signature-algorithm")]
+ pub response_signature_algorithm: Secret<String>,
+ #[serde(rename = "response-base64")]
+ pub response_base64: Secret<String>,
+}
+
+#[derive(Debug, Serialize, Deserialize, PartialEq)]
+pub struct WebhookResponseData {
+ pub statuses: Statuses,
+ pub descriptor: String,
+ pub notifications: NotificationContainer,
+ #[serde(rename = "merchant-account-id")]
+ pub merchant_account_id: MerchantAccountId,
+ #[serde(rename = "transaction-id")]
+ pub transaction_id: String,
+ #[serde(rename = "request-id")]
+ pub request_id: String,
+ #[serde(rename = "transaction-type")]
+ pub transaction_type: GetnetTransactionType,
+ #[serde(rename = "transaction-state")]
+ pub transaction_state: GetnetPaymentStatus,
+ #[serde(rename = "completion-time-stamp")]
+ pub completion_time_stamp: u64,
+ #[serde(rename = "requested-amount")]
+ pub requested_amount: Amount,
+ #[serde(rename = "parent-transaction-id")]
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub parent_transaction_id: Option<String>,
+ #[serde(rename = "account-holder")]
+ pub account_holder: Option<AccountHolder>,
+ #[serde(rename = "card-token")]
+ pub card_token: CardToken,
+ #[serde(rename = "ip-address")]
+ pub ip_address: Option<Secret<String, IpAddress>>,
+ #[serde(rename = "payment-methods")]
+ pub payment_methods: PaymentMethodContainer,
+ #[serde(rename = "parent-transaction-amount")]
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub parent_transaction_amount: Option<Amount>,
+ #[serde(rename = "authorization-code")]
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub authorization_code: Option<String>,
+ #[serde(rename = "api-id")]
+ pub api_id: String,
+ #[serde(rename = "provider-account-id")]
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub provider_account_id: Option<String>,
+}
+
+#[derive(Serialize, Deserialize, Debug)]
+pub struct GetnetWebhookNotificationResponseBody {
+ pub payment: WebhookResponseData,
+}
+
+pub fn is_refund_event(transaction_type: &GetnetTransactionType) -> bool {
+ matches!(
+ transaction_type,
+ GetnetTransactionType::RefundPurchase | GetnetTransactionType::RefundCapture
+ )
+}
+
+pub fn get_webhook_object_from_body(
+ body: &[u8],
+) -> CustomResult<GetnetWebhookNotificationResponseBody, errors::ConnectorError> {
+ let body_bytes = bytes::Bytes::copy_from_slice(body);
+ let parsed_param: GetnetWebhookNotificationResponse =
+ parse_url_encoded_to_struct(body_bytes)
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
+ let response_base64 = &parsed_param.response_base64.peek();
+ let decoded_response = BASE64_ENGINE
+ .decode(response_base64)
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
+
+ let getnet_webhook_notification_response: GetnetWebhookNotificationResponseBody =
+ match serde_json::from_slice::<GetnetWebhookNotificationResponseBody>(&decoded_response) {
+ Ok(response) => response,
+ Err(_e) => {
+ return Err(errors::ConnectorError::WebhookBodyDecodingFailed)?;
+ }
+ };
+
+ Ok(getnet_webhook_notification_response)
+}
+
+pub fn get_webhook_response(
+ body: &[u8],
+) -> CustomResult<GetnetWebhookNotificationResponse, errors::ConnectorError> {
+ let body_bytes = bytes::Bytes::copy_from_slice(body);
+ let parsed_param: GetnetWebhookNotificationResponse =
+ parse_url_encoded_to_struct(body_bytes)
+ .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?;
+ Ok(parsed_param)
+}
+
+pub fn get_incoming_webhook_event(
+ transaction_type: GetnetTransactionType,
+ transaction_status: GetnetPaymentStatus,
+) -> IncomingWebhookEvent {
+ match transaction_type {
+ GetnetTransactionType::Purchase => match transaction_status {
+ GetnetPaymentStatus::Success => IncomingWebhookEvent::PaymentIntentSuccess,
+ GetnetPaymentStatus::Failed => IncomingWebhookEvent::PaymentIntentFailure,
+ GetnetPaymentStatus::InProgress => IncomingWebhookEvent::PaymentIntentProcessing,
+ },
+
+ GetnetTransactionType::Authorization => match transaction_status {
+ GetnetPaymentStatus::Success => IncomingWebhookEvent::PaymentIntentAuthorizationSuccess,
+ GetnetPaymentStatus::Failed => IncomingWebhookEvent::PaymentIntentAuthorizationFailure,
+ GetnetPaymentStatus::InProgress => IncomingWebhookEvent::PaymentIntentProcessing,
+ },
+
+ GetnetTransactionType::CaptureAuthorization => match transaction_status {
+ GetnetPaymentStatus::Success => IncomingWebhookEvent::PaymentIntentCaptureSuccess,
+ GetnetPaymentStatus::Failed => IncomingWebhookEvent::PaymentIntentCaptureFailure,
+ GetnetPaymentStatus::InProgress => IncomingWebhookEvent::PaymentIntentCaptureFailure,
+ },
+
+ GetnetTransactionType::RefundPurchase => match transaction_status {
+ GetnetPaymentStatus::Success => IncomingWebhookEvent::RefundSuccess,
+ GetnetPaymentStatus::Failed => IncomingWebhookEvent::RefundFailure,
+ GetnetPaymentStatus::InProgress => IncomingWebhookEvent::RefundFailure,
+ },
+
+ GetnetTransactionType::RefundCapture => match transaction_status {
+ GetnetPaymentStatus::Success => IncomingWebhookEvent::RefundSuccess,
+ GetnetPaymentStatus::Failed => IncomingWebhookEvent::RefundFailure,
+ GetnetPaymentStatus::InProgress => IncomingWebhookEvent::RefundFailure,
+ },
+
+ GetnetTransactionType::VoidAuthorization => match transaction_status {
+ GetnetPaymentStatus::Success => IncomingWebhookEvent::PaymentIntentCancelled,
+ GetnetPaymentStatus::Failed => IncomingWebhookEvent::PaymentIntentCancelFailure,
+ GetnetPaymentStatus::InProgress => IncomingWebhookEvent::PaymentIntentCancelFailure,
+ },
+
+ GetnetTransactionType::VoidPurchase => match transaction_status {
+ GetnetPaymentStatus::Success => IncomingWebhookEvent::PaymentIntentCancelled,
+ GetnetPaymentStatus::Failed => IncomingWebhookEvent::PaymentIntentCancelFailure,
+ GetnetPaymentStatus::InProgress => IncomingWebhookEvent::PaymentIntentCancelFailure,
+ },
+ }
+}
diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs
index b082962e400..a13f98ed788 100644
--- a/crates/hyperswitch_connectors/src/utils.rs
+++ b/crates/hyperswitch_connectors/src/utils.rs
@@ -1855,6 +1855,7 @@ pub trait PaymentsCaptureRequestData {
fn get_optional_language_from_browser_info(&self) -> Option<String>;
fn is_multiple_capture(&self) -> bool;
fn get_browser_info(&self) -> Result<BrowserInformation, Error>;
+ fn get_webhook_url(&self) -> Result<String, Error>;
}
impl PaymentsCaptureRequestData for PaymentsCaptureData {
@@ -1871,6 +1872,11 @@ impl PaymentsCaptureRequestData for PaymentsCaptureData {
.clone()
.and_then(|browser_info| browser_info.language)
}
+ fn get_webhook_url(&self) -> Result<String, Error> {
+ self.webhook_url
+ .clone()
+ .ok_or_else(missing_field_err("webhook_url"))
+ }
}
pub trait PaymentsSyncRequestData {
@@ -1924,6 +1930,7 @@ pub trait PaymentsCancelRequestData {
fn get_currency(&self) -> Result<enums::Currency, Error>;
fn get_cancellation_reason(&self) -> Result<String, Error>;
fn get_browser_info(&self) -> Result<BrowserInformation, Error>;
+ fn get_webhook_url(&self) -> Result<String, Error>;
}
impl PaymentsCancelRequestData for PaymentsCancelData {
@@ -1948,6 +1955,11 @@ impl PaymentsCancelRequestData for PaymentsCancelData {
.clone()
.and_then(|browser_info| browser_info.language)
}
+ fn get_webhook_url(&self) -> Result<String, Error> {
+ self.webhook_url
+ .clone()
+ .ok_or_else(missing_field_err("webhook_url"))
+ }
}
pub trait RefundsRequestData {
diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs
index 6c1e11ced4e..ff5534dcebc 100644
--- a/crates/hyperswitch_domain_models/src/router_request_types.rs
+++ b/crates/hyperswitch_domain_models/src/router_request_types.rs
@@ -125,6 +125,7 @@ pub struct PaymentsCaptureData {
pub minor_payment_amount: MinorUnit,
pub minor_amount_to_capture: MinorUnit,
pub integrity_object: Option<CaptureIntegrityObject>,
+ pub webhook_url: Option<String>,
}
#[derive(Debug, Clone, PartialEq)]
@@ -467,6 +468,8 @@ pub struct PaymentsCancelData {
// minor amount data for amount framework
pub minor_amount: Option<MinorUnit>,
+ pub webhook_url: Option<String>,
+ pub capture_method: Option<storage_enums::CaptureMethod>,
}
#[derive(Debug, Default, Clone)]
@@ -643,6 +646,7 @@ pub struct RefundsData {
pub refund_status: storage_enums::RefundStatus,
pub merchant_account_id: Option<Secret<String>>,
pub merchant_config_currency: Option<storage_enums::Currency>,
+ pub capture_method: Option<storage_enums::CaptureMethod>,
}
#[derive(Debug, Clone, PartialEq)]
diff --git a/crates/hyperswitch_interfaces/src/api.rs b/crates/hyperswitch_interfaces/src/api.rs
index b70d326feb6..cf9b2ff9764 100644
--- a/crates/hyperswitch_interfaces/src/api.rs
+++ b/crates/hyperswitch_interfaces/src/api.rs
@@ -100,6 +100,11 @@ pub trait ConnectorIntegration<T, Req, Resp>:
mime::APPLICATION_JSON.essence_str()
}
+ /// fn get_content_type
+ fn get_accept_type(&self) -> &'static str {
+ mime::APPLICATION_JSON.essence_str()
+ }
+
/// primarily used when creating signature based on request method of payment flow
fn get_http_method(&self) -> Method {
Method::Post
diff --git a/crates/router/src/configs/defaults/payment_connector_required_fields.rs b/crates/router/src/configs/defaults/payment_connector_required_fields.rs
index ac14cfb7c1d..caa24ae1107 100644
--- a/crates/router/src/configs/defaults/payment_connector_required_fields.rs
+++ b/crates/router/src/configs/defaults/payment_connector_required_fields.rs
@@ -5332,6 +5332,62 @@ impl Default for settings::RequiredFields {
common:HashMap::new(),
}
),
+ (
+ enums::Connector::Getnet,
+ RequiredFieldFinal {
+ mandate: HashMap::new(),
+ non_mandate: HashMap::new(),
+ common: HashMap::from(
+ [
+ (
+ "payment_method_data.card.card_number".to_string(),
+ RequiredFieldInfo {
+ required_field: "payment_method_data.card.card_number".to_string(),
+ display_name: "card_number".to_string(),
+ field_type: enums::FieldType::UserCardNumber,
+ value: None,
+ }
+ ),
+ (
+ "payment_method_data.card.card_exp_month".to_string(),
+ RequiredFieldInfo {
+ required_field: "payment_method_data.card.card_exp_month".to_string(),
+ display_name: "card_exp_month".to_string(),
+ field_type: enums::FieldType::UserCardExpiryMonth,
+ value: None,
+ }
+ ),
+ (
+ "payment_method_data.card.card_exp_year".to_string(),
+ RequiredFieldInfo {
+ required_field: "payment_method_data.card.card_exp_year".to_string(),
+ display_name: "card_exp_year".to_string(),
+ field_type: enums::FieldType::UserCardExpiryYear,
+ value: None,
+ }
+ ),
+ (
+ "payment_method_data.card.card_cvc".to_string(),
+ RequiredFieldInfo {
+ required_field: "payment_method_data.card.card_cvc".to_string(),
+ display_name: "card_cvc".to_string(),
+ field_type: enums::FieldType::UserCardCvc,
+ value: None,
+ }
+ ),
+ (
+ "payment_method_data.card.card_network".to_string(),
+ RequiredFieldInfo {
+ required_field: "payment_method_data.card.card_network".to_string(),
+ display_name: "card_network".to_string(),
+ field_type: enums::FieldType::UserCardNetwork,
+ value: None,
+ }
+ ),
+ ]
+ ),
+ }
+ ),
(
enums::Connector::Globalpay,
RequiredFieldFinal {
diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs
index 0da8bbf1828..c79154bf680 100644
--- a/crates/router/src/core/admin.rs
+++ b/crates/router/src/core/admin.rs
@@ -1382,10 +1382,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> {
forte::transformers::ForteAuthType::try_from(self.auth_type)?;
Ok(())
}
- // api_enums::Connector::Getnet => {
- // getnet::transformers::GetnetAuthType::try_from(self.auth_type)?;
- // Ok(())
- // }
+ api_enums::Connector::Getnet => {
+ getnet::transformers::GetnetAuthType::try_from(self.auth_type)?;
+ Ok(())
+ }
api_enums::Connector::Globalpay => {
globalpay::transformers::GlobalpayAuthType::try_from(self.auth_type)?;
Ok(())
diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs
index b5104391ab8..308a3f2ede3 100644
--- a/crates/router/src/core/payments/flows/authorize_flow.rs
+++ b/crates/router/src/core/payments/flows/authorize_flow.rs
@@ -627,6 +627,7 @@ impl<F>
minor_amount_to_capture: item.request.minor_amount,
integrity_object: None,
split_payments: item.request.split_payments,
+ webhook_url: item.request.webhook_url,
})
}
}
diff --git a/crates/router/src/core/payments/flows/complete_authorize_flow.rs b/crates/router/src/core/payments/flows/complete_authorize_flow.rs
index 6e8152716d0..54dca9b2e41 100644
--- a/crates/router/src/core/payments/flows/complete_authorize_flow.rs
+++ b/crates/router/src/core/payments/flows/complete_authorize_flow.rs
@@ -319,6 +319,7 @@ impl<F>
minor_amount_to_capture: item.request.minor_amount,
integrity_object: None,
split_payments: None,
+ webhook_url: None,
})
}
}
diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs
index a34c137dbda..d528a320e6d 100644
--- a/crates/router/src/core/payments/transformers.rs
+++ b/crates/router/src/core/payments/transformers.rs
@@ -473,6 +473,7 @@ pub async fn construct_payment_router_data_for_capture<'a>(
metadata: payment_data.payment_intent.metadata.expose_option(),
integrity_object: None,
split_payments: None,
+ webhook_url: None,
};
// TODO: evaluate the fields in router data, if they are required or not
@@ -3436,6 +3437,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD
metadata: payment_data.payment_intent.metadata.expose_option(),
integrity_object: None,
split_payments: None,
+ webhook_url: None,
})
}
}
@@ -3466,6 +3468,21 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD
field_name: "browser_info",
})?;
let amount = payment_data.payment_attempt.get_total_amount();
+
+ let router_base_url = &additional_data.router_base_url;
+ let attempt = &payment_data.payment_attempt;
+
+ let merchant_connector_account_id = payment_data
+ .payment_attempt
+ .merchant_connector_id
+ .as_ref()
+ .map(|mca_id| mca_id.get_string_repr())
+ .ok_or(errors::ApiErrorResponse::MerchantAccountNotFound)?;
+ let webhook_url: Option<_> = Some(helpers::create_webhook_url(
+ router_base_url,
+ &attempt.merchant_id,
+ merchant_connector_account_id,
+ ));
Ok(Self {
capture_method: payment_data.get_capture_method(),
amount_to_capture: amount_to_capture.get_amount_as_i64(), // This should be removed once we start moving to connector module
@@ -3492,6 +3509,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD
metadata: payment_data.payment_intent.metadata,
integrity_object: None,
split_payments: payment_data.payment_intent.split_payments,
+ webhook_url,
})
}
}
@@ -3527,6 +3545,22 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCancelDa
field_name: "browser_info",
})?;
let amount = payment_data.payment_attempt.get_total_amount();
+
+ let router_base_url = &additional_data.router_base_url;
+ let attempt = &payment_data.payment_attempt;
+
+ let merchant_connector_account_id = payment_data
+ .payment_attempt
+ .merchant_connector_id
+ .as_ref()
+ .map(|mca_id| mca_id.get_string_repr())
+ .ok_or(errors::ApiErrorResponse::MerchantAccountNotFound)?;
+ let webhook_url: Option<_> = Some(helpers::create_webhook_url(
+ router_base_url,
+ &attempt.merchant_id,
+ merchant_connector_account_id,
+ ));
+ let capture_method = payment_data.payment_attempt.capture_method;
Ok(Self {
amount: Some(amount.get_amount_as_i64()), // This should be removed once we start moving to connector module
minor_amount: Some(amount),
@@ -3539,6 +3573,8 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCancelDa
connector_meta: payment_data.payment_attempt.connector_metadata,
browser_info,
metadata: payment_data.payment_intent.metadata,
+ webhook_url,
+ capture_method,
})
}
}
diff --git a/crates/router/src/core/relay/utils.rs b/crates/router/src/core/relay/utils.rs
index 969566c098e..b4d70038c67 100644
--- a/crates/router/src/core/relay/utils.rs
+++ b/crates/router/src/core/relay/utils.rs
@@ -109,6 +109,7 @@ pub async fn construct_relay_refund_router_data<F>(
refund_status: common_enums::RefundStatus::from(relay_record.status),
merchant_account_id: None,
merchant_config_currency: None,
+ capture_method: None,
},
response: Err(ErrorResponse::default()),
diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs
index 537f67871ea..d9467d19ced 100644
--- a/crates/router/src/core/utils.rs
+++ b/crates/router/src/core/utils.rs
@@ -337,6 +337,7 @@ pub async fn construct_refund_router_data<'a, F>(
})?;
let connector_refund_id = refund.get_optional_connector_refund_id().cloned();
+ let capture_method = payment_attempt.capture_method;
let braintree_metadata = payment_intent
.connector_metadata
@@ -395,6 +396,7 @@ pub async fn construct_refund_router_data<'a, F>(
refund_status: refund.refund_status,
merchant_account_id,
merchant_config_currency,
+ capture_method,
},
response: Ok(types::RefundsResponseData {
diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs
index 9499eed165b..8132d720263 100644
--- a/crates/router/src/types/api.rs
+++ b/crates/router/src/types/api.rs
@@ -442,9 +442,9 @@ impl ConnectorData {
enums::Connector::Forte => {
Ok(ConnectorEnum::Old(Box::new(connector::Forte::new())))
}
- // enums::Connector::Getnet => {
- // Ok(ConnectorEnum::Old(Box::new(connector::Getnet::new())))
- // }
+ enums::Connector::Getnet => {
+ Ok(ConnectorEnum::Old(Box::new(connector::Getnet::new())))
+ }
enums::Connector::Globalpay => {
Ok(ConnectorEnum::Old(Box::new(connector::Globalpay::new())))
}
diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs
index 2fa29ccaf96..450cf7c3d66 100644
--- a/crates/router/src/types/transformers.rs
+++ b/crates/router/src/types/transformers.rs
@@ -246,7 +246,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors {
api_enums::Connector::Fiservemea => Self::Fiservemea,
api_enums::Connector::Fiuu => Self::Fiuu,
api_enums::Connector::Forte => Self::Forte,
- // api_enums::Connector::Getnet => Self::Getnet,
+ api_enums::Connector::Getnet => Self::Getnet,
api_enums::Connector::Globalpay => Self::Globalpay,
api_enums::Connector::Globepay => Self::Globepay,
api_enums::Connector::Gocardless => Self::Gocardless,
diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs
index ead0173ed56..c8747225513 100644
--- a/crates/router/tests/connectors/utils.rs
+++ b/crates/router/tests/connectors/utils.rs
@@ -408,6 +408,7 @@ pub trait ConnectorActions: Connector {
refund_status: enums::RefundStatus::Pending,
merchant_account_id: None,
merchant_config_currency: None,
+ capture_method: None,
}),
payment_info,
);
@@ -1075,6 +1076,7 @@ impl Default for PaymentRefundType {
refund_status: enums::RefundStatus::Pending,
merchant_account_id: None,
merchant_config_currency: None,
+ capture_method: None,
};
Self(data)
}
diff --git a/cypress-tests/cypress/e2e/configs/Payment/Getnet.js b/cypress-tests/cypress/e2e/configs/Payment/Getnet.js
new file mode 100644
index 00000000000..ac80e207849
--- /dev/null
+++ b/cypress-tests/cypress/e2e/configs/Payment/Getnet.js
@@ -0,0 +1,330 @@
+const successfulNo3DSCardDetails = {
+ card_number: "5413330300001006",
+ card_exp_month: "02",
+ card_exp_year: "2027",
+ card_holder_name: "John Doe",
+ card_cvc: "006",
+ card_network: "Visa",
+};
+
+export const connectorDetails = {
+ card_pm: {
+ PaymentIntent: {
+ Request: {
+ currency: "GBP",
+ customer_acceptance: null,
+ setup_future_usage: "on_session",
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "requires_payment_method",
+ },
+ },
+ },
+ PaymentIntentWithShippingCost: {
+ Request: {
+ currency: "GBP",
+ shipping_cost: 50,
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "requires_payment_method",
+ amount: 6000,
+ shipping_cost: 50,
+ },
+ },
+ },
+ PaymentConfirmWithShippingCost: {
+ Request: {
+ payment_method: "card",
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ customer_acceptance: null,
+ setup_future_usage: "on_session",
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "succeeded",
+ shipping_cost: 50,
+ amount_received: 6050,
+ amount: 6000,
+ net_amount: 6050,
+ },
+ },
+ },
+ "3DSManualCapture": {
+ Request: {
+ payment_method: "card",
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ currency: "GBP",
+ customer_acceptance: null,
+ setup_future_usage: "on_session",
+ },
+ Response: {
+ status: 501,
+ body: {
+ error: {
+ type: "invalid_request",
+ message: "Payment method type not supported",
+ code: "IR_19",
+ reason: "3DS payments is not supported by Getnet",
+ },
+ },
+ },
+ },
+ "3DSAutoCapture": {
+ Request: {
+ payment_method: "card",
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ currency: "GBP",
+ customer_acceptance: null,
+ setup_future_usage: "on_session",
+ },
+ Response: {
+ status: 501,
+ body: {
+ error: {
+ type: "invalid_request",
+ message: "Payment method type not supported",
+ code: "IR_19",
+ reason: "3DS payments is not supported by Getnet",
+ },
+ },
+ },
+ },
+ No3DSManualCapture: {
+ Request: {
+ currency: "GBP",
+ payment_method: "card",
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ customer_acceptance: null,
+ setup_future_usage: "on_session",
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "requires_capture",
+ },
+ },
+ },
+ No3DSAutoCapture: {
+ Request: {
+ currency: "GBP",
+ payment_method: "card",
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ customer_acceptance: null,
+ setup_future_usage: "on_session",
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "succeeded",
+ },
+ },
+ },
+ Capture: {
+ Request: {
+ payment_method: "card",
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ customer_acceptance: null,
+ amount_to_capture: 6000,
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "succeeded",
+ amount: 6000,
+ amount_capturable: 0,
+ amount_received: 6000,
+ },
+ },
+ },
+ PartialCapture: {
+ Request: {
+ amount_to_capture: 2000,
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "partially_captured",
+ amount: 6000,
+ amount_capturable: 0,
+ amount_received: 2000,
+ },
+ },
+ },
+ Refund: {
+ Request: {
+ amount: 6000,
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "succeeded",
+ },
+ },
+ },
+ manualPaymentRefund: {
+ Request: {
+ amount: 6000,
+ payment_method: "card",
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ customer_acceptance: null,
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "succeeded",
+ },
+ },
+ },
+ manualPaymentPartialRefund: {
+ Configs: {
+ TRIGGER_SKIP: true,
+ },
+ Request: {
+ amount: 2000,
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "succeeded",
+ },
+ },
+ },
+ PartialRefund: {
+ Configs: {
+ TRIGGER_SKIP: true,
+ },
+ Request: {
+ amount: 2000,
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "succeeded",
+ },
+ },
+ },
+ SyncRefund: {
+ Response: {
+ status: 200,
+ body: {
+ status: "succeeded",
+ },
+ },
+ },
+ ZeroAuthMandate: {
+ Response: {
+ status: 501,
+ body: {
+ error: {
+ type: "invalid_request",
+ message: "Setup Mandate flow for Getnet is not implemented",
+ code: "IR_00",
+ },
+ },
+ },
+ },
+ ZeroAuthPaymentIntent: {
+ Request: {
+ amount: 0,
+ setup_future_usage: "off_session",
+ currency: "USD",
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "requires_payment_method",
+ setup_future_usage: "off_session",
+ },
+ },
+ },
+ ZeroAuthConfirmPayment: {
+ Request: {
+ payment_type: "setup_mandate",
+ payment_method: "card",
+ payment_method_type: "credit",
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ },
+ Response: {
+ status: 501,
+ body: {
+ error: {
+ type: "invalid_request",
+ message: "Setup Mandate flow for Getnet is not implemented",
+ code: "IR_00",
+ },
+ },
+ },
+ },
+ SaveCardUseNo3DSAutoCapture: {
+ Request: {
+ payment_method: "card",
+ amount: 5000,
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ currency: "USD",
+ setup_future_usage: "on_session",
+ customer_acceptance: {
+ acceptance_type: "offline",
+ accepted_at: "1963-05-03T04:07:52.723Z",
+ online: {
+ ip_address: "127.0.0.1",
+ user_agent: "amet irure esse",
+ },
+ },
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "succeeded",
+ },
+ },
+ },
+ SaveCardUseNo3DSManualCapture: {
+ Request: {
+ payment_method: "card",
+ amount: 5000,
+ payment_method_data: {
+ card: successfulNo3DSCardDetails,
+ },
+ currency: "USD",
+ setup_future_usage: "on_session",
+ customer_acceptance: {
+ acceptance_type: "offline",
+ accepted_at: "1963-05-03T04:07:52.723Z",
+ online: {
+ ip_address: "127.0.0.1",
+ user_agent: "amet irure esse",
+ },
+ },
+ },
+ Response: {
+ status: 200,
+ body: {
+ status: "requires_capture",
+ },
+ },
+ },
+ },
+};
diff --git a/cypress-tests/cypress/e2e/configs/Payment/Utils.js b/cypress-tests/cypress/e2e/configs/Payment/Utils.js
index 4f383d6e2c0..4c3f9a08524 100644
--- a/cypress-tests/cypress/e2e/configs/Payment/Utils.js
+++ b/cypress-tests/cypress/e2e/configs/Payment/Utils.js
@@ -11,6 +11,7 @@ import { connectorDetails as datatransConnectorDetails } from "./Datatrans.js";
import { connectorDetails as elavonConnectorDetails } from "./Elavon.js";
import { connectorDetails as fiservemeaConnectorDetails } from "./Fiservemea.js";
import { connectorDetails as fiuuConnectorDetails } from "./Fiuu.js";
+import { connectorDetails as getnetConnectorDetails } from "./Getnet.js";
import { connectorDetails as iatapayConnectorDetails } from "./Iatapay.js";
import { connectorDetails as itaubankConnectorDetails } from "./ItauBank.js";
import { connectorDetails as jpmorganConnectorDetails } from "./Jpmorgan.js";
@@ -38,6 +39,7 @@ const connectorDetails = {
cybersource: cybersourceConnectorDetails,
deutschebank: deutschebankConnectorDetails,
fiservemea: fiservemeaConnectorDetails,
+ getnet: getnetConnectorDetails,
iatapay: iatapayConnectorDetails,
itaubank: itaubankConnectorDetails,
jpmorgan: jpmorganConnectorDetails,
|
feat
|
[GETNET] Add cards payment flow (#7256)
|
912a1084846b6dc8e843e852a3b664a4faaf9f00
|
2023-05-18 02:46:04
|
Prasunna Soppa
|
fix(connector): [Checkout] Fix incoming webhook event mapping (#1197)
| false
|
diff --git a/crates/router/src/connector/checkout/transformers.rs b/crates/router/src/connector/checkout/transformers.rs
index dcf89e550dc..662a4dfe7c3 100644
--- a/crates/router/src/connector/checkout/transformers.rs
+++ b/crates/router/src/connector/checkout/transformers.rs
@@ -762,7 +762,7 @@ impl From<CheckoutTransactionType> for api::IncomingWebhookEvent {
fn from(transaction_type: CheckoutTransactionType) -> Self {
match transaction_type {
CheckoutTransactionType::PaymentApproved => Self::PaymentIntentSuccess,
- CheckoutTransactionType::PaymentDeclined => Self::PaymentIntentSuccess,
+ CheckoutTransactionType::PaymentDeclined => Self::PaymentIntentFailure,
CheckoutTransactionType::PaymentRefunded => Self::RefundSuccess,
CheckoutTransactionType::PaymentRefundDeclined => Self::RefundFailure,
CheckoutTransactionType::DisputeReceived
|
fix
|
[Checkout] Fix incoming webhook event mapping (#1197)
|
07020d01b5d08d9ba5a146d62fbb8c23c6a6d3c2
|
2023-08-10 18:19:18
|
Shankar Singh C
|
fix(payment_methods): delete token when a payment reaches terminal state (#1818)
| false
|
diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs
index b84d01a052e..65d59bf156d 100644
--- a/crates/router/src/core/payment_methods/cards.rs
+++ b/crates/router/src/core/payment_methods/cards.rs
@@ -42,6 +42,7 @@ use crate::{
routes::{
self,
metrics::{self, request},
+ payment_methods::ParentPaymentMethodToken,
},
services,
types::{
@@ -1792,37 +1793,19 @@ pub async fn list_customer_payment_method(
};
customer_pms.push(pma.to_owned());
+ let intent_created = payment_intent.as_ref().map(|intent| intent.created_at);
+
let redis_conn = state
.store
.get_redis_conn()
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed to get redis connection")?;
-
- let key_for_hyperswitch_token = format!(
- "pm_token_{}_{}_hyperswitch",
- parent_payment_method_token, pma.payment_method
- );
-
- let current_datetime_utc = common_utils::date_time::now();
- let time_eslapsed = current_datetime_utc
- - payment_intent
- .as_ref()
- .map(|intent| intent.created_at)
- .unwrap_or_else(|| current_datetime_utc);
- redis_conn
- .set_key_with_expiry(
- &key_for_hyperswitch_token,
- hyperswitch_token,
- consts::TOKEN_TTL - time_eslapsed.whole_seconds(),
- )
- .await
- .map_err(|error| {
- logger::error!(hyperswitch_token_kv_error=?error);
- errors::StorageError::KVError
- })
- .into_report()
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Failed to add data in redis")?;
+ ParentPaymentMethodToken::create_key_for_token((
+ &parent_payment_method_token,
+ pma.payment_method,
+ ))
+ .insert(intent_created, hyperswitch_token, state)
+ .await?;
if let Some(metadata) = pma.metadata {
let pm_metadata_vec: payment_methods::PaymentMethodMetadata = metadata
@@ -1837,11 +1820,17 @@ pub async fn list_customer_payment_method(
"pm_token_{}_{}_{}",
parent_payment_method_token, pma.payment_method, pm_metadata.0
);
+ let current_datetime_utc = common_utils::date_time::now();
+ let time_elapsed = current_datetime_utc
+ - payment_intent
+ .as_ref()
+ .map(|intent| intent.created_at)
+ .unwrap_or_else(|| current_datetime_utc);
redis_conn
.set_key_with_expiry(
&key,
pm_metadata.1,
- consts::TOKEN_TTL - time_eslapsed.whole_seconds(),
+ consts::TOKEN_TTL - time_elapsed.whole_seconds(),
)
.await
.map_err(|error| {
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index 9465bdf8a2b..65d7bc41f35 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -9,7 +9,7 @@ pub mod transformers;
use std::{collections::HashMap, fmt::Debug, marker::PhantomData, ops::Deref, time::Instant};
use api_models::payments::FrmMessage;
-use common_utils::pii;
+use common_utils::{ext_traits::AsyncExt, pii};
use diesel_models::ephemeral_key;
use error_stack::{IntoReport, ResultExt};
use futures::future::join_all;
@@ -32,7 +32,7 @@ use crate::{
core::errors::{self, CustomResult, RouterResponse, RouterResult},
db::StorageInterface,
logger,
- routes::{metrics, AppState},
+ routes::{metrics, payment_methods::ParentPaymentMethodToken, AppState},
scheduler::{utils as pt_utils, workflows::payment_sync},
services::{self, api::Authenticate},
types::{
@@ -197,6 +197,20 @@ where
.await?
}
};
+ payment_data
+ .payment_attempt
+ .payment_token
+ .as_ref()
+ .zip(payment_data.payment_attempt.payment_method)
+ .map(ParentPaymentMethodToken::create_key_for_token)
+ .async_map(|key_for_hyperswitch_token| async move {
+ if key_for_hyperswitch_token
+ .should_delete_payment_method_token(payment_data.payment_intent.status)
+ {
+ let _ = key_for_hyperswitch_token.delete(state).await;
+ }
+ })
+ .await;
} else {
(_, payment_data) = operation
.to_update_tracker()?
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index 815a195ac8f..e4ec1ae74be 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -27,7 +27,7 @@ use crate::{
payments,
},
db::StorageInterface,
- routes::{metrics, AppState},
+ routes::{metrics, payment_methods::ParentPaymentMethodToken, AppState},
scheduler::metrics as scheduler_metrics,
services,
types::{
@@ -1174,6 +1174,7 @@ pub async fn make_pm_data<'a, F: Clone, R>(
) -> RouterResult<(BoxedOperation<'a, F, R>, Option<api::PaymentMethodData>)> {
let request = &payment_data.payment_method_data;
let token = payment_data.token.clone();
+
let hyperswitch_token = if let Some(token) = token {
let redis_conn = state
.store
@@ -1191,13 +1192,16 @@ pub async fn make_pm_data<'a, F: Clone, R>(
.get_required_value("payment_method")?,
);
- let hyperswitch_token_option = redis_conn
+ let key = redis_conn
.get_key::<Option<String>>(&key)
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Failed to fetch the token from redis")?;
+ .attach_printable("Failed to fetch the token from redis")?
+ .ok_or(error_stack::Report::new(
+ errors::ApiErrorResponse::UnprocessableEntity { entity: token },
+ ))?;
- hyperswitch_token_option.or(Some(token))
+ Some(key)
} else {
None
};
@@ -1273,7 +1277,7 @@ pub async fn make_pm_data<'a, F: Clone, R>(
})
}
(pm_opt @ Some(pm @ api::PaymentMethodData::Card(_)), _) => {
- let token = vault::Vault::store_payment_method_data_in_locker(
+ let hyperswitch_token = vault::Vault::store_payment_method_data_in_locker(
state,
None,
pm,
@@ -1281,7 +1285,30 @@ pub async fn make_pm_data<'a, F: Clone, R>(
enums::PaymentMethod::Card,
)
.await?;
- payment_data.token = Some(token);
+
+ let parent_payment_method_token = generate_id(consts::ID_LENGTH, "token");
+ let key_for_hyperswitch_token =
+ payment_data
+ .payment_attempt
+ .payment_method
+ .map(|payment_method| {
+ ParentPaymentMethodToken::create_key_for_token((
+ &parent_payment_method_token,
+ payment_method,
+ ))
+ });
+ if let Some(key_for_hyperswitch_token) = key_for_hyperswitch_token {
+ key_for_hyperswitch_token
+ .insert(
+ Some(payment_data.payment_intent.created_at),
+ hyperswitch_token,
+ state,
+ )
+ .await?;
+ };
+
+ payment_data.token = Some(parent_payment_method_token);
+
Ok(pm_opt.to_owned())
}
(pm @ Some(api::PaymentMethodData::PayLater(_)), _) => Ok(pm.to_owned()),
diff --git a/crates/router/src/routes/payment_methods.rs b/crates/router/src/routes/payment_methods.rs
index 0e6f5c0e244..589ae7d73d8 100644
--- a/crates/router/src/routes/payment_methods.rs
+++ b/crates/router/src/routes/payment_methods.rs
@@ -1,11 +1,17 @@
use actix_web::{web, HttpRequest, HttpResponse};
-use router_env::{instrument, tracing, Flow};
+use common_utils::{consts::TOKEN_TTL, errors::CustomResult};
+use error_stack::{IntoReport, ResultExt};
+use router_env::{instrument, logger, tracing, Flow};
+use time::PrimitiveDateTime;
use super::app::AppState;
use crate::{
- core::payment_methods::cards,
+ core::{errors, payment_methods::cards},
services::{api, authentication as auth},
- types::api::payment_methods::{self, PaymentMethodId},
+ types::{
+ api::payment_methods::{self, PaymentMethodId},
+ storage::enums as storage_enums,
+ },
};
/// PaymentMethods - Create
@@ -354,3 +360,75 @@ mod tests {
assert!(de_query.is_err())
}
}
+
+#[derive(Clone)]
+pub struct ParentPaymentMethodToken {
+ key_for_token: String,
+}
+
+impl ParentPaymentMethodToken {
+ pub fn create_key_for_token(
+ (parent_pm_token, payment_method): (&String, api_models::enums::PaymentMethod),
+ ) -> Self {
+ Self {
+ key_for_token: format!(
+ "pm_token_{}_{}_hyperswitch",
+ parent_pm_token, payment_method
+ ),
+ }
+ }
+ pub async fn insert(
+ &self,
+ intent_created_at: Option<PrimitiveDateTime>,
+ token: String,
+ state: &AppState,
+ ) -> CustomResult<(), errors::ApiErrorResponse> {
+ let redis_conn = state
+ .store
+ .get_redis_conn()
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed to get redis connection")?;
+ let current_datetime_utc = common_utils::date_time::now();
+ let time_elapsed = current_datetime_utc - intent_created_at.unwrap_or(current_datetime_utc);
+ redis_conn
+ .set_key_with_expiry(
+ &self.key_for_token,
+ token,
+ TOKEN_TTL - time_elapsed.whole_seconds(),
+ )
+ .await
+ .map_err(|error| {
+ logger::error!(hyperswitch_token_kv_error=?error);
+ errors::StorageError::KVError
+ })
+ .into_report()
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed to add data in redis")?;
+
+ Ok(())
+ }
+
+ pub fn should_delete_payment_method_token(&self, status: storage_enums::IntentStatus) -> bool {
+ !matches!(
+ status,
+ diesel_models::enums::IntentStatus::RequiresCustomerAction
+ )
+ }
+
+ pub async fn delete(&self, state: &AppState) -> CustomResult<(), errors::ApiErrorResponse> {
+ let redis_conn = state
+ .store
+ .get_redis_conn()
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed to get redis connection")?;
+ match redis_conn.delete_key(&self.key_for_token).await {
+ Ok(_) => Ok(()),
+ Err(err) => {
+ {
+ logger::info!("Error while deleting redis key: {:?}", err)
+ };
+ Ok(())
+ }
+ }
+ }
+}
|
fix
|
delete token when a payment reaches terminal state (#1818)
|
5773faf739f1525cfe442c2df9d33f7475cf6b7c
|
2023-08-01 16:22:51
|
Jagan
|
refactor(ui_tests): move ui_tests to test_utils crate to reduce development time (#1822)
| false
|
diff --git a/.github/scripts/run_ui_tests.sh b/.github/scripts/run_ui_tests.sh
index 17cc79bc7c8..5c7a0200ddd 100644
--- a/.github/scripts/run_ui_tests.sh
+++ b/.github/scripts/run_ui_tests.sh
@@ -37,6 +37,6 @@ done
IN="$INPUT"
for i in $(echo $IN | tr "," "\n"); do
- cargo test --package router --test connectors -- "${i}_ui::" --test-threads=1 >> tests/test_results.log 2>&1
+ cargo test --package test_utils --test connectors -- "${i}_ui::" --test-threads=1 >> tests/test_results.log 2>&1
done
cat tests/test_results.log
\ No newline at end of file
diff --git a/Cargo.lock b/Cargo.lock
index 0d6070a128f..8adfa95d7d5 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -446,9 +446,9 @@ dependencies = [
[[package]]
name = "async-channel"
-version = "1.8.0"
+version = "1.9.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cf46fee83e5ccffc220104713af3292ff9bc7c64c7de289f66dae8e38d826833"
+checksum = "81953c529336010edd6d8e358f886d9581267795c61b19475b71314bffa46d35"
dependencies = [
"concurrent-queue",
"event-listener",
@@ -4733,14 +4733,25 @@ dependencies = [
name = "test_utils"
version = "0.1.0"
dependencies = [
+ "actix-http",
+ "actix-web",
"api_models",
+ "async-trait",
+ "awc",
"clap",
+ "derive_deref",
"masking",
- "router",
+ "rand 0.8.5",
"serde",
"serde_json",
"serde_path_to_error",
+ "serde_urlencoded",
+ "serial_test",
+ "thirtyfour",
+ "time 0.3.22",
+ "tokio",
"toml 0.7.4",
+ "uuid",
]
[[package]]
diff --git a/connector-template/test.rs b/connector-template/test.rs
index 008e3d50dc5..5bbf761dea1 100644
--- a/connector-template/test.rs
+++ b/connector-template/test.rs
@@ -21,10 +21,10 @@ impl utils::Connector for {{project-name | downcase | pascal_case}}Test {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.{{project-name | downcase}}
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration").into(),
)
}
diff --git a/crates/router/tests/connectors/aci.rs b/crates/router/tests/connectors/aci.rs
index d82c3eff6fa..e75553b23be 100644
--- a/crates/router/tests/connectors/aci.rs
+++ b/crates/router/tests/connectors/aci.rs
@@ -11,7 +11,7 @@ use router::{
};
use tokio::sync::oneshot;
-use crate::connector_auth::ConnectorAuthentication;
+use crate::{connector_auth::ConnectorAuthentication, utils};
fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData {
let auth = ConnectorAuthentication::new()
@@ -28,7 +28,7 @@ fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData {
status: enums::AttemptStatus::default(),
auth_type: enums::AuthenticationType::NoThreeDs,
payment_method: enums::PaymentMethod::Card,
- connector_auth_type: auth.into(),
+ connector_auth_type: utils::to_connector_auth_type(auth.into()),
description: Some("This is a test".to_string()),
return_url: None,
request: types::PaymentsAuthorizeData {
@@ -105,7 +105,7 @@ fn construct_refund_router_data<F>() -> types::RefundsRouterData<F> {
status: enums::AttemptStatus::default(),
payment_method: enums::PaymentMethod::Card,
auth_type: enums::AuthenticationType::NoThreeDs,
- connector_auth_type: auth.into(),
+ connector_auth_type: utils::to_connector_auth_type(auth.into()),
description: Some("This is a test".to_string()),
return_url: None,
request: types::RefundsData {
diff --git a/crates/router/tests/connectors/adyen.rs b/crates/router/tests/connectors/adyen.rs
index 886069e3c43..68d641e5ec4 100644
--- a/crates/router/tests/connectors/adyen.rs
+++ b/crates/router/tests/connectors/adyen.rs
@@ -32,10 +32,11 @@ impl utils::Connector for AdyenTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.adyen_uk
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/airwallex.rs b/crates/router/tests/connectors/airwallex.rs
index 014c030827f..7d9070a94df 100644
--- a/crates/router/tests/connectors/airwallex.rs
+++ b/crates/router/tests/connectors/airwallex.rs
@@ -25,10 +25,11 @@ impl Connector for AirwallexTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.airwallex
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/authorizedotnet.rs b/crates/router/tests/connectors/authorizedotnet.rs
index 1e409e68f5c..125851d0bea 100644
--- a/crates/router/tests/connectors/authorizedotnet.rs
+++ b/crates/router/tests/connectors/authorizedotnet.rs
@@ -22,10 +22,11 @@ impl utils::Connector for AuthorizedotnetTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.authorizedotnet
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/bambora.rs b/crates/router/tests/connectors/bambora.rs
index ed9c7c221a0..a6dd7d17b03 100644
--- a/crates/router/tests/connectors/bambora.rs
+++ b/crates/router/tests/connectors/bambora.rs
@@ -23,10 +23,11 @@ impl utils::Connector for BamboraTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.bambora
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/bitpay.rs b/crates/router/tests/connectors/bitpay.rs
index 615582b751c..1eaf1580f0a 100644
--- a/crates/router/tests/connectors/bitpay.rs
+++ b/crates/router/tests/connectors/bitpay.rs
@@ -21,10 +21,11 @@ impl utils::Connector for BitpayTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.bitpay
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/bluesnap.rs b/crates/router/tests/connectors/bluesnap.rs
index 78e12cfb5a8..ea3fe9a1fe2 100644
--- a/crates/router/tests/connectors/bluesnap.rs
+++ b/crates/router/tests/connectors/bluesnap.rs
@@ -25,10 +25,11 @@ impl utils::Connector for BluesnapTest {
}
fn get_auth_token(&self) -> ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.bluesnap
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/boku.rs b/crates/router/tests/connectors/boku.rs
index c5e450803e0..132852f904e 100644
--- a/crates/router/tests/connectors/boku.rs
+++ b/crates/router/tests/connectors/boku.rs
@@ -18,10 +18,11 @@ impl utils::Connector for BokuTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.boku
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/cashtocode.rs b/crates/router/tests/connectors/cashtocode.rs
index e07e54c54b0..c78134a1d68 100644
--- a/crates/router/tests/connectors/cashtocode.rs
+++ b/crates/router/tests/connectors/cashtocode.rs
@@ -20,10 +20,11 @@ impl utils::Connector for CashtocodeTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.cashtocode
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/checkout.rs b/crates/router/tests/connectors/checkout.rs
index bd11a432364..18d6d6d2ddb 100644
--- a/crates/router/tests/connectors/checkout.rs
+++ b/crates/router/tests/connectors/checkout.rs
@@ -19,10 +19,11 @@ impl utils::Connector for CheckoutTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.checkout
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/coinbase.rs b/crates/router/tests/connectors/coinbase.rs
index e811f4935b3..dc677c6e31a 100644
--- a/crates/router/tests/connectors/coinbase.rs
+++ b/crates/router/tests/connectors/coinbase.rs
@@ -22,10 +22,11 @@ impl utils::Connector for CoinbaseTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.coinbase
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/cryptopay.rs b/crates/router/tests/connectors/cryptopay.rs
index 597e394e706..d8628415995 100644
--- a/crates/router/tests/connectors/cryptopay.rs
+++ b/crates/router/tests/connectors/cryptopay.rs
@@ -21,10 +21,11 @@ impl utils::Connector for CryptopayTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.cryptopay
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/cybersource.rs b/crates/router/tests/connectors/cybersource.rs
index 438c7f8b949..bcc5aaa2a20 100644
--- a/crates/router/tests/connectors/cybersource.rs
+++ b/crates/router/tests/connectors/cybersource.rs
@@ -23,10 +23,11 @@ impl utils::Connector for Cybersource {
}
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.cybersource
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
fn get_name(&self) -> String {
diff --git a/crates/router/tests/connectors/dlocal.rs b/crates/router/tests/connectors/dlocal.rs
index d58e2b6ea65..05d42ef7fee 100644
--- a/crates/router/tests/connectors/dlocal.rs
+++ b/crates/router/tests/connectors/dlocal.rs
@@ -23,10 +23,11 @@ impl utils::Connector for DlocalTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.dlocal
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/dummyconnector.rs b/crates/router/tests/connectors/dummyconnector.rs
index 35e68e99f89..7efaa832959 100644
--- a/crates/router/tests/connectors/dummyconnector.rs
+++ b/crates/router/tests/connectors/dummyconnector.rs
@@ -21,10 +21,11 @@ impl utils::Connector for DummyConnectorTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.dummyconnector
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/fiserv.rs b/crates/router/tests/connectors/fiserv.rs
index 91cbfc334f7..532084a7465 100644
--- a/crates/router/tests/connectors/fiserv.rs
+++ b/crates/router/tests/connectors/fiserv.rs
@@ -23,10 +23,11 @@ impl utils::Connector for FiservTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.fiserv
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/forte.rs b/crates/router/tests/connectors/forte.rs
index 6028f44117c..456c7a7e147 100644
--- a/crates/router/tests/connectors/forte.rs
+++ b/crates/router/tests/connectors/forte.rs
@@ -23,10 +23,11 @@ impl utils::Connector for ForteTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.forte
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/globalpay.rs b/crates/router/tests/connectors/globalpay.rs
index 598b66eda0a..39e0ed58f4a 100644
--- a/crates/router/tests/connectors/globalpay.rs
+++ b/crates/router/tests/connectors/globalpay.rs
@@ -23,10 +23,11 @@ impl Connector for Globalpay {
}
fn get_auth_token(&self) -> ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.globalpay
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/globepay.rs b/crates/router/tests/connectors/globepay.rs
index 54d9c3eaf8c..607abac7387 100644
--- a/crates/router/tests/connectors/globepay.rs
+++ b/crates/router/tests/connectors/globepay.rs
@@ -20,10 +20,11 @@ impl utils::Connector for GlobepayTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.globepay
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/iatapay.rs b/crates/router/tests/connectors/iatapay.rs
index 8d318a4fa5b..c1f4492bceb 100644
--- a/crates/router/tests/connectors/iatapay.rs
+++ b/crates/router/tests/connectors/iatapay.rs
@@ -22,10 +22,11 @@ impl Connector for IatapayTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.iatapay
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs
index 07fb5162057..5fa7ebdb2cd 100644
--- a/crates/router/tests/connectors/main.rs
+++ b/crates/router/tests/connectors/main.rs
@@ -7,22 +7,15 @@
use test_utils::connector_auth;
mod aci;
-mod aci_ui;
mod adyen;
-mod adyen_uk_ui;
mod airwallex;
-mod airwallex_ui;
mod authorizedotnet;
-mod authorizedotnet_ui;
mod bambora;
-mod bambora_ui;
mod bitpay;
mod bluesnap;
-mod bluesnap_ui;
mod boku;
mod cashtocode;
mod checkout;
-mod checkout_ui;
mod coinbase;
mod cryptopay;
mod cybersource;
@@ -32,43 +25,29 @@ mod dummyconnector;
mod fiserv;
mod forte;
mod globalpay;
-mod globalpay_ui;
mod globepay;
mod iatapay;
mod mollie;
-mod mollie_ui;
mod multisafepay;
-mod multisafepay_ui;
mod nexinets;
-mod nexinets_ui;
mod nmi;
mod noon;
-mod noon_ui;
mod nuvei;
-mod nuvei_ui;
mod opayo;
mod opennode;
mod payeezy;
mod payme;
mod paypal;
-mod paypal_ui;
mod payu;
-mod payu_ui;
mod powertranz;
mod rapyd;
-mod selenium;
mod shift4;
-mod shift4_ui;
mod stax;
mod stripe;
-mod stripe_ui;
mod trustpay;
-mod trustpay_3ds_ui;
mod tsys;
mod utils;
mod wise;
mod worldline;
-mod worldline_ui;
mod worldpay;
mod zen;
-mod zen_ui;
diff --git a/crates/router/tests/connectors/mollie.rs b/crates/router/tests/connectors/mollie.rs
index e52736fd5b8..e5a1f090d3c 100644
--- a/crates/router/tests/connectors/mollie.rs
+++ b/crates/router/tests/connectors/mollie.rs
@@ -19,10 +19,11 @@ impl utils::Connector for MollieTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.mollie
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/multisafepay.rs b/crates/router/tests/connectors/multisafepay.rs
index 53517d01589..a5d9dda9221 100644
--- a/crates/router/tests/connectors/multisafepay.rs
+++ b/crates/router/tests/connectors/multisafepay.rs
@@ -21,10 +21,11 @@ impl utils::Connector for MultisafepayTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.multisafepay
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/nexinets.rs b/crates/router/tests/connectors/nexinets.rs
index 662ce7ebbdd..21380c27a6d 100644
--- a/crates/router/tests/connectors/nexinets.rs
+++ b/crates/router/tests/connectors/nexinets.rs
@@ -24,10 +24,11 @@ impl utils::Connector for NexinetsTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.nexinets
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/nmi.rs b/crates/router/tests/connectors/nmi.rs
index 0727ef8da3e..42301dc3a24 100644
--- a/crates/router/tests/connectors/nmi.rs
+++ b/crates/router/tests/connectors/nmi.rs
@@ -20,10 +20,11 @@ impl utils::Connector for NmiTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.nmi
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/noon.rs b/crates/router/tests/connectors/noon.rs
index c426d977c34..01a38fcd783 100644
--- a/crates/router/tests/connectors/noon.rs
+++ b/crates/router/tests/connectors/noon.rs
@@ -25,10 +25,11 @@ impl utils::Connector for NoonTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.noon
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/nuvei.rs b/crates/router/tests/connectors/nuvei.rs
index 564ca5c4ca6..d0f8fbaa93b 100644
--- a/crates/router/tests/connectors/nuvei.rs
+++ b/crates/router/tests/connectors/nuvei.rs
@@ -26,10 +26,11 @@ impl utils::Connector for NuveiTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.nuvei
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/opayo.rs b/crates/router/tests/connectors/opayo.rs
index fa3e8a44dd9..23b1098e273 100644
--- a/crates/router/tests/connectors/opayo.rs
+++ b/crates/router/tests/connectors/opayo.rs
@@ -22,10 +22,11 @@ impl utils::Connector for OpayoTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.opayo
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/opennode.rs b/crates/router/tests/connectors/opennode.rs
index 8d43d6dcc76..79fadf3e130 100644
--- a/crates/router/tests/connectors/opennode.rs
+++ b/crates/router/tests/connectors/opennode.rs
@@ -21,10 +21,11 @@ impl utils::Connector for OpennodeTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.opennode
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/payeezy.rs b/crates/router/tests/connectors/payeezy.rs
index 7fa14bdf937..66d81a67708 100644
--- a/crates/router/tests/connectors/payeezy.rs
+++ b/crates/router/tests/connectors/payeezy.rs
@@ -28,10 +28,11 @@ impl utils::Connector for PayeezyTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.payeezy
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/payme.rs b/crates/router/tests/connectors/payme.rs
index ad3b7d8cf7b..67e7919caf7 100644
--- a/crates/router/tests/connectors/payme.rs
+++ b/crates/router/tests/connectors/payme.rs
@@ -24,10 +24,11 @@ impl utils::Connector for PaymeTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.payme
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/paypal.rs b/crates/router/tests/connectors/paypal.rs
index b177ed4efbb..7a6d1b48661 100644
--- a/crates/router/tests/connectors/paypal.rs
+++ b/crates/router/tests/connectors/paypal.rs
@@ -21,10 +21,11 @@ impl Connector for PaypalTest {
}
fn get_auth_token(&self) -> ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.paypal
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/payu.rs b/crates/router/tests/connectors/payu.rs
index ad3b1ed9203..f1030092a4e 100644
--- a/crates/router/tests/connectors/payu.rs
+++ b/crates/router/tests/connectors/payu.rs
@@ -18,10 +18,11 @@ impl Connector for Payu {
}
fn get_auth_token(&self) -> ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.payu
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/powertranz.rs b/crates/router/tests/connectors/powertranz.rs
index acd95cfd11d..0f9ce943a40 100644
--- a/crates/router/tests/connectors/powertranz.rs
+++ b/crates/router/tests/connectors/powertranz.rs
@@ -20,10 +20,11 @@ impl utils::Connector for PowertranzTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.powertranz
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/rapyd.rs b/crates/router/tests/connectors/rapyd.rs
index 662e8b5073a..4ca7148a9c6 100644
--- a/crates/router/tests/connectors/rapyd.rs
+++ b/crates/router/tests/connectors/rapyd.rs
@@ -23,10 +23,11 @@ impl utils::Connector for Rapyd {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.rapyd
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/shift4.rs b/crates/router/tests/connectors/shift4.rs
index 945911e31a3..e236d2ad9d0 100644
--- a/crates/router/tests/connectors/shift4.rs
+++ b/crates/router/tests/connectors/shift4.rs
@@ -22,10 +22,11 @@ impl utils::Connector for Shift4Test {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.shift4
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/stax.rs b/crates/router/tests/connectors/stax.rs
index ebf57d53bb8..98527d91f35 100644
--- a/crates/router/tests/connectors/stax.rs
+++ b/crates/router/tests/connectors/stax.rs
@@ -20,10 +20,11 @@ impl utils::Connector for StaxTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.stax
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/stripe.rs b/crates/router/tests/connectors/stripe.rs
index 64f545d22cf..5e0c1dae36e 100644
--- a/crates/router/tests/connectors/stripe.rs
+++ b/crates/router/tests/connectors/stripe.rs
@@ -21,10 +21,11 @@ impl utils::Connector for Stripe {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.stripe
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/trustpay.rs b/crates/router/tests/connectors/trustpay.rs
index 7ce38336daa..cefc0f5ab12 100644
--- a/crates/router/tests/connectors/trustpay.rs
+++ b/crates/router/tests/connectors/trustpay.rs
@@ -22,10 +22,11 @@ impl utils::Connector for TrustpayTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.trustpay
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/tsys.rs b/crates/router/tests/connectors/tsys.rs
index 51112b47245..51d0575a7a5 100644
--- a/crates/router/tests/connectors/tsys.rs
+++ b/crates/router/tests/connectors/tsys.rs
@@ -23,10 +23,11 @@ impl utils::Connector for TsysTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.tsys
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs
index 1bffcb36fa1..929240ff96c 100644
--- a/crates/router/tests/connectors/utils.rs
+++ b/crates/router/tests/connectors/utils.rs
@@ -11,6 +11,7 @@ use router::{
routes, services,
types::{self, api, storage::enums, AccessToken, PaymentAddress, RouterData},
};
+use test_utils::connector_auth::ConnectorAuthType;
use tokio::sync::oneshot;
use wiremock::{Mock, MockServer};
@@ -994,3 +995,33 @@ pub fn get_connector_metadata(
_ => None,
}
}
+
+pub fn to_connector_auth_type(auth_type: ConnectorAuthType) -> types::ConnectorAuthType {
+ match auth_type {
+ ConnectorAuthType::HeaderKey { api_key } => types::ConnectorAuthType::HeaderKey { api_key },
+ ConnectorAuthType::BodyKey { api_key, key1 } => {
+ types::ConnectorAuthType::BodyKey { api_key, key1 }
+ }
+ ConnectorAuthType::SignatureKey {
+ api_key,
+ key1,
+ api_secret,
+ } => types::ConnectorAuthType::SignatureKey {
+ api_key,
+ key1,
+ api_secret,
+ },
+ ConnectorAuthType::MultiAuthKey {
+ api_key,
+ key1,
+ api_secret,
+ key2,
+ } => types::ConnectorAuthType::MultiAuthKey {
+ api_key,
+ key1,
+ api_secret,
+ key2,
+ },
+ _ => types::ConnectorAuthType::NoKey,
+ }
+}
diff --git a/crates/router/tests/connectors/wise.rs b/crates/router/tests/connectors/wise.rs
index 1857a790654..fad3a73cafe 100644
--- a/crates/router/tests/connectors/wise.rs
+++ b/crates/router/tests/connectors/wise.rs
@@ -29,10 +29,11 @@ impl utils::Connector for WiseTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.wise
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/worldline.rs b/crates/router/tests/connectors/worldline.rs
index 164240dabf5..ac717ecb2a4 100644
--- a/crates/router/tests/connectors/worldline.rs
+++ b/crates/router/tests/connectors/worldline.rs
@@ -26,10 +26,11 @@ impl utils::Connector for WorldlineTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
ConnectorAuthentication::new()
.worldline
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/worldpay.rs b/crates/router/tests/connectors/worldpay.rs
index 48f87d9c767..a7e0f19af71 100644
--- a/crates/router/tests/connectors/worldpay.rs
+++ b/crates/router/tests/connectors/worldpay.rs
@@ -27,10 +27,11 @@ impl utils::Connector for Worldpay {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.worldpay
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/router/tests/connectors/zen.rs b/crates/router/tests/connectors/zen.rs
index d79c0f4ebf6..5a73b0befad 100644
--- a/crates/router/tests/connectors/zen.rs
+++ b/crates/router/tests/connectors/zen.rs
@@ -25,10 +25,11 @@ impl utils::Connector for ZenTest {
}
fn get_auth_token(&self) -> types::ConnectorAuthType {
- types::ConnectorAuthType::from(
+ utils::to_connector_auth_type(
connector_auth::ConnectorAuthentication::new()
.zen
- .expect("Missing connector authentication configuration"),
+ .expect("Missing connector authentication configuration")
+ .into(),
)
}
diff --git a/crates/test_utils/Cargo.toml b/crates/test_utils/Cargo.toml
index 35c58c8efc0..7044bc0279b 100644
--- a/crates/test_utils/Cargo.toml
+++ b/crates/test_utils/Cargo.toml
@@ -13,13 +13,24 @@ dummy_connector = ["api_models/dummy_connector"]
payouts = []
[dependencies]
-clap = { version = "4.3.2", default-features = false, features = ["derive"] }
+async-trait = "0.1.68"
+actix-web = "4.3.1"
+clap = { version = "4.3.2", default-features = false, features = ["std", "derive", "help", "usage"] }
serde = { version = "1.0.163", features = ["derive"] }
serde_json = "1.0.96"
serde_path_to_error = "0.1.11"
toml = "0.7.4"
+serial_test = "2.0.0"
+serde_urlencoded = "0.7.1"
+actix-http = "3.3.1"
+awc = { version = "3.1.1", features = ["rustls"] }
+derive_deref = "1.1.1"
+rand = "0.8.5"
+thirtyfour = "0.31.0"
+time = { version = "0.3.21", features = ["macros"] }
+tokio = "1.28.2"
+uuid = { version = "1.3.3", features = ["serde", "v4"] }
# First party crates
-router = { version = "0.2.0", path = "../router" }
api_models = { version = "0.1.0", path = "../api_models", features = ["errors"] }
masking = { version = "0.1.0", path = "../masking" }
diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs
index 5f97dc08add..c19c1ffea86 100644
--- a/crates/test_utils/src/connector_auth.rs
+++ b/crates/test_utils/src/connector_auth.rs
@@ -1,7 +1,6 @@
use std::{collections::HashMap, env};
use masking::Secret;
-use router::types::ConnectorAuthType;
use serde::{Deserialize, Serialize};
#[derive(Debug, Serialize, Deserialize, Clone)]
@@ -289,3 +288,28 @@ pub struct AutomationConfigs {
pub adyen_bancontact_username: Option<String>,
pub adyen_bancontact_pass: Option<String>,
}
+
+#[derive(Default, Debug, Clone, serde::Deserialize)]
+#[serde(tag = "auth_type")]
+pub enum ConnectorAuthType {
+ HeaderKey {
+ api_key: Secret<String>,
+ },
+ BodyKey {
+ api_key: Secret<String>,
+ key1: Secret<String>,
+ },
+ SignatureKey {
+ api_key: Secret<String>,
+ key1: Secret<String>,
+ api_secret: Secret<String>,
+ },
+ MultiAuthKey {
+ api_key: Secret<String>,
+ key1: Secret<String>,
+ api_secret: Secret<String>,
+ key2: Secret<String>,
+ },
+ #[default]
+ NoKey,
+}
diff --git a/crates/test_utils/src/main.rs b/crates/test_utils/src/main.rs
index dac0854925e..f6b56bffcf4 100644
--- a/crates/test_utils/src/main.rs
+++ b/crates/test_utils/src/main.rs
@@ -5,8 +5,7 @@ use std::{
use clap::{arg, command, Parser};
use masking::PeekInterface;
-use router::types::ConnectorAuthType;
-use test_utils::connector_auth::ConnectorAuthenticationMap;
+use test_utils::connector_auth::{ConnectorAuthType, ConnectorAuthenticationMap};
// Just by the name of the connector, this function generates the name of the collection
// Example: CONNECTOR_NAME="stripe" -> OUTPUT: postman/stripe.postman_collection.json
diff --git a/crates/router/tests/connectors/aci_ui.rs b/crates/test_utils/tests/connectors/aci_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/aci_ui.rs
rename to crates/test_utils/tests/connectors/aci_ui.rs
diff --git a/crates/router/tests/connectors/adyen_uk_ui.rs b/crates/test_utils/tests/connectors/adyen_uk_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/adyen_uk_ui.rs
rename to crates/test_utils/tests/connectors/adyen_uk_ui.rs
diff --git a/crates/router/tests/connectors/airwallex_ui.rs b/crates/test_utils/tests/connectors/airwallex_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/airwallex_ui.rs
rename to crates/test_utils/tests/connectors/airwallex_ui.rs
diff --git a/crates/router/tests/connectors/authorizedotnet_ui.rs b/crates/test_utils/tests/connectors/authorizedotnet_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/authorizedotnet_ui.rs
rename to crates/test_utils/tests/connectors/authorizedotnet_ui.rs
diff --git a/crates/router/tests/connectors/bambora_ui.rs b/crates/test_utils/tests/connectors/bambora_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/bambora_ui.rs
rename to crates/test_utils/tests/connectors/bambora_ui.rs
diff --git a/crates/router/tests/connectors/bluesnap_ui.rs b/crates/test_utils/tests/connectors/bluesnap_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/bluesnap_ui.rs
rename to crates/test_utils/tests/connectors/bluesnap_ui.rs
diff --git a/crates/router/tests/connectors/checkout_ui.rs b/crates/test_utils/tests/connectors/checkout_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/checkout_ui.rs
rename to crates/test_utils/tests/connectors/checkout_ui.rs
diff --git a/crates/router/tests/connectors/globalpay_ui.rs b/crates/test_utils/tests/connectors/globalpay_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/globalpay_ui.rs
rename to crates/test_utils/tests/connectors/globalpay_ui.rs
diff --git a/crates/test_utils/tests/connectors/main.rs b/crates/test_utils/tests/connectors/main.rs
new file mode 100644
index 00000000000..10e19b94bd6
--- /dev/null
+++ b/crates/test_utils/tests/connectors/main.rs
@@ -0,0 +1,27 @@
+#![allow(
+ clippy::expect_used,
+ clippy::panic,
+ clippy::unwrap_in_result,
+ clippy::unwrap_used
+)]
+mod aci_ui;
+mod adyen_uk_ui;
+mod airwallex_ui;
+mod authorizedotnet_ui;
+mod bambora_ui;
+mod bluesnap_ui;
+mod checkout_ui;
+mod globalpay_ui;
+mod mollie_ui;
+mod multisafepay_ui;
+mod nexinets_ui;
+mod noon_ui;
+mod nuvei_ui;
+mod paypal_ui;
+mod payu_ui;
+mod selenium;
+mod shift4_ui;
+mod stripe_ui;
+mod trustpay_3ds_ui;
+mod worldline_ui;
+mod zen_ui;
diff --git a/crates/router/tests/connectors/mollie_ui.rs b/crates/test_utils/tests/connectors/mollie_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/mollie_ui.rs
rename to crates/test_utils/tests/connectors/mollie_ui.rs
diff --git a/crates/router/tests/connectors/multisafepay_ui.rs b/crates/test_utils/tests/connectors/multisafepay_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/multisafepay_ui.rs
rename to crates/test_utils/tests/connectors/multisafepay_ui.rs
diff --git a/crates/router/tests/connectors/nexinets_ui.rs b/crates/test_utils/tests/connectors/nexinets_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/nexinets_ui.rs
rename to crates/test_utils/tests/connectors/nexinets_ui.rs
diff --git a/crates/router/tests/connectors/noon_ui.rs b/crates/test_utils/tests/connectors/noon_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/noon_ui.rs
rename to crates/test_utils/tests/connectors/noon_ui.rs
diff --git a/crates/router/tests/connectors/nuvei_ui.rs b/crates/test_utils/tests/connectors/nuvei_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/nuvei_ui.rs
rename to crates/test_utils/tests/connectors/nuvei_ui.rs
diff --git a/crates/router/tests/connectors/paypal_ui.rs b/crates/test_utils/tests/connectors/paypal_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/paypal_ui.rs
rename to crates/test_utils/tests/connectors/paypal_ui.rs
diff --git a/crates/router/tests/connectors/payu_ui.rs b/crates/test_utils/tests/connectors/payu_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/payu_ui.rs
rename to crates/test_utils/tests/connectors/payu_ui.rs
diff --git a/crates/router/tests/connectors/selenium.rs b/crates/test_utils/tests/connectors/selenium.rs
similarity index 99%
rename from crates/router/tests/connectors/selenium.rs
rename to crates/test_utils/tests/connectors/selenium.rs
index 0f25cc3c9d6..3a2b07c42c8 100644
--- a/crates/router/tests/connectors/selenium.rs
+++ b/crates/test_utils/tests/connectors/selenium.rs
@@ -1,3 +1,10 @@
+#![allow(
+ clippy::expect_used,
+ clippy::panic,
+ clippy::unwrap_in_result,
+ clippy::missing_panics_doc,
+ clippy::unwrap_used
+)]
use std::{
collections::{HashMap, HashSet},
env,
@@ -8,10 +15,9 @@ use std::{
use async_trait::async_trait;
use serde_json::json;
+use test_utils::connector_auth;
use thirtyfour::{components::SelectElement, prelude::*, WebDriver};
-use crate::connector_auth;
-
#[derive(Clone)]
pub enum Event<'a> {
RunIf(Assert<'a>, Vec<Event<'a>>),
@@ -729,7 +735,6 @@ pub fn should_ignore_test(name: &str) -> bool {
.clone();
let tests_to_ignore: HashSet<String> =
serde_json::from_value(conf).unwrap_or_else(|_| HashSet::new());
- // let tests_to_ignore = conf.automation_configs.unwrap().tests_to_ignore.unwrap_or_else(|| HashSet::new());
let modules: Vec<_> = name.split("::").collect();
let file_match = format!("{}::*", <&str>::clone(&modules[1]));
let module_name = modules[1..3].join("::");
@@ -741,6 +746,7 @@ pub fn get_browser() -> String {
"firefox".to_string()
}
+// based on the browser settings build profile info
pub fn make_capabilities(browser: &str) -> Capabilities {
match browser {
"firefox" => {
diff --git a/crates/router/tests/connectors/shift4_ui.rs b/crates/test_utils/tests/connectors/shift4_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/shift4_ui.rs
rename to crates/test_utils/tests/connectors/shift4_ui.rs
diff --git a/crates/router/tests/connectors/stripe_ui.rs b/crates/test_utils/tests/connectors/stripe_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/stripe_ui.rs
rename to crates/test_utils/tests/connectors/stripe_ui.rs
diff --git a/crates/router/tests/connectors/trustpay_3ds_ui.rs b/crates/test_utils/tests/connectors/trustpay_3ds_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/trustpay_3ds_ui.rs
rename to crates/test_utils/tests/connectors/trustpay_3ds_ui.rs
diff --git a/crates/router/tests/connectors/worldline_ui.rs b/crates/test_utils/tests/connectors/worldline_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/worldline_ui.rs
rename to crates/test_utils/tests/connectors/worldline_ui.rs
diff --git a/crates/router/tests/connectors/zen_ui.rs b/crates/test_utils/tests/connectors/zen_ui.rs
similarity index 100%
rename from crates/router/tests/connectors/zen_ui.rs
rename to crates/test_utils/tests/connectors/zen_ui.rs
diff --git a/crates/test_utils/tests/sample_auth.toml b/crates/test_utils/tests/sample_auth.toml
new file mode 100644
index 00000000000..0ae7c40d42d
--- /dev/null
+++ b/crates/test_utils/tests/sample_auth.toml
@@ -0,0 +1,170 @@
+# Copy this file and rename it as `auth.toml`
+# Each of the connector's section is optional
+
+[aci]
+api_key = "Bearer MyApiKey"
+key1 = "MyEntityId"
+
+[adyen]
+api_key = "Bearer MyApiKey"
+key1 = "MerchantId"
+api_secret = "Secondary key"
+
+[authorizedotnet]
+api_key = "MyMerchantName"
+key1 = "MyTransactionKey"
+
+[checkout]
+api_key = "PublicKey"
+api_secret = "SecretKey"
+key1 = "MyProcessingChannelId"
+
+[cybersource]
+api_key = "Bearer MyApiKey"
+key1 = "Merchant id"
+api_secret = "Secret key"
+
+[shift4]
+api_key = "Bearer MyApiKey"
+
+[worldpay]
+api_key = "api_key"
+key1 = "key1"
+
+[payu]
+api_key = "Bearer MyApiKey"
+key1 = "MerchantPosId"
+
+[globalpay]
+api_key = "api_key"
+key1 = "key1"
+
+[rapyd]
+api_key = "access_key"
+key1 = "secret_key"
+
+[fiserv]
+api_key = "MyApiKey"
+key1 = "MerchantID"
+api_secret = "MySecretKey"
+
+[worldline]
+key1 = "Merchant Id"
+api_key = "API Key"
+api_secret = "API Secret Key"
+
+[multisafepay]
+api_key = "API Key"
+
+[dlocal]
+key1 = "key1"
+api_key = "api_key"
+api_secret = "secret"
+
+[bambora]
+api_key = "api_key"
+key1 = "key1"
+
+[nmi]
+api_key = "NMI API Key"
+
+[nuvei]
+api_key = "api_key"
+key1 = "key1"
+api_secret = "secret"
+
+[paypal]
+api_key = "api_key"
+key1 = "key1"
+
+[mollie]
+api_key = "API Key"
+
+[forte]
+api_key = "api_key"
+key1 = "key1"
+key2 = "key2"
+api_secret = "api_secret"
+
+
+[coinbase]
+api_key = "API Key"
+
+[opennode]
+api_key = "API Key"
+
+[nexinets]
+api_key = "api_key"
+key1 = "key1"
+
+[payeezy]
+api_key = "api_key"
+key1 = "key1"
+api_secret = "secret"
+
+[bitpay]
+api_key = "API Key"
+
+[iatapay]
+key1 = "key1"
+api_key = "api_key"
+api_secret = "secrect"
+
+[dummyconnector]
+api_key = "API Key"
+
+[noon]
+api_key = "Application API KEY"
+api_secret = "Application Identifier"
+key1 = "Business Identifier"
+
+[opayo]
+api_key="API Key"
+
+[wise]
+api_key = "API Key"
+key1 = "Profile ID"
+
+[automation_configs]
+hs_base_url="http://localhost:8080"
+hs_test_browser="firefox"
+chrome_profile_path=""
+firefox_profile_path=""
+pypl_email=""
+pypl_pass=""
+gmail_email=""
+gmail_pass=""
+
+[payme]
+# Open api key
+api_key="seller payme id"
+key1="payme client key"
+
+[cryptopay]
+api_key = "api_key"
+key1 = "key1"
+
+[cashtocode]
+api_key="Classic PMT API Key"
+key1 = "Evoucher PMT API Key"
+
+
+[tsys]
+api_key="device id"
+key1 = "transaction key"
+api_secret = "developer id"
+
+[globepay]
+api_key = "Partner code"
+key1 = "Credential code"
+
+[powertranz]
+api_key="PowerTranz-PowerTranzPassword"
+key1 = "PowerTranz-PowerTranzId"
+
+[stax]
+api_key="API Key"
+
+[boku]
+api_key="API Key"
+key1 = "transaction key"
\ No newline at end of file
|
refactor
|
move ui_tests to test_utils crate to reduce development time (#1822)
|
9466ced89407f31963bb0eb7c762749e3713591a
|
2024-12-11 17:32:42
|
Sahkal Poddar
|
feat(core): Add uas framework support (#6743)
| false
|
diff --git a/crates/diesel_models/src/authentication.rs b/crates/diesel_models/src/authentication.rs
index 0310e60ebbd..5d0e58c5627 100644
--- a/crates/diesel_models/src/authentication.rs
+++ b/crates/diesel_models/src/authentication.rs
@@ -152,6 +152,10 @@ pub enum AuthenticationUpdate {
PostAuthorizationUpdate {
authentication_lifecycle_status: common_enums::AuthenticationLifecycleStatus,
},
+ AuthenticationStatusUpdate {
+ trans_status: common_enums::TransactionStatus,
+ authentication_status: common_enums::AuthenticationStatus,
+ },
}
#[derive(Clone, Debug, Eq, PartialEq, AsChangeset, Serialize, Deserialize)]
@@ -418,6 +422,14 @@ impl From<AuthenticationUpdate> for AuthenticationUpdateInternal {
connector_metadata,
..Default::default()
},
+ AuthenticationUpdate::AuthenticationStatusUpdate {
+ trans_status,
+ authentication_status,
+ } => Self {
+ trans_status: Some(trans_status),
+ authentication_status: Some(authentication_status),
+ ..Default::default()
+ },
}
}
}
diff --git a/crates/hyperswitch_domain_models/src/router_data.rs b/crates/hyperswitch_domain_models/src/router_data.rs
index a3867ce3e62..b070c6bc848 100644
--- a/crates/hyperswitch_domain_models/src/router_data.rs
+++ b/crates/hyperswitch_domain_models/src/router_data.rs
@@ -87,6 +87,7 @@ pub struct RouterData<Flow, Request, Response> {
pub connector_mandate_request_reference_id: Option<String>,
+ pub authentication_id: Option<String>,
/// Contains the type of sca exemption required for the transaction
pub psd2_sca_exemption_type: Option<common_enums::ScaExemptionType>,
}
diff --git a/crates/hyperswitch_domain_models/src/router_data_v2.rs b/crates/hyperswitch_domain_models/src/router_data_v2.rs
index 9e3a7f255a2..acc7343cb14 100644
--- a/crates/hyperswitch_domain_models/src/router_data_v2.rs
+++ b/crates/hyperswitch_domain_models/src/router_data_v2.rs
@@ -8,7 +8,7 @@ pub use flow_common_types::FrmFlowData;
pub use flow_common_types::PayoutFlowData;
pub use flow_common_types::{
AccessTokenFlowData, DisputesFlowData, ExternalAuthenticationFlowData, FilesFlowData,
- MandateRevokeFlowData, PaymentFlowData, RefundFlowData, WebhookSourceVerifyData,
+ MandateRevokeFlowData, PaymentFlowData, RefundFlowData, UasFlowData, WebhookSourceVerifyData,
};
use crate::router_data::{ConnectorAuthType, ErrorResponse};
diff --git a/crates/hyperswitch_domain_models/src/router_data_v2/flow_common_types.rs b/crates/hyperswitch_domain_models/src/router_data_v2/flow_common_types.rs
index b2dea40082a..85028a3bd7f 100644
--- a/crates/hyperswitch_domain_models/src/router_data_v2/flow_common_types.rs
+++ b/crates/hyperswitch_domain_models/src/router_data_v2/flow_common_types.rs
@@ -149,3 +149,9 @@ pub struct FilesFlowData {
pub connector_meta_data: Option<pii::SecretSerdeValue>,
pub connector_request_reference_id: String,
}
+
+#[derive(Debug, Clone)]
+pub struct UasFlowData {
+ pub authenticate_by: String,
+ pub source_authentication_id: String,
+}
diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs
index b14e27e8453..7a45faf0262 100644
--- a/crates/hyperswitch_domain_models/src/router_request_types.rs
+++ b/crates/hyperswitch_domain_models/src/router_request_types.rs
@@ -1,5 +1,6 @@
pub mod authentication;
pub mod fraud_check;
+pub mod unified_authentication_service;
use api_models::payments::{AdditionalPaymentData, RequestSurchargeDetails};
use common_utils::{
consts, errors,
diff --git a/crates/hyperswitch_domain_models/src/router_request_types/unified_authentication_service.rs b/crates/hyperswitch_domain_models/src/router_request_types/unified_authentication_service.rs
new file mode 100644
index 00000000000..cbca353b100
--- /dev/null
+++ b/crates/hyperswitch_domain_models/src/router_request_types/unified_authentication_service.rs
@@ -0,0 +1,58 @@
+use masking::Secret;
+
+#[derive(Clone, serde::Deserialize, Debug, serde::Serialize)]
+pub struct UasPreAuthenticationRequestData {
+ pub service_details: Option<ServiceDetails>,
+ pub transaction_details: Option<TransactionDetails>,
+}
+
+#[derive(Clone, serde::Deserialize, Debug, serde::Serialize)]
+pub struct ServiceDetails {
+ pub service_session_ids: Option<ServiceSessionIds>,
+}
+
+#[derive(Clone, serde::Deserialize, Debug, serde::Serialize)]
+pub struct ServiceSessionIds {
+ pub correlation_id: Option<String>,
+ pub merchant_transaction_id: Option<String>,
+ pub x_src_flow_id: Option<String>,
+}
+
+#[derive(Debug, serde::Serialize, serde::Deserialize, Clone)]
+pub struct TransactionDetails {
+ pub amount: common_utils::types::MinorUnit,
+ pub currency: common_enums::Currency,
+}
+
+#[derive(Clone, Debug)]
+pub struct UasPostAuthenticationRequestData;
+
+#[derive(Debug, Clone)]
+pub enum UasAuthenticationResponseData {
+ PreAuthentication {},
+ PostAuthentication {
+ authentication_details: PostAuthenticationDetails,
+ },
+}
+
+#[derive(serde::Serialize, serde::Deserialize, Debug, Clone)]
+pub struct PostAuthenticationDetails {
+ pub eci: Option<String>,
+ pub token_details: TokenDetails,
+ pub dynamic_data_details: Option<DynamicData>,
+}
+
+#[derive(serde::Serialize, serde::Deserialize, Debug, Clone)]
+pub struct TokenDetails {
+ pub payment_token: cards::CardNumber,
+ pub payment_account_reference: String,
+ pub token_expiration_month: Secret<String>,
+ pub token_expiration_year: Secret<String>,
+}
+
+#[derive(serde::Serialize, serde::Deserialize, Debug, Clone)]
+pub struct DynamicData {
+ pub dynamic_data_value: Option<Secret<String>>,
+ pub dynamic_data_type: String,
+ pub ds_trans_id: Option<String>,
+}
diff --git a/crates/router/src/core.rs b/crates/router/src/core.rs
index a2da3384196..f6fe1d85b5d 100644
--- a/crates/router/src/core.rs
+++ b/crates/router/src/core.rs
@@ -52,3 +52,5 @@ pub mod verification;
#[cfg(feature = "olap")]
pub mod verify_connector;
pub mod webhooks;
+
+pub mod unified_authentication_service;
diff --git a/crates/router/src/core/authentication/transformers.rs b/crates/router/src/core/authentication/transformers.rs
index c4b35d52798..da6252d5429 100644
--- a/crates/router/src/core/authentication/transformers.rs
+++ b/crates/router/src/core/authentication/transformers.rs
@@ -190,6 +190,7 @@ pub fn construct_router_data<F: Clone, Req, Res>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type,
})
}
diff --git a/crates/router/src/core/fraud_check/flows/checkout_flow.rs b/crates/router/src/core/fraud_check/flows/checkout_flow.rs
index 84ba1f26a5d..b07268ae666 100644
--- a/crates/router/src/core/fraud_check/flows/checkout_flow.rs
+++ b/crates/router/src/core/fraud_check/flows/checkout_flow.rs
@@ -161,6 +161,7 @@ impl ConstructFlowSpecificData<frm_api::Checkout, FraudCheckCheckoutData, FraudC
additional_merchant_data: None,
header_payload,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
diff --git a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs
index 92edc083e08..8b837d7b22e 100644
--- a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs
+++ b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs
@@ -128,6 +128,7 @@ pub async fn construct_fulfillment_router_data<'a>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
Ok(router_data)
diff --git a/crates/router/src/core/fraud_check/flows/record_return.rs b/crates/router/src/core/fraud_check/flows/record_return.rs
index 6e29d01c81f..d05f7280024 100644
--- a/crates/router/src/core/fraud_check/flows/record_return.rs
+++ b/crates/router/src/core/fraud_check/flows/record_return.rs
@@ -129,6 +129,7 @@ impl ConstructFlowSpecificData<RecordReturn, FraudCheckRecordReturnData, FraudCh
additional_merchant_data: None,
header_payload,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
diff --git a/crates/router/src/core/fraud_check/flows/sale_flow.rs b/crates/router/src/core/fraud_check/flows/sale_flow.rs
index cdab3e4dae0..683a153ff1a 100644
--- a/crates/router/src/core/fraud_check/flows/sale_flow.rs
+++ b/crates/router/src/core/fraud_check/flows/sale_flow.rs
@@ -137,6 +137,7 @@ impl ConstructFlowSpecificData<frm_api::Sale, FraudCheckSaleData, FraudCheckResp
additional_merchant_data: None,
header_payload,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
diff --git a/crates/router/src/core/fraud_check/flows/transaction_flow.rs b/crates/router/src/core/fraud_check/flows/transaction_flow.rs
index a66a47f7097..da73267bd0b 100644
--- a/crates/router/src/core/fraud_check/flows/transaction_flow.rs
+++ b/crates/router/src/core/fraud_check/flows/transaction_flow.rs
@@ -146,6 +146,7 @@ impl
additional_merchant_data: None,
header_payload,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
diff --git a/crates/router/src/core/mandate/utils.rs b/crates/router/src/core/mandate/utils.rs
index 99af1657620..f2db3228db9 100644
--- a/crates/router/src/core/mandate/utils.rs
+++ b/crates/router/src/core/mandate/utils.rs
@@ -81,6 +81,7 @@ pub async fn construct_mandate_revoke_router_data(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index dcbafa5aa9d..7912eb090d5 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -4327,7 +4327,7 @@ pub fn if_not_create_change_operation<'a, Op, F>(
current: &'a Op,
) -> BoxedOperation<'a, F, api::PaymentsRequest, PaymentData<F>>
where
- F: Send + Clone,
+ F: Send + Clone + Sync,
Op: Operation<F, api::PaymentsRequest, Data = PaymentData<F>> + Send + Sync,
&'a Op: Operation<F, api::PaymentsRequest, Data = PaymentData<F>>,
PaymentStatus: Operation<F, api::PaymentsRequest, Data = PaymentData<F>>,
diff --git a/crates/router/src/core/payments/connector_integration_v2_impls.rs b/crates/router/src/core/payments/connector_integration_v2_impls.rs
index 286680062f8..8725470e259 100644
--- a/crates/router/src/core/payments/connector_integration_v2_impls.rs
+++ b/crates/router/src/core/payments/connector_integration_v2_impls.rs
@@ -2226,3 +2226,114 @@ default_imp_for_new_connector_integration_connector_authentication!(
connector::Zsl,
connector::Plaid
);
+
+macro_rules! default_imp_for_new_connector_integration_uas {
+ ($($path:ident::$connector:ident),*) => {
+ $( impl api::UnifiedAuthenticationServiceV2 for $path::$connector {}
+ impl api::UasPreAuthenticationV2 for $path::$connector {}
+ impl api::UasPostAuthenticationV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PreAuthenticate,
+ types::UasFlowData,
+ types::UasPreAuthenticationRequestData,
+ types::UasAuthenticationResponseData,
+ > for $path::$connector
+ {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PostAuthenticate,
+ types::UasFlowData,
+ types::UasPostAuthenticationRequestData,
+ types::UasAuthenticationResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_uas!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Amazonpay,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bamboraapac,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Datatrans,
+ connector::Deutschebank,
+ connector::Digitalvirgo,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Elavon,
+ connector::Fiserv,
+ connector::Fiservemea,
+ connector::Forte,
+ connector::Fiuu,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Inespay,
+ connector::Itaubank,
+ connector::Jpmorgan,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nexixpay,
+ connector::Nmi,
+ connector::Nomupay,
+ connector::Noon,
+ connector::Novalnet,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Paybox,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Razorpay,
+ connector::Redsys,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Taxjar,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Thunes,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wellsfargo,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl,
+ connector::Plaid
+);
diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs
index 00001e0e6c0..9ce0ccb4496 100644
--- a/crates/router/src/core/payments/flows.rs
+++ b/crates/router/src/core/payments/flows.rs
@@ -2610,6 +2610,232 @@ default_imp_for_post_session_tokens!(
connector::Wise
);
+macro_rules! default_imp_for_uas_pre_authentication {
+ ($($path:ident::$connector:ident),*) => {
+ $( impl api::UnifiedAuthenticationService for $path::$connector {}
+ impl api::UasPreAuthentication for $path::$connector {}
+ impl
+ services::ConnectorIntegration<
+ api::PreAuthenticate,
+ types::UasPreAuthenticationRequestData,
+ types::UasAuthenticationResponseData
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8> api::UasPreAuthentication for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8> api::UnifiedAuthenticationService for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8>
+ services::ConnectorIntegration<
+ api::PreAuthenticate,
+ types::UasPreAuthenticationRequestData,
+ types::UasAuthenticationResponseData,
+ > for connector::DummyConnector<T>
+{
+}
+
+default_imp_for_uas_pre_authentication!(
+ connector::Adyenplatform,
+ connector::Aci,
+ connector::Adyen,
+ connector::Airwallex,
+ connector::Amazonpay,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bamboraapac,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Datatrans,
+ connector::Deutschebank,
+ connector::Digitalvirgo,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Elavon,
+ connector::Fiserv,
+ connector::Fiservemea,
+ connector::Fiuu,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Itaubank,
+ connector::Jpmorgan,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Netcetera,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Nexinets,
+ connector::Nexixpay,
+ connector::Nmi,
+ connector::Nomupay,
+ connector::Noon,
+ connector::Novalnet,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Paybox,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Plaid,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Razorpay,
+ connector::Riskified,
+ connector::Shift4,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Threedsecureio,
+ connector::Taxjar,
+ connector::Trustpay,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wellsfargo,
+ connector::Wellsfargopayout,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl,
+ connector::Inespay,
+ connector::Redsys,
+ connector::UnifiedAuthenticationService
+);
+
+macro_rules! default_imp_for_uas_post_authentication {
+ ($($path:ident::$connector:ident),*) => {
+ $( impl api::UasPostAuthentication for $path::$connector {}
+ impl
+ services::ConnectorIntegration<
+ api::PostAuthenticate,
+ types::UasPostAuthenticationRequestData,
+ types::UasAuthenticationResponseData
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8> api::UasPostAuthentication for connector::DummyConnector<T> {}
+#[cfg(feature = "dummy_connector")]
+impl<const T: u8>
+ services::ConnectorIntegration<
+ api::PostAuthenticate,
+ types::UasPostAuthenticationRequestData,
+ types::UasAuthenticationResponseData,
+ > for connector::DummyConnector<T>
+{
+}
+
+default_imp_for_uas_post_authentication!(
+ connector::Adyenplatform,
+ connector::Aci,
+ connector::Adyen,
+ connector::Airwallex,
+ connector::Amazonpay,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bamboraapac,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Datatrans,
+ connector::Deutschebank,
+ connector::Digitalvirgo,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Elavon,
+ connector::Fiserv,
+ connector::Fiservemea,
+ connector::Fiuu,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gpayments,
+ connector::Gocardless,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Itaubank,
+ connector::Jpmorgan,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Netcetera,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Nexinets,
+ connector::Nexixpay,
+ connector::Nmi,
+ connector::Nomupay,
+ connector::Noon,
+ connector::Novalnet,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Paybox,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Plaid,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Razorpay,
+ connector::Riskified,
+ connector::Shift4,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Threedsecureio,
+ connector::Taxjar,
+ connector::Trustpay,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wellsfargo,
+ connector::Wellsfargopayout,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl,
+ connector::Inespay,
+ connector::Redsys,
+ connector::UnifiedAuthenticationService
+);
/// Determines whether a capture API call should be made for a payment attempt
/// This function evaluates whether an authorized payment should proceed with a capture API call
/// based on various payment parameters. It's primarily used in two-step (auth + capture) payment flows for CaptureMethod SequentialAutomatic
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index 61b47df3256..6265ac3f185 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -3964,6 +3964,7 @@ pub fn router_data_type_conversion<F1, F2, Req1, Req2, Res1, Res2>(
additional_merchant_data: router_data.additional_merchant_data,
header_payload: router_data.header_payload,
connector_mandate_request_reference_id: router_data.connector_mandate_request_reference_id,
+ authentication_id: router_data.authentication_id,
psd2_sca_exemption_type: router_data.psd2_sca_exemption_type,
}
}
diff --git a/crates/router/src/core/payments/operations.rs b/crates/router/src/core/payments/operations.rs
index f957b939acf..a7e60274d13 100644
--- a/crates/router/src/core/payments/operations.rs
+++ b/crates/router/src/core/payments/operations.rs
@@ -295,6 +295,18 @@ pub trait Domain<F: Clone, R, D>: Send + Sync {
Ok(())
}
+ async fn call_unified_authentication_service_if_eligible<'a>(
+ &'a self,
+ _state: &SessionState,
+ _payment_data: &mut D,
+ _should_continue_confirm_transaction: &mut bool,
+ _connector_call_type: &ConnectorCallType,
+ _merchant_account: &domain::Profile,
+ _key_store: &domain::MerchantKeyStore,
+ ) -> CustomResult<(), errors::ApiErrorResponse> {
+ Ok(())
+ }
+
#[allow(clippy::too_many_arguments)]
async fn payments_dynamic_tax_calculation<'a>(
&'a self,
diff --git a/crates/router/src/core/payments/operations/payment_approve.rs b/crates/router/src/core/payments/operations/payment_approve.rs
index 97832a08184..b3d2985bf80 100644
--- a/crates/router/src/core/payments/operations/payment_approve.rs
+++ b/crates/router/src/core/payments/operations/payment_approve.rs
@@ -32,7 +32,7 @@ type PaymentApproveOperation<'a, F> =
BoxedOperation<'a, F, api::PaymentsCaptureRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsCaptureRequest>
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsCaptureRequest>
for PaymentApprove
{
#[instrument(skip_all)]
@@ -209,7 +209,9 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsCaptureRequest>
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsCaptureRequest> for PaymentApprove {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsCaptureRequest>
+ for PaymentApprove
+{
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
@@ -268,7 +270,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsCaptureRequest> for
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsCaptureRequest, PaymentData<F>>
+impl<F: Send + Clone + Sync> ValidateRequest<F, api::PaymentsCaptureRequest, PaymentData<F>>
for PaymentApprove
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_cancel.rs b/crates/router/src/core/payments/operations/payment_cancel.rs
index ef6570abf8c..a40ecf0242e 100644
--- a/crates/router/src/core/payments/operations/payment_cancel.rs
+++ b/crates/router/src/core/payments/operations/payment_cancel.rs
@@ -33,7 +33,9 @@ type PaymentCancelOperation<'b, F> =
BoxedOperation<'b, F, api::PaymentsCancelRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsCancelRequest> for PaymentCancel {
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsCancelRequest>
+ for PaymentCancel
+{
#[instrument(skip_all)]
async fn get_trackers<'a>(
&'a self,
@@ -218,7 +220,9 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsCancelRequest>
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsCancelRequest> for PaymentCancel {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsCancelRequest>
+ for PaymentCancel
+{
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
@@ -286,7 +290,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsCancelRequest> for
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsCancelRequest, PaymentData<F>>
+impl<F: Send + Clone + Sync> ValidateRequest<F, api::PaymentsCancelRequest, PaymentData<F>>
for PaymentCancel
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_capture.rs b/crates/router/src/core/payments/operations/payment_capture.rs
index 2451cbcd8e9..d9068b402ce 100644
--- a/crates/router/src/core/payments/operations/payment_capture.rs
+++ b/crates/router/src/core/payments/operations/payment_capture.rs
@@ -32,7 +32,7 @@ type PaymentCaptureOperation<'b, F> =
BoxedOperation<'b, F, api::PaymentsCaptureRequest, payments::PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, payments::PaymentData<F>, api::PaymentsCaptureRequest>
+impl<F: Send + Clone + Sync> GetTracker<F, payments::PaymentData<F>, api::PaymentsCaptureRequest>
for PaymentCapture
{
#[instrument(skip_all)]
@@ -269,7 +269,7 @@ impl<F: Send + Clone> GetTracker<F, payments::PaymentData<F>, api::PaymentsCaptu
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, payments::PaymentData<F>, api::PaymentsCaptureRequest>
+impl<F: Clone + Sync> UpdateTracker<F, payments::PaymentData<F>, api::PaymentsCaptureRequest>
for PaymentCapture
{
#[instrument(skip_all)]
@@ -326,8 +326,8 @@ impl<F: Clone> UpdateTracker<F, payments::PaymentData<F>, api::PaymentsCaptureRe
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsCaptureRequest, payments::PaymentData<F>>
- for PaymentCapture
+impl<F: Send + Clone + Sync>
+ ValidateRequest<F, api::PaymentsCaptureRequest, payments::PaymentData<F>> for PaymentCapture
{
#[instrument(skip_all)]
fn validate_request<'a, 'b>(
diff --git a/crates/router/src/core/payments/operations/payment_complete_authorize.rs b/crates/router/src/core/payments/operations/payment_complete_authorize.rs
index b296d6c3052..f4f5813c1b0 100644
--- a/crates/router/src/core/payments/operations/payment_complete_authorize.rs
+++ b/crates/router/src/core/payments/operations/payment_complete_authorize.rs
@@ -35,7 +35,9 @@ type CompleteAuthorizeOperation<'b, F> =
BoxedOperation<'b, F, api::PaymentsRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for CompleteAuthorize {
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest>
+ for CompleteAuthorize
+{
#[instrument(skip_all)]
async fn get_trackers<'a>(
&'a self,
@@ -369,7 +371,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Co
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for CompleteAuthorize {
+impl<F: Clone + Send + Sync> Domain<F, api::PaymentsRequest, PaymentData<F>> for CompleteAuthorize {
#[instrument(skip_all)]
async fn get_or_create_customer_details<'a>(
&'a self,
@@ -458,7 +460,7 @@ impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for Comple
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for CompleteAuthorize {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for CompleteAuthorize {
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
@@ -504,7 +506,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Comple
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsRequest, PaymentData<F>>
+impl<F: Send + Clone + Sync> ValidateRequest<F, api::PaymentsRequest, PaymentData<F>>
for CompleteAuthorize
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs
index 67829f1fb73..c3fe518ff5e 100644
--- a/crates/router/src/core/payments/operations/payment_confirm.rs
+++ b/crates/router/src/core/payments/operations/payment_confirm.rs
@@ -38,6 +38,10 @@ use crate::{
self, helpers, operations, populate_surcharge_details, CustomerDetails, PaymentAddress,
PaymentData,
},
+ unified_authentication_service::{
+ self,
+ types::{ClickToPay, UnifiedAuthenticationService, CTP_MASTERCARD},
+ },
utils as core_utils,
},
routes::{app::ReqState, SessionState},
@@ -59,7 +63,9 @@ pub struct PaymentConfirm;
type PaymentConfirmOperation<'b, F> = BoxedOperation<'b, F, api::PaymentsRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentConfirm {
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest>
+ for PaymentConfirm
+{
#[instrument(skip_all)]
async fn get_trackers<'a>(
&'a self,
@@ -827,7 +833,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for PaymentConfirm {
+impl<F: Clone + Send + Sync> Domain<F, api::PaymentsRequest, PaymentData<F>> for PaymentConfirm {
#[instrument(skip_all)]
async fn get_or_create_customer_details<'a>(
&'a self,
@@ -1027,6 +1033,93 @@ impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for Paymen
Ok(())
}
+ #[allow(clippy::too_many_arguments)]
+ async fn call_unified_authentication_service_if_eligible<'a>(
+ &'a self,
+ state: &SessionState,
+ payment_data: &mut PaymentData<F>,
+ _should_continue_confirm_transaction: &mut bool,
+ _connector_call_type: &ConnectorCallType,
+ business_profile: &domain::Profile,
+ key_store: &domain::MerchantKeyStore,
+ ) -> CustomResult<(), errors::ApiErrorResponse> {
+ let is_click_to_pay_enabled = true; // fetch from business profile
+
+ if let Some(payment_method) = payment_data.payment_attempt.payment_method {
+ if payment_method == storage_enums::PaymentMethod::Card && is_click_to_pay_enabled {
+ let connector_name = CTP_MASTERCARD; // since the above checks satisfies the connector should be click to pay hence hardcoded the connector name
+ let connector_mca = helpers::get_merchant_connector_account(
+ state,
+ &business_profile.merchant_id,
+ None,
+ key_store,
+ business_profile.get_id(),
+ connector_name,
+ None,
+ )
+ .await?;
+
+ let authentication_id =
+ common_utils::generate_id_with_default_len(consts::AUTHENTICATION_ID_PREFIX);
+
+ let payment_method = payment_data.payment_attempt.payment_method.ok_or(
+ errors::ApiErrorResponse::MissingRequiredField {
+ field_name: "payment_method",
+ },
+ )?;
+
+ let connector_transaction_id = connector_mca
+ .clone()
+ .get_mca_id()
+ .ok_or(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable(
+ "Error while finding mca_id from merchant_connector_account",
+ )?;
+
+ ClickToPay::pre_authentication(
+ state,
+ key_store,
+ business_profile,
+ payment_data,
+ &connector_mca,
+ connector_name,
+ &authentication_id,
+ payment_method,
+ )
+ .await?;
+
+ payment_data.payment_attempt.authentication_id = Some(authentication_id.clone());
+
+ let network_token = ClickToPay::post_authentication(
+ state,
+ key_store,
+ business_profile,
+ payment_data,
+ &connector_mca,
+ connector_name,
+ payment_method,
+ )
+ .await?;
+
+ payment_data.payment_method_data =
+ network_token.map(domain::PaymentMethodData::NetworkToken);
+
+ unified_authentication_service::create_new_authentication(
+ state,
+ payment_data.payment_attempt.merchant_id.clone(),
+ connector_name.to_string(),
+ business_profile.get_id().clone(),
+ Some(payment_data.payment_intent.get_id().clone()),
+ connector_transaction_id,
+ &authentication_id,
+ )
+ .await?;
+ }
+ }
+
+ Ok(())
+ }
+
#[instrument(skip_all)]
async fn guard_payment_against_blocklist<'a>(
&'a self,
@@ -1111,7 +1204,7 @@ impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for Paymen
#[cfg(all(feature = "v2", feature = "customer_v2"))]
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentConfirm {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentConfirm {
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
@@ -1137,7 +1230,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
#[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentConfirm {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentConfirm {
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
@@ -1540,7 +1633,9 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsRequest, PaymentData<F>> for PaymentConfirm {
+impl<F: Send + Clone + Sync> ValidateRequest<F, api::PaymentsRequest, PaymentData<F>>
+ for PaymentConfirm
+{
#[instrument(skip_all)]
fn validate_request<'a, 'b>(
&'b self,
diff --git a/crates/router/src/core/payments/operations/payment_confirm_intent.rs b/crates/router/src/core/payments/operations/payment_confirm_intent.rs
index 05c90102565..f6c47de3762 100644
--- a/crates/router/src/core/payments/operations/payment_confirm_intent.rs
+++ b/crates/router/src/core/payments/operations/payment_confirm_intent.rs
@@ -71,7 +71,7 @@ type BoxedConfirmOperation<'b, F> =
// TODO: change the macro to include changes for v2
// TODO: PaymentData in the macro should be an input
-impl<F: Send + Clone> Operation<F, PaymentsConfirmIntentRequest> for &PaymentIntentConfirm {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsConfirmIntentRequest> for &PaymentIntentConfirm {
type Data = PaymentConfirmData<F>;
fn to_validate_request(
&self,
@@ -99,7 +99,7 @@ impl<F: Send + Clone> Operation<F, PaymentsConfirmIntentRequest> for &PaymentInt
}
}
#[automatically_derived]
-impl<F: Send + Clone> Operation<F, PaymentsConfirmIntentRequest> for PaymentIntentConfirm {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsConfirmIntentRequest> for PaymentIntentConfirm {
type Data = PaymentConfirmData<F>;
fn to_validate_request(
&self,
@@ -125,7 +125,7 @@ impl<F: Send + Clone> Operation<F, PaymentsConfirmIntentRequest> for PaymentInte
}
}
-impl<F: Send + Clone> ValidateRequest<F, PaymentsConfirmIntentRequest, PaymentConfirmData<F>>
+impl<F: Send + Clone + Sync> ValidateRequest<F, PaymentsConfirmIntentRequest, PaymentConfirmData<F>>
for PaymentIntentConfirm
{
#[instrument(skip_all)]
@@ -145,7 +145,7 @@ impl<F: Send + Clone> ValidateRequest<F, PaymentsConfirmIntentRequest, PaymentCo
}
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentConfirmData<F>, PaymentsConfirmIntentRequest>
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentConfirmData<F>, PaymentsConfirmIntentRequest>
for PaymentIntentConfirm
{
#[instrument(skip_all)]
@@ -259,7 +259,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentConfirmData<F>, PaymentsConfirmIntent
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, PaymentsConfirmIntentRequest, PaymentConfirmData<F>>
+impl<F: Clone + Send + Sync> Domain<F, PaymentsConfirmIntentRequest, PaymentConfirmData<F>>
for PaymentIntentConfirm
{
async fn get_customer_details<'a>(
@@ -348,7 +348,7 @@ impl<F: Clone + Send> Domain<F, PaymentsConfirmIntentRequest, PaymentConfirmData
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmIntentRequest>
+impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmIntentRequest>
for PaymentIntentConfirm
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs
index 3bd5b9abcdd..6b9a4a76711 100644
--- a/crates/router/src/core/payments/operations/payment_create.rs
+++ b/crates/router/src/core/payments/operations/payment_create.rs
@@ -67,7 +67,7 @@ type PaymentCreateOperation<'a, F> = BoxedOperation<'a, F, api::PaymentsRequest,
/// The `get_trackers` function for `PaymentsCreate` is an entrypoint for new payments
/// This will create all the entities required for a new payment from the request
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentCreate {
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentCreate {
#[instrument(skip_all)]
async fn get_trackers<'a>(
&'a self,
@@ -628,7 +628,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for PaymentCreate {
+impl<F: Clone + Send + Sync> Domain<F, api::PaymentsRequest, PaymentData<F>> for PaymentCreate {
#[instrument(skip_all)]
async fn get_or_create_customer_details<'a>(
&'a self,
@@ -816,7 +816,7 @@ impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for Paymen
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentCreate {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentCreate {
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
@@ -940,7 +940,9 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsRequest, PaymentData<F>> for PaymentCreate {
+impl<F: Send + Clone + Sync> ValidateRequest<F, api::PaymentsRequest, PaymentData<F>>
+ for PaymentCreate
+{
#[instrument(skip_all)]
fn validate_request<'a, 'b>(
&'b self,
diff --git a/crates/router/src/core/payments/operations/payment_create_intent.rs b/crates/router/src/core/payments/operations/payment_create_intent.rs
index 988e040f376..372d106eb92 100644
--- a/crates/router/src/core/payments/operations/payment_create_intent.rs
+++ b/crates/router/src/core/payments/operations/payment_create_intent.rs
@@ -29,7 +29,7 @@ use crate::{
#[derive(Debug, Clone, Copy)]
pub struct PaymentIntentCreate;
-impl<F: Send + Clone> Operation<F, PaymentsCreateIntentRequest> for &PaymentIntentCreate {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsCreateIntentRequest> for &PaymentIntentCreate {
type Data = payments::PaymentIntentData<F>;
fn to_validate_request(
&self,
@@ -55,7 +55,7 @@ impl<F: Send + Clone> Operation<F, PaymentsCreateIntentRequest> for &PaymentInte
}
}
-impl<F: Send + Clone> Operation<F, PaymentsCreateIntentRequest> for PaymentIntentCreate {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsCreateIntentRequest> for PaymentIntentCreate {
type Data = payments::PaymentIntentData<F>;
fn to_validate_request(
&self,
@@ -85,7 +85,8 @@ type PaymentsCreateIntentOperation<'b, F> =
BoxedOperation<'b, F, PaymentsCreateIntentRequest, payments::PaymentIntentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, payments::PaymentIntentData<F>, PaymentsCreateIntentRequest>
+impl<F: Send + Clone + Sync>
+ GetTracker<F, payments::PaymentIntentData<F>, PaymentsCreateIntentRequest>
for PaymentIntentCreate
{
#[instrument(skip_all)]
@@ -168,7 +169,7 @@ impl<F: Send + Clone> GetTracker<F, payments::PaymentIntentData<F>, PaymentsCrea
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, payments::PaymentIntentData<F>, PaymentsCreateIntentRequest>
+impl<F: Clone + Sync> UpdateTracker<F, payments::PaymentIntentData<F>, PaymentsCreateIntentRequest>
for PaymentIntentCreate
{
#[instrument(skip_all)]
@@ -213,7 +214,7 @@ impl<F: Send + Clone>
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, PaymentsCreateIntentRequest, payments::PaymentIntentData<F>>
+impl<F: Clone + Send + Sync> Domain<F, PaymentsCreateIntentRequest, payments::PaymentIntentData<F>>
for PaymentIntentCreate
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_get.rs b/crates/router/src/core/payments/operations/payment_get.rs
index f66186c7c57..14eb9c2d8b1 100644
--- a/crates/router/src/core/payments/operations/payment_get.rs
+++ b/crates/router/src/core/payments/operations/payment_get.rs
@@ -53,7 +53,7 @@ type BoxedConfirmOperation<'b, F> =
// TODO: change the macro to include changes for v2
// TODO: PaymentData in the macro should be an input
-impl<F: Send + Clone> Operation<F, PaymentsRetrieveRequest> for &PaymentGet {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsRetrieveRequest> for &PaymentGet {
type Data = PaymentStatusData<F>;
fn to_validate_request(
&self,
@@ -77,7 +77,7 @@ impl<F: Send + Clone> Operation<F, PaymentsRetrieveRequest> for &PaymentGet {
}
}
#[automatically_derived]
-impl<F: Send + Clone> Operation<F, PaymentsRetrieveRequest> for PaymentGet {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsRetrieveRequest> for PaymentGet {
type Data = PaymentStatusData<F>;
fn to_validate_request(
&self,
@@ -101,7 +101,7 @@ impl<F: Send + Clone> Operation<F, PaymentsRetrieveRequest> for PaymentGet {
}
}
-impl<F: Send + Clone> ValidateRequest<F, PaymentsRetrieveRequest, PaymentStatusData<F>>
+impl<F: Send + Clone + Sync> ValidateRequest<F, PaymentsRetrieveRequest, PaymentStatusData<F>>
for PaymentGet
{
#[instrument(skip_all)]
@@ -121,7 +121,9 @@ impl<F: Send + Clone> ValidateRequest<F, PaymentsRetrieveRequest, PaymentStatusD
}
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentStatusData<F>, PaymentsRetrieveRequest> for PaymentGet {
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentStatusData<F>, PaymentsRetrieveRequest>
+ for PaymentGet
+{
#[instrument(skip_all)]
async fn get_trackers<'a>(
&'a self,
@@ -196,7 +198,9 @@ impl<F: Send + Clone> GetTracker<F, PaymentStatusData<F>, PaymentsRetrieveReques
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, PaymentsRetrieveRequest, PaymentStatusData<F>> for PaymentGet {
+impl<F: Clone + Send + Sync> Domain<F, PaymentsRetrieveRequest, PaymentStatusData<F>>
+ for PaymentGet
+{
async fn get_customer_details<'a>(
&'a self,
state: &SessionState,
@@ -284,7 +288,9 @@ impl<F: Clone + Send> Domain<F, PaymentsRetrieveRequest, PaymentStatusData<F>> f
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentStatusData<F>, PaymentsRetrieveRequest> for PaymentGet {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentStatusData<F>, PaymentsRetrieveRequest>
+ for PaymentGet
+{
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
diff --git a/crates/router/src/core/payments/operations/payment_get_intent.rs b/crates/router/src/core/payments/operations/payment_get_intent.rs
index 344f10434bd..16b44436c18 100644
--- a/crates/router/src/core/payments/operations/payment_get_intent.rs
+++ b/crates/router/src/core/payments/operations/payment_get_intent.rs
@@ -22,7 +22,7 @@ use crate::{
#[derive(Debug, Clone, Copy)]
pub struct PaymentGetIntent;
-impl<F: Send + Clone> Operation<F, PaymentsGetIntentRequest> for &PaymentGetIntent {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsGetIntentRequest> for &PaymentGetIntent {
type Data = payments::PaymentIntentData<F>;
fn to_validate_request(
&self,
@@ -47,7 +47,7 @@ impl<F: Send + Clone> Operation<F, PaymentsGetIntentRequest> for &PaymentGetInte
}
}
-impl<F: Send + Clone> Operation<F, PaymentsGetIntentRequest> for PaymentGetIntent {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsGetIntentRequest> for PaymentGetIntent {
type Data = payments::PaymentIntentData<F>;
fn to_validate_request(
&self,
@@ -76,7 +76,7 @@ type PaymentsGetIntentOperation<'b, F> =
BoxedOperation<'b, F, PaymentsGetIntentRequest, payments::PaymentIntentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, payments::PaymentIntentData<F>, PaymentsGetIntentRequest>
+impl<F: Send + Clone + Sync> GetTracker<F, payments::PaymentIntentData<F>, PaymentsGetIntentRequest>
for PaymentGetIntent
{
#[instrument(skip_all)]
@@ -111,7 +111,7 @@ impl<F: Send + Clone> GetTracker<F, payments::PaymentIntentData<F>, PaymentsGetI
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, payments::PaymentIntentData<F>, PaymentsGetIntentRequest>
+impl<F: Clone + Sync> UpdateTracker<F, payments::PaymentIntentData<F>, PaymentsGetIntentRequest>
for PaymentGetIntent
{
#[instrument(skip_all)]
@@ -137,7 +137,8 @@ impl<F: Clone> UpdateTracker<F, payments::PaymentIntentData<F>, PaymentsGetInten
}
}
-impl<F: Send + Clone> ValidateRequest<F, PaymentsGetIntentRequest, payments::PaymentIntentData<F>>
+impl<F: Send + Clone + Sync>
+ ValidateRequest<F, PaymentsGetIntentRequest, payments::PaymentIntentData<F>>
for PaymentGetIntent
{
#[instrument(skip_all)]
@@ -155,7 +156,7 @@ impl<F: Send + Clone> ValidateRequest<F, PaymentsGetIntentRequest, payments::Pay
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, PaymentsGetIntentRequest, payments::PaymentIntentData<F>>
+impl<F: Clone + Send + Sync> Domain<F, PaymentsGetIntentRequest, payments::PaymentIntentData<F>>
for PaymentGetIntent
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_post_session_tokens.rs b/crates/router/src/core/payments/operations/payment_post_session_tokens.rs
index 846f739e082..7c30d9c5b75 100644
--- a/crates/router/src/core/payments/operations/payment_post_session_tokens.rs
+++ b/crates/router/src/core/payments/operations/payment_post_session_tokens.rs
@@ -32,7 +32,7 @@ type PaymentPostSessionTokensOperation<'b, F> =
BoxedOperation<'b, F, api::PaymentsPostSessionTokensRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsPostSessionTokensRequest>
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsPostSessionTokensRequest>
for PaymentPostSessionTokens
{
#[instrument(skip_all)]
@@ -179,7 +179,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsPostSessionToke
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, api::PaymentsPostSessionTokensRequest, PaymentData<F>>
+impl<F: Clone + Send + Sync> Domain<F, api::PaymentsPostSessionTokensRequest, PaymentData<F>>
for PaymentPostSessionTokens
{
#[instrument(skip_all)]
@@ -241,7 +241,7 @@ impl<F: Clone + Send> Domain<F, api::PaymentsPostSessionTokensRequest, PaymentDa
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsPostSessionTokensRequest>
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsPostSessionTokensRequest>
for PaymentPostSessionTokens
{
#[instrument(skip_all)]
@@ -264,7 +264,8 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsPostSessionTokensRe
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsPostSessionTokensRequest, PaymentData<F>>
+impl<F: Send + Clone + Sync>
+ ValidateRequest<F, api::PaymentsPostSessionTokensRequest, PaymentData<F>>
for PaymentPostSessionTokens
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_reject.rs b/crates/router/src/core/payments/operations/payment_reject.rs
index c747c7d984a..df9544dfb48 100644
--- a/crates/router/src/core/payments/operations/payment_reject.rs
+++ b/crates/router/src/core/payments/operations/payment_reject.rs
@@ -30,7 +30,9 @@ pub struct PaymentReject;
type PaymentRejectOperation<'b, F> = BoxedOperation<'b, F, PaymentsCancelRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, PaymentsCancelRequest> for PaymentReject {
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, PaymentsCancelRequest>
+ for PaymentReject
+{
#[instrument(skip_all)]
async fn get_trackers<'a>(
&'a self,
@@ -205,7 +207,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, PaymentsCancelRequest> for P
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, PaymentsCancelRequest> for PaymentReject {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, PaymentsCancelRequest> for PaymentReject {
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
@@ -280,7 +282,9 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, PaymentsCancelRequest> for Payme
}
}
-impl<F: Send + Clone> ValidateRequest<F, PaymentsCancelRequest, PaymentData<F>> for PaymentReject {
+impl<F: Send + Clone + Sync> ValidateRequest<F, PaymentsCancelRequest, PaymentData<F>>
+ for PaymentReject
+{
#[instrument(skip_all)]
fn validate_request<'a, 'b>(
&'b self,
diff --git a/crates/router/src/core/payments/operations/payment_session.rs b/crates/router/src/core/payments/operations/payment_session.rs
index ebc663aaf39..a9a64c68809 100644
--- a/crates/router/src/core/payments/operations/payment_session.rs
+++ b/crates/router/src/core/payments/operations/payment_session.rs
@@ -31,7 +31,7 @@ type PaymentSessionOperation<'b, F> =
BoxedOperation<'b, F, api::PaymentsSessionRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsSessionRequest>
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsSessionRequest>
for PaymentSession
{
#[instrument(skip_all)]
@@ -227,7 +227,9 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsSessionRequest>
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsSessionRequest> for PaymentSession {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsSessionRequest>
+ for PaymentSession
+{
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
@@ -267,7 +269,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsSessionRequest> for
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsSessionRequest, PaymentData<F>>
+impl<F: Send + Clone + Sync> ValidateRequest<F, api::PaymentsSessionRequest, PaymentData<F>>
for PaymentSession
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_session_intent.rs b/crates/router/src/core/payments/operations/payment_session_intent.rs
index ee490408cb1..6072681c2ff 100644
--- a/crates/router/src/core/payments/operations/payment_session_intent.rs
+++ b/crates/router/src/core/payments/operations/payment_session_intent.rs
@@ -48,7 +48,7 @@ impl ValidateStatusForOperation for PaymentSessionIntent {
}
}
-impl<F: Send + Clone> Operation<F, PaymentsSessionRequest> for &PaymentSessionIntent {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsSessionRequest> for &PaymentSessionIntent {
type Data = payments::PaymentIntentData<F>;
fn to_validate_request(
&self,
@@ -66,7 +66,7 @@ impl<F: Send + Clone> Operation<F, PaymentsSessionRequest> for &PaymentSessionIn
}
}
-impl<F: Send + Clone> Operation<F, PaymentsSessionRequest> for PaymentSessionIntent {
+impl<F: Send + Clone + Sync> Operation<F, PaymentsSessionRequest> for PaymentSessionIntent {
type Data = payments::PaymentIntentData<F>;
fn to_validate_request(
&self,
@@ -88,7 +88,7 @@ type PaymentsCreateIntentOperation<'b, F> =
BoxedOperation<'b, F, PaymentsSessionRequest, payments::PaymentIntentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, payments::PaymentIntentData<F>, PaymentsSessionRequest>
+impl<F: Send + Clone + Sync> GetTracker<F, payments::PaymentIntentData<F>, PaymentsSessionRequest>
for PaymentSessionIntent
{
#[instrument(skip_all)]
@@ -131,7 +131,8 @@ impl<F: Send + Clone> GetTracker<F, payments::PaymentIntentData<F>, PaymentsSess
}
}
-impl<F: Send + Clone> ValidateRequest<F, PaymentsSessionRequest, payments::PaymentIntentData<F>>
+impl<F: Send + Clone + Sync>
+ ValidateRequest<F, PaymentsSessionRequest, payments::PaymentIntentData<F>>
for PaymentSessionIntent
{
#[instrument(skip_all)]
@@ -149,7 +150,7 @@ impl<F: Send + Clone> ValidateRequest<F, PaymentsSessionRequest, payments::Payme
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, PaymentsSessionRequest, payments::PaymentIntentData<F>>
+impl<F: Clone + Send + Sync> Domain<F, PaymentsSessionRequest, payments::PaymentIntentData<F>>
for PaymentSessionIntent
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_start.rs b/crates/router/src/core/payments/operations/payment_start.rs
index edcb0282bdd..3285914affa 100644
--- a/crates/router/src/core/payments/operations/payment_start.rs
+++ b/crates/router/src/core/payments/operations/payment_start.rs
@@ -30,7 +30,9 @@ type PaymentSessionOperation<'b, F> =
BoxedOperation<'b, F, api::PaymentsStartRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsStartRequest> for PaymentStart {
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsStartRequest>
+ for PaymentStart
+{
#[instrument(skip_all)]
async fn get_trackers<'a>(
&'a self,
@@ -212,7 +214,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsStartRequest> f
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsStartRequest> for PaymentStart {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsStartRequest> for PaymentStart {
#[instrument(skip_all)]
async fn update_trackers<'b>(
&'b self,
@@ -233,7 +235,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsStartRequest> for P
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsStartRequest, PaymentData<F>>
+impl<F: Send + Clone + Sync> ValidateRequest<F, api::PaymentsStartRequest, PaymentData<F>>
for PaymentStart
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/payment_status.rs b/crates/router/src/core/payments/operations/payment_status.rs
index ab3a70aa1bb..e2c9a4d7a3b 100644
--- a/crates/router/src/core/payments/operations/payment_status.rs
+++ b/crates/router/src/core/payments/operations/payment_status.rs
@@ -31,7 +31,7 @@ pub struct PaymentStatus;
type PaymentStatusOperation<'b, F, R> = BoxedOperation<'b, F, R, PaymentData<F>>;
-impl<F: Send + Clone> Operation<F, api::PaymentsRequest> for PaymentStatus {
+impl<F: Send + Clone + Sync> Operation<F, api::PaymentsRequest> for PaymentStatus {
type Data = PaymentData<F>;
fn to_domain(&self) -> RouterResult<&dyn Domain<F, api::PaymentsRequest, PaymentData<F>>> {
Ok(self)
@@ -43,7 +43,7 @@ impl<F: Send + Clone> Operation<F, api::PaymentsRequest> for PaymentStatus {
Ok(self)
}
}
-impl<F: Send + Clone> Operation<F, api::PaymentsRequest> for &PaymentStatus {
+impl<F: Send + Clone + Sync> Operation<F, api::PaymentsRequest> for &PaymentStatus {
type Data = PaymentData<F>;
fn to_domain(&self) -> RouterResult<&dyn Domain<F, api::PaymentsRequest, PaymentData<F>>> {
Ok(*self)
@@ -57,7 +57,7 @@ impl<F: Send + Clone> Operation<F, api::PaymentsRequest> for &PaymentStatus {
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for PaymentStatus {
+impl<F: Clone + Send + Sync> Domain<F, api::PaymentsRequest, PaymentData<F>> for PaymentStatus {
#[instrument(skip_all)]
async fn get_or_create_customer_details<'a>(
&'a self,
@@ -137,7 +137,7 @@ impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for Paymen
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentStatus {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentStatus {
async fn update_trackers<'b>(
&'b self,
_state: &'b SessionState,
@@ -161,7 +161,9 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for Paymen
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRetrieveRequest> for PaymentStatus {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRetrieveRequest>
+ for PaymentStatus
+{
async fn update_trackers<'b>(
&'b self,
_state: &'b SessionState,
@@ -185,7 +187,7 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRetrieveRequest> fo
}
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRetrieveRequest>
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRetrieveRequest>
for PaymentStatus
{
#[instrument(skip_all)]
@@ -519,7 +521,7 @@ async fn get_tracker_for_sync<
Ok(get_trackers_response)
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsRetrieveRequest, PaymentData<F>>
+impl<F: Send + Clone + Sync> ValidateRequest<F, api::PaymentsRetrieveRequest, PaymentData<F>>
for PaymentStatus
{
fn validate_request<'b>(
diff --git a/crates/router/src/core/payments/operations/payment_update.rs b/crates/router/src/core/payments/operations/payment_update.rs
index 61a52e7dfb5..1fba79968b6 100644
--- a/crates/router/src/core/payments/operations/payment_update.rs
+++ b/crates/router/src/core/payments/operations/payment_update.rs
@@ -45,7 +45,7 @@ pub struct PaymentUpdate;
type PaymentUpdateOperation<'a, F> = BoxedOperation<'a, F, api::PaymentsRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentUpdate {
+impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentUpdate {
#[instrument(skip_all)]
async fn get_trackers<'a>(
&'a self,
@@ -505,7 +505,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for PaymentUpdate {
+impl<F: Clone + Send + Sync> Domain<F, api::PaymentsRequest, PaymentData<F>> for PaymentUpdate {
#[instrument(skip_all)]
async fn get_or_create_customer_details<'a>(
&'a self,
@@ -692,7 +692,7 @@ impl<F: Clone + Send> Domain<F, api::PaymentsRequest, PaymentData<F>> for Paymen
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentUpdate {
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for PaymentUpdate {
#[cfg(all(feature = "v2", feature = "customer_v2"))]
#[instrument(skip_all)]
async fn update_trackers<'b>(
@@ -955,7 +955,9 @@ impl ForeignTryFrom<domain::Customer> for CustomerData {
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsRequest, PaymentData<F>> for PaymentUpdate {
+impl<F: Send + Clone + Sync> ValidateRequest<F, api::PaymentsRequest, PaymentData<F>>
+ for PaymentUpdate
+{
#[instrument(skip_all)]
fn validate_request<'a, 'b>(
&'b self,
diff --git a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs
index 1b7acc796ec..a629938936b 100644
--- a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs
+++ b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs
@@ -34,7 +34,7 @@ type PaymentIncrementalAuthorizationOperation<'b, F> =
BoxedOperation<'b, F, PaymentsIncrementalAuthorizationRequest, payments::PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone>
+impl<F: Send + Clone + Sync>
GetTracker<F, payments::PaymentData<F>, PaymentsIncrementalAuthorizationRequest>
for PaymentIncrementalAuthorization
{
@@ -186,7 +186,8 @@ impl<F: Send + Clone>
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, payments::PaymentData<F>, PaymentsIncrementalAuthorizationRequest>
+impl<F: Clone + Sync>
+ UpdateTracker<F, payments::PaymentData<F>, PaymentsIncrementalAuthorizationRequest>
for PaymentIncrementalAuthorization
{
#[instrument(skip_all)]
@@ -278,7 +279,7 @@ impl<F: Clone> UpdateTracker<F, payments::PaymentData<F>, PaymentsIncrementalAut
}
}
-impl<F: Send + Clone>
+impl<F: Send + Clone + Sync>
ValidateRequest<F, PaymentsIncrementalAuthorizationRequest, payments::PaymentData<F>>
for PaymentIncrementalAuthorization
{
@@ -304,7 +305,8 @@ impl<F: Send + Clone>
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, PaymentsIncrementalAuthorizationRequest, payments::PaymentData<F>>
+impl<F: Clone + Send + Sync>
+ Domain<F, PaymentsIncrementalAuthorizationRequest, payments::PaymentData<F>>
for PaymentIncrementalAuthorization
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/operations/tax_calculation.rs b/crates/router/src/core/payments/operations/tax_calculation.rs
index 712dff35c7a..dbfed35a44f 100644
--- a/crates/router/src/core/payments/operations/tax_calculation.rs
+++ b/crates/router/src/core/payments/operations/tax_calculation.rs
@@ -36,7 +36,8 @@ type PaymentSessionUpdateOperation<'b, F> =
BoxedOperation<'b, F, api::PaymentsDynamicTaxCalculationRequest, PaymentData<F>>;
#[async_trait]
-impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsDynamicTaxCalculationRequest>
+impl<F: Send + Clone + Sync>
+ GetTracker<F, PaymentData<F>, api::PaymentsDynamicTaxCalculationRequest>
for PaymentSessionUpdate
{
#[instrument(skip_all)]
@@ -192,7 +193,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsDynamicTaxCalcu
}
#[async_trait]
-impl<F: Clone + Send> Domain<F, api::PaymentsDynamicTaxCalculationRequest, PaymentData<F>>
+impl<F: Clone + Send + Sync> Domain<F, api::PaymentsDynamicTaxCalculationRequest, PaymentData<F>>
for PaymentSessionUpdate
{
#[instrument(skip_all)]
@@ -364,7 +365,7 @@ impl<F: Clone + Send> Domain<F, api::PaymentsDynamicTaxCalculationRequest, Payme
}
#[async_trait]
-impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsDynamicTaxCalculationRequest>
+impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsDynamicTaxCalculationRequest>
for PaymentSessionUpdate
{
#[instrument(skip_all)]
@@ -442,7 +443,8 @@ impl<F: Clone> UpdateTracker<F, PaymentData<F>, api::PaymentsDynamicTaxCalculati
}
}
-impl<F: Send + Clone> ValidateRequest<F, api::PaymentsDynamicTaxCalculationRequest, PaymentData<F>>
+impl<F: Send + Clone + Sync>
+ ValidateRequest<F, api::PaymentsDynamicTaxCalculationRequest, PaymentData<F>>
for PaymentSessionUpdate
{
#[instrument(skip_all)]
diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs
index 0f248d6cc36..1a635b097ef 100644
--- a/crates/router/src/core/payments/transformers.rs
+++ b/crates/router/src/core/payments/transformers.rs
@@ -167,6 +167,7 @@ where
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
Ok(router_data)
@@ -370,6 +371,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>(
additional_merchant_data: None,
header_payload,
connector_mandate_request_reference_id,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
@@ -503,6 +505,7 @@ pub async fn construct_router_data_for_psync<'a>(
additional_merchant_data: None,
header_payload,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
@@ -650,6 +653,7 @@ pub async fn construct_payment_router_data_for_sdk_session<'a>(
header_payload,
connector_mandate_request_reference_id: None,
psd2_sca_exemption_type: None,
+ authentication_id: None,
};
Ok(router_data)
@@ -847,6 +851,7 @@ where
}),
header_payload,
connector_mandate_request_reference_id,
+ authentication_id: None,
psd2_sca_exemption_type: payment_data.payment_intent.psd2_sca_exemption_type,
};
diff --git a/crates/router/src/core/unified_authentication_service.rs b/crates/router/src/core/unified_authentication_service.rs
new file mode 100644
index 00000000000..bd08ea7fe6b
--- /dev/null
+++ b/crates/router/src/core/unified_authentication_service.rs
@@ -0,0 +1,187 @@
+pub mod transformers;
+pub mod types;
+pub mod utils;
+
+use diesel_models::authentication::{Authentication, AuthenticationNew};
+use error_stack::ResultExt;
+use hyperswitch_domain_models::{
+ errors::api_error_response::ApiErrorResponse,
+ router_request_types::unified_authentication_service::{
+ UasAuthenticationResponseData, UasPostAuthenticationRequestData,
+ UasPreAuthenticationRequestData,
+ },
+};
+
+use super::{errors::RouterResult, payments::helpers::MerchantConnectorAccountType};
+use crate::{
+ core::{
+ errors::utils::StorageErrorExt,
+ payments::PaymentData,
+ unified_authentication_service::types::{
+ ClickToPay, UnifiedAuthenticationService, UNIFIED_AUTHENTICATION_SERVICE,
+ },
+ },
+ db::domain,
+ routes::SessionState,
+ types::api,
+};
+
+#[cfg(feature = "v1")]
+#[async_trait::async_trait]
+impl<F: Clone + Sync> UnifiedAuthenticationService<F> for ClickToPay {
+ async fn pre_authentication(
+ state: &SessionState,
+ _key_store: &domain::MerchantKeyStore,
+ _business_profile: &domain::Profile,
+ payment_data: &PaymentData<F>,
+ merchant_connector_account: &MerchantConnectorAccountType,
+ connector_name: &str,
+ authentication_id: &str,
+ payment_method: common_enums::PaymentMethod,
+ ) -> RouterResult<()> {
+ let pre_authentication_data =
+ UasPreAuthenticationRequestData::try_from(payment_data.clone())?;
+
+ let pre_auth_router_data: api::unified_authentication_service::UasPreAuthenticationRouterData = utils::construct_uas_router_data(
+ connector_name.to_string(),
+ payment_method,
+ payment_data.payment_attempt.merchant_id.clone(),
+ None,
+ pre_authentication_data,
+ merchant_connector_account,
+ Some(authentication_id.to_owned()),
+ )?;
+
+ utils::do_auth_connector_call(
+ state,
+ UNIFIED_AUTHENTICATION_SERVICE.to_string(),
+ pre_auth_router_data,
+ )
+ .await?;
+
+ Ok(())
+ }
+
+ async fn post_authentication(
+ state: &SessionState,
+ _key_store: &domain::MerchantKeyStore,
+ _business_profile: &domain::Profile,
+ payment_data: &PaymentData<F>,
+ merchant_connector_account: &MerchantConnectorAccountType,
+ connector_name: &str,
+ payment_method: common_enums::PaymentMethod,
+ ) -> RouterResult<Option<hyperswitch_domain_models::payment_method_data::NetworkTokenData>>
+ {
+ let post_authentication_data = UasPostAuthenticationRequestData;
+ let authentication_id = payment_data
+ .payment_attempt
+ .authentication_id
+ .clone()
+ .ok_or(ApiErrorResponse::InternalServerError)
+ .attach_printable("Missing authentication id in payment attempt")?;
+
+ let post_auth_router_data: api::unified_authentication_service::UasPostAuthenticationRouterData = utils::construct_uas_router_data(
+ connector_name.to_string(),
+ payment_method,
+ payment_data.payment_attempt.merchant_id.clone(),
+ None,
+ post_authentication_data,
+ merchant_connector_account,
+ Some(authentication_id.clone()),
+ )?;
+
+ let response = utils::do_auth_connector_call(
+ state,
+ UNIFIED_AUTHENTICATION_SERVICE.to_string(),
+ post_auth_router_data,
+ )
+ .await?;
+
+ let network_token = match response.response.clone() {
+ Ok(UasAuthenticationResponseData::PostAuthentication {
+ authentication_details,
+ }) => Some(
+ hyperswitch_domain_models::payment_method_data::NetworkTokenData {
+ token_number: authentication_details.token_details.payment_token,
+ token_exp_month: authentication_details.token_details.token_expiration_month,
+ token_exp_year: authentication_details.token_details.token_expiration_year,
+ token_cryptogram: None,
+ card_issuer: None,
+ card_network: None,
+ card_type: None,
+ card_issuing_country: None,
+ bank_code: None,
+ nick_name: None,
+ },
+ ),
+ _ => None,
+ };
+
+ Ok(network_token)
+ }
+
+ fn confirmation(
+ _state: &SessionState,
+ _key_store: &domain::MerchantKeyStore,
+ _business_profile: &domain::Profile,
+ _merchant_connector_account: &MerchantConnectorAccountType,
+ ) -> RouterResult<()> {
+ Ok(())
+ }
+}
+
+pub async fn create_new_authentication(
+ state: &SessionState,
+ merchant_id: common_utils::id_type::MerchantId,
+ authentication_connector: String,
+ profile_id: common_utils::id_type::ProfileId,
+ payment_id: Option<common_utils::id_type::PaymentId>,
+ merchant_connector_id: common_utils::id_type::MerchantConnectorAccountId,
+ authentication_id: &str,
+) -> RouterResult<Authentication> {
+ let new_authorization = AuthenticationNew {
+ authentication_id: authentication_id.to_owned(),
+ merchant_id,
+ authentication_connector,
+ connector_authentication_id: None,
+ payment_method_id: "".to_string(),
+ authentication_type: None,
+ authentication_status: common_enums::AuthenticationStatus::Started,
+ authentication_lifecycle_status: common_enums::AuthenticationLifecycleStatus::Unused,
+ error_message: None,
+ error_code: None,
+ connector_metadata: None,
+ maximum_supported_version: None,
+ threeds_server_transaction_id: None,
+ cavv: None,
+ authentication_flow_type: None,
+ message_version: None,
+ eci: None,
+ trans_status: None,
+ acquirer_bin: None,
+ acquirer_merchant_id: None,
+ three_ds_method_data: None,
+ three_ds_method_url: None,
+ acs_url: None,
+ challenge_request: None,
+ acs_reference_number: None,
+ acs_trans_id: None,
+ acs_signed_content: None,
+ profile_id,
+ payment_id,
+ merchant_connector_id,
+ ds_trans_id: None,
+ directory_server_id: None,
+ acquirer_country_code: None,
+ };
+ state
+ .store
+ .insert_authentication(new_authorization)
+ .await
+ .to_duplicate_response(ApiErrorResponse::GenericDuplicateError {
+ message: format!(
+ "Authentication with authentication_id {} already exists",
+ authentication_id
+ ),
+ })
+}
diff --git a/crates/router/src/core/unified_authentication_service/transformers.rs b/crates/router/src/core/unified_authentication_service/transformers.rs
new file mode 100644
index 00000000000..cf3cb6f1f63
--- /dev/null
+++ b/crates/router/src/core/unified_authentication_service/transformers.rs
@@ -0,0 +1,36 @@
+use error_stack::Report;
+use hyperswitch_domain_models::{
+ errors::api_error_response::ApiErrorResponse,
+ router_request_types::unified_authentication_service::{
+ ServiceDetails, ServiceSessionIds, TransactionDetails, UasPreAuthenticationRequestData,
+ },
+};
+
+use crate::core::payments::PaymentData;
+
+#[cfg(feature = "v1")]
+impl<F: Clone + Sync> TryFrom<PaymentData<F>> for UasPreAuthenticationRequestData {
+ type Error = Report<ApiErrorResponse>;
+ fn try_from(payment_data: PaymentData<F>) -> Result<Self, Self::Error> {
+ let service_details = ServiceDetails {
+ service_session_ids: Some(ServiceSessionIds {
+ merchant_transaction_id: None,
+ correlation_id: None,
+ x_src_flow_id: None,
+ }),
+ };
+ let currency = payment_data.payment_attempt.currency.ok_or(
+ ApiErrorResponse::MissingRequiredField {
+ field_name: "currency",
+ },
+ )?;
+
+ let amount = payment_data.payment_attempt.net_amount.get_order_amount();
+ let transaction_details = TransactionDetails { amount, currency };
+
+ Ok(Self {
+ service_details: Some(service_details),
+ transaction_details: Some(transaction_details),
+ })
+ }
+}
diff --git a/crates/router/src/core/unified_authentication_service/types.rs b/crates/router/src/core/unified_authentication_service/types.rs
new file mode 100644
index 00000000000..6fc73ec6cd2
--- /dev/null
+++ b/crates/router/src/core/unified_authentication_service/types.rs
@@ -0,0 +1,52 @@
+use crate::{
+ core::{
+ errors::RouterResult,
+ payments::{helpers::MerchantConnectorAccountType, PaymentData},
+ },
+ db::domain,
+ routes::SessionState,
+};
+
+pub const CTP_MASTERCARD: &str = "ctp_mastercard";
+
+pub const UNIFIED_AUTHENTICATION_SERVICE: &str = "unified_authentication_service";
+
+pub const IRRELEVANT_ATTEMPT_ID_IN_AUTHENTICATION_FLOW: &str =
+ "irrelevant_attempt_id_in_AUTHENTICATION_flow";
+
+pub const IRRELEVANT_CONNECTOR_REQUEST_REFERENCE_ID_IN_AUTHENTICATION_FLOW: &str =
+ "irrelevant_connector_request_reference_id_in_AUTHENTICATION_flow";
+
+pub struct ClickToPay;
+
+#[async_trait::async_trait]
+pub trait UnifiedAuthenticationService<F: Clone + Sync> {
+ #[allow(clippy::too_many_arguments)]
+ async fn pre_authentication(
+ _state: &SessionState,
+ _key_store: &domain::MerchantKeyStore,
+ _business_profile: &domain::Profile,
+ _payment_data: &PaymentData<F>,
+ _merchant_connector_account: &MerchantConnectorAccountType,
+ _connector_name: &str,
+ _authentication_id: &str,
+ _payment_method: common_enums::PaymentMethod,
+ ) -> RouterResult<()>;
+
+ async fn post_authentication(
+ _state: &SessionState,
+ _key_store: &domain::MerchantKeyStore,
+ _business_profile: &domain::Profile,
+ _payment_data: &PaymentData<F>,
+ _merchant_connector_account: &MerchantConnectorAccountType,
+ _connector_name: &str,
+ _payment_method: common_enums::PaymentMethod,
+ ) -> RouterResult<Option<hyperswitch_domain_models::payment_method_data::NetworkTokenData>>;
+
+ fn confirmation(
+ _state: &SessionState,
+ _key_store: &domain::MerchantKeyStore,
+ _business_profile: &domain::Profile,
+ _merchant_connector_account: &MerchantConnectorAccountType,
+ ) -> RouterResult<()>;
+}
diff --git a/crates/router/src/core/unified_authentication_service/utils.rs b/crates/router/src/core/unified_authentication_service/utils.rs
new file mode 100644
index 00000000000..e0d10251049
--- /dev/null
+++ b/crates/router/src/core/unified_authentication_service/utils.rs
@@ -0,0 +1,172 @@
+use std::marker::PhantomData;
+
+use common_enums::enums::PaymentMethod;
+use common_utils::ext_traits::ValueExt;
+use diesel_models::authentication::{Authentication, AuthenticationUpdate};
+use error_stack::ResultExt;
+use hyperswitch_domain_models::{
+ errors::api_error_response::ApiErrorResponse,
+ payment_address::PaymentAddress,
+ router_data::{ConnectorAuthType, ErrorResponse, RouterData},
+ router_data_v2::UasFlowData,
+ router_request_types::unified_authentication_service::UasAuthenticationResponseData,
+};
+use masking::ExposeOptionInterface;
+
+use super::types::{
+ IRRELEVANT_ATTEMPT_ID_IN_AUTHENTICATION_FLOW,
+ IRRELEVANT_CONNECTOR_REQUEST_REFERENCE_ID_IN_AUTHENTICATION_FLOW,
+};
+use crate::{
+ core::{
+ errors::{utils::ConnectorErrorExt, RouterResult},
+ payments,
+ unified_authentication_service::MerchantConnectorAccountType,
+ },
+ services::{self, execute_connector_processing_step},
+ types::api,
+ SessionState,
+};
+
+pub async fn update_trackers<F: Clone, Req>(
+ state: &SessionState,
+ router_data: RouterData<F, Req, UasAuthenticationResponseData>,
+ authentication: Authentication,
+) -> RouterResult<Authentication> {
+ let authentication_update = match router_data.response {
+ Ok(response) => match response {
+ UasAuthenticationResponseData::PreAuthentication {} => {
+ AuthenticationUpdate::AuthenticationStatusUpdate {
+ trans_status: common_enums::TransactionStatus::InformationOnly,
+ authentication_status: common_enums::AuthenticationStatus::Pending,
+ }
+ }
+ UasAuthenticationResponseData::PostAuthentication {
+ authentication_details,
+ } => AuthenticationUpdate::PostAuthenticationUpdate {
+ authentication_status: common_enums::AuthenticationStatus::Success,
+ trans_status: common_enums::TransactionStatus::Success,
+ authentication_value: authentication_details
+ .dynamic_data_details
+ .and_then(|data| data.dynamic_data_value.expose_option()),
+ eci: authentication_details.eci,
+ },
+ },
+ Err(error) => AuthenticationUpdate::ErrorUpdate {
+ connector_authentication_id: error.connector_transaction_id,
+ authentication_status: common_enums::AuthenticationStatus::Failed,
+ error_message: error
+ .reason
+ .map(|reason| format!("message: {}, reason: {}", error.message, reason))
+ .or(Some(error.message)),
+ error_code: Some(error.code),
+ },
+ };
+
+ state
+ .store
+ .update_authentication_by_merchant_id_authentication_id(
+ authentication,
+ authentication_update,
+ )
+ .await
+ .change_context(ApiErrorResponse::InternalServerError)
+ .attach_printable("Error while updating authentication for uas")
+}
+
+pub async fn do_auth_connector_call<F, Req, Res>(
+ state: &SessionState,
+ authentication_connector_name: String,
+ router_data: RouterData<F, Req, Res>,
+) -> RouterResult<RouterData<F, Req, Res>>
+where
+ Req: std::fmt::Debug + Clone + 'static,
+ Res: std::fmt::Debug + Clone + 'static,
+ F: std::fmt::Debug + Clone + 'static,
+ dyn api::Connector + Sync: services::api::ConnectorIntegration<F, Req, Res>,
+ dyn api::ConnectorV2 + Sync: services::api::ConnectorIntegrationV2<F, UasFlowData, Req, Res>,
+{
+ let connector_data =
+ api::AuthenticationConnectorData::get_connector_by_name(&authentication_connector_name)?;
+ let connector_integration: services::BoxedUnifiedAuthenticationServiceInterface<F, Req, Res> =
+ connector_data.connector.get_connector_integration();
+ let router_data = execute_connector_processing_step(
+ state,
+ connector_integration,
+ &router_data,
+ payments::CallConnectorAction::Trigger,
+ None,
+ )
+ .await
+ .to_payment_failed_response()?;
+ Ok(router_data)
+}
+
+pub fn construct_uas_router_data<F: Clone, Req, Res>(
+ authentication_connector_name: String,
+ payment_method: PaymentMethod,
+ merchant_id: common_utils::id_type::MerchantId,
+ address: Option<PaymentAddress>,
+ request_data: Req,
+ merchant_connector_account: &MerchantConnectorAccountType,
+ authentication_id: Option<String>,
+) -> RouterResult<RouterData<F, Req, Res>> {
+ let test_mode: Option<bool> = merchant_connector_account.is_test_mode_on();
+ let auth_type: ConnectorAuthType = merchant_connector_account
+ .get_connector_account_details()
+ .parse_value("ConnectorAuthType")
+ .change_context(ApiErrorResponse::InternalServerError)?;
+ Ok(RouterData {
+ flow: PhantomData,
+ merchant_id,
+ customer_id: None,
+ connector_customer: None,
+ connector: authentication_connector_name,
+ payment_id: common_utils::id_type::PaymentId::get_irrelevant_id("authentication")
+ .get_string_repr()
+ .to_owned(),
+ attempt_id: IRRELEVANT_ATTEMPT_ID_IN_AUTHENTICATION_FLOW.to_owned(),
+ status: common_enums::AttemptStatus::default(),
+ payment_method,
+ connector_auth_type: auth_type,
+ description: None,
+ return_url: None,
+ address: address.unwrap_or_default(),
+ auth_type: common_enums::AuthenticationType::default(),
+ connector_meta_data: merchant_connector_account.get_metadata(),
+ connector_wallets_details: merchant_connector_account.get_connector_wallets_details(),
+ amount_captured: None,
+ minor_amount_captured: None,
+ access_token: None,
+ session_token: None,
+ reference_id: None,
+ payment_method_token: None,
+ recurring_mandate_payment_data: None,
+ preprocessing_id: None,
+ payment_method_balance: None,
+ connector_api_version: None,
+ request: request_data,
+ response: Err(ErrorResponse::default()),
+ connector_request_reference_id:
+ IRRELEVANT_CONNECTOR_REQUEST_REFERENCE_ID_IN_AUTHENTICATION_FLOW.to_owned(),
+ #[cfg(feature = "payouts")]
+ payout_method_data: None,
+ #[cfg(feature = "payouts")]
+ quote_id: None,
+ test_mode,
+ connector_http_status_code: None,
+ external_latency: None,
+ apple_pay_flow: None,
+ frm_metadata: None,
+ dispute_id: None,
+ refund_id: None,
+ payment_method_status: None,
+ connector_response: None,
+ integrity_check: Ok(()),
+ additional_merchant_data: None,
+ header_payload: None,
+ connector_mandate_request_reference_id: None,
+ authentication_id,
+ psd2_sca_exemption_type: None,
+ })
+}
diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs
index 56e5bc2b085..1f214f48ffd 100644
--- a/crates/router/src/core/utils.rs
+++ b/crates/router/src/core/utils.rs
@@ -215,6 +215,7 @@ pub async fn construct_payout_router_data<'a, F>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
@@ -396,6 +397,7 @@ pub async fn construct_refund_router_data<'a, F>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
@@ -704,6 +706,7 @@ pub async fn construct_accept_dispute_router_data<'a>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
Ok(router_data)
@@ -801,6 +804,7 @@ pub async fn construct_submit_evidence_router_data<'a>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
Ok(router_data)
@@ -904,6 +908,7 @@ pub async fn construct_upload_file_router_data<'a>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
Ok(router_data)
@@ -1027,6 +1032,7 @@ pub async fn construct_payments_dynamic_tax_calculation_router_data<'a, F: Clone
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
Ok(router_data)
@@ -1127,6 +1133,7 @@ pub async fn construct_defend_dispute_router_data<'a>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
Ok(router_data)
@@ -1221,6 +1228,7 @@ pub async fn construct_retrieve_file_router_data<'a>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
Ok(router_data)
diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs
index f1e84b2226a..f86ed910e46 100644
--- a/crates/router/src/core/webhooks/utils.rs
+++ b/crates/router/src/core/webhooks/utils.rs
@@ -123,6 +123,7 @@ pub async fn construct_webhook_router_data<'a>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
};
Ok(router_data)
diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs
index cfff235856b..f746aa28fd5 100644
--- a/crates/router/src/services/api.rs
+++ b/crates/router/src/services/api.rs
@@ -103,6 +103,9 @@ pub type BoxedAccessTokenConnectorIntegrationInterface<T, Req, Resp> =
pub type BoxedFilesConnectorIntegrationInterface<T, Req, Resp> =
BoxedConnectorIntegrationInterface<T, common_types::FilesFlowData, Req, Resp>;
+pub type BoxedUnifiedAuthenticationServiceInterface<T, Req, Resp> =
+ BoxedConnectorIntegrationInterface<T, common_types::UasFlowData, Req, Resp>;
+
/// Handle the flow by interacting with connector module
/// `connector_request` is applicable only in case if the `CallConnectorAction` is `Trigger`
/// In other cases, It will be created if required, even if it is not passed
diff --git a/crates/router/src/services/conversion_impls.rs b/crates/router/src/services/conversion_impls.rs
index 6ac934cd2fd..3902ef624da 100644
--- a/crates/router/src/services/conversion_impls.rs
+++ b/crates/router/src/services/conversion_impls.rs
@@ -1,3 +1,4 @@
+use error_stack::ResultExt;
#[cfg(feature = "frm")]
use hyperswitch_domain_models::router_data_v2::flow_common_types::FrmFlowData;
#[cfg(feature = "payouts")]
@@ -8,7 +9,8 @@ use hyperswitch_domain_models::{
router_data_v2::{
flow_common_types::{
AccessTokenFlowData, DisputesFlowData, ExternalAuthenticationFlowData, FilesFlowData,
- MandateRevokeFlowData, PaymentFlowData, RefundFlowData, WebhookSourceVerifyData,
+ MandateRevokeFlowData, PaymentFlowData, RefundFlowData, UasFlowData,
+ WebhookSourceVerifyData,
},
RouterDataV2,
},
@@ -77,6 +79,7 @@ fn get_default_router_data<F, Req, Resp>(
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
}
}
@@ -688,3 +691,47 @@ impl<T, Req: Clone, Resp: Clone> RouterDataConversion<T, Req, Resp>
Ok(router_data)
}
}
+
+impl<T, Req: Clone, Resp: Clone> RouterDataConversion<T, Req, Resp> for UasFlowData {
+ fn from_old_router_data(
+ old_router_data: &RouterData<T, Req, Resp>,
+ ) -> errors::CustomResult<RouterDataV2<T, Self, Req, Resp>, errors::ConnectorError>
+ where
+ Self: Sized,
+ {
+ let resource_common_data = Self {
+ authenticate_by: old_router_data.connector.clone(),
+ source_authentication_id: old_router_data
+ .authentication_id
+ .clone()
+ .ok_or(errors::ConnectorError::MissingRequiredField {
+ field_name: "source_authentication_id",
+ })
+ .attach_printable("missing authentication id for uas")?,
+ };
+ Ok(RouterDataV2 {
+ flow: std::marker::PhantomData,
+ resource_common_data,
+ connector_auth_type: old_router_data.connector_auth_type.clone(),
+ request: old_router_data.request.clone(),
+ response: old_router_data.response.clone(),
+ })
+ }
+
+ fn to_old_router_data(
+ new_router_data: RouterDataV2<T, Self, Req, Resp>,
+ ) -> errors::CustomResult<RouterData<T, Req, Resp>, errors::ConnectorError>
+ where
+ Self: Sized,
+ {
+ let Self {
+ authenticate_by,
+ source_authentication_id,
+ } = new_router_data.resource_common_data;
+ let mut router_data =
+ get_default_router_data("uas", new_router_data.request, new_router_data.response);
+ router_data.connector = authenticate_by;
+ router_data.authentication_id = Some(source_authentication_id);
+ Ok(router_data)
+ }
+}
diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs
index 9e7fc4e204f..e3d5b7246a8 100644
--- a/crates/router/src/types.rs
+++ b/crates/router/src/types.rs
@@ -48,10 +48,14 @@ pub use hyperswitch_domain_models::{
},
router_data_v2::{
AccessTokenFlowData, DisputesFlowData, ExternalAuthenticationFlowData, FilesFlowData,
- MandateRevokeFlowData, PaymentFlowData, RefundFlowData, RouterDataV2,
+ MandateRevokeFlowData, PaymentFlowData, RefundFlowData, RouterDataV2, UasFlowData,
WebhookSourceVerifyData,
},
router_request_types::{
+ unified_authentication_service::{
+ UasAuthenticationResponseData, UasPostAuthenticationRequestData,
+ UasPreAuthenticationRequestData,
+ },
AcceptDisputeRequestData, AccessTokenRequestData, AuthorizeSessionTokenData,
BrowserInformation, ChargeRefunds, ChargeRefundsOptions, CompleteAuthorizeData,
CompleteAuthorizeRedirectResponse, ConnectorCustomerData, DefendDisputeRequestData,
@@ -952,6 +956,7 @@ impl<F1, F2, T1, T2> ForeignFrom<(&RouterData<F1, T1, PaymentsResponseData>, T2)
connector_mandate_request_reference_id: data
.connector_mandate_request_reference_id
.clone(),
+ authentication_id: data.authentication_id.clone(),
psd2_sca_exemption_type: data.psd2_sca_exemption_type,
}
}
@@ -1015,10 +1020,11 @@ impl<F1, F2>
dispute_id: None,
connector_response: data.connector_response.clone(),
integrity_check: Ok(()),
- additional_merchant_data: data.additional_merchant_data.clone(),
header_payload: data.header_payload.clone(),
- connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
+ additional_merchant_data: data.additional_merchant_data.clone(),
+ connector_mandate_request_reference_id: None,
}
}
}
diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs
index 661c557e20c..f542eece81f 100644
--- a/crates/router/src/types/api.rs
+++ b/crates/router/src/types/api.rs
@@ -36,6 +36,9 @@ pub mod payments_v2;
pub mod payouts_v2;
pub mod refunds_v2;
+pub mod unified_authentication_service;
+pub mod unified_authentication_service_v2;
+
use std::{fmt::Debug, str::FromStr};
use api_models::routing::{self as api_routing, RoutableConnectorChoice};
@@ -58,7 +61,7 @@ pub use self::payouts::*;
pub use self::{
admin::*, api_keys::*, authentication::*, configs::*, customers::*, disputes::*, files::*,
payment_link::*, payment_methods::*, payments::*, poll::*, refunds::*, refunds_v2::*,
- webhooks::*,
+ unified_authentication_service::*, webhooks::*,
};
use super::transformers::ForeignTryFrom;
use crate::{
@@ -106,6 +109,7 @@ pub trait Connector:
+ ConnectorMandateRevoke
+ ExternalAuthentication
+ TaxCalculation
+ + UnifiedAuthenticationService
{
}
@@ -124,7 +128,8 @@ impl<
+ FraudCheck
+ ConnectorMandateRevoke
+ ExternalAuthentication
- + TaxCalculation,
+ + TaxCalculation
+ + UnifiedAuthenticationService,
> Connector for T
{
}
@@ -144,6 +149,7 @@ pub trait ConnectorV2:
+ FraudCheckV2
+ ConnectorMandateRevokeV2
+ ExternalAuthenticationV2
+ + UnifiedAuthenticationServiceV2
{
}
impl<
@@ -160,7 +166,8 @@ impl<
+ ConnectorVerifyWebhookSourceV2
+ FraudCheckV2
+ ConnectorMandateRevokeV2
- + ExternalAuthenticationV2,
+ + ExternalAuthenticationV2
+ + UnifiedAuthenticationServiceV2,
> ConnectorV2 for T
{
}
diff --git a/crates/router/src/types/api/unified_authentication_service.rs b/crates/router/src/types/api/unified_authentication_service.rs
new file mode 100644
index 00000000000..97f698856fc
--- /dev/null
+++ b/crates/router/src/types/api/unified_authentication_service.rs
@@ -0,0 +1,59 @@
+use hyperswitch_domain_models::{
+ router_data::RouterData,
+ router_request_types::unified_authentication_service::{
+ UasAuthenticationResponseData, UasPostAuthenticationRequestData,
+ UasPreAuthenticationRequestData,
+ },
+};
+
+pub use super::unified_authentication_service_v2::{
+ UasPostAuthenticationV2, UasPreAuthenticationV2, UnifiedAuthenticationServiceV2,
+};
+use crate::services;
+
+#[derive(Debug, Clone)]
+pub struct PreAuthenticate;
+
+pub trait UnifiedAuthenticationService:
+ super::ConnectorCommon + UasPreAuthentication + UasPostAuthentication
+{
+}
+
+#[derive(Debug, Clone)]
+pub struct PostAuthenticate;
+
+pub trait UasPreAuthentication:
+ services::ConnectorIntegration<
+ PreAuthenticate,
+ UasPreAuthenticationRequestData,
+ UasAuthenticationResponseData,
+>
+{
+}
+
+pub trait UasPostAuthentication:
+ services::ConnectorIntegration<
+ PostAuthenticate,
+ UasPostAuthenticationRequestData,
+ UasAuthenticationResponseData,
+>
+{
+}
+
+pub type UasPostAuthenticationRouterData =
+ RouterData<PostAuthenticate, UasPostAuthenticationRequestData, UasAuthenticationResponseData>;
+
+pub type UasPostAuthenticationType = dyn services::ConnectorIntegration<
+ PostAuthenticate,
+ UasPostAuthenticationRequestData,
+ UasAuthenticationResponseData,
+>;
+
+pub type UasPreAuthenticationRouterData =
+ RouterData<PreAuthenticate, UasPreAuthenticationRequestData, UasAuthenticationResponseData>;
+
+pub type UasPreAuthenticationType = dyn services::ConnectorIntegration<
+ PreAuthenticate,
+ UasPreAuthenticationRequestData,
+ UasAuthenticationResponseData,
+>;
diff --git a/crates/router/src/types/api/unified_authentication_service_v2.rs b/crates/router/src/types/api/unified_authentication_service_v2.rs
new file mode 100644
index 00000000000..3de12b0bb9e
--- /dev/null
+++ b/crates/router/src/types/api/unified_authentication_service_v2.rs
@@ -0,0 +1,35 @@
+use hyperswitch_domain_models::{
+ router_data_v2::UasFlowData,
+ router_request_types::unified_authentication_service::{
+ UasAuthenticationResponseData, UasPostAuthenticationRequestData,
+ UasPreAuthenticationRequestData,
+ },
+};
+
+use super::unified_authentication_service::{PostAuthenticate, PreAuthenticate};
+use crate::services;
+
+pub trait UnifiedAuthenticationServiceV2:
+ super::ConnectorCommon + UasPreAuthenticationV2 + UasPostAuthenticationV2
+{
+}
+
+pub trait UasPreAuthenticationV2:
+ services::ConnectorIntegrationV2<
+ PreAuthenticate,
+ UasFlowData,
+ UasPreAuthenticationRequestData,
+ UasAuthenticationResponseData,
+>
+{
+}
+
+pub trait UasPostAuthenticationV2:
+ services::ConnectorIntegrationV2<
+ PostAuthenticate,
+ UasFlowData,
+ UasPostAuthenticationRequestData,
+ UasAuthenticationResponseData,
+>
+{
+}
diff --git a/crates/router/src/types/api/verify_connector.rs b/crates/router/src/types/api/verify_connector.rs
index c368a3fb37d..d046a57678b 100644
--- a/crates/router/src/types/api/verify_connector.rs
+++ b/crates/router/src/types/api/verify_connector.rs
@@ -118,6 +118,7 @@ impl VerifyConnectorData {
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
}
}
diff --git a/crates/router/tests/connectors/aci.rs b/crates/router/tests/connectors/aci.rs
index 2d0272cfa7e..e3fd2bc1ee9 100644
--- a/crates/router/tests/connectors/aci.rs
+++ b/crates/router/tests/connectors/aci.rs
@@ -130,6 +130,7 @@ fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData {
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
}
}
@@ -201,6 +202,7 @@ fn construct_refund_router_data<F>() -> types::RefundsRouterData<F> {
additional_merchant_data: None,
header_payload: None,
connector_mandate_request_reference_id: None,
+ authentication_id: None,
psd2_sca_exemption_type: None,
}
}
diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs
index 18c171d58c5..19fb4a43720 100644
--- a/crates/router/tests/connectors/utils.rs
+++ b/crates/router/tests/connectors/utils.rs
@@ -549,6 +549,7 @@ pub trait ConnectorActions: Connector {
header_payload: None,
connector_mandate_request_reference_id: None,
psd2_sca_exemption_type: None,
+ authentication_id: None,
}
}
diff --git a/crates/router_derive/src/macros/operation.rs b/crates/router_derive/src/macros/operation.rs
index a096c236b2f..995db7a6cec 100644
--- a/crates/router_derive/src/macros/operation.rs
+++ b/crates/router_derive/src/macros/operation.rs
@@ -44,7 +44,7 @@ impl Derives {
let req_type = Conversion::get_req_type(self);
quote! {
#[automatically_derived]
- impl<F:Send+Clone> Operation<F,#req_type> for #struct_name {
+ impl<F:Send+Clone+Sync> Operation<F,#req_type> for #struct_name {
type Data = PaymentData<F>;
#(#fns)*
}
@@ -59,7 +59,7 @@ impl Derives {
let req_type = Conversion::get_req_type(self);
quote! {
#[automatically_derived]
- impl<F:Send+Clone> Operation<F,#req_type> for &#struct_name {
+ impl<F:Send+Clone+Sync> Operation<F,#req_type> for &#struct_name {
type Data = PaymentData<F>;
#(#ref_fns)*
}
|
feat
|
Add uas framework support (#6743)
|
00386f32954a6f9a3f71388e9cad7fbdb8824206
|
2024-09-12 18:59:25
|
Gitanjli
|
feat(refunds): Refunds aggregate api (#5795)
| false
|
diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json
index 2af9ccb87db..b80319add88 100644
--- a/api-reference-v2/openapi_spec.json
+++ b/api-reference-v2/openapi_spec.json
@@ -16469,6 +16469,22 @@
}
}
},
+ "RefundAggregateResponse": {
+ "type": "object",
+ "required": [
+ "status_with_count"
+ ],
+ "properties": {
+ "status_with_count": {
+ "type": "object",
+ "description": "The list of refund status with their count",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
"RefundListRequest": {
"allOf": [
{
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
index 8bc958c619b..58d11fc49a9 100644
--- a/api-reference/openapi_spec.json
+++ b/api-reference/openapi_spec.json
@@ -20927,6 +20927,22 @@
}
}
},
+ "RefundAggregateResponse": {
+ "type": "object",
+ "required": [
+ "status_with_count"
+ ],
+ "properties": {
+ "status_with_count": {
+ "type": "object",
+ "description": "The list of refund status with their count",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ },
"RefundListRequest": {
"allOf": [
{
diff --git a/crates/api_models/src/events/refund.rs b/crates/api_models/src/events/refund.rs
index 0717b66c6bf..d180753735f 100644
--- a/crates/api_models/src/events/refund.rs
+++ b/crates/api_models/src/events/refund.rs
@@ -1,9 +1,9 @@
use common_utils::events::{ApiEventMetric, ApiEventsType};
use crate::refunds::{
- RefundListFilters, RefundListMetaData, RefundListRequest, RefundListResponse,
- RefundManualUpdateRequest, RefundRequest, RefundResponse, RefundUpdateRequest,
- RefundsRetrieveRequest,
+ RefundAggregateResponse, RefundListFilters, RefundListMetaData, RefundListRequest,
+ RefundListResponse, RefundManualUpdateRequest, RefundRequest, RefundResponse,
+ RefundUpdateRequest, RefundsRetrieveRequest,
};
impl ApiEventMetric for RefundRequest {
@@ -66,6 +66,12 @@ impl ApiEventMetric for RefundListResponse {
}
}
+impl ApiEventMetric for RefundAggregateResponse {
+ fn get_api_event_type(&self) -> Option<ApiEventsType> {
+ Some(ApiEventsType::ResourceListAPI)
+ }
+}
+
impl ApiEventMetric for RefundListMetaData {
fn get_api_event_type(&self) -> Option<ApiEventsType> {
Some(ApiEventsType::ResourceListAPI)
diff --git a/crates/api_models/src/refunds.rs b/crates/api_models/src/refunds.rs
index 649c0dbf5cf..edc0e75bdf2 100644
--- a/crates/api_models/src/refunds.rs
+++ b/crates/api_models/src/refunds.rs
@@ -234,6 +234,12 @@ pub struct RefundListFilters {
pub refund_status: Vec<enums::RefundStatus>,
}
+#[derive(Clone, Debug, serde::Serialize, ToSchema)]
+pub struct RefundAggregateResponse {
+ /// The list of refund status with their count
+ pub status_with_count: HashMap<enums::RefundStatus, i64>,
+}
+
/// The status for refunds
#[derive(
Debug,
diff --git a/crates/openapi/src/openapi.rs b/crates/openapi/src/openapi.rs
index 4724f448e4f..93975cc57c5 100644
--- a/crates/openapi/src/openapi.rs
+++ b/crates/openapi/src/openapi.rs
@@ -463,6 +463,7 @@ Never share your secret api keys. Keep them guarded and secure.
api_models::payment_methods::PaymentMethodCollectLinkResponse,
api_models::refunds::RefundListRequest,
api_models::refunds::RefundListResponse,
+ api_models::refunds::RefundAggregateResponse,
api_models::payments::TimeRange,
api_models::payments::AmountFilter,
api_models::mandates::MandateRevokedResponse,
diff --git a/crates/openapi/src/openapi_v2.rs b/crates/openapi/src/openapi_v2.rs
index 0debe22db02..dd258843319 100644
--- a/crates/openapi/src/openapi_v2.rs
+++ b/crates/openapi/src/openapi_v2.rs
@@ -381,6 +381,7 @@ Never share your secret api keys. Keep them guarded and secure.
api_models::payment_methods::PaymentMethodCollectLinkResponse,
api_models::refunds::RefundListRequest,
api_models::refunds::RefundListResponse,
+ api_models::refunds::RefundAggregateResponse,
api_models::payments::TimeRange,
api_models::payments::AmountFilter,
api_models::mandates::MandateRevokedResponse,
diff --git a/crates/router/src/core/refunds.rs b/crates/router/src/core/refunds.rs
index a5a13c8304b..c30ef755655 100644
--- a/crates/router/src/core/refunds.rs
+++ b/crates/router/src/core/refunds.rs
@@ -1034,6 +1034,32 @@ pub async fn get_filters_for_refunds(
))
}
+#[instrument(skip_all)]
+#[cfg(feature = "olap")]
+pub async fn get_aggregates_for_refunds(
+ state: SessionState,
+ merchant: domain::MerchantAccount,
+ time_range: api::TimeRange,
+) -> RouterResponse<api_models::refunds::RefundAggregateResponse> {
+ let db = state.store.as_ref();
+ let refund_status_with_count = db
+ .get_refund_status_with_count(merchant.get_id(), &time_range, merchant.storage_scheme)
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed to find status count")?;
+ let mut status_map: HashMap<enums::RefundStatus, i64> =
+ refund_status_with_count.into_iter().collect();
+ for status in enums::RefundStatus::iter() {
+ status_map.entry(status).or_default();
+ }
+
+ Ok(services::ApplicationResponse::Json(
+ api_models::refunds::RefundAggregateResponse {
+ status_with_count: status_map,
+ },
+ ))
+}
+
impl ForeignFrom<storage::Refund> for api::RefundResponse {
fn foreign_from(refund: storage::Refund) -> Self {
let refund = refund;
diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs
index 76111afc6bd..641b4c8b0e8 100644
--- a/crates/router/src/db/kafka_store.rs
+++ b/crates/router/src/db/kafka_store.rs
@@ -2394,6 +2394,18 @@ impl RefundInterface for KafkaStore {
.await
}
+ #[cfg(feature = "olap")]
+ async fn get_refund_status_with_count(
+ &self,
+ merchant_id: &id_type::MerchantId,
+ constraints: &api_models::payments::TimeRange,
+ storage_scheme: MerchantStorageScheme,
+ ) -> CustomResult<Vec<(common_enums::RefundStatus, i64)>, errors::StorageError> {
+ self.diesel_store
+ .get_refund_status_with_count(merchant_id, constraints, storage_scheme)
+ .await
+ }
+
#[cfg(feature = "olap")]
async fn get_total_count_of_refunds(
&self,
diff --git a/crates/router/src/db/refund.rs b/crates/router/src/db/refund.rs
index 6208a06d141..e8cebc43aee 100644
--- a/crates/router/src/db/refund.rs
+++ b/crates/router/src/db/refund.rs
@@ -1,5 +1,5 @@
#[cfg(feature = "olap")]
-use std::collections::HashSet;
+use std::collections::{HashMap, HashSet};
#[cfg(feature = "olap")]
use common_utils::types::MinorUnit;
@@ -84,6 +84,14 @@ pub trait RefundInterface {
storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<api_models::refunds::RefundListMetaData, errors::StorageError>;
+ #[cfg(feature = "olap")]
+ async fn get_refund_status_with_count(
+ &self,
+ merchant_id: &common_utils::id_type::MerchantId,
+ constraints: &api_models::payments::TimeRange,
+ storage_scheme: enums::MerchantStorageScheme,
+ ) -> CustomResult<Vec<(common_enums::RefundStatus, i64)>, errors::StorageError>;
+
#[cfg(feature = "olap")]
async fn get_total_count_of_refunds(
&self,
@@ -251,6 +259,21 @@ mod storage {
.await
.map_err(|error|report!(errors::StorageError::from(error)))
}
+
+ #[cfg(feature = "olap")]
+ #[instrument(skip_all)]
+ async fn get_refund_status_with_count(
+ &self,
+ merchant_id: &common_utils::id_type::MerchantId,
+ time_range: &api_models::payments::TimeRange,
+ _storage_scheme: enums::MerchantStorageScheme,
+ ) -> CustomResult<Vec<(common_enums::RefundStatus, i64)>, errors::StorageError> {
+ let conn = connection::pg_connection_read(self).await?;
+ <diesel_models::refund::Refund as storage_types::RefundDbExt>::get_refund_status_with_count(&conn, merchant_id, time_range)
+ .await
+ .map_err(|error|report!(errors::StorageError::from(error)))
+ }
+
#[cfg(feature = "olap")]
#[instrument(skip_all)]
async fn get_total_count_of_refunds(
@@ -785,6 +808,20 @@ mod storage {
.map_err(|error|report!(errors::StorageError::from(error)))
}
+ #[cfg(feature = "olap")]
+ #[instrument(skip_all)]
+ async fn get_refund_status_with_count(
+ &self,
+ merchant_id: &common_utils::id_type::MerchantId,
+ constraints: &api_models::payments::TimeRange,
+ _storage_scheme: enums::MerchantStorageScheme,
+ ) -> CustomResult<Vec<(common_enums::RefundStatus, i64)>, errors::StorageError> {
+ let conn = connection::pg_connection_read(self).await?;
+ <diesel_models::refund::Refund as storage_types::RefundDbExt>::get_refund_status_with_count(&conn, merchant_id, constraints)
+ .await
+ .map_err(|error| report!(errors::StorageError::from(error)))
+ }
+
#[cfg(feature = "olap")]
#[instrument(skip_all)]
async fn get_total_count_of_refunds(
@@ -1123,6 +1160,41 @@ impl RefundInterface for MockDb {
Ok(refund_meta_data)
}
+ #[cfg(feature = "olap")]
+ async fn get_refund_status_with_count(
+ &self,
+ _merchant_id: &common_utils::id_type::MerchantId,
+ time_range: &api_models::payments::TimeRange,
+ _storage_scheme: enums::MerchantStorageScheme,
+ ) -> CustomResult<Vec<(api_models::enums::RefundStatus, i64)>, errors::StorageError> {
+ let refunds = self.refunds.lock().await;
+
+ let start_time = time_range.start_time;
+ let end_time = time_range
+ .end_time
+ .unwrap_or_else(common_utils::date_time::now);
+
+ let filtered_refunds = refunds
+ .iter()
+ .filter(|refund| refund.created_at >= start_time && refund.created_at <= end_time)
+ .cloned()
+ .collect::<Vec<diesel_models::refund::Refund>>();
+
+ let mut refund_status_counts: HashMap<api_models::enums::RefundStatus, i64> =
+ HashMap::new();
+
+ for refund in filtered_refunds {
+ *refund_status_counts
+ .entry(refund.refund_status)
+ .or_insert(0) += 1;
+ }
+
+ let result: Vec<(api_models::enums::RefundStatus, i64)> =
+ refund_status_counts.into_iter().collect();
+
+ Ok(result)
+ }
+
#[cfg(feature = "olap")]
async fn get_total_count_of_refunds(
&self,
diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs
index 210ded9c25d..c36bf10b8c2 100644
--- a/crates/router/src/routes/app.rs
+++ b/crates/router/src/routes/app.rs
@@ -995,6 +995,7 @@ impl Refunds {
.service(web::resource("/profile/list").route(web::post().to(refunds_list_profile)))
.service(web::resource("/filter").route(web::post().to(refunds_filter_list)))
.service(web::resource("/v2/filter").route(web::get().to(get_refunds_filters)))
+ .service(web::resource("/aggregate").route(web::get().to(get_refunds_aggregates)))
.service(
web::resource("/v2/profile/filter")
.route(web::get().to(get_refunds_filters_profile)),
diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs
index 13148801aa9..0cdfd90e998 100644
--- a/crates/router/src/routes/lock_utils.rs
+++ b/crates/router/src/routes/lock_utils.rs
@@ -153,6 +153,7 @@ impl From<Flow> for ApiIdentifier {
| Flow::RefundsUpdate
| Flow::RefundsList
| Flow::RefundsFilters
+ | Flow::RefundsAggregate
| Flow::RefundsManualUpdate => Self::Refunds,
Flow::FrmFulfillment
diff --git a/crates/router/src/routes/refunds.rs b/crates/router/src/routes/refunds.rs
index 4b964dba626..2f5cb332837 100644
--- a/crates/router/src/routes/refunds.rs
+++ b/crates/router/src/routes/refunds.rs
@@ -421,6 +421,36 @@ pub async fn get_refunds_filters_profile(
.await
}
+#[instrument(skip_all, fields(flow = ?Flow::RefundsAggregate))]
+#[cfg(feature = "olap")]
+pub async fn get_refunds_aggregates(
+ state: web::Data<AppState>,
+ req: HttpRequest,
+ query_params: web::Query<api_models::payments::TimeRange>,
+) -> HttpResponse {
+ let flow = Flow::RefundsAggregate;
+ let query_params = query_params.into_inner();
+ Box::pin(api::server_wrap(
+ flow,
+ state,
+ &req,
+ query_params,
+ |state, auth: auth::AuthenticationData, req, _| {
+ get_aggregates_for_refunds(state, auth.merchant_account, req)
+ },
+ auth::auth_type(
+ &auth::HeaderAuth(auth::ApiKeyAuth),
+ &auth::JWTAuth {
+ permission: Permission::RefundRead,
+ minimum_entity_level: EntityType::Merchant,
+ },
+ req.headers(),
+ ),
+ api_locking::LockAction::NotApplicable,
+ ))
+ .await
+}
+
#[instrument(skip_all, fields(flow = ?Flow::RefundsManualUpdate))]
#[cfg(feature = "olap")]
pub async fn refunds_manual_update(
diff --git a/crates/router/src/types/storage/refund.rs b/crates/router/src/types/storage/refund.rs
index 257982a0fba..8e0040abfae 100644
--- a/crates/router/src/types/storage/refund.rs
+++ b/crates/router/src/types/storage/refund.rs
@@ -37,6 +37,12 @@ pub trait RefundDbExt: Sized {
merchant_id: &common_utils::id_type::MerchantId,
refund_list_details: &refunds::RefundListConstraints,
) -> CustomResult<i64, errors::DatabaseError>;
+
+ async fn get_refund_status_with_count(
+ conn: &PgPooledConn,
+ merchant_id: &common_utils::id_type::MerchantId,
+ time_range: &api_models::payments::TimeRange,
+ ) -> CustomResult<Vec<(RefundStatus, i64)>, errors::DatabaseError>;
}
#[async_trait::async_trait]
@@ -289,4 +295,33 @@ impl RefundDbExt for Refund {
.change_context(errors::DatabaseError::NotFound)
.attach_printable_lazy(|| "Error filtering count of refunds")
}
+
+ async fn get_refund_status_with_count(
+ conn: &PgPooledConn,
+ merchant_id: &common_utils::id_type::MerchantId,
+ time_range: &api_models::payments::TimeRange,
+ ) -> CustomResult<Vec<(RefundStatus, i64)>, errors::DatabaseError> {
+ let mut query = <Self as HasTable>::table()
+ .group_by(dsl::refund_status)
+ .select((dsl::refund_status, diesel::dsl::count_star()))
+ .filter(dsl::merchant_id.eq(merchant_id.to_owned()))
+ .into_boxed();
+
+ query = query.filter(dsl::created_at.ge(time_range.start_time));
+
+ query = match time_range.end_time {
+ Some(ending_at) => query.filter(dsl::created_at.le(ending_at)),
+ None => query,
+ };
+
+ logger::debug!(filter = %diesel::debug_query::<diesel::pg::Pg,_>(&query).to_string());
+
+ db_metrics::track_database_call::<<Self as HasTable>::Table, _, _>(
+ query.get_results_async::<(RefundStatus, i64)>(conn),
+ db_metrics::DatabaseOperation::Count,
+ )
+ .await
+ .change_context(errors::DatabaseError::NotFound)
+ .attach_printable_lazy(|| "Error filtering status count of refunds")
+ }
}
diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs
index 79ab704fbbe..6126ca9afbe 100644
--- a/crates/router_env/src/logger/types.rs
+++ b/crates/router_env/src/logger/types.rs
@@ -212,6 +212,8 @@ pub enum Flow {
RefundsList,
/// Refunds filters flow
RefundsFilters,
+ /// Refunds aggregates flow
+ RefundsAggregate,
// Retrieve forex flow.
RetrieveForexFlow,
/// Toggles recon service for a merchant.
|
feat
|
Refunds aggregate api (#5795)
|
5d515050cf77705e3bf8c4b83f81ee51a8bff052
|
2023-06-20 12:16:32
|
Abhishek Marrivagu
|
refactor(errors): remove RedisErrorExt (#1389)
| false
|
diff --git a/crates/router/src/core/errors/utils.rs b/crates/router/src/core/errors/utils.rs
index 7c2b48cfe83..235b83f0b2d 100644
--- a/crates/router/src/core/errors/utils.rs
+++ b/crates/router/src/core/errors/utils.rs
@@ -192,19 +192,3 @@ impl<T> ConnectorErrorExt<T> for error_stack::Result<T, errors::ConnectorError>
})
}
}
-
-pub trait RedisErrorExt {
- #[track_caller]
- fn to_redis_failed_response(self, key: &str) -> error_stack::Report<errors::StorageError>;
-}
-
-impl RedisErrorExt for error_stack::Report<errors::RedisError> {
- fn to_redis_failed_response(self, key: &str) -> error_stack::Report<errors::StorageError> {
- match self.current_context() {
- errors::RedisError::NotFound => self.change_context(
- errors::StorageError::ValueNotFound(format!("Data does not exist for key {key}",)),
- ),
- _ => self.change_context(errors::StorageError::KVError),
- }
- }
-}
|
refactor
|
remove RedisErrorExt (#1389)
|
641c4d6d024bf5514de0d42ea1e940d0ecf113e3
|
2023-03-03 14:14:02
|
Narayan Bhat
|
enhance(stripe): send statement descriptor to stripe (#707)
| false
|
diff --git a/crates/api_models/src/customers.rs b/crates/api_models/src/customers.rs
index 0fe9624ab33..3ccb8e09639 100644
--- a/crates/api_models/src/customers.rs
+++ b/crates/api_models/src/customers.rs
@@ -33,7 +33,7 @@ pub struct CustomerRequest {
#[schema(value_type = Option<Object>,example = json!({
"city": "Bangalore",
"country": "IN",
- "line1": "Juspay router",
+ "line1": "Hyperswitch router",
"line2": "Koramangala",
"line3": "Stallion",
"state": "Karnataka",
@@ -73,7 +73,7 @@ pub struct CustomerResponse {
#[schema(value_type = Option<Object>,example = json!({
"city": "Bangalore",
"country": "IN",
- "line1": "Juspay router",
+ "line1": "Hyperswitch router",
"line2": "Koramangala",
"line3": "Stallion",
"state": "Karnataka",
diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs
index ba192d83df8..54ff9740478 100644
--- a/crates/api_models/src/payments.rs
+++ b/crates/api_models/src/payments.rs
@@ -154,8 +154,8 @@ pub struct PaymentsRequest {
pub billing: Option<Address>,
/// For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- #[schema(max_length = 255, example = "Juspay Router")]
- pub statement_descriptor_name: Option<String>,
+ #[schema(max_length = 255, example = "Hyperswitch Router")]
+ pub statement_descriptor: Option<String>,
/// Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
#[schema(max_length = 255, example = "Payment for shoes purchase")]
@@ -861,8 +861,8 @@ pub struct PaymentsResponse {
#[schema(value_type = Option<AuthenticationType>, example = "no_three_ds", default = "three_ds")]
pub authentication_type: Option<api_enums::AuthenticationType>,
/// For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- #[schema(max_length = 255, example = "Juspay Router")]
- pub statement_descriptor_name: Option<String>,
+ #[schema(max_length = 255, example = "Hyperswitch Router")]
+ pub statement_descriptor: Option<String>,
/// Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 255 characters for the concatenated descriptor.
#[schema(max_length = 255, example = "Payment for shoes purchase")]
pub statement_descriptor_suffix: Option<String>,
diff --git a/crates/router/src/compatibility/stripe/payment_intents/types.rs b/crates/router/src/compatibility/stripe/payment_intents/types.rs
index 077917813a4..5c11ceb7a7d 100644
--- a/crates/router/src/compatibility/stripe/payment_intents/types.rs
+++ b/crates/router/src/compatibility/stripe/payment_intents/types.rs
@@ -181,7 +181,7 @@ impl TryFrom<StripePaymentIntentRequest> for payments::PaymentsRequest {
.billing_details
.as_ref()
.map(|b| payments::Address::from(b.to_owned())),
- statement_descriptor_name: item.statement_descriptor,
+ statement_descriptor: item.statement_descriptor,
statement_descriptor_suffix: item.statement_descriptor_suffix,
metadata: item.metadata,
client_secret: item.client_secret.map(|s| s.peek().clone()),
@@ -336,7 +336,7 @@ impl From<payments::PaymentsResponse> for StripePaymentIntentResponse {
name: resp.name,
phone: resp.phone,
authentication_type: resp.authentication_type,
- statement_descriptor_name: resp.statement_descriptor_name,
+ statement_descriptor_name: resp.statement_descriptor,
statement_descriptor_suffix: resp.statement_descriptor_suffix,
next_action: into_stripe_next_action(resp.next_action, resp.return_url),
cancellation_reason: resp.cancellation_reason,
diff --git a/crates/router/src/compatibility/stripe/setup_intents/types.rs b/crates/router/src/compatibility/stripe/setup_intents/types.rs
index d9e58f3fe5b..86e1e73fdcb 100644
--- a/crates/router/src/compatibility/stripe/setup_intents/types.rs
+++ b/crates/router/src/compatibility/stripe/setup_intents/types.rs
@@ -159,7 +159,7 @@ impl From<StripeSetupIntentRequest> for payments::PaymentsRequest {
.billing_details
.as_ref()
.map(|b| payments::Address::from(b.to_owned())),
- statement_descriptor_name: item.statement_descriptor,
+ statement_descriptor: item.statement_descriptor,
statement_descriptor_suffix: item.statement_descriptor_suffix,
metadata: item.metadata,
client_secret: item.client_secret.map(|s| s.peek().clone()),
diff --git a/crates/router/src/connector/stripe/transformers.rs b/crates/router/src/connector/stripe/transformers.rs
index 09ac25fecdb..6875b5a4699 100644
--- a/crates/router/src/connector/stripe/transformers.rs
+++ b/crates/router/src/connector/stripe/transformers.rs
@@ -33,10 +33,6 @@ impl TryFrom<&types::ConnectorAuthType> for StripeAuthType {
}
}
-// Stripe Types Definition
-// PAYMENT
-// PaymentIntentRequest
-
#[derive(Debug, Default, Eq, PartialEq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum StripeCaptureMethod {
@@ -72,6 +68,7 @@ pub struct PaymentIntentRequest {
pub amount: i64, //amount in cents, hence passed as integer
pub currency: String,
pub statement_descriptor_suffix: Option<String>,
+ pub statement_descriptor: Option<String>,
#[serde(rename = "metadata[order_id]")]
pub metadata_order_id: String,
#[serde(rename = "metadata[txn_id]")]
@@ -626,6 +623,7 @@ impl TryFrom<&types::PaymentsAuthorizeRouterData> for PaymentIntentRequest {
amount: item.request.amount, //hopefully we don't loose some cents here
currency: item.request.currency.to_string(), //we need to copy the value and not transfer ownership
statement_descriptor_suffix: item.request.statement_descriptor_suffix.clone(),
+ statement_descriptor: item.request.statement_descriptor.clone(),
metadata_order_id,
metadata_txn_id,
metadata_txn_uuid,
@@ -672,8 +670,6 @@ impl TryFrom<&types::VerifyRouterData> for SetupIntentRequest {
}
}
-// PaymentIntentResponse
-
#[derive(Clone, Debug, Default, Eq, PartialEq, Deserialize, Serialize)]
pub struct StripeMetadata {
pub order_id: String,
diff --git a/crates/router/src/core/payment_methods/transformers.rs b/crates/router/src/core/payment_methods/transformers.rs
index fd0e7798707..486ea1f49db 100644
--- a/crates/router/src/core/payment_methods/transformers.rs
+++ b/crates/router/src/core/payment_methods/transformers.rs
@@ -83,7 +83,7 @@ pub fn mk_add_card_request(
card_exp_year: card.card_exp_year.clone(),
merchant_id: locker_id,
email_address: Some("[email protected]".to_string().into()), //
- name_on_card: Some("juspay".to_string().into()), // [#256]
+ name_on_card: Some("John Doe".to_string().into()), // [#256]
nickname: Some("router".to_string()), //
};
let body = utils::Encode::<AddCardRequest<'_>>::encode(&add_card_req)
diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs
index ee20cdc4df5..fac63910a37 100644
--- a/crates/router/src/core/payments/operations/payment_create.rs
+++ b/crates/router/src/core/payments/operations/payment_create.rs
@@ -500,7 +500,7 @@ impl PaymentCreate {
return_url: request.return_url.as_ref().map(|a| a.to_string()),
shipping_address_id,
billing_address_id,
- statement_descriptor_name: request.statement_descriptor_name.clone(),
+ statement_descriptor_name: request.statement_descriptor.clone(),
statement_descriptor_suffix: request.statement_descriptor_suffix.clone(),
metadata,
..storage::PaymentIntentNew::default()
diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs
index 2c53bec09ef..5f4c510ed0b 100644
--- a/crates/router/src/core/payments/transformers.rs
+++ b/crates/router/src/core/payments/transformers.rs
@@ -324,7 +324,7 @@ where
.authentication_type
.map(ForeignInto::foreign_into),
)
- .set_statement_descriptor_name(payment_intent.statement_descriptor_name)
+ .set_statement_descriptor(payment_intent.statement_descriptor_name)
.set_statement_descriptor_suffix(payment_intent.statement_descriptor_suffix)
.set_setup_future_usage(
payment_intent
@@ -432,6 +432,7 @@ impl<F: Clone> TryFrom<PaymentData<F>> for types::PaymentsAuthorizeData {
setup_mandate_details: payment_data.setup_mandate.clone(),
confirm: payment_data.payment_attempt.confirm,
statement_descriptor_suffix: payment_data.payment_intent.statement_descriptor_suffix,
+ statement_descriptor: payment_data.payment_intent.statement_descriptor_name,
capture_method: payment_data.payment_attempt.capture_method,
amount: payment_data.amount.into(),
currency: payment_data.currency,
diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs
index 13354aff5b5..f8033b00584 100644
--- a/crates/router/src/types.rs
+++ b/crates/router/src/types.rs
@@ -116,6 +116,7 @@ pub struct PaymentsAuthorizeData {
pub currency: storage_enums::Currency,
pub confirm: bool,
pub statement_descriptor_suffix: Option<String>,
+ pub statement_descriptor: Option<String>,
pub capture_method: Option<storage_enums::CaptureMethod>,
// Mandates
pub setup_future_usage: Option<storage_enums::FutureUsage>,
diff --git a/crates/router/tests/connectors/aci.rs b/crates/router/tests/connectors/aci.rs
index c99eaeed9dc..9fbf3a881f7 100644
--- a/crates/router/tests/connectors/aci.rs
+++ b/crates/router/tests/connectors/aci.rs
@@ -44,6 +44,7 @@ fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData {
}),
confirm: true,
statement_descriptor_suffix: None,
+ statement_descriptor: None,
setup_future_usage: None,
mandate_id: None,
off_session: None,
diff --git a/crates/router/tests/connectors/adyen.rs b/crates/router/tests/connectors/adyen.rs
index 6c34f2f444e..cff3c79606d 100644
--- a/crates/router/tests/connectors/adyen.rs
+++ b/crates/router/tests/connectors/adyen.rs
@@ -72,6 +72,7 @@ impl AdyenTest {
}),
confirm: true,
statement_descriptor_suffix: None,
+ statement_descriptor: None,
setup_future_usage: None,
mandate_id: None,
off_session: None,
diff --git a/crates/router/tests/connectors/authorizedotnet.rs b/crates/router/tests/connectors/authorizedotnet.rs
index 737bda93de1..b74d502f768 100644
--- a/crates/router/tests/connectors/authorizedotnet.rs
+++ b/crates/router/tests/connectors/authorizedotnet.rs
@@ -44,6 +44,7 @@ fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData {
}),
confirm: true,
statement_descriptor_suffix: None,
+ statement_descriptor: None,
setup_future_usage: None,
mandate_id: None,
off_session: None,
diff --git a/crates/router/tests/connectors/checkout.rs b/crates/router/tests/connectors/checkout.rs
index 151c1c98ad7..2c28753cce0 100644
--- a/crates/router/tests/connectors/checkout.rs
+++ b/crates/router/tests/connectors/checkout.rs
@@ -41,6 +41,7 @@ fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData {
}),
confirm: true,
statement_descriptor_suffix: None,
+ statement_descriptor: None,
setup_future_usage: None,
mandate_id: None,
off_session: None,
diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs
index bcbc239dac7..3e0f3f739cb 100644
--- a/crates/router/tests/connectors/utils.rs
+++ b/crates/router/tests/connectors/utils.rs
@@ -475,6 +475,7 @@ impl Default for PaymentAuthorizeType {
currency: enums::Currency::USD,
confirm: true,
statement_descriptor_suffix: None,
+ statement_descriptor: None,
capture_method: None,
setup_future_usage: None,
mandate_id: None,
diff --git a/crates/router/tests/connectors/worldline.rs b/crates/router/tests/connectors/worldline.rs
index 0932123addd..375b5601151 100644
--- a/crates/router/tests/connectors/worldline.rs
+++ b/crates/router/tests/connectors/worldline.rs
@@ -74,6 +74,7 @@ impl WorldlineTest {
}),
confirm: true,
statement_descriptor_suffix: None,
+ statement_descriptor: None,
setup_future_usage: None,
mandate_id: None,
off_session: None,
diff --git a/crates/router/tests/payments.rs b/crates/router/tests/payments.rs
index 7436180ad68..e94069ad815 100644
--- a/crates/router/tests/payments.rs
+++ b/crates/router/tests/payments.rs
@@ -317,8 +317,8 @@ async fn payments_create_core() {
address: None,
phone: None,
}),
- statement_descriptor_name: Some("Juspay".to_string()),
- statement_descriptor_suffix: Some("Router".to_string()),
+ statement_descriptor: Some("Hyperswtich".to_string()),
+ statement_descriptor_suffix: Some("Hyperswitch".to_string()),
..Default::default()
};
@@ -463,7 +463,7 @@ async fn payments_create_core_adyen_no_redirect() {
address: None,
phone: None,
}),
- statement_descriptor_name: Some("Juspay".to_string()),
+ statement_descriptor: Some("Juspay".to_string()),
statement_descriptor_suffix: Some("Router".to_string()),
..Default::default()
};
diff --git a/crates/router/tests/payments2.rs b/crates/router/tests/payments2.rs
index fecf9c9c903..c55a923223e 100644
--- a/crates/router/tests/payments2.rs
+++ b/crates/router/tests/payments2.rs
@@ -77,8 +77,8 @@ async fn payments_create_core() {
address: None,
phone: None,
}),
- statement_descriptor_name: Some("Juspay".to_string()),
- statement_descriptor_suffix: Some("Router".to_string()),
+ statement_descriptor: Some("Hyperswitch".to_string()),
+ statement_descriptor_suffix: Some("Hyperswitch".to_string()),
..<_>::default()
};
@@ -229,7 +229,7 @@ async fn payments_create_core_adyen_no_redirect() {
address: None,
phone: None,
}),
- statement_descriptor_name: Some("Juspay".to_string()),
+ statement_descriptor: Some("Juspay".to_string()),
statement_descriptor_suffix: Some("Router".to_string()),
..Default::default()
};
diff --git a/crates/router/tests/utils.rs b/crates/router/tests/utils.rs
index ef2497af2fb..c420662d35b 100644
--- a/crates/router/tests/utils.rs
+++ b/crates/router/tests/utils.rs
@@ -250,8 +250,8 @@ fn mk_payment(amount: i64, amount_to_capture: i32) -> Value {
"card_cvc": "123"
}
},
- "statement_descriptor_name": "Juspay",
- "statement_descriptor_suffix": "Router",
+ "statement_descriptor_name": "Hyperswitch",
+ "statement_descriptor_suffix": "Hyperswitch",
"metadata": {
"udf1": "value1",
"new_customer": "true",
diff --git a/openapi/generated.json b/openapi/generated.json
index 659dbe5f8fc..25990006954 100644
--- a/openapi/generated.json
+++ b/openapi/generated.json
@@ -4397,10 +4397,10 @@
"billing": {
"$ref": "#/components/schemas/Address"
},
- "statement_descriptor_name": {
+ "statement_descriptor": {
"type": "string",
"description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
- "example": "Juspay Router",
+ "example": "Hyperswitch Router",
"maxLength": 255
},
"statement_descriptor_suffix": {
@@ -4593,10 +4593,10 @@
"authentication_type": {
"$ref": "#/components/schemas/AuthenticationType"
},
- "statement_descriptor_name": {
+ "statement_descriptor": {
"type": "string",
"description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
- "example": "Juspay Router",
+ "example": "Hyperswitch Router",
"maxLength": 255
},
"statement_descriptor_suffix": {
diff --git a/postman/portman-config.json b/postman/portman-config.json
index cdfb2b65944..3d7da939c6b 100644
--- a/postman/portman-config.json
+++ b/postman/portman-config.json
@@ -432,7 +432,7 @@
},
{
"key": "address.line1",
- "value": "Juspay router"
+ "value": "Hyperswitch router"
},
{
"key": "address.line2",
@@ -523,7 +523,7 @@
},
{
"key": "address.line1",
- "value": "Juspay router"
+ "value": "Hyperswitch router"
},
{
"key": "address.line2",
@@ -928,7 +928,7 @@
},
{
"key": "address.line1",
- "value": "Juspay router"
+ "value": "Hyperswitch router"
},
{
"key": "address.line2",
|
enhance
|
send statement descriptor to stripe (#707)
|
41b7742b5498bfa9ef32b9408ab2d9a7a43b01dc
|
2023-10-19 17:25:37
|
SamraatBansal
|
refactor(connector): [noon] remove cancellation_reason (#2627)
| false
|
diff --git a/crates/router/src/connector/noon/transformers.rs b/crates/router/src/connector/noon/transformers.rs
index 9d727d3ce88..cde6de2e43b 100644
--- a/crates/router/src/connector/noon/transformers.rs
+++ b/crates/router/src/connector/noon/transformers.rs
@@ -506,7 +506,6 @@ pub struct NoonActionTransaction {
#[serde(rename_all = "camelCase")]
pub struct NoonActionOrder {
id: String,
- cancellation_reason: Option<String>,
}
#[derive(Debug, Serialize)]
@@ -522,7 +521,6 @@ impl TryFrom<&types::PaymentsCaptureRouterData> for NoonPaymentsActionRequest {
fn try_from(item: &types::PaymentsCaptureRouterData) -> Result<Self, Self::Error> {
let order = NoonActionOrder {
id: item.request.connector_transaction_id.clone(),
- cancellation_reason: None,
};
let transaction = NoonActionTransaction {
amount: conn_utils::to_currency_base_unit(
@@ -552,11 +550,6 @@ impl TryFrom<&types::PaymentsCancelRouterData> for NoonPaymentsCancelRequest {
fn try_from(item: &types::PaymentsCancelRouterData) -> Result<Self, Self::Error> {
let order = NoonActionOrder {
id: item.request.connector_transaction_id.clone(),
- cancellation_reason: item
- .request
- .cancellation_reason
- .clone()
- .map(|reason| reason.chars().take(100).collect()), // Max 100 chars
};
Ok(Self {
api_operation: NoonApiOperations::Reverse,
@@ -570,7 +563,6 @@ impl<F> TryFrom<&types::RefundsRouterData<F>> for NoonPaymentsActionRequest {
fn try_from(item: &types::RefundsRouterData<F>) -> Result<Self, Self::Error> {
let order = NoonActionOrder {
id: item.request.connector_transaction_id.clone(),
- cancellation_reason: None,
};
let transaction = NoonActionTransaction {
amount: conn_utils::to_currency_base_unit(
|
refactor
|
[noon] remove cancellation_reason (#2627)
|
1e32c6e873711e4f7715176c7d1057c18d4ec540
|
2024-03-14 13:00:29
|
Pa1NarK
|
ci(postman): adyen collection save card flow make `customer_id` properly dynamic (#4086)
| false
|
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario20-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/.event.meta.json b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario20-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/.event.meta.json
index 688c85746ef..eb871bbcb9b 100644
--- a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario20-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario20-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/.event.meta.json
@@ -1,5 +1,3 @@
{
- "eventOrder": [
- "event.test.js"
- ]
+ "eventOrder": ["event.prerequest.js", "event.test.js"]
}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario20-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/event.prerequest.js b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario20-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/event.prerequest.js
new file mode 100644
index 00000000000..30d9fbf35a0
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario20-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/event.prerequest.js
@@ -0,0 +1 @@
+pm.environment.set("random_number", _.random(100, 100000));
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy/Payments - Create/.event.meta.json b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy/Payments - Create/.event.meta.json
index 688c85746ef..eb871bbcb9b 100644
--- a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy/Payments - Create/.event.meta.json
@@ -1,5 +1,3 @@
{
- "eventOrder": [
- "event.test.js"
- ]
+ "eventOrder": ["event.prerequest.js", "event.test.js"]
}
diff --git a/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy/Payments - Create/event.prerequest.js b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy/Payments - Create/event.prerequest.js
new file mode 100644
index 00000000000..30d9fbf35a0
--- /dev/null
+++ b/postman/collection-dir/adyen_uk/Flow Testcases/Happy Cases/Scenario21-Don't Pass CVV for save card flow and verify failed payment Copy/Payments - Create/event.prerequest.js
@@ -0,0 +1 @@
+pm.environment.set("random_number", _.random(100, 100000));
diff --git a/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario10-Save card flow/Payments - Create/.event.meta.json b/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario10-Save card flow/Payments - Create/.event.meta.json
index 688c85746ef..2df9d47d936 100644
--- a/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario10-Save card flow/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario10-Save card flow/Payments - Create/.event.meta.json
@@ -1,5 +1,6 @@
{
"eventOrder": [
+ "event.prerequest.js",
"event.test.js"
]
}
diff --git a/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario11-Pass Invalid CVV for save card flow and verify failed payment Copy/Payments - Create/.event.meta.json b/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario11-Pass Invalid CVV for save card flow and verify failed payment Copy/Payments - Create/.event.meta.json
index 688c85746ef..eb871bbcb9b 100644
--- a/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario11-Pass Invalid CVV for save card flow and verify failed payment Copy/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario11-Pass Invalid CVV for save card flow and verify failed payment Copy/Payments - Create/.event.meta.json
@@ -1,5 +1,3 @@
{
- "eventOrder": [
- "event.test.js"
- ]
+ "eventOrder": ["event.prerequest.js", "event.test.js"]
}
diff --git a/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario12-Save card payment with manual capture Copy/Payments - Create/.event.meta.json b/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario12-Save card payment with manual capture Copy/Payments - Create/.event.meta.json
index 688c85746ef..eb871bbcb9b 100644
--- a/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario12-Save card payment with manual capture Copy/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario12-Save card payment with manual capture Copy/Payments - Create/.event.meta.json
@@ -1,5 +1,3 @@
{
- "eventOrder": [
- "event.test.js"
- ]
+ "eventOrder": ["event.prerequest.js", "event.test.js"]
}
diff --git a/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario13-Don't Pass CVV for save card flow and verify success payment Copy/Payments - Create/.event.meta.json b/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario13-Don't Pass CVV for save card flow and verify success payment Copy/Payments - Create/.event.meta.json
index 688c85746ef..eb871bbcb9b 100644
--- a/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario13-Don't Pass CVV for save card flow and verify success payment Copy/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/bluesnap/Flow Testcases/Happy Cases/Scenario13-Don't Pass CVV for save card flow and verify success payment Copy/Payments - Create/.event.meta.json
@@ -1,5 +1,3 @@
{
- "eventOrder": [
- "event.test.js"
- ]
+ "eventOrder": ["event.prerequest.js", "event.test.js"]
}
diff --git a/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario11-Save card flow/Payments - Create/.event.meta.json b/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario11-Save card flow/Payments - Create/.event.meta.json
index 688c85746ef..eb871bbcb9b 100644
--- a/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario11-Save card flow/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario11-Save card flow/Payments - Create/.event.meta.json
@@ -1,5 +1,3 @@
{
- "eventOrder": [
- "event.test.js"
- ]
+ "eventOrder": ["event.prerequest.js", "event.test.js"]
}
diff --git a/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario12-Don't Pass CVV for save card flow and verify success payment/Payments - Create/.event.meta.json b/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario12-Don't Pass CVV for save card flow and verify success payment/Payments - Create/.event.meta.json
index 688c85746ef..eb871bbcb9b 100644
--- a/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario12-Don't Pass CVV for save card flow and verify success payment/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario12-Don't Pass CVV for save card flow and verify success payment/Payments - Create/.event.meta.json
@@ -1,5 +1,3 @@
{
- "eventOrder": [
- "event.test.js"
- ]
+ "eventOrder": ["event.prerequest.js", "event.test.js"]
}
diff --git a/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario13-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/.event.meta.json b/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario13-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/.event.meta.json
index 688c85746ef..eb871bbcb9b 100644
--- a/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario13-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario13-Pass Invalid CVV for save card flow and verify failed payment/Payments - Create/.event.meta.json
@@ -1,5 +1,3 @@
{
- "eventOrder": [
- "event.test.js"
- ]
+ "eventOrder": ["event.prerequest.js", "event.test.js"]
}
diff --git a/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario14-Save card payment with manual capture/Payments - Create/.event.meta.json b/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario14-Save card payment with manual capture/Payments - Create/.event.meta.json
index 688c85746ef..eb871bbcb9b 100644
--- a/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario14-Save card payment with manual capture/Payments - Create/.event.meta.json
+++ b/postman/collection-dir/checkout/Flow Testcases/Happy Cases/Scenario14-Save card payment with manual capture/Payments - Create/.event.meta.json
@@ -1,5 +1,3 @@
{
- "eventOrder": [
- "event.test.js"
- ]
+ "eventOrder": ["event.prerequest.js", "event.test.js"]
}
diff --git a/postman/collection-json/adyen_uk.postman_collection.json b/postman/collection-json/adyen_uk.postman_collection.json
index a0b493ca750..a5447103184 100644
--- a/postman/collection-json/adyen_uk.postman_collection.json
+++ b/postman/collection-json/adyen_uk.postman_collection.json
@@ -9692,6 +9692,16 @@
{
"name": "Payments - Create",
"event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ "pm.environment.set(\"random_number\", _.random(100, 100000));",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
{
"listen": "test",
"script": {
@@ -10325,6 +10335,16 @@
{
"name": "Payments - Create",
"event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ "pm.environment.set(\"random_number\", _.random(100, 100000));",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
{
"listen": "test",
"script": {
|
ci
|
adyen collection save card flow make `customer_id` properly dynamic (#4086)
|
cbbebe2408093d84a51b3916ea5a43d79404b4e9
|
2023-09-07 17:08:10
|
Shankar Singh C
|
chore: address Rust 1.72 clippy lints (#2099)
| false
|
diff --git a/crates/router/src/connection.rs b/crates/router/src/connection.rs
index 00d6496f1bf..1a48b6e0e2c 100644
--- a/crates/router/src/connection.rs
+++ b/crates/router/src/connection.rs
@@ -9,7 +9,7 @@ pub type PgPool = bb8::Pool<async_bb8_diesel::ConnectionManager<PgConnection>>;
pub type PgPooledConn = async_bb8_diesel::Connection<PgConnection>;
-///
+/// Creates a Redis connection pool for the specified Redis settings
/// # Panics
///
/// Panics if failed to create a redis pool
diff --git a/crates/router/src/utils.rs b/crates/router/src/utils.rs
index 6676f34b759..a5aa35b35b4 100644
--- a/crates/router/src/utils.rs
+++ b/crates/router/src/utils.rs
@@ -25,7 +25,7 @@ use uuid::Uuid;
pub use self::{
ext_traits::{OptionExt, ValidateCall},
- storage::*,
+ storage::PaymentIntent,
};
use crate::{
consts,
diff --git a/crates/storage_impl/src/connection.rs b/crates/storage_impl/src/connection.rs
index 057e7762fd0..2ac90521ba4 100644
--- a/crates/storage_impl/src/connection.rs
+++ b/crates/storage_impl/src/connection.rs
@@ -7,6 +7,10 @@ pub type PgPool = bb8::Pool<async_bb8_diesel::ConnectionManager<PgConnection>>;
pub type PgPooledConn = async_bb8_diesel::Connection<PgConnection>;
+/// Creates a Redis connection pool for the specified Redis settings
+/// # Panics
+///
+/// Panics if failed to create a redis pool
#[allow(clippy::expect_used)]
pub async fn redis_connection(
redis: &redis_interface::RedisSettings,
|
chore
|
address Rust 1.72 clippy lints (#2099)
|
4137d7b48a95647646853f7b346a525642d5c04c
|
2024-09-16 12:19:49
|
Chethan Rao
|
refactor(payment_methods): unify locker api function call (#5863)
| false
|
diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs
index 75b8d922f82..5b80f64efa8 100644
--- a/crates/router/src/core/admin.rs
+++ b/crates/router/src/core/admin.rs
@@ -4490,7 +4490,7 @@ async fn locker_recipient_create_call(
ttl: state.conf.locker.ttl_for_storage_in_secs,
});
- let store_resp = cards::call_to_locker_hs(
+ let store_resp = cards::add_card_to_hs_locker(
state,
&payload,
&cust_id,
diff --git a/crates/router/src/core/errors.rs b/crates/router/src/core/errors.rs
index c22465c3a32..7fc3e9a9559 100644
--- a/crates/router/src/core/errors.rs
+++ b/crates/router/src/core/errors.rs
@@ -124,6 +124,8 @@ pub enum VaultError {
SaveCardFailed,
#[error("Failed to fetch card details from card vault")]
FetchCardFailed,
+ #[error("Failed to delete card in card vault")]
+ DeleteCardFailed,
#[error("Failed to encode card vault request")]
RequestEncodingFailed,
#[error("Failed to deserialize card vault response")]
@@ -146,6 +148,8 @@ pub enum VaultError {
SavePaymentMethodFailed,
#[error("Failed to generate fingerprint")]
GenerateFingerprintFailed,
+ #[error("Failed while calling locker API")]
+ ApiError,
}
#[derive(Debug, thiserror::Error)]
diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs
index ccd64f066df..376faeb6464 100644
--- a/crates/router/src/core/payment_methods/cards.rs
+++ b/crates/router/src/core/payment_methods/cards.rs
@@ -28,8 +28,10 @@ use common_utils::{
consts,
crypto::{self, Encryptable},
encryption::Encryption,
- ext_traits::{AsyncExt, Encode, StringExt, ValueExt},
- generate_id, id_type, type_name,
+ ext_traits::{AsyncExt, BytesExt, Encode, StringExt, ValueExt},
+ generate_id, id_type,
+ request::Request,
+ type_name,
types::{
keymanager::{Identifier, KeyManagerState},
MinorUnit,
@@ -93,7 +95,7 @@ use crate::{
storage::{self, enums, PaymentMethodListContext, PaymentTokenData},
transformers::ForeignTryFrom,
},
- utils::{ConnectorResponseExt, OptionExt},
+ utils::OptionExt,
};
#[cfg(all(
any(feature = "v1", feature = "v2"),
@@ -1876,7 +1878,7 @@ pub async fn add_bank_to_locker(
enc_data,
ttl: state.conf.locker.ttl_for_storage_in_secs,
});
- let store_resp = call_to_locker_hs(
+ let store_resp = add_card_to_hs_locker(
state,
&payload,
customer_id,
@@ -1920,7 +1922,7 @@ pub async fn add_card_to_locker(
card_reference,
)
.await
- .inspect_err(|error| {
+ .inspect_err(|_| {
metrics::CARD_LOCKER_FAILURES.add(
&metrics::CONTEXT,
1,
@@ -1929,7 +1931,6 @@ pub async fn add_card_to_locker(
router_env::opentelemetry::KeyValue::new("operation", "add"),
],
);
- logger::error!(?error, "Failed to add card in locker");
})
},
&metrics::CARD_ADD_TIME,
@@ -1962,7 +1963,7 @@ pub async fn get_card_from_locker(
.await
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Failed while getting card from hyperswitch card vault")
- .inspect_err(|error| {
+ .inspect_err(|_| {
metrics::CARD_LOCKER_FAILURES.add(
&metrics::CONTEXT,
1,
@@ -1971,7 +1972,6 @@ pub async fn get_card_from_locker(
router_env::opentelemetry::KeyValue::new("operation", "get"),
],
);
- logger::error!(?error, "Failed to retrieve card from locker");
})
},
&metrics::CARD_GET_TIME,
@@ -1996,9 +1996,15 @@ pub async fn delete_card_from_locker(
async move {
delete_card_from_hs_locker(state, customer_id, merchant_id, card_reference)
.await
- .inspect_err(|error| {
- metrics::CARD_LOCKER_FAILURES.add(&metrics::CONTEXT, 1, &[]);
- logger::error!(?error, "Failed to delete card from locker");
+ .inspect_err(|_| {
+ metrics::CARD_LOCKER_FAILURES.add(
+ &metrics::CONTEXT,
+ 1,
+ &[
+ router_env::opentelemetry::KeyValue::new("locker", "rust"),
+ router_env::opentelemetry::KeyValue::new("operation", "delete"),
+ ],
+ );
})
},
&metrics::CARD_DELETE_TIME,
@@ -2006,6 +2012,8 @@ pub async fn delete_card_from_locker(
&[],
)
.await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Failed while deleting card from locker")
}
#[cfg(all(feature = "v2", feature = "customer_v2"))]
@@ -2049,7 +2057,8 @@ pub async fn add_card_hs(
ttl: state.conf.locker.ttl_for_storage_in_secs,
});
- let store_card_payload = call_to_locker_hs(state, &payload, customer_id, locker_choice).await?;
+ let store_card_payload =
+ add_card_to_hs_locker(state, &payload, customer_id, locker_choice).await?;
let payment_method_resp = payment_methods::mk_add_card_response_hs(
card.clone(),
@@ -2111,30 +2120,22 @@ pub async fn get_payment_method_from_hs_locker<'a>(
merchant_id,
payment_method_reference,
locker_choice,
+ state.tenant.name.clone(),
+ state.request_id,
)
.await
.change_context(errors::VaultError::FetchPaymentMethodFailed)
.attach_printable("Making get payment method request failed")?;
- let response = services::call_connector_api(state, request, "add_card_to_locker")
- .await
- .change_context(errors::VaultError::FetchPaymentMethodFailed)
- .attach_printable("Failed while executing call_connector_api for get_card");
- let jwe_body: services::JweBody = response
- .get_response_inner("JweBody")
- .change_context(errors::VaultError::FetchPaymentMethodFailed)?;
- let decrypted_payload = payment_methods::get_decrypted_response_payload(
- jwekey,
- jwe_body,
+
+ let get_card_resp = call_locker_api::<payment_methods::RetrieveCardResp>(
+ state,
+ request,
+ "get_pm_from_locker",
locker_choice,
- locker.decryption_scheme.clone(),
)
.await
- .change_context(errors::VaultError::FetchPaymentMethodFailed)
- .attach_printable("Error getting decrypted response payload for get card")?;
- let get_card_resp: payment_methods::RetrieveCardResp = decrypted_payload
- .parse_struct("RetrieveCardResp")
- .change_context(errors::VaultError::FetchPaymentMethodFailed)
- .attach_printable("Failed to parse struct to RetrieveCardResp")?;
+ .change_context(errors::VaultError::FetchPaymentMethodFailed)?;
+
let retrieve_card_resp = get_card_resp
.payload
.get_required_value("RetrieveCardRespPayload")
@@ -2158,7 +2159,7 @@ pub async fn get_payment_method_from_hs_locker<'a>(
}
#[instrument(skip_all)]
-pub async fn call_to_locker_hs(
+pub async fn add_card_to_hs_locker(
state: &routes::SessionState,
payload: &payment_methods::StoreLockerReq,
customer_id: &id_type::CustomerId,
@@ -2168,30 +2169,23 @@ pub async fn call_to_locker_hs(
let jwekey = state.conf.jwekey.get_inner();
let db = &*state.store;
let stored_card_response = if !locker.mock_locker {
- let request =
- payment_methods::mk_add_locker_request_hs(jwekey, locker, payload, locker_choice)
- .await?;
- let response = services::call_connector_api(state, request, "add_card_to_hs_locker")
- .await
- .change_context(errors::VaultError::SaveCardFailed);
-
- let jwe_body: services::JweBody = response
- .get_response_inner("JweBody")
- .change_context(errors::VaultError::FetchCardFailed)?;
-
- let decrypted_payload = payment_methods::get_decrypted_response_payload(
+ let request = payment_methods::mk_add_locker_request_hs(
jwekey,
- jwe_body,
+ locker,
+ payload,
+ locker_choice,
+ state.tenant.name.clone(),
+ state.request_id,
+ )
+ .await?;
+ call_locker_api::<payment_methods::StoreCardResp>(
+ state,
+ request,
+ "add_card_to_hs_locker",
Some(locker_choice),
- locker.decryption_scheme.clone(),
)
.await
- .change_context(errors::VaultError::SaveCardFailed)
- .attach_printable("Error getting decrypted response payload")?;
- let stored_card_resp: payment_methods::StoreCardResp = decrypted_payload
- .parse_struct("StoreCardResp")
- .change_context(errors::VaultError::ResponseDeserializationFailed)?;
- stored_card_resp
+ .change_context(errors::VaultError::SaveCardFailed)?
} else {
let card_id = generate_id(consts::ID_LENGTH, "card");
mock_call_to_locker_hs(db, &card_id, payload, None, None, Some(customer_id)).await?
@@ -2204,6 +2198,61 @@ pub async fn call_to_locker_hs(
Ok(stored_card)
}
+#[instrument(skip_all)]
+pub async fn call_locker_api<T>(
+ state: &routes::SessionState,
+ request: Request,
+ flow_name: &str,
+ locker_choice: Option<api_enums::LockerChoice>,
+) -> errors::CustomResult<T, errors::VaultError>
+where
+ T: serde::de::DeserializeOwned,
+{
+ let locker = &state.conf.locker;
+ let jwekey = state.conf.jwekey.get_inner();
+ let response_type_name = type_name!(T);
+
+ let response = services::call_connector_api(state, request, flow_name)
+ .await
+ .change_context(errors::VaultError::ApiError)?;
+
+ let is_locker_call_succeeded = response.is_ok();
+
+ let jwe_body = response
+ .unwrap_or_else(|err| err)
+ .response
+ .parse_struct::<services::JweBody>("JweBody")
+ .change_context(errors::VaultError::ResponseDeserializationFailed)
+ .attach_printable("Failed while parsing locker response into JweBody")?;
+
+ let decrypted_payload = payment_methods::get_decrypted_response_payload(
+ jwekey,
+ jwe_body,
+ locker_choice,
+ locker.decryption_scheme.clone(),
+ )
+ .await
+ .change_context(errors::VaultError::ResponseDeserializationFailed)
+ .attach_printable("Failed while decrypting locker payload response")?;
+
+ // Irrespective of locker's response status, payload is JWE + JWS decrypted. But based on locker's status,
+ // if Ok, deserialize the decrypted payload into given type T
+ // if Err, raise an error including locker error message too
+ if is_locker_call_succeeded {
+ let stored_card_resp: Result<T, error_stack::Report<errors::VaultError>> =
+ decrypted_payload
+ .parse_struct(response_type_name)
+ .change_context(errors::VaultError::ResponseDeserializationFailed)
+ .attach_printable_lazy(|| {
+ format!("Failed while parsing locker response into {response_type_name}")
+ });
+ stored_card_resp
+ } else {
+ Err::<T, error_stack::Report<errors::VaultError>>((errors::VaultError::ApiError).into())
+ .attach_printable_lazy(|| format!("Locker error response: {decrypted_payload:?}"))
+ }
+}
+
#[cfg(all(
any(feature = "v1", feature = "v2"),
not(feature = "payment_methods_v2")
@@ -2322,29 +2371,21 @@ pub async fn get_card_from_hs_locker<'a>(
merchant_id,
card_reference,
Some(locker_choice),
+ state.tenant.name.clone(),
+ state.request_id,
)
.await
.change_context(errors::VaultError::FetchCardFailed)
.attach_printable("Making get card request failed")?;
- let response = services::call_connector_api(state, request, "get_card_from_locker")
- .await
- .change_context(errors::VaultError::FetchCardFailed)
- .attach_printable("Failed while executing call_connector_api for get_card");
- let jwe_body: services::JweBody = response
- .get_response_inner("JweBody")
- .change_context(errors::VaultError::FetchCardFailed)?;
- let decrypted_payload = payment_methods::get_decrypted_response_payload(
- jwekey,
- jwe_body,
+ let get_card_resp = call_locker_api::<payment_methods::RetrieveCardResp>(
+ state,
+ request,
+ "get_card_from_locker",
Some(locker_choice),
- locker.decryption_scheme.clone(),
)
.await
- .change_context(errors::VaultError::FetchCardFailed)
- .attach_printable("Error getting decrypted response payload for get card")?;
- let get_card_resp: payment_methods::RetrieveCardResp = decrypted_payload
- .parse_struct("RetrieveCardResp")
- .change_context(errors::VaultError::FetchCardFailed)?;
+ .change_context(errors::VaultError::FetchCardFailed)?;
+
let retrieve_card_resp = get_card_resp
.payload
.get_required_value("RetrieveCardRespPayload")
@@ -2366,7 +2407,7 @@ pub async fn delete_card_from_hs_locker<'a>(
customer_id: &id_type::CustomerId,
merchant_id: &id_type::MerchantId,
card_reference: &'a str,
-) -> errors::RouterResult<payment_methods::DeleteCardResp> {
+) -> errors::CustomResult<payment_methods::DeleteCardResp, errors::VaultError> {
let locker = &state.conf.locker;
let jwekey = &state.conf.jwekey.get_inner();
@@ -2376,35 +2417,26 @@ pub async fn delete_card_from_hs_locker<'a>(
customer_id,
merchant_id,
card_reference,
+ state.tenant.name.clone(),
+ state.request_id,
)
.await
- .change_context(errors::ApiErrorResponse::InternalServerError)
+ .change_context(errors::VaultError::DeleteCardFailed)
.attach_printable("Making delete card request failed")?;
if !locker.mock_locker {
- let response = services::call_connector_api(state, request, "delete_card_from_locker")
- .await
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Failed while executing call_connector_api for delete card");
- let jwe_body: services::JweBody = response.get_response_inner("JweBody")?;
- let decrypted_payload = payment_methods::get_decrypted_response_payload(
- jwekey,
- jwe_body,
+ call_locker_api::<payment_methods::DeleteCardResp>(
+ state,
+ request,
+ "delete_card_from_locker",
Some(api_enums::LockerChoice::HyperswitchCardVault),
- locker.decryption_scheme.clone(),
)
.await
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Error getting decrypted response payload for delete card")?;
- let delete_card_resp: payment_methods::DeleteCardResp = decrypted_payload
- .parse_struct("DeleteCardResp")
- .change_context(errors::ApiErrorResponse::InternalServerError)?;
- Ok(delete_card_resp)
+ .change_context(errors::VaultError::DeleteCardFailed)
} else {
Ok(mock_delete_card_hs(&*state.store, card_reference)
.await
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("card_delete_failure_message")?)
+ .change_context(errors::VaultError::DeleteCardFailed)?)
}
}
@@ -4871,6 +4903,10 @@ pub async fn list_customer_payment_method(
let mut filtered_saved_payment_methods_ctx = Vec::new();
for pm in saved_payment_methods.into_iter() {
+ logger::debug!(
+ "Fetching payment method from locker for payment_method_id: {}",
+ pm.id
+ );
let payment_method = pm.payment_method.get_required_value("payment_method")?;
let parent_payment_method_token =
is_payment_associated.then(|| generate_id(consts::ID_LENGTH, "token"));
diff --git a/crates/router/src/core/payment_methods/transformers.rs b/crates/router/src/core/payment_methods/transformers.rs
index f594feb5954..f01ecffbbb3 100644
--- a/crates/router/src/core/payment_methods/transformers.rs
+++ b/crates/router/src/core/payment_methods/transformers.rs
@@ -10,6 +10,7 @@ use common_utils::{
};
use error_stack::ResultExt;
use josekit::jwe;
+use router_env::tracing_actix_web::RequestId;
use serde::{Deserialize, Serialize};
use crate::{
@@ -301,6 +302,8 @@ pub async fn mk_add_locker_request_hs(
locker: &settings::Locker,
payload: &StoreLockerReq,
locker_choice: api_enums::LockerChoice,
+ tenant_id: String,
+ request_id: Option<RequestId>,
) -> CustomResult<services::Request, errors::VaultError> {
let payload = payload
.encode_to_vec()
@@ -319,6 +322,13 @@ pub async fn mk_add_locker_request_hs(
url.push_str("/cards/add");
let mut request = services::Request::new(services::Method::Post, &url);
request.add_header(headers::CONTENT_TYPE, "application/json".into());
+ request.add_header(headers::X_TENANT_ID, tenant_id.into());
+ if let Some(req_id) = request_id {
+ request.add_header(
+ headers::X_REQUEST_ID,
+ req_id.as_hyphenated().to_string().into(),
+ );
+ }
request.set_body(RequestContent::Json(Box::new(jwe_payload)));
Ok(request)
}
@@ -425,6 +435,7 @@ pub fn mk_add_card_response_hs(
todo!()
}
+#[allow(clippy::too_many_arguments)]
pub async fn mk_get_card_request_hs(
jwekey: &settings::Jwekey,
locker: &settings::Locker,
@@ -432,6 +443,8 @@ pub async fn mk_get_card_request_hs(
merchant_id: &id_type::MerchantId,
card_reference: &str,
locker_choice: Option<api_enums::LockerChoice>,
+ tenant_id: String,
+ request_id: Option<RequestId>,
) -> CustomResult<services::Request, errors::VaultError> {
let merchant_customer_id = customer_id.to_owned();
let card_req_body = CardReqBody {
@@ -458,6 +471,14 @@ pub async fn mk_get_card_request_hs(
url.push_str("/cards/retrieve");
let mut request = services::Request::new(services::Method::Post, &url);
request.add_header(headers::CONTENT_TYPE, "application/json".into());
+ request.add_header(headers::X_TENANT_ID, tenant_id.into());
+ if let Some(req_id) = request_id {
+ request.add_header(
+ headers::X_REQUEST_ID,
+ req_id.as_hyphenated().to_string().into(),
+ );
+ }
+
request.set_body(RequestContent::Json(Box::new(jwe_payload)));
Ok(request)
}
@@ -503,6 +524,8 @@ pub async fn mk_delete_card_request_hs(
customer_id: &id_type::CustomerId,
merchant_id: &id_type::MerchantId,
card_reference: &str,
+ tenant_id: String,
+ request_id: Option<RequestId>,
) -> CustomResult<services::Request, errors::VaultError> {
let merchant_customer_id = customer_id.to_owned();
let card_req_body = CardReqBody {
@@ -527,6 +550,14 @@ pub async fn mk_delete_card_request_hs(
url.push_str("/cards/delete");
let mut request = services::Request::new(services::Method::Post, &url);
request.add_header(headers::CONTENT_TYPE, "application/json".into());
+ request.add_header(headers::X_TENANT_ID, tenant_id.into());
+ if let Some(req_id) = request_id {
+ request.add_header(
+ headers::X_REQUEST_ID,
+ req_id.as_hyphenated().to_string().into(),
+ );
+ }
+
request.set_body(RequestContent::Json(Box::new(jwe_payload)));
Ok(request)
}
@@ -539,6 +570,8 @@ pub async fn mk_delete_card_request_hs_by_id(
id: &String,
merchant_id: &id_type::MerchantId,
card_reference: &str,
+ tenant_id: String,
+ request_id: Option<RequestId>,
) -> CustomResult<services::Request, errors::VaultError> {
let merchant_customer_id = id.to_owned();
let card_req_body = CardReqBodyV2 {
@@ -563,6 +596,14 @@ pub async fn mk_delete_card_request_hs_by_id(
url.push_str("/cards/delete");
let mut request = services::Request::new(services::Method::Post, &url);
request.add_header(headers::CONTENT_TYPE, "application/json".into());
+ request.add_header(headers::X_TENANT_ID, tenant_id.into());
+ if let Some(req_id) = request_id {
+ request.add_header(
+ headers::X_REQUEST_ID,
+ req_id.as_hyphenated().to_string().into(),
+ );
+ }
+
request.set_body(RequestContent::Json(Box::new(jwe_payload)));
Ok(request)
}
@@ -641,12 +682,22 @@ pub fn mk_crud_locker_request(
locker: &settings::Locker,
path: &str,
req: api::TokenizePayloadEncrypted,
+ tenant_id: String,
+ request_id: Option<RequestId>,
) -> CustomResult<services::Request, errors::VaultError> {
let mut url = locker.basilisk_host.to_owned();
url.push_str(path);
let mut request = services::Request::new(services::Method::Post, &url);
request.add_default_headers();
request.add_header(headers::CONTENT_TYPE, "application/json".into());
+ request.add_header(headers::X_TENANT_ID, tenant_id.into());
+ if let Some(req_id) = request_id {
+ request.add_header(
+ headers::X_REQUEST_ID,
+ req_id.as_hyphenated().to_string().into(),
+ );
+ }
+
request.set_body(RequestContent::Json(Box::new(req)));
Ok(request)
}
diff --git a/crates/router/src/core/payouts/helpers.rs b/crates/router/src/core/payouts/helpers.rs
index 11cb0c11761..035c5c139a8 100644
--- a/crates/router/src/core/payouts/helpers.rs
+++ b/crates/router/src/core/payouts/helpers.rs
@@ -307,7 +307,7 @@ pub async fn save_payout_data_to_locker(
};
// Store payout method in locker
- let stored_resp = cards::call_to_locker_hs(
+ let stored_resp = cards::add_card_to_hs_locker(
state,
&locker_req,
customer_id,
@@ -559,6 +559,7 @@ pub async fn save_payout_data_to_locker(
card_reference,
)
.await
+ .change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable(
"Failed to delete PMD from locker as a part of metadata update operation",
)?;
@@ -566,7 +567,7 @@ pub async fn save_payout_data_to_locker(
locker_req.update_requestor_card_reference(Some(card_reference.to_string()));
// Store in locker
- let stored_resp = cards::call_to_locker_hs(
+ let stored_resp = cards::add_card_to_hs_locker(
state,
&locker_req,
customer_id,
diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs
index ac452233e0f..caa96826937 100644
--- a/crates/router/src/lib.rs
+++ b/crates/router/src/lib.rs
@@ -83,6 +83,7 @@ pub mod headers {
pub const BROWSER_NAME: &str = "x-browser-name";
pub const X_CLIENT_PLATFORM: &str = "x-client-platform";
pub const X_MERCHANT_DOMAIN: &str = "x-merchant-domain";
+ pub const X_TENANT_ID: &str = "x-tenant-id";
}
pub mod pii {
|
refactor
|
unify locker api function call (#5863)
|
f8291973c38bde874c45ca15ff8d48c1f2de9781
|
2023-11-16 21:06:19
|
github-actions
|
test(postman): update postman collection files
| false
|
diff --git a/postman/collection-json/bankofamerica.postman_collection.json b/postman/collection-json/bankofamerica.postman_collection.json
index 2b1a8fdc470..01524d91953 100644
--- a/postman/collection-json/bankofamerica.postman_collection.json
+++ b/postman/collection-json/bankofamerica.postman_collection.json
@@ -1,4310 +1,4310 @@
{
- "info": {
- "_postman_id": "646f7167-da26-4a24-adb0-4157fd3a1781",
- "name": "bankofamerica",
- "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [[email protected]](mailto:[email protected])",
- "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
- "_exporter_id": "28305597"
- },
- "item": [
- {
- "name": "Health check",
- "item": [
- {
- "name": "New Request",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "x-feature",
- "value": "router-custom",
- "type": "text",
- "disabled": true
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/health",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "health"
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "MerchantAccounts",
- "item": [
- {
- "name": "Merchant Account - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) { }",
- "",
- "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
- "if (jsonData?.merchant_id) {",
- " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
- " console.log(",
- " \"- use {{merchant_id}} as collection variable for value\",",
- " jsonData.merchant_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
- "if (jsonData?.merchant_id) {",
- " pm.collectionVariables.set(\"organization_id\", jsonData.organization_id);",
- " console.log(",
- " \"- use {{organization_id}} as collection variable for value\",",
- " jsonData.organization_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{organization_id}}, as jsonData.organization_id is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have \"mandate_id\"",
- "pm.test(",
- " \"[POST]::/accounts - Organization id is generated\",",
- " function () {",
- " pm.expect(typeof jsonData.organization_id !== \"undefined\").to.be.true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"merchant_id\": \"postman_merchant_GHAction_{{$guid}}\",\n \"locker_id\": \"m0010\",\n \"merchant_name\": \"NewAge Retailer\",\n \"merchant_details\": {\n \"primary_contact_person\": \"John Test\",\n \"primary_email\": \"[email protected]\",\n \"primary_phone\": \"sunt laborum\",\n \"secondary_contact_person\": \"John Test2\",\n \"secondary_email\": \"[email protected]\",\n \"secondary_phone\": \"cillum do dolor id\",\n \"website\": \"www.example.com\",\n \"about_business\": \"Online Retail with a wide selection of organic products for North America\",\n \"address\": {\n \"line1\": \"1467\",\n \"line2\": \"Harrison Street\",\n \"line3\": \"Harrison Street\",\n \"city\": \"San Fransico\",\n \"state\": \"California\",\n \"zip\": \"94122\",\n \"country\": \"US\"\n }\n },\n \"return_url\": \"https://duck.com/success\",\n \"webhook_details\": {\n \"webhook_version\": \"1.0.1\",\n \"webhook_username\": \"ekart_retail\",\n \"webhook_password\": \"password_ekart@123\",\n \"payment_created_enabled\": true,\n \"payment_succeeded_enabled\": true,\n \"payment_failed_enabled\": true\n },\n \"sub_merchants_enabled\": false,\n \"metadata\": {\n \"city\": \"NY\",\n \"unit\": \"245\"\n },\n \"primary_business_details\": [\n {\n \"country\": \"US\",\n \"business\": \"default\"\n }\n ]\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/accounts",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts"
- ]
- },
- "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
- },
- "response": []
- },
- {
- "name": "Merchant Account - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/accounts/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/accounts/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/accounts/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Retrieve a merchant account details."
- },
- "response": []
- },
- {
- "name": "Merchant Account - List",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/accounts/list - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/accounts/list - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) { }",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/accounts/list?organization_id={{organization_id}}",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts",
- "list"
- ],
- "query": [
- {
- "key": "organization_id",
- "value": "{{organization_id}}"
- }
- ],
- "variable": [
- {
- "key": "organization_id",
- "value": "{{organization_id}}",
- "description": "(Required) - Organization id"
- }
- ]
- },
- "description": "List merchant accounts for an organization"
- },
- "response": []
- },
- {
- "name": "Merchant Account - Update",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/accounts/:id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"merchant_id\":\"{{merchant_id}}\",\"merchant_name\":\"NewAge Retailer\",\"locker_id\":\"m0010\",\"merchant_details\":{\"primary_contact_person\":\"joseph Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"veniam aute officia ullamco esse\",\"secondary_contact_person\":\"joseph Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"proident adipisicing officia nulla\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"parent_merchant_id\":\"xkkdf909012sdjki2dkh5sdf\",\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/accounts/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "To update an existing merchant account. Helpful in updating merchant details such as email, contact deteails, or other configuration details like webhook, routing algorithm etc"
- },
- "response": []
- }
- ]
- },
- {
- "name": "API Key",
- "item": [
- {
- "name": "Create API Key",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"name\": \"API Key 1\",\n \"description\": null,\n \"expiration\": \"2069-09-23T01:02:03.000Z\"\n}"
- },
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Update API Key",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id/:api_key_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id/:api_key_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"name\":null,\"description\":\"My very awesome API key\",\"expiration\":null}"
- },
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id/:api_key_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id",
- ":api_key_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "api_key_id",
- "value": "{{api_key_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Retrieve API Key",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[GET]::/api_keys/:merchant_id/:api_key_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/api_keys/:merchant_id/:api_key_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id/:api_key_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id",
- ":api_key_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "api_key_id",
- "value": "{{api_key_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "List API Keys",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/api_keys/:merchant_id/list - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/api_keys/:merchant_id/list - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id/list",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id",
- "list"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Delete API Key",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[DELETE]::/api_keys/:merchant_id/:api-key - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[DELETE]::/api_keys/:merchant_id/:api-key - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "DELETE",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id/:api-key",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id",
- ":api-key"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "api-key",
- "value": "{{api_key_id}}"
- }
- ]
- }
- },
- "response": []
- }
- ]
- },
- {
- "name": "PaymentConnectors",
- "item": [
- {
- "name": "Payment Connector - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/accounts/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/accounts/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) { }",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- "",
- "// Validate if the connector label is the one that is passed in the request",
- "pm.test(",
- " \"[POST]::/accounts/:account_id/connectors - connector_label is not autogenerated\",",
- " function () {",
- " pm.expect(jsonData.connector_label).to.eql(\"first_boa_connector\")",
- " },",
- ");"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"connector_type\": \"fiz_operations\",\n \"connector_name\": \"bankofamerica\",\n \"business_country\": \"US\",\n \"business_label\": \"default\",\n \"connector_label\": \"first_boa_connector\",\n \"connector_account_details\": {\n \"auth_type\": \"SignatureKey\",\n \"api_key\": \"{{connector_api_key}}\",\n \"api_secret\": \"{{connector_api_secret}}\",\n \"key1\": \"{{connector_key1}}\"\n },\n \"test_mode\": false,\n \"disabled\": false,\n \"payment_methods_enabled\": [\n {\n \"payment_method\": \"card\",\n \"payment_method_types\": [\n {\n \"payment_method_type\": \"credit\",\n \"card_networks\": [\n \"Visa\",\n \"Mastercard\"\n ],\n \"minimum_amount\": 1,\n \"maximum_amount\": 68607706,\n \"recurring_enabled\": true,\n \"installment_payment_enabled\": true\n },\n {\n \"payment_method_type\": \"debit\",\n \"card_networks\": [\n \"Visa\",\n \"Mastercard\"\n ],\n \"minimum_amount\": 1,\n \"maximum_amount\": 68607706,\n \"recurring_enabled\": true,\n \"installment_payment_enabled\": true\n }\n ]\n }\n ],\n \"metadata\": {\n \"city\": \"NY\",\n \"unit\": \"245\"\n }\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
- },
- "response": []
- },
- {
- "name": "Payment Connector - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[GET]::/accounts/:account_id/connectors/:connector_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/accounts/:account_id/connectors/:connector_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors",
- ":connector_id"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- },
- {
- "key": "connector_id",
- "value": "{{merchant_connector_id}}",
- "description": "(Required) The unique identifier for the payment connector"
- }
- ]
- },
- "description": "Retrieve Payment Connector details."
- },
- "response": []
- },
- {
- "name": "Payment Connector - Update",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) { }",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- "",
- "// Validate if the connector label is the one that is passed in the request",
- "pm.test(",
- " \"[POST]::/accounts/:account_id/connectors - connector_label is not autogenerated\",",
- " function () {",
- " pm.expect(jsonData.connector_label).to.eql(\"updated_stripe_connector\")",
- " },",
- ");"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"connector_type\": \"fiz_operations\",\n \"connector_account_details\": {\n \"auth_type\": \"SignatureKey\",\n \"api_key\": \"{{connector_api_key}}\",\n \"api_secret\": \"{{connector_api_secret}}\",\n \"key1\": \"{{connector_key1}}\"\n },\n \"connector_label\": \"updated_stripe_connector\",\n \"test_mode\": false,\n \"disabled\": false,\n \"payment_methods_enabled\": [\n {\n \"payment_method\": \"card\",\n \"payment_method_types\": [\n {\n \"payment_method_type\": \"credit\",\n \"card_networks\": [\n \"Visa\",\n \"Mastercard\"\n ],\n \"minimum_amount\": 1,\n \"maximum_amount\": 68607706,\n \"recurring_enabled\": true,\n \"installment_payment_enabled\": true\n },\n {\n \"payment_method_type\": \"debit\",\n \"card_networks\": [\n \"Visa\",\n \"Mastercard\"\n ],\n \"minimum_amount\": 1,\n \"maximum_amount\": 68607706,\n \"recurring_enabled\": true,\n \"installment_payment_enabled\": true\n }\n ]\n }\n ],\n \"metadata\": {\n \"city\": \"NY\",\n \"unit\": \"245\"\n }\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors",
- ":connector_id"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "connector_id",
- "value": "{{merchant_connector_id}}"
- }
- ]
- },
- "description": "To update an existing Payment Connector. Helpful in enabling / disabling different payment methods and other settings for the connector etc"
- },
- "response": []
- },
- {
- "name": "List Connectors by MID",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[GET]::/account/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[GET]::/account/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Payment Connector - Delete",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[DELETE]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[DELETE]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "DELETE",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors",
- ":connector_id"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}"
- },
- {
- "key": "connector_id",
- "value": "{{merchant_connector_id}}"
- }
- ]
- },
- "description": "Delete or Detach a Payment Connector from Merchant Account"
- },
- "response": []
- },
- {
- "name": "Merchant Account - Delete",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[DELETE]::/accounts/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[DELETE]::/accounts/:id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Response Validation",
- "const schema = {",
- " type: \"object\",",
- " description: \"Merchant Account\",",
- " required: [\"merchant_id\", \"deleted\"],",
- " properties: {",
- " merchant_id: {",
- " type: \"string\",",
- " description: \"The identifier for the MerchantAccount object.\",",
- " maxLength: 255,",
- " example: \"y3oqhf46pyzuxjbcn2giaqnb44\",",
- " },",
- " deleted: {",
- " type: \"boolean\",",
- " description:",
- " \"Indicates the deletion status of the Merchant Account object.\",",
- " example: true,",
- " },",
- " },",
- "};",
- "",
- "// Validate if response matches JSON schema",
- "pm.test(\"[DELETE]::/accounts/:id - Schema is valid\", function () {",
- " pm.response.to.have.jsonSchema(schema, {",
- " unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"],",
- " });",
- "});",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "DELETE",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/accounts/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Delete a Merchant Account"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Flow Testcases",
- "item": [
- {
- "name": "QuickStart",
- "item": [
- {
- "name": "Merchant Account - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
- "if (jsonData?.merchant_id) {",
- " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
- " console.log(",
- " \"- use {{merchant_id}} as collection variable for value\",",
- " jsonData.merchant_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
- "if (jsonData?.publishable_key) {",
- " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
- " console.log(",
- " \"- use {{publishable_key}} as collection variable for value\",",
- " jsonData.publishable_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"merchant_id\": \"postman_merchant_GHAction_{{$guid}}\",\n \"locker_id\": \"m0010\",\n \"merchant_name\": \"NewAge Retailer\",\n \"merchant_details\": {\n \"primary_contact_person\": \"John Test\",\n \"primary_email\": \"[email protected]\",\n \"primary_phone\": \"sunt laborum\",\n \"secondary_contact_person\": \"John Test2\",\n \"secondary_email\": \"[email protected]\",\n \"secondary_phone\": \"cillum do dolor id\",\n \"website\": \"www.example.com\",\n \"about_business\": \"Online Retail with a wide selection of organic products for North America\",\n \"address\": {\n \"line1\": \"1467\",\n \"line2\": \"Harrison Street\",\n \"line3\": \"Harrison Street\",\n \"city\": \"San Fransico\",\n \"state\": \"California\",\n \"zip\": \"94122\",\n \"country\": \"US\"\n }\n },\n \"return_url\": \"https://duck.com/success\",\n \"webhook_details\": {\n \"webhook_version\": \"1.0.1\",\n \"webhook_username\": \"ekart_retail\",\n \"webhook_password\": \"password_ekart@123\",\n \"payment_created_enabled\": true,\n \"payment_succeeded_enabled\": true,\n \"payment_failed_enabled\": true\n },\n \"sub_merchants_enabled\": false,\n \"metadata\": {\n \"city\": \"NY\",\n \"unit\": \"245\"\n },\n \"primary_business_details\": [\n {\n \"country\": \"US\",\n \"business\": \"default\"\n }\n ]\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/accounts",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "accounts"
- ]
- },
- "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
- },
- "response": []
- },
- {
- "name": "API Key - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
- "if (jsonData?.key_id) {",
- " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
- " console.log(",
- " \"- use {{api_key_id}} as collection variable for value\",",
- " jsonData.key_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
- "if (jsonData?.api_key) {",
- " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
- " console.log(",
- " \"- use {{api_key}} as collection variable for value\",",
- " jsonData.api_key,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
- },
- "url": {
- "raw": "{{baseUrl}}/api_keys/:merchant_id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "api_keys",
- ":merchant_id"
- ],
- "variable": [
- {
- "key": "merchant_id",
- "value": "{{merchant_id}}"
- }
- ]
- }
- },
- "response": []
- },
- {
- "name": "Payment Connector - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
- " function () {",
- " pm.response.to.be.success;",
- " },",
- ");",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
- "if (jsonData?.merchant_connector_id) {",
- " pm.collectionVariables.set(",
- " \"merchant_connector_id\",",
- " jsonData.merchant_connector_id,",
- " );",
- " console.log(",
- " \"- use {{merchant_connector_id}} as collection variable for value\",",
- " jsonData.merchant_connector_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{admin_api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"connector_type\": \"fiz_operations\",\n \"connector_name\": \"bankofamerica\",\n \"business_country\": \"US\",\n \"business_label\": \"default\",\n \"connector_label\": \"first_boa_connector\",\n \"connector_account_details\": {\n \"auth_type\": \"SignatureKey\",\n \"api_key\": \"{{connector_api_key}}\",\n \"api_secret\": \"{{connector_api_secret}}\",\n \"key1\": \"{{connector_key1}}\"\n },\n \"test_mode\": false,\n \"disabled\": false,\n \"payment_methods_enabled\": [\n {\n \"payment_method\": \"card\",\n \"payment_method_types\": [\n {\n \"payment_method_type\": \"credit\",\n \"card_networks\": [\n \"Visa\",\n \"Mastercard\"\n ],\n \"minimum_amount\": 1,\n \"maximum_amount\": 68607706,\n \"recurring_enabled\": true,\n \"installment_payment_enabled\": true\n },\n {\n \"payment_method_type\": \"debit\",\n \"card_networks\": [\n \"Visa\",\n \"Mastercard\"\n ],\n \"minimum_amount\": 1,\n \"maximum_amount\": 68607706,\n \"recurring_enabled\": true,\n \"installment_payment_enabled\": true\n }\n ]\n }\n ],\n \"metadata\": {\n \"city\": \"NY\",\n \"unit\": \"245\"\n }\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/account/:account_id/connectors",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "account",
- ":account_id",
- "connectors"
- ],
- "variable": [
- {
- "key": "account_id",
- "value": "{{merchant_id}}",
- "description": "(Required) The unique identifier for the merchant account"
- }
- ]
- },
- "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
- },
- "response": []
- },
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"amount\": 6540,\n \"currency\": \"USD\",\n \"confirm\": true,\n \"capture_method\": \"automatic\",\n \"capture_on\": \"2022-09-10T10:11:12Z\",\n \"amount_to_capture\": 6540,\n \"customer_id\": \"StripeCustomer\",\n \"email\": \"[email protected]\",\n \"name\": \"John Doe\",\n \"phone\": \"999999999\",\n \"phone_country_code\": \"+1\",\n \"description\": \"Its my first payment request\",\n \"authentication_type\": \"no_three_ds\",\n \"return_url\": \"https://duck.com\",\n \"payment_method\": \"card\",\n \"payment_method_type\": \"credit\",\n \"payment_method_data\": {\n \"card\": {\n \"card_number\": \"4111111111111111\",\n \"card_exp_month\": \"12\",\n \"card_exp_year\": \"30\",\n \"card_holder_name\": \"joseph Doe\",\n \"card_cvc\": \"123\"\n }\n },\n \"billing\": {\n \"address\": {\n \"line1\": \"1467\",\n \"line2\": \"Harrison Street\",\n \"line3\": \"Harrison Street\",\n \"city\": \"San Fransico\",\n \"state\": \"California\",\n \"zip\": \"94122\",\n \"country\": \"US\",\n \"first_name\": \"joseph\",\n \"last_name\": \"Doe\"\n },\n \"phone\": {\n \"number\": \"8056594427\",\n \"country_code\": \"+91\"\n }\n },\n \"shipping\": {\n \"address\": {\n \"line1\": \"1467\",\n \"line2\": \"Harrison Street\",\n \"line3\": \"Harrison Street\",\n \"city\": \"San Fransico\",\n \"state\": \"California\",\n \"zip\": \"94122\",\n \"country\": \"US\",\n \"first_name\": \"joseph\",\n \"last_name\": \"Doe\"\n },\n \"phone\": {\n \"number\": \"8056594427\",\n \"country_code\": \"+91\"\n }\n },\n \"statement_descriptor_name\": \"joseph\",\n \"statement_descriptor_suffix\": \"JS\",\n \"metadata\": {\n \"udf1\": \"value1\",\n \"new_customer\": \"true\",\n \"login_date\": \"2019-09-10T10:11:12Z\"\n },\n \"routing\": {\n \"type\": \"single\",\n \"data\": \"bankofamerica\"\n }\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Happy Cases",
- "item": [
- {
- "name": "Scenario1-Create payment with confirm true",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"processing\" for \"status\" because payment gets succeeded after one day.",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "// pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- "// pm.response.to.be.success;",
- "// });",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"processing\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "// pm.test(",
- "// \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- "// function () {",
- "// pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- "// .true;",
- "// },",
- "// );",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario2-Create payment with confirm false",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_confirmation\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 0'\",",
- " function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"processing\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have \"connector_transaction_id\"",
- "pm.test(",
- " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
- " function () {",
- " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
- " .true;",
- " },",
- ");",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "// pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- "// pm.response.to.be.success;",
- "// });",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"processing\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount_capturable\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 0'\",",
- " function () {",
- " pm.expect(jsonData.amount_capturable).to.eql(0);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario3-Create payment without PMD",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_payment_method\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"amount\": 6540,\n \"currency\": \"USD\",\n \"confirm\": false,\n \"capture_method\": \"automatic\",\n \"capture_on\": \"2022-09-10T10:11:12Z\",\n \"amount_to_capture\": 6540,\n \"customer_id\": \"StripeCustomer\",\n \"email\": \"[email protected]\",\n \"name\": \"John Doe\",\n \"phone\": \"999999999\",\n \"phone_country_code\": \"+65\",\n \"description\": \"Its my first payment request\",\n \"authentication_type\": \"no_three_ds\",\n \"return_url\": \"https://duck.com\",\n \"billing\": {\n \"address\": {\n \"line1\": \"1467\",\n \"line2\": \"Harrison Street\",\n \"line3\": \"Harrison Street\",\n \"city\": \"San Fransico\",\n \"state\": \"California\",\n \"zip\": \"94122\",\n \"country\": \"US\",\n \"first_name\": \"sundari\",\n \"last_name\": \"abcd\"\n }\n },\n \"shipping\": {\n \"address\": {\n \"line1\": \"1467\",\n \"line2\": \"Harrison Street\",\n \"line3\": \"Harrison Street\",\n \"city\": \"San Fransico\",\n \"state\": \"California\",\n \"zip\": \"94122\",\n \"country\": \"US\",\n \"first_name\": \"sundari\",\n \"last_name\": \"abcd\"\n }\n },\n \"statement_descriptor_name\": \"joseph\",\n \"statement_descriptor_suffix\": \"JS\",\n \"metadata\": {\n \"udf1\": \"value1\",\n \"new_customer\": \"true\",\n \"login_date\": \"2019-09-10T10:11:12Z\"\n },\n \"routing\": {\n \"type\": \"single\",\n \"data\": \"bankofamerica\"\n }\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Confirm",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "// Response body should have value \"processing\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{publishable_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/confirm",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "confirm"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "// pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- "// pm.response.to.be.success;",
- "// });",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"processing\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments:id - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario4-Create payment with Manual capture",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"3566111111111113\",\"card_exp_month\":\"12\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Capture",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"processing\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6540\" for \"amount\"",
- "if (jsonData?.amount) {",
- " pm.test(",
- " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
- " function () {",
- " pm.expect(jsonData.amount).to.eql(6540);",
- " },",
- " );",
- "}",
- "",
- "// Response body should have value \"6000\" for \"amount_received\"",
- "if (jsonData?.amount_received) {",
- " pm.test(",
- " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
- " function () {",
- " pm.expect(jsonData.amount_received).to.eql(6000);",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/capture",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "capture"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To capture the funds for an uncaptured payment"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "// pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- "// pm.response.to.be.success;",
- "// });",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"processing\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'processing'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"processing\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- },
- {
- "name": "Scenario5-Void the payment",
- "item": [
- {
- "name": "Payments - Create",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"requires_capture\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"3566111111111113\",\"card_exp_month\":\"12\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments"
- ]
- },
- "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
- },
- "response": []
- },
- {
- "name": "Payments - Cancel",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(",
- " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
- " function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- " },",
- ");",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"cancelled\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id/cancel - Content check if value for 'status' matches 'cancelled'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"cancelled\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [
- {
- "key": "Content-Type",
- "value": "application/json"
- },
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\"cancellation_reason\":\"requested_by_customer\"}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "{{baseUrl}}/payments/:id/cancel",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id",
- "cancel"
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
- },
- "response": []
- },
- {
- "name": "Payments - Retrieve",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "// Validate status 2xx",
- "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
- " pm.response.to.be.success;",
- "});",
- "",
- "// Validate if response header has matching content-type",
- "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
- " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
- " \"application/json\",",
- " );",
- "});",
- "",
- "// Validate if response has JSON Body",
- "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
- " pm.response.to.have.jsonBody();",
- "});",
- "",
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(",
- " \"- use {{payment_id}} as collection variable for value\",",
- " jsonData.payment_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
- "if (jsonData?.mandate_id) {",
- " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
- " console.log(",
- " \"- use {{mandate_id}} as collection variable for value\",",
- " jsonData.mandate_id,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
- " );",
- "}",
- "",
- "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
- "if (jsonData?.client_secret) {",
- " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
- " console.log(",
- " \"- use {{client_secret}} as collection variable for value\",",
- " jsonData.client_secret,",
- " );",
- "} else {",
- " console.log(",
- " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
- " );",
- "}",
- "",
- "// Response body should have value \"cancelled\" for \"status\"",
- "if (jsonData?.status) {",
- " pm.test(",
- " \"[POST]::/payments/:id - Content check if value for 'status' matches 'cancelled'\",",
- " function () {",
- " pm.expect(jsonData.status).to.eql(\"cancelled\");",
- " },",
- " );",
- "}",
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "GET",
- "header": [
- {
- "key": "Accept",
- "value": "application/json"
- }
- ],
- "url": {
- "raw": "{{baseUrl}}/payments/:id?force_sync=true",
- "host": [
- "{{baseUrl}}"
- ],
- "path": [
- "payments",
- ":id"
- ],
- "query": [
- {
- "key": "force_sync",
- "value": "true"
- }
- ],
- "variable": [
- {
- "key": "id",
- "value": "{{payment_id}}",
- "description": "(Required) unique payment id"
- }
- ]
- },
- "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
- },
- "response": []
- }
- ]
- }
- ]
- }
- ]
- }
- ],
- "auth": {
- "type": "apikey",
- "apikey": [
- {
- "key": "value",
- "value": "{{api_key}}",
- "type": "string"
- },
- {
- "key": "key",
- "value": "api-key",
- "type": "string"
- },
- {
- "key": "in",
- "value": "header",
- "type": "string"
- }
- ]
- },
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "type": "text/javascript",
- "exec": [
- ""
- ]
- }
- },
- {
- "listen": "test",
- "script": {
- "type": "text/javascript",
- "exec": [
- "// Set response object as internal variable",
- "let jsonData = {};",
- "try {",
- " jsonData = pm.response.json();",
- "} catch (e) {}",
- "",
- "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
- "if (jsonData?.payment_id) {",
- " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
- " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);",
- "}",
- "",
- "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));",
- ""
- ]
- }
- }
- ],
- "variable": [
- {
- "key": "baseUrl",
- "value": "",
- "type": "string"
- },
- {
- "key": "admin_api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "merchant_id",
- "value": ""
- },
- {
- "key": "payment_id",
- "value": ""
- },
- {
- "key": "customer_id",
- "value": ""
- },
- {
- "key": "mandate_id",
- "value": ""
- },
- {
- "key": "payment_method_id",
- "value": ""
- },
- {
- "key": "refund_id",
- "value": ""
- },
- {
- "key": "merchant_connector_id",
- "value": ""
- },
- {
- "key": "client_secret",
- "value": "",
- "type": "string"
- },
- {
- "key": "connector_api_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "publishable_key",
- "value": "",
- "type": "string"
- },
- {
- "key": "api_key_id",
- "value": "",
- "type": "string"
- },
- {
- "key": "payment_token",
- "value": ""
- },
- {
- "key": "gateway_merchant_id",
- "value": "",
- "type": "string"
- },
- {
- "key": "certificate",
- "value": "",
- "type": "string"
- },
- {
- "key": "certificate_keys",
- "value": "",
- "type": "string"
- },
- {
- "key": "organization_id",
- "value": ""
- },
- {
- "key": "connector_api_secret",
- "value": "",
- "type": "string"
- },
- {
- "key": "connector_key1",
- "value": "",
- "type": "string"
- }
- ]
-}
\ No newline at end of file
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(\"[LOG]::payment_id - \" + jsonData.payment_id);",
+ "}",
+ "",
+ "console.log(\"[LOG]::x-request-id - \" + pm.response.headers.get(\"x-request-id\"));",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "item": [
+ {
+ "name": "Health check",
+ "item": [
+ {
+ "name": "New Request",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "x-feature",
+ "value": "router-custom",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/health",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "health"
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "MerchantAccounts",
+ "item": [
+ {
+ "name": "Merchant Account - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
+ " console.log(",
+ " \"- use {{merchant_id}} as collection variable for value\",",
+ " jsonData.merchant_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"organization_id\", jsonData.organization_id);",
+ " console.log(",
+ " \"- use {{organization_id}} as collection variable for value\",",
+ " jsonData.organization_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{organization_id}}, as jsonData.organization_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"mandate_id\"",
+ "pm.test(",
+ " \"[POST]::/accounts - Organization id is generated\",",
+ " function () {",
+ " pm.expect(typeof jsonData.organization_id !== \"undefined\").to.be.true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com/success\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"},\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}]}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts"
+ ]
+ },
+ "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
+ },
+ "response": []
+ },
+ {
+ "name": "Merchant Account - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/accounts/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/accounts/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/accounts/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Retrieve a merchant account details."
+ },
+ "response": []
+ },
+ {
+ "name": "Merchant Account - List",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/accounts/list - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/accounts/list - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/accounts/list?organization_id={{organization_id}}",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts",
+ "list"
+ ],
+ "query": [
+ {
+ "key": "organization_id",
+ "value": "{{organization_id}}"
+ }
+ ],
+ "variable": [
+ {
+ "key": "organization_id",
+ "value": "{{organization_id}}",
+ "description": "(Required) - Organization id"
+ }
+ ]
+ },
+ "description": "List merchant accounts for an organization"
+ },
+ "response": []
+ },
+ {
+ "name": "Merchant Account - Update",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/accounts/:id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"{{merchant_id}}\",\"merchant_name\":\"NewAge Retailer\",\"locker_id\":\"m0010\",\"merchant_details\":{\"primary_contact_person\":\"joseph Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"veniam aute officia ullamco esse\",\"secondary_contact_person\":\"joseph Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"proident adipisicing officia nulla\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"parent_merchant_id\":\"xkkdf909012sdjki2dkh5sdf\",\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "To update an existing merchant account. Helpful in updating merchant details such as email, contact deteails, or other configuration details like webhook, routing algorithm etc"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "API Key",
+ "item": [
+ {
+ "name": "Create API Key",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Update API Key",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id/:api_key_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id/:api_key_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":null,\"description\":\"My very awesome API key\",\"expiration\":null}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id/:api_key_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id",
+ ":api_key_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "api_key_id",
+ "value": "{{api_key_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Retrieve API Key",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[GET]::/api_keys/:merchant_id/:api_key_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/api_keys/:merchant_id/:api_key_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id/:api_key_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id",
+ ":api_key_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "api_key_id",
+ "value": "{{api_key_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "List API Keys",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/api_keys/:merchant_id/list - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/api_keys/:merchant_id/list - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id/list",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id",
+ "list"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Delete API Key",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[DELETE]::/api_keys/:merchant_id/:api-key - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[DELETE]::/api_keys/:merchant_id/:api-key - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "DELETE",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id/:api-key",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id",
+ ":api-key"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "api-key",
+ "value": "{{api_key_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "PaymentConnectors",
+ "item": [
+ {
+ "name": "Payment Connector - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/accounts/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/accounts/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Validate if the connector label is the one that is passed in the request",
+ "pm.test(",
+ " \"[POST]::/accounts/:account_id/connectors - connector_label is not autogenerated\",",
+ " function () {",
+ " pm.expect(jsonData.connector_label).to.eql(\"first_boa_connector\")",
+ " },",
+ ");"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"bankofamerica\",\"business_country\":\"US\",\"business_label\":\"default\",\"connector_label\":\"first_boa_connector\",\"connector_account_details\":{\"auth_type\":\"SignatureKey\",\"api_key\":\"{{connector_api_key}}\",\"api_secret\":\"{{connector_api_secret}}\",\"key1\":\"{{connector_key1}}\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[GET]::/accounts/:account_id/connectors/:connector_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/accounts/:account_id/connectors/:connector_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors",
+ ":connector_id"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ },
+ {
+ "key": "connector_id",
+ "value": "{{merchant_connector_id}}",
+ "description": "(Required) The unique identifier for the payment connector"
+ }
+ ]
+ },
+ "description": "Retrieve Payment Connector details."
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Update",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) { }",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Validate if the connector label is the one that is passed in the request",
+ "pm.test(",
+ " \"[POST]::/accounts/:account_id/connectors - connector_label is not autogenerated\",",
+ " function () {",
+ " pm.expect(jsonData.connector_label).to.eql(\"updated_stripe_connector\")",
+ " },",
+ ");"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"fiz_operations\",\"connector_account_details\":{\"auth_type\":\"SignatureKey\",\"api_key\":\"{{connector_api_key}}\",\"api_secret\":\"{{connector_api_secret}}\",\"key1\":\"{{connector_key1}}\"},\"connector_label\":\"updated_stripe_connector\",\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors",
+ ":connector_id"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "connector_id",
+ "value": "{{merchant_connector_id}}"
+ }
+ ]
+ },
+ "description": "To update an existing Payment Connector. Helpful in enabling / disabling different payment methods and other settings for the connector etc"
+ },
+ "response": []
+ },
+ {
+ "name": "List Connectors by MID",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[GET]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[GET]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "GET",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Delete",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[DELETE]::/account/:account_id/connectors/:connector_id - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[DELETE]::/account/:account_id/connectors/:connector_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "DELETE",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors/:connector_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors",
+ ":connector_id"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}"
+ },
+ {
+ "key": "connector_id",
+ "value": "{{merchant_connector_id}}"
+ }
+ ]
+ },
+ "description": "Delete or Detach a Payment Connector from Merchant Account"
+ },
+ "response": []
+ },
+ {
+ "name": "Merchant Account - Delete",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[DELETE]::/accounts/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[DELETE]::/accounts/:id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Response Validation",
+ "const schema = {",
+ " type: \"object\",",
+ " description: \"Merchant Account\",",
+ " required: [\"merchant_id\", \"deleted\"],",
+ " properties: {",
+ " merchant_id: {",
+ " type: \"string\",",
+ " description: \"The identifier for the MerchantAccount object.\",",
+ " maxLength: 255,",
+ " example: \"y3oqhf46pyzuxjbcn2giaqnb44\",",
+ " },",
+ " deleted: {",
+ " type: \"boolean\",",
+ " description:",
+ " \"Indicates the deletion status of the Merchant Account object.\",",
+ " example: true,",
+ " },",
+ " },",
+ "};",
+ "",
+ "// Validate if response matches JSON schema",
+ "pm.test(\"[DELETE]::/accounts/:id - Schema is valid\", function () {",
+ " pm.response.to.have.jsonSchema(schema, {",
+ " unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"],",
+ " });",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "DELETE",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/accounts/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Delete a Merchant Account"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Flow Testcases",
+ "item": [
+ {
+ "name": "QuickStart",
+ "item": [
+ {
+ "name": "Merchant Account - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/accounts - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/accounts - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_id as variable for jsonData.merchant_id",
+ "if (jsonData?.merchant_id) {",
+ " pm.collectionVariables.set(\"merchant_id\", jsonData.merchant_id);",
+ " console.log(",
+ " \"- use {{merchant_id}} as collection variable for value\",",
+ " jsonData.merchant_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_id}}, as jsonData.merchant_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set publishable_key as variable for jsonData.publishable_key",
+ "if (jsonData?.publishable_key) {",
+ " pm.collectionVariables.set(\"publishable_key\", jsonData.publishable_key);",
+ " console.log(",
+ " \"- use {{publishable_key}} as collection variable for value\",",
+ " jsonData.publishable_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{publishable_key}}, as jsonData.publishable_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"merchant_id\":\"postman_merchant_GHAction_{{$guid}}\",\"locker_id\":\"m0010\",\"merchant_name\":\"NewAge Retailer\",\"merchant_details\":{\"primary_contact_person\":\"John Test\",\"primary_email\":\"[email protected]\",\"primary_phone\":\"sunt laborum\",\"secondary_contact_person\":\"John Test2\",\"secondary_email\":\"[email protected]\",\"secondary_phone\":\"cillum do dolor id\",\"website\":\"www.example.com\",\"about_business\":\"Online Retail with a wide selection of organic products for North America\",\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\"}},\"return_url\":\"https://duck.com/success\",\"webhook_details\":{\"webhook_version\":\"1.0.1\",\"webhook_username\":\"ekart_retail\",\"webhook_password\":\"password_ekart@123\",\"payment_created_enabled\":true,\"payment_succeeded_enabled\":true,\"payment_failed_enabled\":true},\"sub_merchants_enabled\":false,\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"},\"primary_business_details\":[{\"country\":\"US\",\"business\":\"default\"}]}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/accounts",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "accounts"
+ ]
+ },
+ "description": "Create a new account for a merchant. The merchant could be a seller or retailer or client who likes to receive and send payments."
+ },
+ "response": []
+ },
+ {
+ "name": "API Key - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/api_keys/:merchant_id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/api_keys/:merchant_id - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set api_key_id as variable for jsonData.key_id",
+ "if (jsonData?.key_id) {",
+ " pm.collectionVariables.set(\"api_key_id\", jsonData.key_id);",
+ " console.log(",
+ " \"- use {{api_key_id}} as collection variable for value\",",
+ " jsonData.key_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key_id}}, as jsonData.key_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set api_key as variable for jsonData.api_key",
+ "if (jsonData?.api_key) {",
+ " pm.collectionVariables.set(\"api_key\", jsonData.api_key);",
+ " console.log(",
+ " \"- use {{api_key}} as collection variable for value\",",
+ " jsonData.api_key,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{api_key}}, as jsonData.api_key is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\"name\":\"API Key 1\",\"description\":null,\"expiration\":\"2069-09-23T01:02:03.000Z\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/api_keys/:merchant_id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "api_keys",
+ ":merchant_id"
+ ],
+ "variable": [
+ {
+ "key": "merchant_id",
+ "value": "{{merchant_id}}"
+ }
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Payment Connector - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Status code is 2xx\",",
+ " function () {",
+ " pm.response.to.be.success;",
+ " },",
+ ");",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/account/:account_id/connectors - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set merchant_connector_id as variable for jsonData.merchant_connector_id",
+ "if (jsonData?.merchant_connector_id) {",
+ " pm.collectionVariables.set(",
+ " \"merchant_connector_id\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ " console.log(",
+ " \"- use {{merchant_connector_id}} as collection variable for value\",",
+ " jsonData.merchant_connector_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{merchant_connector_id}}, as jsonData.merchant_connector_id is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{admin_api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"connector_type\":\"fiz_operations\",\"connector_name\":\"bankofamerica\",\"business_country\":\"US\",\"business_label\":\"default\",\"connector_label\":\"first_boa_connector\",\"connector_account_details\":{\"auth_type\":\"SignatureKey\",\"api_key\":\"{{connector_api_key}}\",\"api_secret\":\"{{connector_api_secret}}\",\"key1\":\"{{connector_key1}}\"},\"test_mode\":false,\"disabled\":false,\"payment_methods_enabled\":[{\"payment_method\":\"card\",\"payment_method_types\":[{\"payment_method_type\":\"credit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true},{\"payment_method_type\":\"debit\",\"card_networks\":[\"Visa\",\"Mastercard\"],\"minimum_amount\":1,\"maximum_amount\":68607706,\"recurring_enabled\":true,\"installment_payment_enabled\":true}]}],\"metadata\":{\"city\":\"NY\",\"unit\":\"245\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/account/:account_id/connectors",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "account",
+ ":account_id",
+ "connectors"
+ ],
+ "variable": [
+ {
+ "key": "account_id",
+ "value": "{{merchant_id}}",
+ "description": "(Required) The unique identifier for the merchant account"
+ }
+ ]
+ },
+ "description": "Create a new Payment Connector for the merchant account. The connector could be a payment processor / facilitator / acquirer or specialised services like Fraud / Accounting etc."
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+1\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"payment_method\":\"card\",\"payment_method_type\":\"credit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4111111111111111\",\"card_exp_month\":\"12\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"joseph\",\"last_name\":\"Doe\"},\"phone\":{\"number\":\"8056594427\",\"country_code\":\"+91\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"bankofamerica\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Happy Cases",
+ "item": [
+ {
+ "name": "Scenario1-Create payment with confirm true",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"processing\" for \"status\" because payment gets succeeded after one day.",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "// pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "// pm.response.to.be.success;",
+ "// });",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"processing\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "// pm.test(",
+ "// \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ "// function () {",
+ "// pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ "// .true;",
+ "// },",
+ "// );",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario2-Create payment with confirm false",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_confirmation\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_confirmation'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_confirmation\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"01\",\"card_exp_year\":\"24\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 0'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"processing\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have \"connector_transaction_id\"",
+ "pm.test(",
+ " \"[POST]::/payments - Content check if 'connector_transaction_id' exists\",",
+ " function () {",
+ " pm.expect(typeof jsonData.connector_transaction_id !== \"undefined\").to.be",
+ " .true;",
+ " },",
+ ");",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "// pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "// pm.response.to.be.success;",
+ "// });",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"processing\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount_capturable\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount_capturable' matches 'amount - 0'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_capturable).to.eql(0);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario3-Create payment without PMD",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_payment_method\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_payment_method'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_payment_method\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":false,\"capture_method\":\"automatic\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":6540,\"customer_id\":\"StripeCustomer\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"abcd\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"abcd\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"bankofamerica\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Confirm",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/confirm - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/confirm - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/confirm - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "// Response body should have value \"processing\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/confirm - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "prerequest",
+ "script": {
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{publishable_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"payment_method\":\"card\",\"payment_method_data\":{\"card\":{\"card_number\":\"4242424242424242\",\"card_exp_month\":\"10\",\"card_exp_year\":\"25\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"client_secret\":\"{{client_secret}}\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/confirm",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "confirm"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "This API is to confirm the payment request and forward payment to the payment processor. This API provides more granular control upon when the API is forwarded to the payment processor. Alternatively you can confirm the payment within the Payments-Create API"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "// pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "// pm.response.to.be.success;",
+ "// });",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"processing\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments:id - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario4-Create payment with Manual capture",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"3566111111111113\",\"card_exp_month\":\"12\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Capture",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/capture - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/capture - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/capture - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"processing\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]:://payments/:id/capture - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6540\" for \"amount\"",
+ "if (jsonData?.amount) {",
+ " pm.test(",
+ " \"[post]:://payments/:id/capture - Content check if value for 'amount' matches '6540'\",",
+ " function () {",
+ " pm.expect(jsonData.amount).to.eql(6540);",
+ " },",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"6000\" for \"amount_received\"",
+ "if (jsonData?.amount_received) {",
+ " pm.test(",
+ " \"[POST]::/payments:id/capture - Content check if value for 'amount_received' matches '6000'\",",
+ " function () {",
+ " pm.expect(jsonData.amount_received).to.eql(6000);",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount_to_capture\":6000,\"statement_descriptor_name\":\"Joseph\",\"statement_descriptor_suffix\":\"JS\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/capture",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "capture"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To capture the funds for an uncaptured payment"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "// pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ "// pm.response.to.be.success;",
+ "// });",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"processing\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'processing'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"processing\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "Scenario5-Void the payment",
+ "item": [
+ {
+ "name": "Payments - Create",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[POST]::/payments - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"requires_capture\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments - Content check if value for 'status' matches 'requires_capture'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"requires_capture\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"amount\":6540,\"currency\":\"USD\",\"confirm\":true,\"business_country\":\"US\",\"business_label\":\"default\",\"capture_method\":\"manual\",\"capture_on\":\"2022-09-10T10:11:12Z\",\"amount_to_capture\":1,\"customer_id\":\"bernard123\",\"email\":\"[email protected]\",\"name\":\"John Doe\",\"phone\":\"999999999\",\"phone_country_code\":\"+65\",\"description\":\"Its my first payment request\",\"authentication_type\":\"no_three_ds\",\"return_url\":\"https://duck.com\",\"setup_future_usage\":\"on_session\",\"payment_method\":\"card\",\"payment_method_type\":\"debit\",\"payment_method_data\":{\"card\":{\"card_number\":\"3566111111111113\",\"card_exp_month\":\"12\",\"card_exp_year\":\"30\",\"card_holder_name\":\"joseph Doe\",\"card_cvc\":\"123\"}},\"billing\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"shipping\":{\"address\":{\"line1\":\"1467\",\"line2\":\"Harrison Street\",\"line3\":\"Harrison Street\",\"city\":\"San Fransico\",\"state\":\"California\",\"zip\":\"94122\",\"country\":\"US\",\"first_name\":\"sundari\",\"last_name\":\"sundari\"}},\"statement_descriptor_name\":\"joseph\",\"statement_descriptor_suffix\":\"JS\",\"metadata\":{\"udf1\":\"value1\",\"new_customer\":\"true\",\"login_date\":\"2019-09-10T10:11:12Z\"},\"routing\":{\"type\":\"single\",\"data\":\"stripe\"}}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments"
+ ]
+ },
+ "description": "To process a payment you will have to create a payment, attach a payment method and confirm. Depending on the user journey you wish to achieve, you may opt to all the steps in a single request or in a sequence of API request using following APIs: (i) Payments - Update, (ii) Payments - Confirm, and (iii) Payments - Capture"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Cancel",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[POST]::/payments/:id/cancel - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content-Type is application/json\",",
+ " function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ " },",
+ ");",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[POST]::/payments/:id/cancel - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"cancelled\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id/cancel - Content check if value for 'status' matches 'cancelled'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"cancelled\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ },
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ },
+ "raw": "{\"cancellation_reason\":\"requested_by_customer\"}"
+ },
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id/cancel",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id",
+ "cancel"
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action"
+ },
+ "response": []
+ },
+ {
+ "name": "Payments - Retrieve",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "exec": [
+ "// Validate status 2xx",
+ "pm.test(\"[GET]::/payments/:id - Status code is 2xx\", function () {",
+ " pm.response.to.be.success;",
+ "});",
+ "",
+ "// Validate if response header has matching content-type",
+ "pm.test(\"[GET]::/payments/:id - Content-Type is application/json\", function () {",
+ " pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(",
+ " \"application/json\",",
+ " );",
+ "});",
+ "",
+ "// Validate if response has JSON Body",
+ "pm.test(\"[GET]::/payments/:id - Response has JSON Body\", function () {",
+ " pm.response.to.have.jsonBody();",
+ "});",
+ "",
+ "// Set response object as internal variable",
+ "let jsonData = {};",
+ "try {",
+ " jsonData = pm.response.json();",
+ "} catch (e) {}",
+ "",
+ "// pm.collectionVariables - Set payment_id as variable for jsonData.payment_id",
+ "if (jsonData?.payment_id) {",
+ " pm.collectionVariables.set(\"payment_id\", jsonData.payment_id);",
+ " console.log(",
+ " \"- use {{payment_id}} as collection variable for value\",",
+ " jsonData.payment_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{payment_id}}, as jsonData.payment_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set mandate_id as variable for jsonData.mandate_id",
+ "if (jsonData?.mandate_id) {",
+ " pm.collectionVariables.set(\"mandate_id\", jsonData.mandate_id);",
+ " console.log(",
+ " \"- use {{mandate_id}} as collection variable for value\",",
+ " jsonData.mandate_id,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{mandate_id}}, as jsonData.mandate_id is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// pm.collectionVariables - Set client_secret as variable for jsonData.client_secret",
+ "if (jsonData?.client_secret) {",
+ " pm.collectionVariables.set(\"client_secret\", jsonData.client_secret);",
+ " console.log(",
+ " \"- use {{client_secret}} as collection variable for value\",",
+ " jsonData.client_secret,",
+ " );",
+ "} else {",
+ " console.log(",
+ " \"INFO - Unable to assign variable {{client_secret}}, as jsonData.client_secret is undefined.\",",
+ " );",
+ "}",
+ "",
+ "// Response body should have value \"cancelled\" for \"status\"",
+ "if (jsonData?.status) {",
+ " pm.test(",
+ " \"[POST]::/payments/:id - Content check if value for 'status' matches 'cancelled'\",",
+ " function () {",
+ " pm.expect(jsonData.status).to.eql(\"cancelled\");",
+ " },",
+ " );",
+ "}",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [
+ {
+ "key": "Accept",
+ "value": "application/json"
+ }
+ ],
+ "url": {
+ "raw": "{{baseUrl}}/payments/:id?force_sync=true",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "payments",
+ ":id"
+ ],
+ "query": [
+ {
+ "key": "force_sync",
+ "value": "true"
+ }
+ ],
+ "variable": [
+ {
+ "key": "id",
+ "value": "{{payment_id}}",
+ "description": "(Required) unique payment id"
+ }
+ ]
+ },
+ "description": "To retrieve the properties of a Payment. This may be used to get the status of a previously initiated payment or next action for an ongoing payment"
+ },
+ "response": []
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "auth": {
+ "type": "apikey",
+ "apikey": [
+ {
+ "key": "value",
+ "value": "{{api_key}}",
+ "type": "string"
+ },
+ {
+ "key": "key",
+ "value": "api-key",
+ "type": "string"
+ },
+ {
+ "key": "in",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "info": {
+ "_postman_id": "646f7167-da26-4a24-adb0-4157fd3a1781",
+ "name": "bankofamerica",
+ "description": "## Get started\n\nJuspay Router provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. \nYou can consume the APIs directly using your favorite HTTP/REST library. \nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without affecting production data.\n\n### Base URLs\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n| --- | --- |\n| Sandbox | [https://sandbox.hyperswitch.io](https://sandbox.hyperswitch.io) |\n| Production | [https://router.juspay.io](https://router.juspay.io) |\n\n# Authentication\n\nWhen you sign up for an account, you are given a secret key (also referred as api-key). You may authenticate all API requests with Juspay server by providing the appropriate key in the request Authorization header. \nNever share your secret api keys. Keep them guarded and secure.\n\nContact Support: \nName: Juspay Support \nEmail: [[email protected]](mailto:[email protected])",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
+ "_exporter_id": "28305597"
+ },
+ "variable": [
+ {
+ "key": "baseUrl",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "admin_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "merchant_id",
+ "value": ""
+ },
+ {
+ "key": "payment_id",
+ "value": ""
+ },
+ {
+ "key": "customer_id",
+ "value": ""
+ },
+ {
+ "key": "mandate_id",
+ "value": ""
+ },
+ {
+ "key": "payment_method_id",
+ "value": ""
+ },
+ {
+ "key": "refund_id",
+ "value": ""
+ },
+ {
+ "key": "merchant_connector_id",
+ "value": ""
+ },
+ {
+ "key": "client_secret",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_api_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "publishable_key",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "api_key_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "payment_token",
+ "value": ""
+ },
+ {
+ "key": "gateway_merchant_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "certificate_keys",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "organization_id",
+ "value": ""
+ },
+ {
+ "key": "connector_api_secret",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "connector_key1",
+ "value": "",
+ "type": "string"
+ }
+ ]
+}
|
test
|
update postman collection files
|
eb4fe6f46bebcafeddb5af243df786b938602bd3
|
2022-12-13 12:00:27
|
ItsMeShashank
|
refactor(router): move db models into separate crate and refactoring around it (#125)
| false
|
diff --git a/Cargo.lock b/Cargo.lock
index 71bdc995eca..b1c77fc7f1e 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2651,6 +2651,7 @@ dependencies = [
"serde_path_to_error",
"serde_qs",
"serde_urlencoded",
+ "storage_models",
"structopt",
"strum",
"thiserror",
@@ -2996,6 +2997,22 @@ checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d"
[[package]]
name = "storage_models"
version = "0.1.0"
+dependencies = [
+ "async-bb8-diesel",
+ "async-trait",
+ "common_utils",
+ "diesel",
+ "error-stack",
+ "hex",
+ "masking",
+ "router_derive",
+ "router_env",
+ "serde",
+ "serde_json",
+ "strum",
+ "thiserror",
+ "time",
+]
[[package]]
name = "strsim"
diff --git a/crates/router/Cargo.toml b/crates/router/Cargo.toml
index f1c78431c50..cbb245bb242 100644
--- a/crates/router/Cargo.toml
+++ b/crates/router/Cargo.toml
@@ -69,6 +69,7 @@ masking = { version = "0.1.0", path = "../masking" }
redis_interface = { version = "0.1.0", path = "../redis_interface" }
router_derive = { version = "0.1.0", path = "../router_derive" }
router_env = { version = "0.1.0", path = "../router_env", features = ["log_extra_implicit_fields", "log_custom_entries_to_extra"] }
+storage_models = { version = "0.1.0", path = "../storage_models" }
[build-dependencies]
router_env = { version = "0.1.0", path = "../router_env", default-features = false, features = ["vergen"] }
diff --git a/crates/router/src/connector/checkout/transformers.rs b/crates/router/src/connector/checkout/transformers.rs
index c777592321b..d6e00c3b120 100644
--- a/crates/router/src/connector/checkout/transformers.rs
+++ b/crates/router/src/connector/checkout/transformers.rs
@@ -6,7 +6,11 @@ use crate::{
core::errors,
pii::{self, Secret},
services,
- types::{self, api, storage::enums},
+ types::{
+ self, api,
+ storage::enums,
+ transformers::{Foreign, ForeignFrom},
+ },
};
#[derive(Debug, Serialize)]
@@ -138,8 +142,11 @@ pub enum CheckoutPaymentStatus {
Captured,
}
-impl From<(CheckoutPaymentStatus, Option<enums::CaptureMethod>)> for enums::AttemptStatus {
- fn from(item: (CheckoutPaymentStatus, Option<enums::CaptureMethod>)) -> Self {
+impl From<Foreign<(CheckoutPaymentStatus, Option<enums::CaptureMethod>)>>
+ for Foreign<enums::AttemptStatus>
+{
+ fn from(item: Foreign<(CheckoutPaymentStatus, Option<enums::CaptureMethod>)>) -> Self {
+ let item = item.0;
let status = item.0;
let capture_method = item.1;
match status {
@@ -157,6 +164,7 @@ impl From<(CheckoutPaymentStatus, Option<enums::CaptureMethod>)> for enums::Atte
CheckoutPaymentStatus::Pending => enums::AttemptStatus::Authorizing,
CheckoutPaymentStatus::CardVerified => enums::AttemptStatus::Pending,
}
+ .into()
}
}
@@ -203,7 +211,7 @@ impl TryFrom<types::PaymentsResponseRouterData<PaymentsResponse>>
),
});
Ok(types::RouterData {
- status: enums::AttemptStatus::from((
+ status: enums::AttemptStatus::foreign_from((
item.response.status,
item.data.request.capture_method,
)),
@@ -227,7 +235,7 @@ impl TryFrom<types::PaymentsSyncResponseRouterData<PaymentsResponse>>
item: types::PaymentsSyncResponseRouterData<PaymentsResponse>,
) -> Result<Self, Self::Error> {
Ok(types::RouterData {
- status: enums::AttemptStatus::from((item.response.status, None)),
+ status: enums::AttemptStatus::foreign_from((item.response.status, None)),
response: Ok(types::PaymentsResponseData::TransactionResponse {
resource_id: types::ResponseId::ConnectorTransactionId(item.response.id),
//TODO: Add redirection details here
diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs
index 951d3c45cc2..d14489ba692 100644
--- a/crates/router/src/core/admin.rs
+++ b/crates/router/src/core/admin.rs
@@ -10,6 +10,7 @@ use crate::{
types::{
self, api,
storage::{self, MerchantAccount},
+ transformers::ForeignInto,
},
utils::{self, OptionExt, ValueExt},
};
@@ -55,7 +56,7 @@ pub async fn create_merchant_account(
merchant_details: Some(merchant_details),
return_url: req.return_url,
webhook_details: Some(webhook_details),
- routing_algorithm: req.routing_algorithm.map(Into::into),
+ routing_algorithm: req.routing_algorithm.map(ForeignInto::foreign_into),
custom_routing_rules: Some(custom_routing_rules),
sub_merchants_enabled: req.sub_merchants_enabled,
parent_merchant_id: get_parent_merchant(
@@ -110,7 +111,9 @@ pub async fn get_merchant_account(
merchant_details,
return_url: merchant_account.return_url,
webhook_details,
- routing_algorithm: merchant_account.routing_algorithm.map(Into::into),
+ routing_algorithm: merchant_account
+ .routing_algorithm
+ .map(ForeignInto::foreign_into),
custom_routing_rules,
sub_merchants_enabled: merchant_account.sub_merchants_enabled,
parent_merchant_id: merchant_account.parent_merchant_id,
@@ -173,7 +176,7 @@ pub async fn merchant_account_update(
},
routing_algorithm: req
.routing_algorithm
- .map(Into::into)
+ .map(ForeignInto::foreign_into)
.or(merchant_account.routing_algorithm),
custom_routing_rules: if req.custom_routing_rules.is_some() {
Some(
@@ -310,7 +313,7 @@ pub async fn create_payment_connector(
let merchant_connector_account = storage::MerchantConnectorAccountNew {
merchant_id: Some(merchant_id.to_string()),
- connector_type: Some(req.connector_type.into()),
+ connector_type: Some(req.connector_type.foreign_into()),
connector_name: Some(req.connector_name),
merchant_connector_id: None,
connector_account_details: req.connector_account_details,
@@ -358,7 +361,7 @@ pub async fn retrieve_payment_connector(
None => None,
};
let response = api::PaymentConnectorCreate {
- connector_type: mca.connector_type.into(),
+ connector_type: mca.connector_type.foreign_into(),
connector_name: mca.connector_name,
merchant_connector_id: Some(mca.merchant_connector_id),
connector_account_details: Some(Secret::new(mca.connector_account_details)),
@@ -409,7 +412,7 @@ pub async fn update_payment_connector(
};
let payment_connector = storage::MerchantConnectorAccountUpdate::Update {
merchant_id: Some(merchant_id.to_string()),
- connector_type: Some(req.connector_type.into()),
+ connector_type: Some(req.connector_type.foreign_into()),
connector_name: Some(req.connector_name),
merchant_connector_id: Some(merchant_connector_id),
connector_account_details: req
@@ -425,7 +428,7 @@ pub async fn update_payment_connector(
.await
.change_context(errors::ApiErrorResponse::InternalServerError)?;
let response = api::PaymentConnectorCreate {
- connector_type: updated_mca.connector_type.into(),
+ connector_type: updated_mca.connector_type.foreign_into(),
connector_name: updated_mca.connector_name,
merchant_connector_id: Some(updated_mca.merchant_connector_id),
connector_account_details: Some(Secret::new(updated_mca.connector_account_details)),
diff --git a/crates/router/src/core/customers.rs b/crates/router/src/core/customers.rs
index 6a4617be6c8..e0981bca4ff 100644
--- a/crates/router/src/core/customers.rs
+++ b/crates/router/src/core/customers.rs
@@ -35,14 +35,17 @@ pub async fn create_customer(
let customer = match db.insert_customer(new_customer).await {
Ok(customer) => customer,
- Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::UniqueViolation) => db
- .find_customer_by_customer_id_merchant_id(&customer_id, &merchant_id)
- .await
- .change_context(errors::ApiErrorResponse::InternalServerError)?,
- _ => Err(error.change_context(errors::ApiErrorResponse::InternalServerError))?,
- },
+ Err(error) => {
+ if error.current_context().is_db_unique_violation() {
+ db.find_customer_by_customer_id_merchant_id(&customer_id, &merchant_id)
+ .await
+ .change_context(errors::ApiErrorResponse::InternalServerError)?
+ } else {
+ Err(error.change_context(errors::ApiErrorResponse::InternalServerError))?
+ }
+ }
};
+
Ok(services::BachResponse::Json(customer.into()))
}
diff --git a/crates/router/src/core/errors.rs b/crates/router/src/core/errors.rs
index 6b5f79a5376..8498613da3c 100644
--- a/crates/router/src/core/errors.rs
+++ b/crates/router/src/core/errors.rs
@@ -10,6 +10,7 @@ use config::ConfigError;
use error_stack;
pub use redis_interface::errors::RedisError;
use router_env::opentelemetry::metrics::MetricsError;
+use storage_models::errors as storage_errors;
pub use self::api_error_response::ApiErrorResponse;
pub(crate) use self::utils::{ApiClientErrorExt, ConnectorErrorExt, StorageErrorExt};
@@ -68,8 +69,7 @@ macro_rules! router_error_error_stack_specific {
#[derive(Debug, thiserror::Error)]
pub enum StorageError {
#[error("DatabaseError: {0}")]
- DatabaseError(#[from] DatabaseError),
-
+ DatabaseError(error_stack::Report<storage_errors::DatabaseError>),
#[error("ValueNotFound: {0}")]
ValueNotFound(String),
#[error("DuplicateValue: {0}")]
@@ -78,21 +78,32 @@ pub enum StorageError {
KVError,
}
-#[derive(Debug, thiserror::Error)]
-pub enum DatabaseError {
- #[error("An error occurred when obtaining database connection")]
- DatabaseConnectionError,
- #[error("The requested resource was not found in the database")]
- NotFound,
- #[error("A unique constraint violation occurred")]
- UniqueViolation,
- #[error("No fields were provided to be updated")]
- NoFieldsToUpdate,
- #[error("An error occurred when generating raw SQL query")]
- QueryGenerationFailed,
- // InsertFailed,
- #[error("An unknown error occurred")]
- Others,
+impl From<error_stack::Report<storage_errors::DatabaseError>> for StorageError {
+ fn from(err: error_stack::Report<storage_errors::DatabaseError>) -> Self {
+ Self::DatabaseError(err)
+ }
+}
+
+impl StorageError {
+ pub fn is_db_not_found(&self) -> bool {
+ match self {
+ Self::DatabaseError(err) => matches!(
+ err.current_context(),
+ storage_errors::DatabaseError::NotFound
+ ),
+ _ => false,
+ }
+ }
+
+ pub fn is_db_unique_violation(&self) -> bool {
+ match self {
+ Self::DatabaseError(err) => matches!(
+ err.current_context(),
+ storage_errors::DatabaseError::UniqueViolation,
+ ),
+ _ => false,
+ }
+ }
}
impl_error_type!(AuthenticationError, "Authentication error");
@@ -123,7 +134,7 @@ pub enum BachError {
ConfigurationError(ConfigError),
#[error("{{ error_description: Database operation failed, error_message: {0} }}")]
- EDatabaseError(error_stack::Report<DatabaseError>),
+ EDatabaseError(error_stack::Report<storage_errors::DatabaseError>),
#[error("{{ error_description: Encryption module operation failed, error_message: {0} }}")]
EEncryptionError(error_stack::Report<EncryptionError>),
@@ -136,7 +147,7 @@ pub enum BachError {
}
router_error_error_stack_specific!(
- error_stack::Report<DatabaseError>,
+ error_stack::Report<storage_errors::DatabaseError>,
BachError::EDatabaseError(error_stack::Report<DatabaseError>)
);
router_error_error_stack_specific!(
diff --git a/crates/router/src/core/errors/utils.rs b/crates/router/src/core/errors/utils.rs
index 3f71f497df2..a7bac854fb5 100644
--- a/crates/router/src/core/errors/utils.rs
+++ b/crates/router/src/core/errors/utils.rs
@@ -1,4 +1,3 @@
-use super::DatabaseError;
use crate::{core::errors, logger};
pub(crate) trait StorageErrorExt {
@@ -18,12 +17,10 @@ impl StorageErrorExt for error_stack::Report<errors::StorageError> {
self,
not_found_response: errors::ApiErrorResponse,
) -> error_stack::Report<errors::ApiErrorResponse> {
- match self.current_context() {
- errors::StorageError::DatabaseError(DatabaseError::NotFound) => {
- self.change_context(not_found_response)
- }
- errors::StorageError::ValueNotFound(_) => self.change_context(not_found_response),
- _ => self.change_context(errors::ApiErrorResponse::InternalServerError),
+ if self.current_context().is_db_not_found() {
+ self.change_context(not_found_response)
+ } else {
+ self.change_context(errors::ApiErrorResponse::InternalServerError)
}
}
@@ -31,11 +28,10 @@ impl StorageErrorExt for error_stack::Report<errors::StorageError> {
self,
duplicate_response: errors::ApiErrorResponse,
) -> error_stack::Report<errors::ApiErrorResponse> {
- match self.current_context() {
- errors::StorageError::DatabaseError(DatabaseError::UniqueViolation) => {
- self.change_context(duplicate_response)
- }
- _ => self.change_context(errors::ApiErrorResponse::InternalServerError),
+ if self.current_context().is_db_unique_violation() {
+ self.change_context(duplicate_response)
+ } else {
+ self.change_context(errors::ApiErrorResponse::InternalServerError)
}
}
}
diff --git a/crates/router/src/core/mandate.rs b/crates/router/src/core/mandate.rs
index 6f78f869a32..7e6a680133d 100644
--- a/crates/router/src/core/mandate.rs
+++ b/crates/router/src/core/mandate.rs
@@ -12,6 +12,7 @@ use crate::{
mandates::{self, MandateResponseExt},
},
storage,
+ transformers::ForeignInto,
},
};
@@ -51,7 +52,7 @@ pub async fn revoke_mandate(
Ok(services::BachResponse::Json(
mandates::MandateRevokedResponse {
mandate_id: mandate.mandate_id,
- status: mandate.mandate_status.into(),
+ status: mandate.mandate_status.foreign_into(),
},
))
}
diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs
index d0bc34ba327..582f2a584a8 100644
--- a/crates/router/src/core/payment_methods/cards.rs
+++ b/crates/router/src/core/payment_methods/cards.rs
@@ -18,6 +18,7 @@ use crate::{
types::{
api::{self, CreatePaymentMethodExt},
storage::{self, enums},
+ transformers::ForeignInto,
},
utils::{self, BytesExt, OptionExt, StringExt, ValueExt},
};
@@ -35,8 +36,8 @@ pub async fn create_payment_method(
customer_id,
merchant_id: merchant_id.to_string(),
payment_method_id,
- payment_method: req.payment_method.into(),
- payment_method_type: req.payment_method_type.map(Into::into),
+ payment_method: req.payment_method.foreign_into(),
+ payment_method_type: req.payment_method_type.map(ForeignInto::foreign_into),
payment_method_issuer: req.payment_method_issuer.clone(),
..storage::PaymentMethodNew::default()
})
@@ -436,12 +437,14 @@ pub async fn list_customer_payment_method(
let pma = api::CustomerPaymentMethod {
payment_token: payment_token.to_string(),
customer_id: pm.customer_id,
- payment_method: pm.payment_method.into(),
- payment_method_type: pm.payment_method_type.map(Into::into),
+ payment_method: pm.payment_method.foreign_into(),
+ payment_method_type: pm.payment_method_type.map(ForeignInto::foreign_into),
payment_method_issuer: pm.payment_method_issuer,
card,
metadata: None,
- payment_method_issuer_code: pm.payment_method_issuer_code.map(Into::into),
+ payment_method_issuer_code: pm
+ .payment_method_issuer_code
+ .map(ForeignInto::foreign_into),
recurring_enabled: false,
installment_payment_enabled: false,
payment_experience: Some(vec!["redirect_to_url".to_string()]), //TODO chnage to enum
@@ -611,13 +614,13 @@ pub async fn retrieve_payment_method(
};
Ok(services::BachResponse::Json(api::PaymentMethodResponse {
payment_method_id: pm.payment_method_id,
- payment_method: pm.payment_method.into(),
- payment_method_type: pm.payment_method_type.map(Into::into),
+ payment_method: pm.payment_method.foreign_into(),
+ payment_method_type: pm.payment_method_type.map(ForeignInto::foreign_into),
payment_method_issuer: pm.payment_method_issuer,
card,
metadata: None, // TODO add in addCard api
created: Some(pm.created_at),
- payment_method_issuer_code: pm.payment_method_issuer_code.map(Into::into),
+ payment_method_issuer_code: pm.payment_method_issuer_code.map(ForeignInto::foreign_into),
recurring_enabled: false, //TODO
installment_payment_enabled: false, //TODO
payment_experience: Some(vec!["redirect_to_url".to_string()]), //TODO,
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index 61a47e4bc23..f51db03acfe 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -33,7 +33,8 @@ use crate::{
types::{
self,
api::{self, PaymentIdTypeExt, PaymentsResponse, PaymentsRetrieveRequest},
- storage::{self, enums},
+ storage::{self, enums, ProcessTrackerExt},
+ transformers::ForeignInto,
},
utils::{self, OptionExt},
};
@@ -573,7 +574,10 @@ pub async fn list_payments(
.await
.map_err(|err| err.to_not_found_response(errors::ApiErrorResponse::PaymentNotFound))?;
- let data: Vec<api::PaymentsResponse> = payment_intent.into_iter().map(From::from).collect();
+ let data: Vec<api::PaymentsResponse> = payment_intent
+ .into_iter()
+ .map(ForeignInto::foreign_into)
+ .collect();
utils::when(
data.is_empty(),
Err(errors::ApiErrorResponse::PaymentNotFound),
diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs
index b1805c5d1f0..5576a172cc2 100644
--- a/crates/router/src/core/payments/helpers.rs
+++ b/crates/router/src/core/payments/helpers.rs
@@ -24,6 +24,7 @@ use crate::{
self,
api::{self, enums as api_enums, CustomerAcceptanceExt, MandateValidationFieldsExt},
storage::{self, enums as storage_enums, ephemeral_key},
+ transformers::ForeignInto,
},
utils::{
self,
@@ -44,7 +45,7 @@ pub async fn get_address_for_payment_request(
Some(address) => {
match address_id {
Some(id) => Some(
- db.update_address(id.to_owned(), address.into())
+ db.update_address(id.to_owned(), address.foreign_into())
.await
.map_err(|err| {
err.to_not_found_response(errors::ApiErrorResponse::AddressNotFound)
@@ -119,7 +120,7 @@ pub async fn get_token_pm_type_mandate_details(
.get_required_value("mandate_data")?;
Ok((
request.payment_token.to_owned(),
- request.payment_method.map(Into::into),
+ request.payment_method.map(ForeignInto::foreign_into),
Some(setup_mandate),
))
}
@@ -130,7 +131,7 @@ pub async fn get_token_pm_type_mandate_details(
}
None => Ok((
request.payment_token.to_owned(),
- request.payment_method.map(Into::into),
+ request.payment_method.map(ForeignInto::foreign_into),
request.mandate_data.clone(),
)),
}
@@ -184,7 +185,7 @@ pub async fn get_token_for_recurring_mandate(
let _ = cards::get_lookup_key_from_locker(state, &token, &payment_method).await?;
if let Some(payment_method_from_request) = req.payment_method {
- let pm: storage_enums::PaymentMethodType = payment_method_from_request.into();
+ let pm: storage_enums::PaymentMethodType = payment_method_from_request.foreign_into();
if pm != payment_method.payment_method {
Err(report!(errors::ApiErrorResponse::PreconditionFailed {
message: "payment method in request does not match previously provided payment \
@@ -464,7 +465,7 @@ pub(crate) async fn call_payment_method(
let customer_id = customer.customer_id.clone();
let payment_method_request = api::CreatePaymentMethod {
merchant_id: Some(merchant_id.to_string()),
- payment_method: payment_method_type.into(),
+ payment_method: payment_method_type.foreign_into(),
payment_method_type: None,
payment_method_issuer: None,
payment_method_issuer_code: None,
@@ -496,7 +497,7 @@ pub(crate) async fn call_payment_method(
_ => {
let payment_method_request = api::CreatePaymentMethod {
merchant_id: Some(merchant_id.to_string()),
- payment_method: payment_method_type.into(),
+ payment_method: payment_method_type.foreign_into(),
payment_method_type: None,
payment_method_issuer: None,
payment_method_issuer_code: None,
@@ -1160,14 +1161,14 @@ pub fn generate_mandate(
Some(match data.mandate_type {
api::MandateType::SingleUse(data) => new_mandate
.set_mandate_amount(Some(data.amount))
- .set_mandate_currency(Some(data.currency.into()))
+ .set_mandate_currency(Some(data.currency.foreign_into()))
.set_mandate_type(storage_enums::MandateType::SingleUse)
.to_owned(),
api::MandateType::MultiUse(op_data) => match op_data {
Some(data) => new_mandate
.set_mandate_amount(Some(data.amount))
- .set_mandate_currency(Some(data.currency.into())),
+ .set_mandate_currency(Some(data.currency.foreign_into())),
None => &mut new_mandate,
}
.set_mandate_type(storage_enums::MandateType::MultiUse)
diff --git a/crates/router/src/core/payments/operations/payment_capture.rs b/crates/router/src/core/payments/operations/payment_capture.rs
index 95fe0858dc4..245b1501118 100644
--- a/crates/router/src/core/payments/operations/payment_capture.rs
+++ b/crates/router/src/core/payments/operations/payment_capture.rs
@@ -15,6 +15,7 @@ use crate::{
types::{
api::{self, PaymentIdTypeExt, PaymentsCaptureRequest},
storage::{self, enums},
+ transformers::ForeignInto,
},
utils::OptionExt,
};
@@ -128,8 +129,8 @@ impl<F: Send + Clone> GetTracker<F, payments::PaymentData<F>, api::PaymentsCaptu
setup_mandate: None,
token: None,
address: payments::PaymentAddress {
- shipping: shipping_address.as_ref().map(|a| a.into()),
- billing: billing_address.as_ref().map(|a| a.into()),
+ shipping: shipping_address.as_ref().map(|a| a.foreign_into()),
+ billing: billing_address.as_ref().map(|a| a.foreign_into()),
},
confirm: None,
payment_method_data: None,
diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs
index 0e0ada459c2..411aa3eaba3 100644
--- a/crates/router/src/core/payments/operations/payment_confirm.rs
+++ b/crates/router/src/core/payments/operations/payment_confirm.rs
@@ -18,6 +18,7 @@ use crate::{
self,
api::{self, PaymentIdTypeExt},
storage::{self, enums},
+ transformers::ForeignInto,
},
utils::{self, OptionExt},
};
@@ -147,8 +148,8 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
setup_mandate,
token,
address: PaymentAddress {
- shipping: shipping_address.as_ref().map(|a| a.into()),
- billing: billing_address.as_ref().map(|a| a.into()),
+ shipping: shipping_address.as_ref().map(|a| a.foreign_into()),
+ billing: billing_address.as_ref().map(|a| a.foreign_into()),
},
confirm: request.confirm,
payment_method_data: request.payment_method_data.clone(),
diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs
index 9233979645c..6f84268c0e1 100644
--- a/crates/router/src/core/payments/operations/payment_create.rs
+++ b/crates/router/src/core/payments/operations/payment_create.rs
@@ -23,6 +23,7 @@ use crate::{
self,
enums::{self, IntentStatus},
},
+ transformers::ForeignInto,
},
utils::OptionExt,
};
@@ -107,8 +108,8 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
{
Ok(payment_attempt) => Ok(payment_attempt),
- Err(err) => match err.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::UniqueViolation) => {
+ Err(err) => {
+ if err.current_context().is_db_unique_violation() {
is_update = true;
db.find_payment_attempt_by_payment_id_merchant_id(
&payment_id,
@@ -119,10 +120,12 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
.map_err(|error| {
error.to_not_found_response(errors::ApiErrorResponse::PaymentNotFound)
})
+ } else {
+ Err(err).change_context(errors::ApiErrorResponse::InternalServerError)
}
- _ => Err(err).change_context(errors::ApiErrorResponse::InternalServerError),
- },
+ }
}?;
+
payment_intent = match db
.insert_payment_intent(
Self::make_payment_intent(
@@ -139,8 +142,8 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
{
Ok(payment_intent) => Ok(payment_intent),
- Err(err) => match err.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::UniqueViolation) => {
+ Err(err) => {
+ if err.current_context().is_db_unique_violation() {
is_update = true;
db.find_payment_intent_by_payment_id_merchant_id(
&payment_id,
@@ -151,9 +154,10 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
.map_err(|error| {
error.to_not_found_response(errors::ApiErrorResponse::PaymentNotFound)
})
+ } else {
+ Err(err).change_context(errors::ApiErrorResponse::InternalServerError)
}
- _ => Err(err).change_context(errors::ApiErrorResponse::InternalServerError),
- },
+ }
}?;
connector_response = match db
@@ -164,16 +168,17 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
.await
{
Ok(connector_resp) => Ok(connector_resp),
- Err(err) => match err.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::UniqueViolation) => {
+ Err(err) => {
+ if err.current_context().is_db_unique_violation() {
Err(err)
.change_context(errors::ApiErrorResponse::InternalServerError)
.attach_printable("Duplicate connector response in the database")
+ } else {
+ Err(err)
+ .change_context(errors::ApiErrorResponse::InternalServerError)
+ .attach_printable("Error occured when inserting connector response")
}
- _ => Err(err)
- .change_context(errors::ApiErrorResponse::InternalServerError)
- .attach_printable("Error occured when inserting connector response")?,
- },
+ }
}?;
let operation = payments::if_not_create_change_operation::<_, F>(
@@ -194,8 +199,8 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
setup_mandate,
token,
address: PaymentAddress {
- shipping: shipping_address.as_ref().map(|a| a.into()),
- billing: billing_address.as_ref().map(|a| a.into()),
+ shipping: shipping_address.as_ref().map(|a| a.foreign_into()),
+ billing: billing_address.as_ref().map(|a| a.foreign_into()),
},
confirm: request.confirm,
payment_method_data: request.payment_method_data.clone(),
@@ -341,13 +346,13 @@ impl PaymentCreate {
amount: amount.into(),
currency,
payment_method,
- capture_method: request.capture_method.map(Into::into),
+ capture_method: request.capture_method.map(ForeignInto::foreign_into),
capture_on: request.capture_on,
confirm: request.confirm.unwrap_or(false),
created_at,
modified_at,
last_synced,
- authentication_type: request.authentication_type.map(Into::into),
+ authentication_type: request.authentication_type.map(ForeignInto::foreign_into),
browser_info,
..storage::PaymentAttemptNew::default()
}
@@ -379,7 +384,7 @@ impl PaymentCreate {
modified_at,
last_synced,
client_secret: Some(client_secret),
- setup_future_usage: request.setup_future_usage.map(Into::into),
+ setup_future_usage: request.setup_future_usage.map(ForeignInto::foreign_into),
off_session: request.off_session,
return_url: request.return_url.clone(),
shipping_address_id,
diff --git a/crates/router/src/core/payments/operations/payment_method_validate.rs b/crates/router/src/core/payments/operations/payment_method_validate.rs
index 3c91337730c..cc3f5b8ba2b 100644
--- a/crates/router/src/core/payments/operations/payment_method_validate.rs
+++ b/crates/router/src/core/payments/operations/payment_method_validate.rs
@@ -21,6 +21,7 @@ use crate::{
self,
api::{self, enums as api_enums, PaymentIdTypeExt},
storage::{self, enums as storage_enums},
+ transformers::ForeignInto,
},
utils,
};
@@ -284,7 +285,7 @@ impl PaymentMethodValidate {
amount: 0,
currency: Default::default(),
connector: None,
- payment_method: payment_method.map(Into::into),
+ payment_method: payment_method.map(ForeignInto::foreign_into),
confirm: true,
created_at,
modified_at,
@@ -314,7 +315,7 @@ impl PaymentMethodValidate {
modified_at,
last_synced,
client_secret: Some(client_secret),
- setup_future_usage: request.setup_future_usage.map(Into::into),
+ setup_future_usage: request.setup_future_usage.map(ForeignInto::foreign_into),
off_session: request.off_session,
..Default::default()
}
diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs
index 61b91bcf312..a2761eb68ed 100644
--- a/crates/router/src/core/payments/operations/payment_response.rs
+++ b/crates/router/src/core/payments/operations/payment_response.rs
@@ -13,6 +13,7 @@ use crate::{
types::{
self, api,
storage::{self, enums},
+ transformers::ForeignInto,
},
utils,
};
@@ -259,7 +260,7 @@ async fn payment_response_update_tracker<F: Clone, T>(
status: enums::IntentStatus::Failed,
},
Ok(_) => storage::PaymentIntentUpdate::ResponseUpdate {
- status: router_data.status.into(),
+ status: router_data.status.foreign_into(),
return_url: router_data.return_url,
amount_captured: None,
},
diff --git a/crates/router/src/core/payments/operations/payment_session.rs b/crates/router/src/core/payments/operations/payment_session.rs
index c87b17b2058..a629e85a3c0 100644
--- a/crates/router/src/core/payments/operations/payment_session.rs
+++ b/crates/router/src/core/payments/operations/payment_session.rs
@@ -16,6 +16,7 @@ use crate::{
types::{
api::{self, PaymentIdTypeExt},
storage::{self, enums},
+ transformers::ForeignInto,
},
utils::OptionExt,
};
@@ -126,8 +127,8 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsSessionRequest>
token: None,
setup_mandate: None,
address: payments::PaymentAddress {
- shipping: shipping_address.as_ref().map(|a| a.into()),
- billing: billing_address.as_ref().map(|a| a.into()),
+ shipping: shipping_address.as_ref().map(|a| a.foreign_into()),
+ billing: billing_address.as_ref().map(|a| a.foreign_into()),
},
confirm: None,
payment_method_data: None,
diff --git a/crates/router/src/core/payments/operations/payment_start.rs b/crates/router/src/core/payments/operations/payment_start.rs
index c4dcaf29fcc..d513c480168 100644
--- a/crates/router/src/core/payments/operations/payment_start.rs
+++ b/crates/router/src/core/payments/operations/payment_start.rs
@@ -16,6 +16,7 @@ use crate::{
types::{
api::{self, PaymentIdTypeExt},
storage::{self, enums, Customer},
+ transformers::ForeignInto,
},
utils::OptionExt,
};
@@ -131,8 +132,8 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsStartRequest> f
setup_mandate: None,
token: None,
address: PaymentAddress {
- shipping: shipping_address.as_ref().map(|a| a.into()),
- billing: billing_address.as_ref().map(|a| a.into()),
+ shipping: shipping_address.as_ref().map(|a| a.foreign_into()),
+ billing: billing_address.as_ref().map(|a| a.foreign_into()),
},
confirm: Some(payment_attempt.confirm),
payment_attempt,
diff --git a/crates/router/src/core/payments/operations/payment_status.rs b/crates/router/src/core/payments/operations/payment_status.rs
index cd80a11cc45..3215a1945a5 100644
--- a/crates/router/src/core/payments/operations/payment_status.rs
+++ b/crates/router/src/core/payments/operations/payment_status.rs
@@ -16,6 +16,7 @@ use crate::{
types::{
api,
storage::{self, enums},
+ transformers::ForeignInto,
},
utils::{self, OptionExt},
};
@@ -201,8 +202,8 @@ async fn get_tracker_for_sync<
setup_mandate: None,
token: None,
address: PaymentAddress {
- shipping: shipping_address.as_ref().map(|a| a.into()),
- billing: billing_address.as_ref().map(|a| a.into()),
+ shipping: shipping_address.as_ref().map(|a| a.foreign_into()),
+ billing: billing_address.as_ref().map(|a| a.foreign_into()),
},
confirm: Some(request.force_sync),
payment_method_data: None,
diff --git a/crates/router/src/core/payments/operations/payment_update.rs b/crates/router/src/core/payments/operations/payment_update.rs
index 21e37d1907b..f5e0c62a07d 100644
--- a/crates/router/src/core/payments/operations/payment_update.rs
+++ b/crates/router/src/core/payments/operations/payment_update.rs
@@ -17,6 +17,7 @@ use crate::{
types::{
api::{self, PaymentIdTypeExt},
storage::{self, enums},
+ transformers::ForeignInto,
},
utils::{OptionExt, StringExt},
};
@@ -147,8 +148,8 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa
token,
setup_mandate,
address: PaymentAddress {
- shipping: shipping_address.as_ref().map(|a| a.into()),
- billing: billing_address.as_ref().map(|a| a.into()),
+ shipping: shipping_address.as_ref().map(|a| a.foreign_into()),
+ billing: billing_address.as_ref().map(|a| a.foreign_into()),
},
confirm: request.confirm,
payment_method_data: request.payment_method_data.clone(),
diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs
index 2e98a615dde..3daf214769b 100644
--- a/crates/router/src/core/payments/transformers.rs
+++ b/crates/router/src/core/payments/transformers.rs
@@ -16,6 +16,7 @@ use crate::{
self,
api::{self, NextAction, PaymentsResponse},
storage::{self, enums},
+ transformers::ForeignInto,
},
utils::{OptionExt, ValueExt},
};
@@ -196,7 +197,10 @@ where
.as_ref()
.and_then(|cus| cus.phone.as_ref().map(|s| s.to_owned())),
mandate_id: data.mandate_id,
- payment_method: data.payment_attempt.payment_method.map(Into::into),
+ payment_method: data
+ .payment_attempt
+ .payment_method
+ .map(ForeignInto::foreign_into),
payment_method_data: data
.payment_method_data
.map(api::PaymentMethodDataResponse::from),
@@ -237,7 +241,7 @@ where
let refunds_response = if refunds.is_empty() {
None
} else {
- Some(refunds.into_iter().map(From::from).collect())
+ Some(refunds.into_iter().map(ForeignInto::foreign_into).collect())
};
Ok(match payment_request {
@@ -265,7 +269,7 @@ where
response
.set_payment_id(Some(payment_attempt.payment_id))
.set_merchant_id(Some(payment_attempt.merchant_id))
- .set_status(payment_intent.status.into())
+ .set_status(payment_intent.status.foreign_into())
.set_amount(payment_attempt.amount)
.set_amount_capturable(None)
.set_amount_received(payment_intent.amount_captured)
@@ -292,7 +296,9 @@ where
.set_description(payment_intent.description)
.set_refunds(refunds_response) // refunds.iter().map(refund_to_refund_response),
.set_payment_method(
- payment_attempt.payment_method.map(Into::into),
+ payment_attempt
+ .payment_method
+ .map(ForeignInto::foreign_into),
auth_flow == services::AuthFlow::Merchant,
)
.set_payment_method_data(
@@ -306,12 +312,22 @@ where
.set_next_action(next_action_response)
.set_return_url(payment_intent.return_url)
.set_authentication_type(
- payment_attempt.authentication_type.map(Into::into),
+ payment_attempt
+ .authentication_type
+ .map(ForeignInto::foreign_into),
)
.set_statement_descriptor_name(payment_intent.statement_descriptor_name)
.set_statement_descriptor_suffix(payment_intent.statement_descriptor_suffix)
- .set_setup_future_usage(payment_intent.setup_future_usage.map(Into::into))
- .set_capture_method(payment_attempt.capture_method.map(Into::into))
+ .set_setup_future_usage(
+ payment_intent
+ .setup_future_usage
+ .map(ForeignInto::foreign_into),
+ )
+ .set_capture_method(
+ payment_attempt
+ .capture_method
+ .map(ForeignInto::foreign_into),
+ )
.to_owned(),
)
}
@@ -319,7 +335,7 @@ where
None => services::BachResponse::Json(PaymentsResponse {
payment_id: Some(payment_attempt.payment_id),
merchant_id: Some(payment_attempt.merchant_id),
- status: payment_intent.status.into(),
+ status: payment_intent.status.foreign_into(),
amount: payment_attempt.amount,
amount_capturable: None,
amount_received: payment_intent.amount_captured,
@@ -329,8 +345,12 @@ where
customer_id: payment_intent.customer_id,
description: payment_intent.description,
refunds: refunds_response,
- payment_method: payment_attempt.payment_method.map(Into::into),
- capture_method: payment_attempt.capture_method.map(Into::into),
+ payment_method: payment_attempt
+ .payment_method
+ .map(ForeignInto::foreign_into),
+ capture_method: payment_attempt
+ .capture_method
+ .map(ForeignInto::foreign_into),
error_message: payment_attempt.error_message,
payment_method_data: payment_method_data.map(api::PaymentMethodDataResponse::from),
email: customer
diff --git a/crates/router/src/core/refunds.rs b/crates/router/src/core/refunds.rs
index fc2e4937ada..f61de78d2af 100644
--- a/crates/router/src/core/refunds.rs
+++ b/crates/router/src/core/refunds.rs
@@ -16,7 +16,8 @@ use crate::{
types::{
self,
api::{self, refunds},
- storage::{self, enums},
+ storage::{self, enums, ProcessTrackerExt},
+ transformers::{Foreign, ForeignInto},
},
utils::{self, OptionExt},
};
@@ -172,10 +173,10 @@ pub async fn refund_response_wrapper<'a, F, Fut, T>(
where
F: Fn(&'a AppState, storage::MerchantAccount, String) -> Fut,
Fut: futures::Future<Output = RouterResult<T>>,
- refunds::RefundResponse: From<T>,
+ T: ForeignInto<refunds::RefundResponse>,
{
Ok(services::BachResponse::Json(
- f(state, merchant_account, refund_id).await?.into(),
+ f(state, merchant_account, refund_id).await?.foreign_into(),
))
}
@@ -327,7 +328,7 @@ pub async fn refund_update_core(
.await
.change_context(errors::ApiErrorResponse::InternalServerError)?;
- Ok(services::BachResponse::Json(response.into()))
+ Ok(services::BachResponse::Json(response.foreign_into()))
}
// ********************************************** VALIDATIONS **********************************************
@@ -442,7 +443,8 @@ pub async fn validate_and_create_refund(
.await?
}
};
- Ok(refund.into())
+
+ Ok(refund.foreign_into())
}
// ********************************************** UTILS **********************************************
@@ -493,7 +495,7 @@ impl<F> TryFrom<types::RefundsRouterData<F>> for refunds::RefundResponse {
let response = data.response;
let (status, error_message) = match response {
- Ok(response) => (response.refund_status.into(), None),
+ Ok(response) => (response.refund_status.foreign_into(), None),
Err(error_response) => (api::RefundStatus::Pending, Some(error_response.message)),
};
@@ -510,18 +512,20 @@ impl<F> TryFrom<types::RefundsRouterData<F>> for refunds::RefundResponse {
}
}
-impl From<storage::Refund> for api::RefundResponse {
- fn from(refund: storage::Refund) -> Self {
- Self {
+impl From<Foreign<storage::Refund>> for Foreign<api::RefundResponse> {
+ fn from(refund: Foreign<storage::Refund>) -> Self {
+ let refund = refund.0;
+ api::RefundResponse {
payment_id: refund.payment_id,
refund_id: refund.refund_id,
amount: refund.refund_amount,
currency: refund.currency.to_string(),
reason: refund.description,
- status: refund.refund_status.into(),
+ status: refund.refund_status.foreign_into(),
metadata: refund.metadata,
error_message: refund.refund_error_message,
}
+ .into()
}
}
diff --git a/crates/router/src/core/refunds/validator.rs b/crates/router/src/core/refunds/validator.rs
index 056a4ef058a..e47591658fb 100644
--- a/crates/router/src/core/refunds/validator.rs
+++ b/crates/router/src/core/refunds/validator.rs
@@ -102,12 +102,16 @@ pub async fn validate_uniqueness_of_refund_id_against_merchant_id(
.await;
logger::debug!(?refund);
match refund {
- Err(err) => match err.current_context() {
- // Empty vec should be returned by query in case of no results, this check exists just
- // to be on the safer side. Fixed this, now vector is not returned but should check the flow in detail later.
- errors::StorageError::DatabaseError(errors::DatabaseError::NotFound) => Ok(None),
- _ => Err(err.change_context(errors::ApiErrorResponse::InternalServerError)),
- },
+ Err(err) => {
+ if err.current_context().is_db_not_found() {
+ // Empty vec should be returned by query in case of no results, this check exists just
+ // to be on the safer side. Fixed this, now vector is not returned but should check the flow in detail later.
+ Ok(None)
+ } else {
+ Err(err.change_context(errors::ApiErrorResponse::InternalServerError))
+ }
+ }
+
Ok(refund) => {
if refund.payment_id == payment_id {
Ok(Some(refund))
diff --git a/crates/router/src/core/webhooks.rs b/crates/router/src/core/webhooks.rs
index 5dff3598036..d581b848a19 100644
--- a/crates/router/src/core/webhooks.rs
+++ b/crates/router/src/core/webhooks.rs
@@ -18,6 +18,7 @@ use crate::{
types::{
api,
storage::{self, enums},
+ transformers::{ForeignInto, ForeignTryInto},
},
utils::{generate_id, Encode, OptionExt, ValueExt},
};
@@ -66,7 +67,7 @@ async fn payments_incoming_webhook_flow(
let event_type: enums::EventType = payments_response
.status
- .try_into()
+ .foreign_try_into()
.into_report()
.change_context(errors::WebhooksFlowError::PaymentsCoreFailed)?;
@@ -123,7 +124,7 @@ async fn create_event_and_trigger_outgoing_webhook(
let outgoing_webhook = api::OutgoingWebhook {
merchant_id: merchant_account.merchant_id.clone(),
event_id: event.event_id,
- event_type: event.event_type.into(),
+ event_type: event.event_type.foreign_into(),
content,
timestamp: event.created_at,
};
diff --git a/crates/router/src/db/address.rs b/crates/router/src/db/address.rs
index 522ac70a994..bfed05381e6 100644
--- a/crates/router/src/db/address.rs
+++ b/crates/router/src/db/address.rs
@@ -1,3 +1,5 @@
+use error_stack::IntoReport;
+
use super::MockDb;
use crate::{
connection::pg_connection,
@@ -24,7 +26,10 @@ pub trait AddressInterface {
impl AddressInterface for super::Store {
async fn find_address(&self, address_id: &str) -> CustomResult<Address, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Address::find_by_address_id(&conn, address_id).await
+ Address::find_by_address_id(&conn, address_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_address(
@@ -33,7 +38,10 @@ impl AddressInterface for super::Store {
address: AddressUpdate,
) -> CustomResult<Address, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Address::update_by_address_id(&conn, address_id, address).await
+ Address::update_by_address_id(&conn, address_id, address)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn insert_address(
@@ -41,7 +49,11 @@ impl AddressInterface for super::Store {
address: AddressNew,
) -> CustomResult<Address, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- address.insert(&conn).await
+ address
+ .insert(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
diff --git a/crates/router/src/db/configs.rs b/crates/router/src/db/configs.rs
index 99d95ce0b72..2d94d508467 100644
--- a/crates/router/src/db/configs.rs
+++ b/crates/router/src/db/configs.rs
@@ -1,3 +1,5 @@
+use error_stack::IntoReport;
+
use super::MockDb;
use crate::{
connection::pg_connection,
@@ -20,12 +22,15 @@ pub trait ConfigInterface {
impl ConfigInterface for super::Store {
async fn insert_config(&self, config: ConfigNew) -> CustomResult<Config, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- config.insert(&conn).await
+ config.insert(&conn).await.map_err(Into::into).into_report()
}
async fn find_config_by_key(&self, key: &str) -> CustomResult<Config, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Config::find_by_key(&conn, key).await
+ Config::find_by_key(&conn, key)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_config_by_key(
@@ -34,7 +39,10 @@ impl ConfigInterface for super::Store {
config_update: ConfigUpdate,
) -> CustomResult<Config, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Config::update_by_key(&conn, key, config_update).await
+ Config::update_by_key(&conn, key, config_update)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
diff --git a/crates/router/src/db/connector_response.rs b/crates/router/src/db/connector_response.rs
index cc68e2b9ad0..b101c5c3fb7 100644
--- a/crates/router/src/db/connector_response.rs
+++ b/crates/router/src/db/connector_response.rs
@@ -1,3 +1,5 @@
+use error_stack::IntoReport;
+
use super::MockDb;
use crate::{
connection::pg_connection,
@@ -37,7 +39,11 @@ impl ConnectorResponseInterface for super::Store {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<ConnectorResponse, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- connector_response.insert(&conn).await
+ connector_response
+ .insert(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_connector_response_by_payment_id_merchant_id_txn_id(
@@ -55,6 +61,8 @@ impl ConnectorResponseInterface for super::Store {
txn_id,
)
.await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_connector_response(
@@ -64,7 +72,10 @@ impl ConnectorResponseInterface for super::Store {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<ConnectorResponse, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, connector_response_update).await
+ this.update(&conn, connector_response_update)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
diff --git a/crates/router/src/db/customers.rs b/crates/router/src/db/customers.rs
index 7bcfd969aa6..dacabafa480 100644
--- a/crates/router/src/db/customers.rs
+++ b/crates/router/src/db/customers.rs
@@ -1,3 +1,5 @@
+use error_stack::IntoReport;
+
use super::MockDb;
use crate::{
connection::pg_connection,
@@ -46,7 +48,10 @@ impl CustomerInterface for super::Store {
merchant_id: &str,
) -> CustomResult<Option<Customer>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Customer::find_optional_by_customer_id_merchant_id(&conn, customer_id, merchant_id).await
+ Customer::find_optional_by_customer_id_merchant_id(&conn, customer_id, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_customer_by_customer_id_merchant_id(
@@ -56,7 +61,10 @@ impl CustomerInterface for super::Store {
customer: CustomerUpdate,
) -> CustomResult<Customer, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Customer::update_by_customer_id_merchant_id(&conn, customer_id, merchant_id, customer).await
+ Customer::update_by_customer_id_merchant_id(&conn, customer_id, merchant_id, customer)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_customer_by_customer_id_merchant_id(
@@ -65,7 +73,10 @@ impl CustomerInterface for super::Store {
merchant_id: &str,
) -> CustomResult<Customer, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Customer::find_by_customer_id_merchant_id(&conn, customer_id, merchant_id).await
+ Customer::find_by_customer_id_merchant_id(&conn, customer_id, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn insert_customer(
@@ -73,7 +84,11 @@ impl CustomerInterface for super::Store {
customer_data: CustomerNew,
) -> CustomResult<Customer, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- customer_data.insert_diesel(&conn).await
+ customer_data
+ .insert_diesel(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn delete_customer_by_customer_id_merchant_id(
@@ -82,7 +97,10 @@ impl CustomerInterface for super::Store {
merchant_id: &str,
) -> CustomResult<bool, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Customer::delete_by_customer_id_merchant_id(&conn, customer_id, merchant_id).await
+ Customer::delete_by_customer_id_merchant_id(&conn, customer_id, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
diff --git a/crates/router/src/db/events.rs b/crates/router/src/db/events.rs
index f78b6b12dbe..6ae0e922092 100644
--- a/crates/router/src/db/events.rs
+++ b/crates/router/src/db/events.rs
@@ -1,3 +1,5 @@
+use error_stack::IntoReport;
+
use super::MockDb;
use crate::{
connection::pg_connection,
@@ -14,7 +16,7 @@ pub trait EventInterface {
impl EventInterface for super::Store {
async fn insert_event(&self, event: EventNew) -> CustomResult<Event, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- event.insert(&conn).await
+ event.insert(&conn).await.map_err(Into::into).into_report()
}
}
diff --git a/crates/router/src/db/locker_mock_up.rs b/crates/router/src/db/locker_mock_up.rs
index 01fdaf04830..24c2b8d4780 100644
--- a/crates/router/src/db/locker_mock_up.rs
+++ b/crates/router/src/db/locker_mock_up.rs
@@ -1,3 +1,5 @@
+use error_stack::IntoReport;
+
use super::MockDb;
use crate::{
connection::pg_connection,
@@ -25,7 +27,10 @@ impl LockerMockUpInterface for super::Store {
card_id: &str,
) -> CustomResult<LockerMockUp, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- LockerMockUp::find_by_card_id(&conn, card_id).await
+ LockerMockUp::find_by_card_id(&conn, card_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn insert_locker_mock_up(
@@ -33,7 +38,7 @@ impl LockerMockUpInterface for super::Store {
new: LockerMockUpNew,
) -> CustomResult<LockerMockUp, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- new.insert(&conn).await
+ new.insert(&conn).await.map_err(Into::into).into_report()
}
}
diff --git a/crates/router/src/db/mandate.rs b/crates/router/src/db/mandate.rs
index d5e25b84bbb..ee970425d24 100644
--- a/crates/router/src/db/mandate.rs
+++ b/crates/router/src/db/mandate.rs
@@ -1,3 +1,5 @@
+use error_stack::IntoReport;
+
use super::MockDb;
use crate::{
connection::pg_connection,
@@ -40,7 +42,10 @@ impl MandateInterface for super::Store {
mandate_id: &str,
) -> CustomResult<Mandate, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Mandate::find_by_merchant_id_mandate_id(&conn, merchant_id, mandate_id).await
+ Mandate::find_by_merchant_id_mandate_id(&conn, merchant_id, mandate_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_mandate_by_merchant_id_customer_id(
@@ -49,7 +54,10 @@ impl MandateInterface for super::Store {
customer_id: &str,
) -> CustomResult<Vec<Mandate>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Mandate::find_by_merchant_id_customer_id(&conn, merchant_id, customer_id).await
+ Mandate::find_by_merchant_id_customer_id(&conn, merchant_id, customer_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_mandate_by_merchant_id_mandate_id(
@@ -59,7 +67,10 @@ impl MandateInterface for super::Store {
mandate: MandateUpdate,
) -> CustomResult<Mandate, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Mandate::update_by_merchant_id_mandate_id(&conn, merchant_id, mandate_id, mandate).await
+ Mandate::update_by_merchant_id_mandate_id(&conn, merchant_id, mandate_id, mandate)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn insert_mandate(
@@ -67,7 +78,11 @@ impl MandateInterface for super::Store {
mandate: MandateNew,
) -> CustomResult<Mandate, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- mandate.insert(&conn).await
+ mandate
+ .insert(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
diff --git a/crates/router/src/db/merchant_account.rs b/crates/router/src/db/merchant_account.rs
index 435e9e88c30..84b3efeecad 100644
--- a/crates/router/src/db/merchant_account.rs
+++ b/crates/router/src/db/merchant_account.rs
@@ -1,10 +1,10 @@
-use error_stack::Report;
+use error_stack::{IntoReport, Report};
use masking::PeekInterface;
use super::MockDb;
use crate::{
connection::pg_connection,
- core::errors::{self, CustomResult, DatabaseError, StorageError},
+ core::errors::{self, CustomResult},
types::storage::{enums, MerchantAccount, MerchantAccountNew, MerchantAccountUpdate},
};
@@ -49,7 +49,11 @@ impl MerchantAccountInterface for super::Store {
merchant_account: MerchantAccountNew,
) -> CustomResult<MerchantAccount, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- merchant_account.insert_diesel(&conn).await
+ merchant_account
+ .insert_diesel(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_merchant_account_by_merchant_id(
@@ -57,7 +61,10 @@ impl MerchantAccountInterface for super::Store {
merchant_id: &str,
) -> CustomResult<MerchantAccount, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- MerchantAccount::find_by_merchant_id(&conn, merchant_id).await
+ MerchantAccount::find_by_merchant_id(&conn, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_merchant(
@@ -66,7 +73,10 @@ impl MerchantAccountInterface for super::Store {
merchant_account: MerchantAccountUpdate,
) -> CustomResult<MerchantAccount, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, merchant_account).await
+ this.update(&conn, merchant_account)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_merchant_account_by_api_key(
@@ -74,7 +84,10 @@ impl MerchantAccountInterface for super::Store {
api_key: &str,
) -> CustomResult<MerchantAccount, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- MerchantAccount::find_by_api_key(&conn, api_key).await
+ MerchantAccount::find_by_api_key(&conn, api_key)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_merchant_account_by_publishable_key(
@@ -82,7 +95,10 @@ impl MerchantAccountInterface for super::Store {
publishable_key: &str,
) -> CustomResult<MerchantAccount, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- MerchantAccount::find_by_publishable_key(&conn, publishable_key).await
+ MerchantAccount::find_by_publishable_key(&conn, publishable_key)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn delete_merchant_account_by_merchant_id(
@@ -90,7 +106,10 @@ impl MerchantAccountInterface for super::Store {
merchant_id: &str,
) -> CustomResult<bool, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- MerchantAccount::delete_by_merchant_id(&conn, merchant_id).await
+ MerchantAccount::delete_by_merchant_id(&conn, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
@@ -163,7 +182,8 @@ impl MerchantAccountInterface for MockDb {
.iter()
.find(|account| account.api_key.as_ref().map(|s| s.peek()) == Some(&api_key.into()))
.cloned()
- .ok_or_else(|| Report::from(StorageError::DatabaseError(DatabaseError::NotFound)))
+ .ok_or_else(|| Report::from(storage_models::errors::DatabaseError::NotFound).into())
+ .into_report()
}
async fn find_merchant_account_by_publishable_key(
diff --git a/crates/router/src/db/merchant_connector_account.rs b/crates/router/src/db/merchant_connector_account.rs
index 548f705c623..022bb3107b2 100644
--- a/crates/router/src/db/merchant_connector_account.rs
+++ b/crates/router/src/db/merchant_connector_account.rs
@@ -1,3 +1,4 @@
+use error_stack::IntoReport;
use masking::ExposeInterface;
use super::MockDb;
@@ -54,7 +55,10 @@ impl MerchantConnectorAccountInterface for super::Store {
connector: &str,
) -> CustomResult<MerchantConnectorAccount, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- MerchantConnectorAccount::find_by_merchant_id_connector(&conn, merchant_id, connector).await
+ MerchantConnectorAccount::find_by_merchant_id_connector(&conn, merchant_id, connector)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_by_merchant_connector_account_merchant_id_merchant_connector_id(
@@ -69,6 +73,8 @@ impl MerchantConnectorAccountInterface for super::Store {
merchant_connector_id,
)
.await
+ .map_err(Into::into)
+ .into_report()
}
async fn insert_merchant_connector_account(
@@ -76,7 +82,10 @@ impl MerchantConnectorAccountInterface for super::Store {
t: MerchantConnectorAccountNew,
) -> CustomResult<MerchantConnectorAccount, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- t.insert_diesel(&conn).await
+ t.insert_diesel(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_merchant_connector_account_by_merchant_id_list(
@@ -84,7 +93,10 @@ impl MerchantConnectorAccountInterface for super::Store {
merchant_id: &str,
) -> CustomResult<Vec<MerchantConnectorAccount>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- MerchantConnectorAccount::find_by_merchant_id(&conn, merchant_id).await
+ MerchantConnectorAccount::find_by_merchant_id(&conn, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_merchant_connector_account(
@@ -93,7 +105,10 @@ impl MerchantConnectorAccountInterface for super::Store {
merchant_connector_account: MerchantConnectorAccountUpdate,
) -> CustomResult<MerchantConnectorAccount, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, merchant_connector_account).await
+ this.update(&conn, merchant_connector_account)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn delete_merchant_connector_account_by_merchant_id_merchant_connector_id(
@@ -108,6 +123,8 @@ impl MerchantConnectorAccountInterface for super::Store {
merchant_connector_id,
)
.await
+ .map_err(Into::into)
+ .into_report()
}
}
diff --git a/crates/router/src/db/payment_attempt.rs b/crates/router/src/db/payment_attempt.rs
index 7eb1ccc0d8a..77af845d07f 100644
--- a/crates/router/src/db/payment_attempt.rs
+++ b/crates/router/src/db/payment_attempt.rs
@@ -58,6 +58,8 @@ pub trait PaymentAttemptInterface {
#[cfg(not(feature = "kv_store"))]
mod storage {
+ use error_stack::IntoReport;
+
use super::PaymentAttemptInterface;
use crate::{
connection::pg_connection,
@@ -74,7 +76,11 @@ mod storage {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<PaymentAttempt, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- payment_attempt.insert_diesel(&conn).await
+ payment_attempt
+ .insert_diesel(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_payment_attempt(
@@ -84,7 +90,10 @@ mod storage {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<PaymentAttempt, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, payment_attempt).await
+ this.update(&conn, payment_attempt)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_payment_attempt_by_payment_id_merchant_id(
@@ -94,7 +103,10 @@ mod storage {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<PaymentAttempt, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- PaymentAttempt::find_by_payment_id_merchant_id(&conn, payment_id, merchant_id).await
+ PaymentAttempt::find_by_payment_id_merchant_id(&conn, payment_id, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_payment_attempt_by_transaction_id_payment_id_merchant_id(
@@ -112,6 +124,8 @@ mod storage {
merchant_id,
)
.await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_payment_attempt_last_successful_attempt_by_payment_id_merchant_id(
@@ -127,6 +141,8 @@ mod storage {
merchant_id,
)
.await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_payment_attempt_by_merchant_id_connector_txn_id(
@@ -144,6 +160,8 @@ mod storage {
connector_txn_id,
)
.await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_payment_attempt_by_merchant_id_txn_id(
@@ -154,7 +172,10 @@ mod storage {
) -> CustomResult<PaymentAttempt, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- PaymentAttempt::find_by_merchant_id_transaction_id(&conn, merchant_id, txn_id).await
+ PaymentAttempt::find_by_merchant_id_transaction_id(&conn, merchant_id, txn_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
}
@@ -305,7 +326,11 @@ mod storage {
match storage_scheme {
enums::MerchantStorageScheme::PostgresOnly => {
let conn = pg_connection(&self.master_pool).await;
- payment_attempt.insert_diesel(&conn).await
+ payment_attempt
+ .insert_diesel(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
enums::MerchantStorageScheme::RedisKv => {
@@ -394,7 +419,10 @@ mod storage {
match storage_scheme {
enums::MerchantStorageScheme::PostgresOnly => {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, payment_attempt).await
+ this.update(&conn, payment_attempt)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
enums::MerchantStorageScheme::RedisKv => {
@@ -445,6 +473,8 @@ mod storage {
let conn = pg_connection(&self.master_pool).await;
PaymentAttempt::find_by_payment_id_merchant_id(&conn, payment_id, merchant_id)
.await
+ .map_err(Into::into)
+ .into_report()
}
enums::MerchantStorageScheme::RedisKv => {
@@ -534,6 +564,8 @@ mod storage {
connector_txn_id,
)
.await
+ .map_err(Into::into)
+ .into_report()
}
enums::MerchantStorageScheme::RedisKv => {
@@ -553,6 +585,8 @@ mod storage {
let conn = pg_connection(&self.master_pool).await;
PaymentAttempt::find_by_merchant_id_transaction_id(&conn, merchant_id, txn_id)
.await
+ .map_err(Into::into)
+ .into_report()
}
enums::MerchantStorageScheme::RedisKv => {
diff --git a/crates/router/src/db/payment_intent.rs b/crates/router/src/db/payment_intent.rs
index 3337dc40ab0..fe2623b9d84 100644
--- a/crates/router/src/db/payment_intent.rs
+++ b/crates/router/src/db/payment_intent.rs
@@ -65,7 +65,10 @@ mod storage {
match storage_scheme {
enums::MerchantStorageScheme::PostgresOnly => {
let conn = pg_connection(&self.master_pool).await;
- new.insert_diesel(&conn).await
+ new.insert_diesel(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
enums::MerchantStorageScheme::RedisKv => {
@@ -142,7 +145,10 @@ mod storage {
match storage_scheme {
enums::MerchantStorageScheme::PostgresOnly => {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, payment_intent).await
+ this.update(&conn, payment_intent)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
enums::MerchantStorageScheme::RedisKv => {
@@ -193,6 +199,8 @@ mod storage {
let conn = pg_connection(&self.master_pool).await;
PaymentIntent::find_by_payment_id_merchant_id(&conn, payment_id, merchant_id)
.await
+ .map_err(Into::into)
+ .into_report()
}
enums::MerchantStorageScheme::RedisKv => {
@@ -225,7 +233,10 @@ mod storage {
match storage_scheme {
enums::MerchantStorageScheme::PostgresOnly => {
let conn = pg_connection(&self.master_pool).await;
- PaymentIntent::filter_by_constraints(&conn, merchant_id, pc).await
+ PaymentIntent::filter_by_constraints(&conn, merchant_id, pc)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
enums::MerchantStorageScheme::RedisKv => {
@@ -239,6 +250,8 @@ mod storage {
#[cfg(not(feature = "kv_store"))]
mod storage {
+ use error_stack::IntoReport;
+
use super::PaymentIntentInterface;
use crate::{
connection::pg_connection,
@@ -258,7 +271,10 @@ mod storage {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<PaymentIntent, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- new.insert_diesel(&conn).await
+ new.insert_diesel(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_payment_intent(
@@ -268,7 +284,10 @@ mod storage {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<PaymentIntent, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, payment_intent).await
+ this.update(&conn, payment_intent)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_payment_intent_by_payment_id_merchant_id(
@@ -278,7 +297,10 @@ mod storage {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<PaymentIntent, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- PaymentIntent::find_by_payment_id_merchant_id(&conn, payment_id, merchant_id).await
+ PaymentIntent::find_by_payment_id_merchant_id(&conn, payment_id, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn filter_payment_intent_by_constraints(
@@ -288,7 +310,10 @@ mod storage {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<Vec<PaymentIntent>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- PaymentIntent::filter_by_constraints(&conn, merchant_id, pc).await
+ PaymentIntent::filter_by_constraints(&conn, merchant_id, pc)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
}
diff --git a/crates/router/src/db/payment_method.rs b/crates/router/src/db/payment_method.rs
index 4df25ff7071..4752c88f4e1 100644
--- a/crates/router/src/db/payment_method.rs
+++ b/crates/router/src/db/payment_method.rs
@@ -1,3 +1,5 @@
+use error_stack::IntoReport;
+
use super::MockDb;
use crate::{
connection::pg_connection,
@@ -37,7 +39,10 @@ impl PaymentMethodInterface for super::Store {
payment_method_id: &str,
) -> CustomResult<PaymentMethod, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- PaymentMethod::find_by_payment_method_id(&conn, payment_method_id).await
+ PaymentMethod::find_by_payment_method_id(&conn, payment_method_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn insert_payment_method(
@@ -45,7 +50,7 @@ impl PaymentMethodInterface for super::Store {
m: PaymentMethodNew,
) -> CustomResult<PaymentMethod, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- m.insert(&conn).await
+ m.insert(&conn).await.map_err(Into::into).into_report()
}
async fn find_payment_method_by_customer_id_merchant_id_list(
@@ -54,7 +59,10 @@ impl PaymentMethodInterface for super::Store {
merchant_id: &str,
) -> CustomResult<Vec<PaymentMethod>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- PaymentMethod::find_by_customer_id_merchant_id(&conn, customer_id, merchant_id).await
+ PaymentMethod::find_by_customer_id_merchant_id(&conn, customer_id, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn delete_payment_method_by_merchant_id_payment_method_id(
@@ -69,6 +77,8 @@ impl PaymentMethodInterface for super::Store {
payment_method_id,
)
.await
+ .map_err(Into::into)
+ .into_report()
}
}
diff --git a/crates/router/src/db/process_tracker.rs b/crates/router/src/db/process_tracker.rs
index cb4cda90643..ae52177db03 100644
--- a/crates/router/src/db/process_tracker.rs
+++ b/crates/router/src/db/process_tracker.rs
@@ -1,3 +1,4 @@
+use error_stack::IntoReport;
use time::PrimitiveDateTime;
use super::MockDb;
@@ -58,7 +59,10 @@ impl ProcessTrackerInterface for super::Store {
id: &str,
) -> CustomResult<Option<ProcessTracker>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- ProcessTracker::find_process_by_id(&conn, id).await
+ ProcessTracker::find_process_by_id(&conn, id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn reinitialize_limbo_processes(
@@ -67,7 +71,10 @@ impl ProcessTrackerInterface for super::Store {
schedule_time: PrimitiveDateTime,
) -> CustomResult<usize, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- ProcessTracker::reinitialize_limbo_processes(&conn, ids, schedule_time).await
+ ProcessTracker::reinitialize_limbo_processes(&conn, ids, schedule_time)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_processes_by_time_status(
@@ -86,6 +93,8 @@ impl ProcessTrackerInterface for super::Store {
limit,
)
.await
+ .map_err(Into::into)
+ .into_report()
}
async fn insert_process(
@@ -93,7 +102,10 @@ impl ProcessTrackerInterface for super::Store {
new: ProcessTrackerNew,
) -> CustomResult<ProcessTracker, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- new.insert_process(&conn).await
+ new.insert_process(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_process(
@@ -102,7 +114,10 @@ impl ProcessTrackerInterface for super::Store {
process: ProcessTrackerUpdate,
) -> CustomResult<ProcessTracker, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, process).await
+ this.update(&conn, process)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_process_tracker(
@@ -111,7 +126,10 @@ impl ProcessTrackerInterface for super::Store {
process: ProcessTrackerUpdate,
) -> CustomResult<ProcessTracker, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, process).await
+ this.update(&conn, process)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn process_tracker_update_process_status_by_ids(
@@ -120,7 +138,10 @@ impl ProcessTrackerInterface for super::Store {
task_update: ProcessTrackerUpdate,
) -> CustomResult<Vec<ProcessTracker>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- ProcessTracker::update_process_status_by_ids(&conn, task_ids, task_update).await
+ ProcessTracker::update_process_status_by_ids(&conn, task_ids, task_update)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
diff --git a/crates/router/src/db/refund.rs b/crates/router/src/db/refund.rs
index d1659caf339..2c34d0744b7 100644
--- a/crates/router/src/db/refund.rs
+++ b/crates/router/src/db/refund.rs
@@ -1,9 +1,10 @@
-use error_stack::Report;
+use error_stack::{IntoReport, Report};
+use storage_models::errors::DatabaseError;
use super::MockDb;
use crate::{
connection::pg_connection,
- core::errors::{self, CustomResult, DatabaseError, StorageError},
+ core::errors::{self, CustomResult, StorageError},
types::storage::{enums, Refund, RefundNew, RefundUpdate},
};
@@ -69,6 +70,8 @@ impl RefundInterface for super::Store {
let conn = pg_connection(&self.master_pool).await;
Refund::find_by_internal_reference_id_merchant_id(&conn, internal_reference_id, merchant_id)
.await
+ .map_err(Into::into)
+ .into_report()
}
async fn insert_refund(
@@ -77,7 +80,7 @@ impl RefundInterface for super::Store {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<Refund, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- new.insert(&conn).await
+ new.insert(&conn).await.map_err(Into::into).into_report()
}
async fn find_refund_by_merchant_id_transaction_id(
&self,
@@ -86,7 +89,10 @@ impl RefundInterface for super::Store {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<Vec<Refund>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Refund::find_by_merchant_id_transaction_id(&conn, merchant_id, txn_id).await
+ Refund::find_by_merchant_id_transaction_id(&conn, merchant_id, txn_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn update_refund(
@@ -96,7 +102,10 @@ impl RefundInterface for super::Store {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<Refund, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- this.update(&conn, refund).await
+ this.update(&conn, refund)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_refund_by_merchant_id_refund_id(
@@ -106,7 +115,10 @@ impl RefundInterface for super::Store {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<Refund, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Refund::find_by_merchant_id_refund_id(&conn, merchant_id, refund_id).await
+ Refund::find_by_merchant_id_refund_id(&conn, merchant_id, refund_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
// async fn find_refund_by_payment_id_merchant_id_refund_id(
@@ -127,7 +139,10 @@ impl RefundInterface for super::Store {
_storage_scheme: enums::MerchantStorageScheme,
) -> CustomResult<Vec<Refund>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- Refund::find_by_payment_id_merchant_id(&conn, payment_id, merchant_id).await
+ Refund::find_by_payment_id_merchant_id(&conn, payment_id, merchant_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
@@ -214,7 +229,11 @@ impl RefundInterface for MockDb {
.iter()
.find(|refund| refund.merchant_id == merchant_id && refund.refund_id == refund_id)
.cloned()
- .ok_or_else(|| Report::from(StorageError::DatabaseError(DatabaseError::NotFound)))
+ .ok_or_else(|| {
+ Report::from(StorageError::DatabaseError(Report::from(
+ DatabaseError::NotFound,
+ )))
+ })
}
async fn find_refund_by_payment_id_merchant_id(
diff --git a/crates/router/src/db/temp_card.rs b/crates/router/src/db/temp_card.rs
index e5e6849a025..b39eadd74b1 100644
--- a/crates/router/src/db/temp_card.rs
+++ b/crates/router/src/db/temp_card.rs
@@ -1,3 +1,5 @@
+use error_stack::IntoReport;
+
use super::MockDb;
use crate::{
connection::pg_connection,
@@ -35,7 +37,11 @@ impl TempCardInterface for super::Store {
address: TempCardNew,
) -> CustomResult<TempCard, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- address.insert_diesel(&conn).await
+ address
+ .insert_diesel(&conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_tempcard_by_transaction_id(
@@ -43,7 +49,10 @@ impl TempCardInterface for super::Store {
transaction_id: &str,
) -> CustomResult<Option<TempCard>, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- TempCard::find_by_transaction_id(&conn, transaction_id).await
+ TempCard::find_by_transaction_id(&conn, transaction_id)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn insert_tempcard_with_token(
@@ -51,7 +60,10 @@ impl TempCardInterface for super::Store {
card: TempCard,
) -> CustomResult<TempCard, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- TempCard::insert_with_token(card, &conn).await
+ TempCard::insert_with_token(card, &conn)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
async fn find_tempcard_by_token(
@@ -59,7 +71,10 @@ impl TempCardInterface for super::Store {
token: &i32,
) -> CustomResult<TempCard, errors::StorageError> {
let conn = pg_connection(&self.master_pool).await;
- TempCard::find_by_token(&conn, token).await
+ TempCard::find_by_token(&conn, token)
+ .await
+ .map_err(Into::into)
+ .into_report()
}
}
diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs
index 06afd4d62e9..de83d4e94ff 100644
--- a/crates/router/src/lib.rs
+++ b/crates/router/src/lib.rs
@@ -31,8 +31,6 @@ pub(crate) mod macros;
pub mod routes;
pub mod scheduler;
-#[allow(unused_imports)] // Allow unused imports only for schema module
-pub mod schema;
pub mod services;
pub mod types;
pub mod utils;
@@ -64,7 +62,7 @@ pub mod headers {
pub mod pii {
//! Personal Identifiable Information protection.
- pub(crate) use common_utils::pii::{CardNumber, Email, IpAddress};
+ pub(crate) use common_utils::pii::{CardNumber, Email};
#[doc(inline)]
pub use masking::*;
}
diff --git a/crates/router/src/scheduler/consumer.rs b/crates/router/src/scheduler/consumer.rs
index 9db54dae04b..92cf5723569 100644
--- a/crates/router/src/scheduler/consumer.rs
+++ b/crates/router/src/scheduler/consumer.rs
@@ -23,7 +23,7 @@ use crate::{
logger::{error, info},
routes::AppState,
scheduler::utils as pt_utils,
- types::storage::{self, enums},
+ types::storage::{self, enums, ProcessTrackerExt},
};
// Valid consumer business statuses
diff --git a/crates/router/src/scheduler/workflows/payment_sync.rs b/crates/router/src/scheduler/workflows/payment_sync.rs
index 6566e40bb07..df8597797e8 100644
--- a/crates/router/src/scheduler/workflows/payment_sync.rs
+++ b/crates/router/src/scheduler/workflows/payment_sync.rs
@@ -9,7 +9,7 @@ use crate::{
scheduler::{consumer, process_data, utils},
types::{
api,
- storage::{self, enums},
+ storage::{self, enums, ProcessTrackerExt},
},
utils::{OptionExt, ValueExt},
};
diff --git a/crates/router/src/types/api/mandates.rs b/crates/router/src/types/api/mandates.rs
index d2b44126e22..f38b96e06fe 100644
--- a/crates/router/src/types/api/mandates.rs
+++ b/crates/router/src/types/api/mandates.rs
@@ -13,6 +13,7 @@ use crate::{
types::{
api,
storage::{self, enums as storage_enums},
+ transformers::ForeignInto,
},
};
@@ -67,7 +68,7 @@ impl MandateResponseExt for MandateResponse {
}),
}),
card,
- status: mandate.mandate_status.into(),
+ status: mandate.mandate_status.foreign_into(),
payment_method: payment_method.payment_method.to_string(),
payment_method_id: mandate.payment_method_id,
})
diff --git a/crates/router/src/types/api/payments.rs b/crates/router/src/types/api/payments.rs
index 4ddc554acad..695c8bb44c4 100644
--- a/crates/router/src/types/api/payments.rs
+++ b/crates/router/src/types/api/payments.rs
@@ -17,7 +17,10 @@ use time::PrimitiveDateTime;
use crate::{
core::errors,
services::api,
- types::{self, api as api_types},
+ types::{
+ self, api as api_types, storage,
+ transformers::{Foreign, ForeignInto},
+ },
};
pub(crate) trait PaymentsRequestExt {
@@ -109,12 +112,13 @@ impl MandateValidationFieldsExt for MandateValidationFields {
}
}
-impl From<types::storage::PaymentIntent> for PaymentsResponse {
- fn from(item: types::storage::PaymentIntent) -> Self {
+impl From<Foreign<storage::PaymentIntent>> for Foreign<PaymentsResponse> {
+ fn from(item: Foreign<storage::PaymentIntent>) -> Self {
+ let item = item.0;
payments::PaymentsResponse {
payment_id: Some(item.payment_id),
merchant_id: Some(item.merchant_id),
- status: item.status.into(),
+ status: item.status.foreign_into(),
amount: item.amount,
amount_capturable: item.amount_captured,
client_secret: item.client_secret.map(|s| s.into()),
@@ -123,8 +127,9 @@ impl From<types::storage::PaymentIntent> for PaymentsResponse {
description: item.description,
metadata: item.metadata,
customer_id: item.customer_id,
- ..Self::default()
+ ..Default::default()
}
+ .into()
}
}
diff --git a/crates/router/src/types/api/refunds.rs b/crates/router/src/types/api/refunds.rs
index 11104cc96d5..f1b6dad2ced 100644
--- a/crates/router/src/types/api/refunds.rs
+++ b/crates/router/src/types/api/refunds.rs
@@ -3,18 +3,19 @@ pub use api_models::refunds::{RefundRequest, RefundResponse, RefundStatus};
use super::ConnectorCommon;
use crate::{
services::api,
- types::{self, storage::enums as storage_enums},
+ types::{self, storage::enums as storage_enums, transformers::Foreign},
};
-impl From<storage_enums::RefundStatus> for RefundStatus {
- fn from(status: storage_enums::RefundStatus) -> Self {
- match status {
+impl From<Foreign<storage_enums::RefundStatus>> for Foreign<RefundStatus> {
+ fn from(status: Foreign<storage_enums::RefundStatus>) -> Self {
+ match status.0 {
storage_enums::RefundStatus::Failure
| storage_enums::RefundStatus::TransactionFailure => RefundStatus::Failed,
storage_enums::RefundStatus::ManualReview => RefundStatus::Review,
storage_enums::RefundStatus::Pending => RefundStatus::Pending,
storage_enums::RefundStatus::Success => RefundStatus::Succeeded,
}
+ .into()
}
}
diff --git a/crates/router/src/types/storage.rs b/crates/router/src/types/storage.rs
index af125e0390f..8f6a4fe4d95 100644
--- a/crates/router/src/types/storage.rs
+++ b/crates/router/src/types/storage.rs
@@ -18,71 +18,8 @@ mod query;
pub mod refund;
pub mod temp_card;
-use diesel_impl::{DieselArray, OptionalDieselArray};
-
pub use self::{
address::*, configs::*, connector_response::*, customers::*, events::*, locker_mock_up::*,
mandate::*, merchant_account::*, merchant_connector_account::*, payment_attempt::*,
payment_intent::*, payment_method::*, process_tracker::*, refund::*, temp_card::*,
};
-
-/// The types and implementations provided by this module are required for the schema generated by
-/// `diesel_cli` 2.0 to work with the types defined in Rust code. This is because
-/// [`diesel`][diesel] 2.0 [changed the nullability of array elements][diesel-2.0-array-nullability],
-/// which causes [`diesel`][diesel] to deserialize arrays as `Vec<Option<T>>`. To prevent declaring
-/// array elements as `Option<T>`, this module provides types and implementations to deserialize
-/// arrays as `Vec<T>`, considering only non-null values (`Some(T)`) among the deserialized
-/// `Option<T>` values.
-///
-/// [diesel-2.0-array-nullability]: https://diesel.rs/guides/migration_guide.html#2-0-0-nullability-of-array-elements
-
-#[doc(hidden)]
-pub(crate) mod diesel_impl {
- use diesel::{
- deserialize::FromSql,
- pg::Pg,
- sql_types::{Array, Nullable},
- Queryable,
- };
-
- pub struct DieselArray<T>(Vec<Option<T>>);
-
- impl<T> From<DieselArray<T>> for Vec<T> {
- fn from(array: DieselArray<T>) -> Self {
- array.0.into_iter().flatten().collect()
- }
- }
-
- impl<T, U> Queryable<Array<Nullable<U>>, Pg> for DieselArray<T>
- where
- T: FromSql<U, Pg>,
- Vec<Option<T>>: FromSql<Array<Nullable<U>>, Pg>,
- {
- type Row = Vec<Option<T>>;
-
- fn build(row: Self::Row) -> diesel::deserialize::Result<Self> {
- Ok(DieselArray(row))
- }
- }
-
- pub struct OptionalDieselArray<T>(Option<Vec<Option<T>>>);
-
- impl<T> From<OptionalDieselArray<T>> for Option<Vec<T>> {
- fn from(option_array: OptionalDieselArray<T>) -> Self {
- option_array
- .0
- .map(|array| array.into_iter().flatten().collect())
- }
- }
-
- impl<T, U> Queryable<Nullable<Array<Nullable<U>>>, Pg> for OptionalDieselArray<T>
- where
- Option<Vec<Option<T>>>: FromSql<Nullable<Array<Nullable<U>>>, Pg>,
- {
- type Row = Option<Vec<Option<T>>>;
-
- fn build(row: Self::Row) -> diesel::deserialize::Result<Self> {
- Ok(OptionalDieselArray(row))
- }
- }
-}
diff --git a/crates/router/src/types/storage/address.rs b/crates/router/src/types/storage/address.rs
index 2eb24884c98..8dd73237150 100644
--- a/crates/router/src/types/storage/address.rs
+++ b/crates/router/src/types/storage/address.rs
@@ -1,188 +1 @@
-use common_utils::custom_serde;
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-use masking::Secret;
-use serde::{Deserialize, Serialize};
-use time::{OffsetDateTime, PrimitiveDateTime};
-
-use crate::{consts, schema::address, types::api, utils::generate_id};
-
-#[derive(Clone, Debug, Deserialize, Serialize, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = address)]
-#[serde(deny_unknown_fields)]
-pub struct AddressNew {
- pub address_id: String,
- pub city: Option<String>,
- pub country: Option<String>,
- pub line1: Option<Secret<String>>,
- pub line2: Option<Secret<String>>,
- pub line3: Option<Secret<String>>,
- pub state: Option<Secret<String>>,
- pub zip: Option<Secret<String>>,
- pub first_name: Option<Secret<String>>,
- pub last_name: Option<Secret<String>>,
- pub phone_number: Option<Secret<String>>,
- pub country_code: Option<String>,
- pub customer_id: String,
- pub merchant_id: String,
-}
-
-#[derive(Clone, Debug, Deserialize, Serialize, Identifiable, Queryable)]
-#[diesel(table_name = address)]
-pub struct Address {
- #[serde(skip_serializing)]
- pub id: i32,
- #[serde(skip_serializing)]
- pub address_id: String,
- pub city: Option<String>,
- pub country: Option<String>,
- pub line1: Option<Secret<String>>,
- pub line2: Option<Secret<String>>,
- pub line3: Option<Secret<String>>,
- pub state: Option<Secret<String>>,
- pub zip: Option<Secret<String>>,
- pub first_name: Option<Secret<String>>,
- pub last_name: Option<Secret<String>>,
- pub phone_number: Option<Secret<String>>,
- pub country_code: Option<String>,
- #[serde(skip_serializing)]
- #[serde(with = "custom_serde::iso8601")]
- pub created_at: PrimitiveDateTime,
- #[serde(skip_serializing)]
- #[serde(with = "custom_serde::iso8601")]
- pub modified_at: PrimitiveDateTime,
- pub customer_id: String,
- pub merchant_id: String,
-}
-
-#[derive(Debug)]
-pub enum AddressUpdate {
- Update {
- city: Option<String>,
- country: Option<String>,
- line1: Option<Secret<String>>,
- line2: Option<Secret<String>>,
- line3: Option<Secret<String>>,
- state: Option<Secret<String>>,
- zip: Option<Secret<String>>,
- first_name: Option<Secret<String>>,
- last_name: Option<Secret<String>>,
- phone_number: Option<Secret<String>>,
- country_code: Option<String>,
- },
-}
-
-#[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)]
-#[diesel(table_name = address)]
-pub(super) struct AddressUpdateInternal {
- city: Option<String>,
- country: Option<String>,
- line1: Option<Secret<String>>,
- line2: Option<Secret<String>>,
- line3: Option<Secret<String>>,
- state: Option<Secret<String>>,
- zip: Option<Secret<String>>,
- first_name: Option<Secret<String>>,
- last_name: Option<Secret<String>>,
- phone_number: Option<Secret<String>>,
- country_code: Option<String>,
- modified_at: PrimitiveDateTime,
-}
-
-impl From<AddressUpdate> for AddressUpdateInternal {
- fn from(address_update: AddressUpdate) -> Self {
- match address_update {
- AddressUpdate::Update {
- city,
- country,
- line1,
- line2,
- line3,
- state,
- zip,
- first_name,
- last_name,
- phone_number,
- country_code,
- } => Self {
- city,
- country,
- line1,
- line2,
- line3,
- state,
- zip,
- first_name,
- last_name,
- phone_number,
- country_code,
- modified_at: convert_to_pdt(OffsetDateTime::now_utc()),
- },
- }
- }
-}
-
-// TODO: Create utils for this since cane be reused outside address
-fn convert_to_pdt(offset_time: OffsetDateTime) -> PrimitiveDateTime {
- PrimitiveDateTime::new(offset_time.date(), offset_time.time())
-}
-
-impl<'a> From<&'a api::Address> for AddressUpdate {
- fn from(address: &api::Address) -> Self {
- AddressUpdate::Update {
- city: address.address.as_ref().and_then(|a| a.city.clone()),
- country: address.address.as_ref().and_then(|a| a.country.clone()),
- line1: address.address.as_ref().and_then(|a| a.line1.clone()),
- line2: address.address.as_ref().and_then(|a| a.line2.clone()),
- line3: address.address.as_ref().and_then(|a| a.line3.clone()),
- state: address.address.as_ref().and_then(|a| a.state.clone()),
- zip: address.address.as_ref().and_then(|a| a.zip.clone()),
- first_name: address.address.as_ref().and_then(|a| a.first_name.clone()),
- last_name: address.address.as_ref().and_then(|a| a.last_name.clone()),
- phone_number: address.phone.as_ref().and_then(|a| a.number.clone()),
- country_code: address.phone.as_ref().and_then(|a| a.country_code.clone()),
- }
- }
-}
-
-impl<'a> From<&'a Address> for api::Address {
- fn from(address: &Address) -> Self {
- api::Address {
- address: Some(api::AddressDetails {
- city: address.city.clone(),
- country: address.country.clone(),
- line1: address.line1.clone(),
- line2: address.line2.clone(),
- line3: address.line3.clone(),
- state: address.state.clone(),
- zip: address.zip.clone(),
- first_name: address.first_name.clone(),
- last_name: address.last_name.clone(),
- }),
- phone: Some(api::PhoneDetails {
- number: address.phone_number.clone(),
- country_code: address.country_code.clone(),
- }),
- }
- }
-}
-
-impl Default for AddressNew {
- fn default() -> Self {
- Self {
- address_id: generate_id(consts::ID_LENGTH, "add"),
- city: None,
- country: None,
- line1: None,
- line2: None,
- line3: None,
- state: None,
- zip: None,
- first_name: None,
- last_name: None,
- phone_number: None,
- country_code: None,
- customer_id: String::default(),
- merchant_id: String::default(),
- }
- }
-}
+pub use storage_models::address::{Address, AddressNew, AddressUpdate, AddressUpdateInternal};
diff --git a/crates/router/src/types/storage/configs.rs b/crates/router/src/types/storage/configs.rs
index b6c637f4412..0adee5fef14 100644
--- a/crates/router/src/types/storage/configs.rs
+++ b/crates/router/src/types/storage/configs.rs
@@ -1,43 +1 @@
-use std::convert::From;
-
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-use serde::{Deserialize, Serialize};
-
-use crate::schema::configs;
-
-#[derive(Default, Clone, Debug, Insertable, Serialize, Deserialize)]
-#[diesel(table_name = configs)]
-
-pub struct ConfigNew {
- pub key: String,
- pub config: String,
-}
-
-#[derive(Default, Clone, Debug, Identifiable, Queryable, Deserialize, Serialize)]
-#[diesel(table_name = configs)]
-
-pub struct Config {
- #[serde(skip_serializing)]
- pub id: i32,
- pub key: String,
- pub config: String,
-}
-
-#[derive(Debug)]
-pub enum ConfigUpdate {
- Update { config: Option<String> },
-}
-
-#[derive(Clone, Debug, AsChangeset, Default)]
-#[diesel(table_name = configs)]
-pub(super) struct ConfigUpdateInternal {
- config: Option<String>,
-}
-
-impl From<ConfigUpdate> for ConfigUpdateInternal {
- fn from(config_update: ConfigUpdate) -> Self {
- match config_update {
- ConfigUpdate::Update { config } => Self { config },
- }
- }
-}
+pub use storage_models::configs::{Config, ConfigNew, ConfigUpdate, ConfigUpdateInternal};
diff --git a/crates/router/src/types/storage/connector_response.rs b/crates/router/src/types/storage/connector_response.rs
index c9978be8ae0..eb4e2474c99 100644
--- a/crates/router/src/types/storage/connector_response.rs
+++ b/crates/router/src/types/storage/connector_response.rs
@@ -1,89 +1,4 @@
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-use serde::{Deserialize, Serialize};
-use time::PrimitiveDateTime;
-
-use crate::schema::connector_response;
-
-#[derive(Clone, Debug, Deserialize, Serialize, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = connector_response)]
-#[serde(deny_unknown_fields)]
-pub struct ConnectorResponseNew {
- pub payment_id: String,
- pub merchant_id: String,
- pub txn_id: String,
- pub created_at: PrimitiveDateTime,
- pub modified_at: PrimitiveDateTime,
- pub connector_name: Option<String>,
- pub connector_transaction_id: Option<String>,
- pub authentication_data: Option<serde_json::Value>,
- pub encoded_data: Option<String>,
-}
-
-#[derive(Clone, Debug, Deserialize, Serialize, Identifiable, Queryable)]
-#[diesel(table_name = connector_response)]
-
-pub struct ConnectorResponse {
- #[serde(skip_serializing)]
- pub id: i32,
- pub payment_id: String,
- pub merchant_id: String,
- pub txn_id: String,
- pub created_at: PrimitiveDateTime,
- pub modified_at: PrimitiveDateTime,
- pub connector_name: Option<String>,
- pub connector_transaction_id: Option<String>,
- pub authentication_data: Option<serde_json::Value>,
- pub encoded_data: Option<String>,
-}
-
-#[derive(Clone, Debug, Deserialize, AsChangeset, Serialize)]
-#[diesel(table_name = connector_response)]
-pub struct ConnectorResponseUpdateInternal {
- pub connector_transaction_id: Option<String>,
- pub authentication_data: Option<serde_json::Value>,
- pub modified_at: PrimitiveDateTime,
- pub encoded_data: Option<String>,
- pub connector_name: Option<String>,
-}
-
-#[derive(Debug)]
-pub enum ConnectorResponseUpdate {
- ResponseUpdate {
- connector_transaction_id: Option<String>,
- authentication_data: Option<serde_json::Value>,
- encoded_data: Option<String>,
- connector_name: Option<String>,
- },
-}
-
-impl ConnectorResponseUpdate {
- pub fn apply_changeset(self, source: ConnectorResponse) -> ConnectorResponse {
- let connector_response_update: ConnectorResponseUpdateInternal = self.into();
- ConnectorResponse {
- modified_at: connector_response_update.modified_at,
- connector_transaction_id: connector_response_update.connector_transaction_id,
- authentication_data: connector_response_update.authentication_data,
- encoded_data: connector_response_update.encoded_data,
- ..source
- }
- }
-}
-
-impl From<ConnectorResponseUpdate> for ConnectorResponseUpdateInternal {
- fn from(connector_response_update: ConnectorResponseUpdate) -> Self {
- match connector_response_update {
- ConnectorResponseUpdate::ResponseUpdate {
- connector_transaction_id,
- authentication_data,
- encoded_data,
- connector_name,
- } => Self {
- connector_transaction_id,
- authentication_data,
- encoded_data,
- modified_at: common_utils::date_time::now(),
- connector_name,
- },
- }
- }
-}
+pub use storage_models::connector_response::{
+ ConnectorResponse, ConnectorResponseNew, ConnectorResponseUpdate,
+ ConnectorResponseUpdateInternal,
+};
diff --git a/crates/router/src/types/storage/customers.rs b/crates/router/src/types/storage/customers.rs
index 58f48a9ed51..abb05695391 100644
--- a/crates/router/src/types/storage/customers.rs
+++ b/crates/router/src/types/storage/customers.rs
@@ -1,80 +1,3 @@
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-use time::PrimitiveDateTime;
-
-use crate::{
- pii::{self, Secret},
- schema::customers,
+pub use storage_models::customers::{
+ Customer, CustomerNew, CustomerUpdate, CustomerUpdateInternal,
};
-
-#[derive(Default, Clone, Debug, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = customers)]
-pub struct CustomerNew {
- pub customer_id: String,
- pub merchant_id: String,
- pub name: Option<String>,
- pub email: Option<Secret<String, pii::Email>>,
- pub phone: Option<Secret<String>>,
- pub description: Option<String>,
- pub phone_country_code: Option<String>,
- pub metadata: Option<serde_json::Value>,
-}
-
-#[derive(Clone, Debug, Identifiable, Queryable)]
-#[diesel(table_name = customers)]
-pub struct Customer {
- pub id: i32,
- pub customer_id: String,
- pub merchant_id: String,
- pub name: Option<String>,
- pub email: Option<Secret<String, pii::Email>>,
- pub phone: Option<Secret<String>>,
- pub phone_country_code: Option<String>,
- pub description: Option<String>,
- pub created_at: PrimitiveDateTime,
- pub metadata: Option<serde_json::Value>,
-}
-
-#[derive(Debug)]
-pub enum CustomerUpdate {
- Update {
- name: Option<String>,
- email: Option<Secret<String, pii::Email>>,
- phone: Option<Secret<String>>,
- description: Option<String>,
- phone_country_code: Option<String>,
- metadata: Option<serde_json::Value>,
- },
-}
-
-#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
-#[diesel(table_name = customers)]
-pub(super) struct CustomerUpdateInternal {
- name: Option<String>,
- email: Option<Secret<String, pii::Email>>,
- phone: Option<Secret<String>>,
- description: Option<String>,
- phone_country_code: Option<String>,
- metadata: Option<serde_json::Value>,
-}
-
-impl From<CustomerUpdate> for CustomerUpdateInternal {
- fn from(customer_update: CustomerUpdate) -> Self {
- match customer_update {
- CustomerUpdate::Update {
- name,
- email,
- phone,
- description,
- phone_country_code,
- metadata,
- } => Self {
- name,
- email,
- phone,
- description,
- phone_country_code,
- metadata,
- },
- }
- }
-}
diff --git a/crates/router/src/types/storage/enums.rs b/crates/router/src/types/storage/enums.rs
index a44577fe06d..4cf03ac8d43 100644
--- a/crates/router/src/types/storage/enums.rs
+++ b/crates/router/src/types/storage/enums.rs
@@ -1,657 +1 @@
-#[doc(hidden)]
-pub mod diesel_exports {
- pub use super::{
- DbAttemptStatus as AttemptStatus, DbAuthenticationType as AuthenticationType,
- DbCaptureMethod as CaptureMethod, DbConnectorType as ConnectorType, DbCurrency as Currency,
- DbEventClass as EventClass, DbEventObjectType as EventObjectType, DbEventType as EventType,
- DbFutureUsage as FutureUsage, DbIntentStatus as IntentStatus,
- DbMandateStatus as MandateStatus, DbMandateType as MandateType,
- DbMerchantStorageScheme as MerchantStorageScheme, DbPaymentFlow as PaymentFlow,
- DbPaymentMethodIssuerCode as PaymentMethodIssuerCode,
- DbPaymentMethodSubType as PaymentMethodSubType, DbPaymentMethodType as PaymentMethodType,
- DbProcessTrackerStatus as ProcessTrackerStatus, DbRefundStatus as RefundStatus,
- DbRefundType as RefundType, DbRoutingAlgorithm as RoutingAlgorithm,
- };
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum AttemptStatus {
- Started,
- AuthenticationFailed,
- JuspayDeclined,
- PendingVbv,
- VbvSuccessful,
- Authorized,
- AuthorizationFailed,
- Charged,
- Authorizing,
- CodInitiated,
- Voided,
- VoidInitiated,
- CaptureInitiated,
- CaptureFailed,
- VoidFailed,
- AutoRefunded,
- PartialCharged,
- #[default]
- Pending,
- Failure,
- PaymentMethodAwaited,
- ConfirmationAwaited,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum AuthenticationType {
- #[default]
- ThreeDs,
- NoThreeDs,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum CaptureMethod {
- #[default]
- Automatic,
- Manual,
- ManualMultiple,
- Scheduled,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- PartialEq,
- strum::Display,
- strum::EnumString,
- serde::Deserialize,
- serde::Serialize,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[strum(serialize_all = "snake_case")]
-#[serde(rename_all = "snake_case")]
-pub enum ConnectorType {
- /// PayFacs, Acquirers, Gateways, BNPL etc
- PaymentProcessor,
- /// Fraud, Currency Conversion, Crypto etc
- PaymentVas,
- /// Accounting, Billing, Invoicing, Tax etc
- FinOperations,
- /// Inventory, ERP, CRM, KYC etc
- FizOperations,
- /// Payment Networks like Visa, MasterCard etc
- Networks,
- /// All types of banks including corporate / commercial / personal / neo banks
- BankingEntities,
- /// All types of non-banking financial institutions including Insurance, Credit / Lending etc
- NonBankingFinance,
-}
-
-#[allow(clippy::upper_case_acronyms)]
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- Hash,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-pub enum Currency {
- AED,
- ALL,
- AMD,
- ARS,
- AUD,
- AWG,
- AZN,
- BBD,
- BDT,
- BHD,
- BMD,
- BND,
- BOB,
- BRL,
- BSD,
- BWP,
- BZD,
- CAD,
- CHF,
- CNY,
- COP,
- CRC,
- CUP,
- CZK,
- DKK,
- DOP,
- DZD,
- EGP,
- ETB,
- EUR,
- FJD,
- GBP,
- GHS,
- GIP,
- GMD,
- GTQ,
- GYD,
- HKD,
- HNL,
- HRK,
- HTG,
- HUF,
- IDR,
- ILS,
- INR,
- JMD,
- JOD,
- JPY,
- KES,
- KGS,
- KHR,
- KRW,
- KWD,
- KYD,
- KZT,
- LAK,
- LBP,
- LKR,
- LRD,
- LSL,
- MAD,
- MDL,
- MKD,
- MMK,
- MNT,
- MOP,
- MUR,
- MVR,
- MWK,
- MXN,
- MYR,
- NAD,
- NGN,
- NIO,
- NOK,
- NPR,
- NZD,
- OMR,
- PEN,
- PGK,
- PHP,
- PKR,
- PLN,
- QAR,
- RUB,
- SAR,
- SCR,
- SEK,
- SGD,
- SLL,
- SOS,
- SSP,
- SVC,
- SZL,
- THB,
- TTD,
- TWD,
- TZS,
- #[default]
- USD,
- UYU,
- UZS,
- YER,
- ZAR,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum EventClass {
- Payments,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum EventObjectType {
- PaymentDetails,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum EventType {
- PaymentSucceeded,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum IntentStatus {
- Succeeded,
- Failed,
- Cancelled,
- Processing,
- RequiresCustomerAction,
- RequiresPaymentMethod,
- #[default]
- RequiresConfirmation,
- RequiresCapture,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum FutureUsage {
- #[default]
- OffSession,
- OnSession,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum MerchantStorageScheme {
- #[default]
- PostgresOnly,
- RedisKv,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- PartialEq,
- strum::Display,
- strum::EnumString,
- serde::Serialize,
- serde::Deserialize,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[strum(serialize_all = "snake_case")]
-pub enum PaymentFlow {
- Vsc,
- Emi,
- Otp,
- UpiIntent,
- UpiCollect,
- UpiScanAndPay,
- Sdk,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- Hash,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[strum(serialize_all = "snake_case")]
-#[serde(rename_all = "snake_case")]
-pub enum PaymentMethodIssuerCode {
- JpHdfc,
- JpIcici,
- JpGooglepay,
- JpApplepay,
- JpPhonepay,
- JpWechat,
- JpSofort,
- JpGiropay,
- JpSepa,
- JpBacs,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- Hash,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum PaymentMethodSubType {
- Credit,
- Debit,
- UpiIntent,
- UpiCollect,
- CreditCardInstallments,
- PayLaterInstallments,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- Hash,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum PaymentMethodType {
- Card,
- PaymentContainer,
- #[default]
- BankTransfer,
- BankDebit,
- PayLater,
- Netbanking,
- Upi,
- OpenBanking,
- ConsumerFinance,
- Wallet,
- Klarna,
- Paypal,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- Hash,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "lowercase")]
-#[strum(serialize_all = "lowercase")]
-pub enum WalletIssuer {
- GooglePay,
- ApplePay,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum ProcessTrackerStatus {
- // Picked by the producer
- Processing,
- // State when the task is added
- New,
- // Send to retry
- Pending,
- // Picked by consumer
- ProcessStarted,
- // Finished by consumer
- Finish,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- PartialEq,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[strum(serialize_all = "snake_case")]
-pub enum RefundStatus {
- Failure,
- ManualReview,
- #[default]
- Pending,
- Success,
- TransactionFailure,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Default,
- Eq,
- PartialEq,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[strum(serialize_all = "snake_case")]
-pub enum RefundType {
- InstantRefund,
- #[default]
- RegularRefund,
- RetryRefund,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- PartialEq,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-#[router_derive::diesel_enum]
-pub enum RoutingAlgorithm {
- RoundRobin,
- MaxConversion,
- MinCost,
- Custom,
-}
-
-// Mandate
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- PartialEq,
- Default,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum MandateType {
- SingleUse,
- #[default]
- MultiUse,
-}
-
-#[derive(
- Clone,
- Copy,
- Debug,
- Eq,
- PartialEq,
- Default,
- serde::Deserialize,
- serde::Serialize,
- strum::Display,
- strum::EnumString,
- router_derive::DieselEnum,
-)]
-#[router_derive::diesel_enum]
-#[serde(rename_all = "snake_case")]
-#[strum(serialize_all = "snake_case")]
-pub enum MandateStatus {
- #[default]
- Active,
- Inactive,
- Pending,
- Revoked,
-}
+pub use storage_models::enums::*;
diff --git a/crates/router/src/types/storage/ephemeral_key.rs b/crates/router/src/types/storage/ephemeral_key.rs
index 44226d50fd6..afbae4eca07 100644
--- a/crates/router/src/types/storage/ephemeral_key.rs
+++ b/crates/router/src/types/storage/ephemeral_key.rs
@@ -1,16 +1 @@
-pub struct EphemeralKeyNew {
- pub id: String,
- pub merchant_id: String,
- pub customer_id: String,
- pub secret: String,
-}
-
-#[derive(Debug, serde::Serialize, serde::Deserialize)]
-pub struct EphemeralKey {
- pub id: String,
- pub merchant_id: String,
- pub customer_id: String,
- pub created_at: i64,
- pub expires: i64,
- pub secret: String,
-}
+pub use storage_models::ephemeral_key::{EphemeralKey, EphemeralKeyNew};
diff --git a/crates/router/src/types/storage/events.rs b/crates/router/src/types/storage/events.rs
index 86edcbae39b..c56791a8de6 100644
--- a/crates/router/src/types/storage/events.rs
+++ b/crates/router/src/types/storage/events.rs
@@ -1,35 +1 @@
-use common_utils::custom_serde;
-use diesel::{Identifiable, Insertable, Queryable};
-use serde::{Deserialize, Serialize};
-use time::PrimitiveDateTime;
-
-use crate::{schema::events, types::storage::enums as storage_enums};
-
-#[derive(Clone, Debug, Deserialize, Insertable, Serialize, router_derive::DebugAsDisplay)]
-#[diesel(table_name = events)]
-#[serde(deny_unknown_fields)]
-pub struct EventNew {
- pub event_id: String,
- pub event_type: storage_enums::EventType,
- pub event_class: storage_enums::EventClass,
- pub is_webhook_notified: bool,
- pub intent_reference_id: Option<String>,
- pub primary_object_id: String,
- pub primary_object_type: storage_enums::EventObjectType,
-}
-
-#[derive(Clone, Debug, Deserialize, Serialize, Identifiable, Queryable)]
-#[diesel(table_name = events)]
-pub struct Event {
- #[serde(skip_serializing)]
- pub id: i32,
- pub event_id: String,
- pub event_type: storage_enums::EventType,
- pub event_class: storage_enums::EventClass,
- pub is_webhook_notified: bool,
- pub intent_reference_id: Option<String>,
- pub primary_object_id: String,
- pub primary_object_type: storage_enums::EventObjectType,
- #[serde(with = "custom_serde::iso8601")]
- pub created_at: PrimitiveDateTime,
-}
+pub use storage_models::events::{Event, EventNew};
diff --git a/crates/router/src/types/storage/locker_mock_up.rs b/crates/router/src/types/storage/locker_mock_up.rs
index 5df7c60b68f..7621ffa539f 100644
--- a/crates/router/src/types/storage/locker_mock_up.rs
+++ b/crates/router/src/types/storage/locker_mock_up.rs
@@ -1,34 +1 @@
-use diesel::{Identifiable, Insertable, Queryable};
-
-use crate::schema::locker_mock_up;
-
-#[derive(Clone, Debug, Eq, Identifiable, Queryable, PartialEq)]
-#[diesel(table_name = locker_mock_up)]
-pub struct LockerMockUp {
- pub id: i32,
- pub card_id: String,
- pub external_id: String,
- pub card_fingerprint: String,
- pub card_global_fingerprint: String,
- pub merchant_id: String,
- pub card_number: String,
- pub card_exp_year: String,
- pub card_exp_month: String,
- pub name_on_card: Option<String>,
- pub nickname: Option<String>,
- pub customer_id: Option<String>,
- pub duplicate: Option<bool>,
-}
-
-#[derive(Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = locker_mock_up)]
-pub struct LockerMockUpNew {
- pub card_id: String,
- pub external_id: String,
- pub card_fingerprint: String,
- pub card_global_fingerprint: String,
- pub merchant_id: String,
- pub card_number: String,
- pub card_exp_year: String,
- pub card_exp_month: String,
-}
+pub use storage_models::locker_mock_up::{LockerMockUp, LockerMockUpNew};
diff --git a/crates/router/src/types/storage/mandate.rs b/crates/router/src/types/storage/mandate.rs
index 17a2203aa0a..bafecb42f25 100644
--- a/crates/router/src/types/storage/mandate.rs
+++ b/crates/router/src/types/storage/mandate.rs
@@ -1,106 +1,3 @@
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-use time::PrimitiveDateTime;
-
-use crate::schema::mandate;
-// use serde::{Deserialize, Serialize};
-use crate::{
- pii::{self, Secret},
- types::storage::enums as storage_enums,
+pub use storage_models::mandate::{
+ Mandate, MandateNew, MandateUpdate, MandateUpdateInternal, SingleUseMandate,
};
-
-#[derive(Clone, Debug, Identifiable, Queryable)]
-#[diesel(table_name = mandate)]
-pub struct Mandate {
- pub id: i32,
- pub mandate_id: String,
- pub customer_id: String,
- pub merchant_id: String,
- pub payment_method_id: String,
- pub mandate_status: storage_enums::MandateStatus,
- pub mandate_type: storage_enums::MandateType,
- pub customer_accepted_at: Option<PrimitiveDateTime>,
- pub customer_ip_address: Option<Secret<String, pii::IpAddress>>,
- pub customer_user_agent: Option<String>,
- pub network_transaction_id: Option<String>,
- pub previous_transaction_id: Option<String>,
- pub created_at: PrimitiveDateTime,
- pub mandate_amount: Option<i32>,
- pub mandate_currency: Option<storage_enums::Currency>,
- pub amount_captured: Option<i32>,
- pub connector: String,
- pub connector_mandate_id: Option<String>,
-}
-
-#[derive(
- router_derive::Setter, Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay,
-)]
-#[diesel(table_name = mandate)]
-pub struct MandateNew {
- pub mandate_id: String,
- pub customer_id: String,
- pub merchant_id: String,
- pub payment_method_id: String,
- pub mandate_status: storage_enums::MandateStatus,
- pub mandate_type: storage_enums::MandateType,
- pub customer_accepted_at: Option<PrimitiveDateTime>,
- pub customer_ip_address: Option<Secret<String, pii::IpAddress>>,
- pub customer_user_agent: Option<String>,
- pub network_transaction_id: Option<String>,
- pub previous_transaction_id: Option<String>,
- pub created_at: Option<PrimitiveDateTime>,
- pub mandate_amount: Option<i32>,
- pub mandate_currency: Option<storage_enums::Currency>,
- pub amount_captured: Option<i32>,
- pub connector: String,
- pub connector_mandate_id: Option<String>,
-}
-
-#[derive(Debug)]
-pub enum MandateUpdate {
- StatusUpdate {
- mandate_status: storage_enums::MandateStatus,
- },
- CaptureAmountUpdate {
- amount_captured: Option<i32>,
- },
- ConnectorReferenceUpdate {
- connector_mandate_id: Option<String>,
- },
-}
-
-#[derive(Clone, Eq, PartialEq, Copy, Debug, Default, serde::Serialize, serde::Deserialize)]
-pub struct MandateAmountData {
- pub amount: i32,
- pub currency: storage_enums::Currency,
-}
-
-#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
-#[diesel(table_name = mandate)]
-pub(super) struct MandateUpdateInternal {
- mandate_status: Option<storage_enums::MandateStatus>,
- amount_captured: Option<i32>,
- connector_mandate_id: Option<String>,
-}
-
-impl From<MandateUpdate> for MandateUpdateInternal {
- fn from(mandate_update: MandateUpdate) -> Self {
- match mandate_update {
- MandateUpdate::StatusUpdate { mandate_status } => Self {
- mandate_status: Some(mandate_status),
- connector_mandate_id: None,
- amount_captured: None,
- },
- MandateUpdate::CaptureAmountUpdate { amount_captured } => Self {
- mandate_status: None,
- amount_captured,
- connector_mandate_id: None,
- },
- MandateUpdate::ConnectorReferenceUpdate {
- connector_mandate_id,
- } => Self {
- connector_mandate_id,
- ..Default::default()
- },
- }
- }
-}
diff --git a/crates/router/src/types/storage/merchant_account.rs b/crates/router/src/types/storage/merchant_account.rs
index 92b32cbaf5a..e6bd21d03cd 100644
--- a/crates/router/src/types/storage/merchant_account.rs
+++ b/crates/router/src/types/storage/merchant_account.rs
@@ -1,120 +1,3 @@
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-
-use crate::{pii::StrongSecret, schema::merchant_account, types::storage::enums as storage_enums};
-
-#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = merchant_account)]
-pub struct MerchantAccount {
- pub id: i32,
- pub merchant_id: String,
- pub api_key: Option<StrongSecret<String>>,
- pub return_url: Option<String>,
- pub enable_payment_response_hash: bool,
- pub payment_response_hash_key: Option<String>,
- pub redirect_to_merchant_with_http_post: bool,
- pub merchant_name: Option<String>,
- pub merchant_details: Option<serde_json::Value>,
- pub webhook_details: Option<serde_json::Value>,
- pub routing_algorithm: Option<storage_enums::RoutingAlgorithm>,
- pub custom_routing_rules: Option<serde_json::Value>,
- pub sub_merchants_enabled: Option<bool>,
- pub parent_merchant_id: Option<String>,
- pub publishable_key: Option<String>,
- pub storage_scheme: storage_enums::MerchantStorageScheme,
-}
-
-#[derive(Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = merchant_account)]
-pub struct MerchantAccountNew {
- pub merchant_id: String,
- pub merchant_name: Option<String>,
- pub api_key: Option<StrongSecret<String>>,
- pub merchant_details: Option<serde_json::Value>,
- pub return_url: Option<String>,
- pub webhook_details: Option<serde_json::Value>,
- pub routing_algorithm: Option<storage_enums::RoutingAlgorithm>,
- pub custom_routing_rules: Option<serde_json::Value>,
- pub sub_merchants_enabled: Option<bool>,
- pub parent_merchant_id: Option<String>,
- pub enable_payment_response_hash: Option<bool>,
- pub payment_response_hash_key: Option<String>,
- pub redirect_to_merchant_with_http_post: Option<bool>,
- pub(crate) publishable_key: Option<String>,
-}
-
-#[derive(Debug)]
-pub enum MerchantAccountUpdate {
- Update {
- merchant_id: String,
- merchant_name: Option<String>,
- api_key: Option<StrongSecret<String>>,
- merchant_details: Option<serde_json::Value>,
- return_url: Option<String>,
- webhook_details: Option<serde_json::Value>,
- routing_algorithm: Option<storage_enums::RoutingAlgorithm>,
- custom_routing_rules: Option<serde_json::Value>,
- sub_merchants_enabled: Option<bool>,
- parent_merchant_id: Option<String>,
- enable_payment_response_hash: Option<bool>,
- payment_response_hash_key: Option<String>,
- redirect_to_merchant_with_http_post: Option<bool>,
- publishable_key: Option<String>,
- },
-}
-
-#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
-#[diesel(table_name = merchant_account)]
-pub(super) struct MerchantAccountUpdateInternal {
- merchant_id: Option<String>,
- merchant_name: Option<String>,
- api_key: Option<StrongSecret<String>>,
- merchant_details: Option<serde_json::Value>,
- return_url: Option<String>,
- webhook_details: Option<serde_json::Value>,
- routing_algorithm: Option<storage_enums::RoutingAlgorithm>,
- custom_routing_rules: Option<serde_json::Value>,
- sub_merchants_enabled: Option<bool>,
- parent_merchant_id: Option<String>,
- enable_payment_response_hash: Option<bool>,
- payment_response_hash_key: Option<String>,
- redirect_to_merchant_with_http_post: Option<bool>,
- publishable_key: Option<String>,
-}
-
-impl From<MerchantAccountUpdate> for MerchantAccountUpdateInternal {
- fn from(merchant_account_update: MerchantAccountUpdate) -> Self {
- match merchant_account_update {
- MerchantAccountUpdate::Update {
- merchant_id,
- merchant_name,
- api_key,
- merchant_details,
- return_url,
- webhook_details,
- routing_algorithm,
- custom_routing_rules,
- sub_merchants_enabled,
- parent_merchant_id,
- enable_payment_response_hash,
- payment_response_hash_key,
- redirect_to_merchant_with_http_post,
- publishable_key,
- } => Self {
- merchant_id: Some(merchant_id),
- merchant_name,
- api_key,
- merchant_details,
- return_url,
- webhook_details,
- routing_algorithm,
- custom_routing_rules,
- sub_merchants_enabled,
- parent_merchant_id,
- enable_payment_response_hash,
- payment_response_hash_key,
- redirect_to_merchant_with_http_post,
- publishable_key,
- },
- }
- }
-}
+pub use storage_models::merchant_account::{
+ MerchantAccount, MerchantAccountNew, MerchantAccountUpdate, MerchantAccountUpdateInternal,
+};
diff --git a/crates/router/src/types/storage/merchant_connector_account.rs b/crates/router/src/types/storage/merchant_connector_account.rs
index 1d7ceedc81f..249538f5823 100644
--- a/crates/router/src/types/storage/merchant_connector_account.rs
+++ b/crates/router/src/types/storage/merchant_connector_account.rs
@@ -1,85 +1,4 @@
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-
-use crate::{
- pii::Secret, schema::merchant_connector_account, types::storage::enums as storage_enums,
+pub use storage_models::merchant_connector_account::{
+ MerchantConnectorAccount, MerchantConnectorAccountNew, MerchantConnectorAccountUpdate,
+ MerchantConnectorAccountUpdateInternal,
};
-
-#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = merchant_connector_account)]
-pub struct MerchantConnectorAccount {
- pub id: i32,
- pub merchant_id: String,
- pub connector_name: String,
- pub connector_account_details: serde_json::Value,
- pub test_mode: Option<bool>,
- pub disabled: Option<bool>,
- pub merchant_connector_id: i32,
- #[diesel(deserialize_as = super::OptionalDieselArray<serde_json::Value>)]
- pub payment_methods_enabled: Option<Vec<serde_json::Value>>,
- pub connector_type: storage_enums::ConnectorType,
-}
-
-#[derive(Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = merchant_connector_account)]
-pub struct MerchantConnectorAccountNew {
- pub merchant_id: Option<String>,
- pub connector_type: Option<storage_enums::ConnectorType>,
- pub connector_name: Option<String>,
- pub connector_account_details: Option<Secret<serde_json::Value>>,
- pub test_mode: Option<bool>,
- pub disabled: Option<bool>,
- pub merchant_connector_id: Option<i32>,
- pub payment_methods_enabled: Option<Vec<serde_json::Value>>,
-}
-
-#[derive(Debug)]
-pub enum MerchantConnectorAccountUpdate {
- Update {
- merchant_id: Option<String>,
- connector_type: Option<storage_enums::ConnectorType>,
- connector_name: Option<String>,
- connector_account_details: Option<Secret<serde_json::Value>>,
- test_mode: Option<bool>,
- disabled: Option<bool>,
- merchant_connector_id: Option<i32>,
- payment_methods_enabled: Option<Vec<serde_json::Value>>,
- },
-}
-#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
-#[diesel(table_name = merchant_connector_account)]
-pub(super) struct MerchantConnectorAccountUpdateInternal {
- merchant_id: Option<String>,
- connector_type: Option<storage_enums::ConnectorType>,
- connector_name: Option<String>,
- connector_account_details: Option<Secret<serde_json::Value>>,
- test_mode: Option<bool>,
- disabled: Option<bool>,
- merchant_connector_id: Option<i32>,
- payment_methods_enabled: Option<Vec<serde_json::Value>>,
-}
-
-impl From<MerchantConnectorAccountUpdate> for MerchantConnectorAccountUpdateInternal {
- fn from(merchant_connector_account_update: MerchantConnectorAccountUpdate) -> Self {
- match merchant_connector_account_update {
- MerchantConnectorAccountUpdate::Update {
- merchant_id,
- connector_type,
- connector_name,
- connector_account_details,
- test_mode,
- disabled,
- merchant_connector_id,
- payment_methods_enabled,
- } => Self {
- merchant_id,
- connector_type,
- connector_name,
- connector_account_details,
- test_mode,
- disabled,
- merchant_connector_id,
- payment_methods_enabled,
- },
- }
- }
-}
diff --git a/crates/router/src/types/storage/payment_attempt.rs b/crates/router/src/types/storage/payment_attempt.rs
index 3f18d125db2..40cd181d766 100644
--- a/crates/router/src/types/storage/payment_attempt.rs
+++ b/crates/router/src/types/storage/payment_attempt.rs
@@ -1,239 +1,9 @@
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-use serde::{Deserialize, Serialize};
-use time::PrimitiveDateTime;
+pub use storage_models::payment_attempt::{
+ PaymentAttempt, PaymentAttemptNew, PaymentAttemptUpdate, PaymentAttemptUpdateInternal,
+};
-use crate::{schema::payment_attempt, types::storage::enums as storage_enums};
-
-#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable, Serialize, Deserialize)]
-#[diesel(table_name = payment_attempt)]
-pub struct PaymentAttempt {
- pub id: i32,
- pub payment_id: String,
- pub merchant_id: String,
- pub txn_id: String,
- pub status: storage_enums::AttemptStatus,
- pub amount: i32,
- pub currency: Option<storage_enums::Currency>,
- pub save_to_locker: Option<bool>,
- pub connector: Option<String>,
- pub error_message: Option<String>,
- pub offer_amount: Option<i32>,
- pub surcharge_amount: Option<i32>,
- pub tax_amount: Option<i32>,
- pub payment_method_id: Option<String>,
- pub payment_method: Option<storage_enums::PaymentMethodType>,
- pub payment_flow: Option<storage_enums::PaymentFlow>,
- pub redirect: Option<bool>,
- pub connector_transaction_id: Option<String>,
- pub capture_method: Option<storage_enums::CaptureMethod>,
- pub capture_on: Option<PrimitiveDateTime>,
- pub confirm: bool,
- pub authentication_type: Option<storage_enums::AuthenticationType>,
- pub created_at: PrimitiveDateTime,
- pub modified_at: PrimitiveDateTime,
- pub last_synced: Option<PrimitiveDateTime>,
- pub cancellation_reason: Option<String>,
- pub amount_to_capture: Option<i32>,
- pub mandate_id: Option<String>,
- pub browser_info: Option<serde_json::Value>,
-}
-
-#[derive(Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = payment_attempt)]
-pub struct PaymentAttemptNew {
- pub payment_id: String,
- pub merchant_id: String,
- pub txn_id: String,
- pub status: storage_enums::AttemptStatus,
- pub amount: i32,
- pub currency: Option<storage_enums::Currency>,
- // pub auto_capture: Option<bool>,
- pub save_to_locker: Option<bool>,
- pub connector: Option<String>,
- pub error_message: Option<String>,
- pub offer_amount: Option<i32>,
- pub surcharge_amount: Option<i32>,
- pub tax_amount: Option<i32>,
- pub payment_method_id: Option<String>,
- pub payment_method: Option<storage_enums::PaymentMethodType>,
- pub payment_flow: Option<storage_enums::PaymentFlow>,
- pub redirect: Option<bool>,
- pub connector_transaction_id: Option<String>,
- pub capture_method: Option<storage_enums::CaptureMethod>,
- pub capture_on: Option<PrimitiveDateTime>,
- pub confirm: bool,
- pub authentication_type: Option<storage_enums::AuthenticationType>,
- pub created_at: Option<PrimitiveDateTime>,
- pub modified_at: Option<PrimitiveDateTime>,
- pub last_synced: Option<PrimitiveDateTime>,
- pub cancellation_reason: Option<String>,
- pub amount_to_capture: Option<i32>,
- pub mandate_id: Option<String>,
- pub browser_info: Option<serde_json::Value>,
-}
-
-#[derive(Debug, Clone)]
-pub enum PaymentAttemptUpdate {
- Update {
- amount: i32,
- currency: storage_enums::Currency,
- status: storage_enums::AttemptStatus,
- authentication_type: Option<storage_enums::AuthenticationType>,
- payment_method: Option<storage_enums::PaymentMethodType>,
- },
- AuthenticationTypeUpdate {
- authentication_type: storage_enums::AuthenticationType,
- },
- ConfirmUpdate {
- status: storage_enums::AttemptStatus,
- payment_method: Option<storage_enums::PaymentMethodType>,
- browser_info: Option<serde_json::Value>,
- connector: Option<String>,
- },
- VoidUpdate {
- status: storage_enums::AttemptStatus,
- cancellation_reason: Option<String>,
- },
- ResponseUpdate {
- status: storage_enums::AttemptStatus,
- connector_transaction_id: Option<String>,
- authentication_type: Option<storage_enums::AuthenticationType>,
- payment_method_id: Option<Option<String>>,
- redirect: Option<bool>,
- mandate_id: Option<String>,
- },
- StatusUpdate {
- status: storage_enums::AttemptStatus,
- },
- ErrorUpdate {
- status: storage_enums::AttemptStatus,
- error_message: Option<String>,
- },
-}
-
-#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
-#[diesel(table_name = payment_attempt)]
-pub(super) struct PaymentAttemptUpdateInternal {
- amount: Option<i32>,
- currency: Option<storage_enums::Currency>,
- status: Option<storage_enums::AttemptStatus>,
- connector_transaction_id: Option<String>,
- connector: Option<String>,
- authentication_type: Option<storage_enums::AuthenticationType>,
- payment_method: Option<storage_enums::PaymentMethodType>,
- error_message: Option<String>,
- payment_method_id: Option<Option<String>>,
- cancellation_reason: Option<String>,
- modified_at: Option<PrimitiveDateTime>,
- redirect: Option<bool>,
- mandate_id: Option<String>,
- browser_info: Option<serde_json::Value>,
-}
-
-impl PaymentAttemptUpdate {
- pub fn apply_changeset(self, source: PaymentAttempt) -> PaymentAttempt {
- let pa_update: PaymentAttemptUpdateInternal = self.into();
- PaymentAttempt {
- amount: pa_update.amount.unwrap_or(source.amount),
- currency: pa_update.currency.or(source.currency),
- status: pa_update.status.unwrap_or(source.status),
- connector_transaction_id: pa_update
- .connector_transaction_id
- .or(source.connector_transaction_id),
- authentication_type: pa_update.authentication_type.or(source.authentication_type),
- payment_method: pa_update.payment_method.or(source.payment_method),
- error_message: pa_update.error_message.or(source.error_message),
- payment_method_id: pa_update
- .payment_method_id
- .unwrap_or(source.payment_method_id),
- browser_info: pa_update.browser_info,
- modified_at: common_utils::date_time::now(),
- ..source
- }
- }
-}
-
-impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal {
- fn from(payment_attempt_update: PaymentAttemptUpdate) -> Self {
- match payment_attempt_update {
- PaymentAttemptUpdate::Update {
- amount,
- currency,
- status,
- // connector_transaction_id,
- authentication_type,
- payment_method,
- } => Self {
- amount: Some(amount),
- currency: Some(currency),
- status: Some(status),
- // connector_transaction_id,
- authentication_type,
- payment_method,
- modified_at: Some(common_utils::date_time::now()),
- ..Default::default()
- },
- PaymentAttemptUpdate::AuthenticationTypeUpdate {
- authentication_type,
- } => Self {
- authentication_type: Some(authentication_type),
- modified_at: Some(common_utils::date_time::now()),
- ..Default::default()
- },
- PaymentAttemptUpdate::ConfirmUpdate {
- status,
- payment_method,
- browser_info,
- connector,
- } => Self {
- status: Some(status),
- payment_method,
- modified_at: Some(common_utils::date_time::now()),
- browser_info,
- connector,
- ..Default::default()
- },
- PaymentAttemptUpdate::VoidUpdate {
- status,
- cancellation_reason,
- } => Self {
- status: Some(status),
- cancellation_reason,
- ..Default::default()
- },
- PaymentAttemptUpdate::ResponseUpdate {
- status,
- connector_transaction_id,
- authentication_type,
- payment_method_id,
- redirect,
- mandate_id,
- } => Self {
- status: Some(status),
- connector_transaction_id,
- authentication_type,
- payment_method_id,
- modified_at: Some(common_utils::date_time::now()),
- redirect,
- mandate_id,
- ..Default::default()
- },
- PaymentAttemptUpdate::ErrorUpdate {
- status,
- error_message,
- } => Self {
- status: Some(status),
- error_message,
- modified_at: Some(common_utils::date_time::now()),
- ..Default::default()
- },
- PaymentAttemptUpdate::StatusUpdate { status } => Self {
- status: Some(status),
- ..Default::default()
- },
- }
- }
-}
+#[cfg(feature = "kv_store")]
+impl crate::utils::storage_partitioning::KvStorePartition for PaymentAttempt {}
#[cfg(test)]
mod tests {
diff --git a/crates/router/src/types/storage/payment_intent.rs b/crates/router/src/types/storage/payment_intent.rs
index a153fa4c64c..3a24b787f63 100644
--- a/crates/router/src/types/storage/payment_intent.rs
+++ b/crates/router/src/types/storage/payment_intent.rs
@@ -1,233 +1,89 @@
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-use serde::{Deserialize, Serialize};
-use time::PrimitiveDateTime;
+use async_bb8_diesel::AsyncRunQueryDsl;
+use diesel::{associations::HasTable, ExpressionMethods, QueryDsl};
+use error_stack::{IntoReport, ResultExt};
+use router_env::tracing::{self, instrument};
+pub use storage_models::{
+ errors,
+ payment_intent::{
+ PaymentIntent, PaymentIntentNew, PaymentIntentUpdate, PaymentIntentUpdateInternal,
+ },
+ schema::payment_intent::dsl,
+};
-use crate::{schema::payment_intent, types::storage::enums as storage_enums};
+use crate::{connection::PgPooledConn, core::errors::CustomResult, types::api};
-#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable, Serialize, Deserialize)]
-#[diesel(table_name = payment_intent)]
-pub struct PaymentIntent {
- pub id: i32,
- pub payment_id: String,
- pub merchant_id: String,
- pub status: storage_enums::IntentStatus,
- pub amount: i32,
- pub currency: Option<storage_enums::Currency>,
- pub amount_captured: Option<i32>,
- pub customer_id: Option<String>,
- pub description: Option<String>,
- pub return_url: Option<String>,
- pub metadata: Option<serde_json::Value>,
- pub connector_id: Option<String>,
- pub shipping_address_id: Option<String>,
- pub billing_address_id: Option<String>,
- pub statement_descriptor_name: Option<String>,
- pub statement_descriptor_suffix: Option<String>,
- pub created_at: PrimitiveDateTime,
- pub modified_at: PrimitiveDateTime,
- pub last_synced: Option<PrimitiveDateTime>, // FIXME: this is optional
- pub setup_future_usage: Option<storage_enums::FutureUsage>,
- pub off_session: Option<bool>,
- pub client_secret: Option<String>,
-}
+#[cfg(feature = "kv_store")]
+impl crate::utils::storage_partitioning::KvStorePartition for PaymentIntent {}
-#[derive(Clone, Debug, Default, Eq, PartialEq, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = payment_intent)]
-pub struct PaymentIntentNew {
- pub payment_id: String,
- pub merchant_id: String,
- pub status: storage_enums::IntentStatus,
- pub amount: i32,
- pub currency: Option<storage_enums::Currency>,
- pub amount_captured: Option<i32>,
- pub customer_id: Option<String>,
- pub description: Option<String>,
- pub return_url: Option<String>,
- pub metadata: Option<serde_json::Value>,
- pub connector_id: Option<String>,
- pub shipping_address_id: Option<String>,
- pub billing_address_id: Option<String>,
- pub statement_descriptor_name: Option<String>,
- pub statement_descriptor_suffix: Option<String>,
- pub created_at: Option<PrimitiveDateTime>,
- pub modified_at: Option<PrimitiveDateTime>,
- pub last_synced: Option<PrimitiveDateTime>,
- pub client_secret: Option<String>,
- pub setup_future_usage: Option<storage_enums::FutureUsage>,
- pub off_session: Option<bool>,
+#[async_trait::async_trait]
+pub trait PaymentIntentDbExt: Sized {
+ async fn filter_by_constraints(
+ conn: &PgPooledConn,
+ merchant_id: &str,
+ pc: &api::PaymentListConstraints,
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError>;
}
-#[derive(Debug, Clone)]
-pub enum PaymentIntentUpdate {
- ResponseUpdate {
- status: storage_enums::IntentStatus,
- amount_captured: Option<i32>,
- return_url: Option<String>,
- },
- MetadataUpdate {
- metadata: serde_json::Value,
- },
- ReturnUrlUpdate {
- return_url: Option<String>,
- status: Option<storage_enums::IntentStatus>,
- customer_id: Option<String>,
- shipping_address_id: Option<String>,
- billing_address_id: Option<String>,
- },
- MerchantStatusUpdate {
- status: storage_enums::IntentStatus,
- shipping_address_id: Option<String>,
- billing_address_id: Option<String>,
- },
- PGStatusUpdate {
- status: storage_enums::IntentStatus,
- },
- Update {
- amount: i32,
- currency: storage_enums::Currency,
- status: storage_enums::IntentStatus,
- customer_id: Option<String>,
- shipping_address_id: Option<String>,
- billing_address_id: Option<String>,
- },
-}
+#[async_trait::async_trait]
+impl PaymentIntentDbExt for PaymentIntent {
+ #[instrument(skip(conn))]
+ async fn filter_by_constraints(
+ conn: &PgPooledConn,
+ merchant_id: &str,
+ pc: &api::PaymentListConstraints,
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
+ let customer_id = &pc.customer_id;
+ let starting_after = &pc.starting_after;
+ let ending_before = &pc.ending_before;
-#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
-#[diesel(table_name = payment_intent)]
+ //TODO: Replace this with Boxable Expression and pass it into generic filter
+ // when https://github.com/rust-lang/rust/issues/52662 becomes stable
-pub struct PaymentIntentUpdateInternal {
- pub amount: Option<i32>,
- pub currency: Option<storage_enums::Currency>,
- pub status: Option<storage_enums::IntentStatus>,
- pub amount_captured: Option<i32>,
- pub customer_id: Option<String>,
- pub return_url: Option<String>,
- pub setup_future_usage: Option<storage_enums::FutureUsage>,
- pub off_session: Option<bool>,
- pub metadata: Option<serde_json::Value>,
- pub client_secret: Option<Option<String>>,
- pub billing_address_id: Option<String>,
- pub shipping_address_id: Option<String>,
- pub modified_at: Option<PrimitiveDateTime>,
-}
+ let mut filter = <PaymentIntent as HasTable>::table()
+ .filter(dsl::merchant_id.eq(merchant_id.to_owned()))
+ .order_by(dsl::id)
+ .into_boxed();
-impl PaymentIntentUpdate {
- pub fn apply_changeset(self, source: PaymentIntent) -> PaymentIntent {
- let internal_update: PaymentIntentUpdateInternal = self.into();
- PaymentIntent {
- amount: internal_update.amount.unwrap_or(source.amount),
- currency: internal_update.currency.or(source.currency),
- status: internal_update.status.unwrap_or(source.status),
- amount_captured: internal_update.amount_captured.or(source.amount_captured),
- customer_id: internal_update.customer_id.or(source.customer_id),
- return_url: internal_update.return_url.or(source.return_url),
- setup_future_usage: internal_update
- .setup_future_usage
- .or(source.setup_future_usage),
- off_session: internal_update.off_session.or(source.off_session),
- metadata: internal_update.metadata.or(source.metadata),
- client_secret: internal_update
- .client_secret
- .unwrap_or(source.client_secret),
- billing_address_id: internal_update
- .billing_address_id
- .or(source.billing_address_id),
- shipping_address_id: internal_update
- .shipping_address_id
- .or(source.shipping_address_id),
- modified_at: common_utils::date_time::now(),
- ..source
+ if let Some(customer_id) = customer_id {
+ filter = filter.filter(dsl::customer_id.eq(customer_id.to_owned()));
}
- }
-}
-
-impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
- fn from(payment_intent_update: PaymentIntentUpdate) -> Self {
- match payment_intent_update {
- PaymentIntentUpdate::Update {
- amount,
- currency,
- status,
- customer_id,
- shipping_address_id,
- billing_address_id,
- } => Self {
- amount: Some(amount),
- currency: Some(currency),
- status: Some(status),
- customer_id,
- client_secret: make_client_secret_null_if_success(Some(status)),
- shipping_address_id,
- billing_address_id,
- modified_at: Some(common_utils::date_time::now()),
- ..Default::default()
- },
- PaymentIntentUpdate::MetadataUpdate { metadata } => Self {
- metadata: Some(metadata),
- modified_at: Some(common_utils::date_time::now()),
- ..Default::default()
- },
- PaymentIntentUpdate::ReturnUrlUpdate {
- return_url,
- status,
- customer_id,
- shipping_address_id,
- billing_address_id,
- } => Self {
- return_url,
- status,
- client_secret: make_client_secret_null_if_success(status),
- customer_id,
- shipping_address_id,
- billing_address_id,
- modified_at: Some(common_utils::date_time::now()),
- ..Default::default()
- },
- PaymentIntentUpdate::PGStatusUpdate { status } => Self {
- status: Some(status),
- modified_at: Some(common_utils::date_time::now()),
- ..Default::default()
- },
- PaymentIntentUpdate::MerchantStatusUpdate {
- status,
- shipping_address_id,
- billing_address_id,
- } => Self {
- status: Some(status),
- client_secret: make_client_secret_null_if_success(Some(status)),
- shipping_address_id,
- billing_address_id,
- modified_at: Some(common_utils::date_time::now()),
- ..Default::default()
- },
- PaymentIntentUpdate::ResponseUpdate {
- // amount,
- // currency,
- status,
- amount_captured,
- // customer_id,
- return_url,
- } => Self {
- // amount,
- // currency: Some(currency),
- status: Some(status),
- amount_captured,
- // customer_id,
- return_url,
- client_secret: make_client_secret_null_if_success(Some(status)),
- modified_at: Some(common_utils::date_time::now()),
- ..Default::default()
- },
+ if let Some(created) = pc.created {
+ filter = filter.filter(dsl::created_at.eq(created));
}
- }
-}
+ if let Some(created_lt) = pc.created_lt {
+ filter = filter.filter(dsl::created_at.lt(created_lt));
+ }
+ if let Some(created_gt) = pc.created_gt {
+ filter = filter.filter(dsl::created_at.gt(created_gt));
+ }
+ if let Some(created_lte) = pc.created_lte {
+ filter = filter.filter(dsl::created_at.le(created_lte));
+ }
+ if let Some(created_gte) = pc.created_gte {
+ filter = filter.filter(dsl::created_at.gt(created_gte));
+ }
+ if let Some(starting_after) = starting_after {
+ let id = Self::find_by_payment_id_merchant_id(conn, starting_after, merchant_id)
+ .await?
+ .id;
+ filter = filter.filter(dsl::id.gt(id));
+ }
+ if let Some(ending_before) = ending_before {
+ let id = Self::find_by_payment_id_merchant_id(conn, ending_before, merchant_id)
+ .await?
+ .id;
+ filter = filter.filter(dsl::id.lt(id.to_owned()));
+ }
+
+ filter = filter.limit(pc.limit);
+
+ crate::logger::debug!(query = %diesel::debug_query::<diesel::pg::Pg, _>(&filter).to_string());
-fn make_client_secret_null_if_success(
- status: Option<storage_enums::IntentStatus>,
-) -> Option<Option<String>> {
- if status == Some(storage_enums::IntentStatus::Succeeded) {
- Option::<Option<String>>::Some(None)
- } else {
- None
+ filter
+ .get_results_async(conn)
+ .await
+ .into_report()
+ .change_context(errors::DatabaseError::NotFound)
+ .attach_printable_lazy(|| "Error filtering records by predicate")
}
}
diff --git a/crates/router/src/types/storage/payment_method.rs b/crates/router/src/types/storage/payment_method.rs
index 58365f9f690..e66b2cd2eff 100644
--- a/crates/router/src/types/storage/payment_method.rs
+++ b/crates/router/src/types/storage/payment_method.rs
@@ -1,86 +1 @@
-use diesel::{Identifiable, Insertable, Queryable};
-use time::PrimitiveDateTime;
-
-use crate::{pii::Secret, schema::payment_methods, types::storage::enums as storage_enums};
-
-#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable)]
-#[diesel(table_name = payment_methods)]
-pub struct PaymentMethod {
- pub id: i32,
- pub customer_id: String,
- pub merchant_id: String,
- pub payment_method_id: String,
- #[diesel(deserialize_as = super::OptionalDieselArray<storage_enums::Currency>)]
- pub accepted_currency: Option<Vec<storage_enums::Currency>>,
- pub scheme: Option<String>,
- pub token: Option<String>,
- pub cardholder_name: Option<Secret<String>>,
- pub issuer_name: Option<String>,
- pub issuer_country: Option<String>,
- #[diesel(deserialize_as = super::OptionalDieselArray<String>)]
- pub payer_country: Option<Vec<String>>,
- pub is_stored: Option<bool>,
- pub swift_code: Option<String>,
- pub direct_debit_token: Option<String>,
- pub network_transaction_id: Option<String>,
- pub created_at: PrimitiveDateTime,
- pub last_modified: PrimitiveDateTime,
- pub payment_method: storage_enums::PaymentMethodType,
- pub payment_method_type: Option<storage_enums::PaymentMethodSubType>,
- pub payment_method_issuer: Option<String>,
- pub payment_method_issuer_code: Option<storage_enums::PaymentMethodIssuerCode>,
-}
-
-#[derive(Clone, Debug, Eq, PartialEq, Insertable, Queryable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = payment_methods)]
-pub struct PaymentMethodNew {
- pub customer_id: String,
- pub merchant_id: String,
- pub payment_method_id: String,
- pub payment_method: storage_enums::PaymentMethodType,
- pub payment_method_type: Option<storage_enums::PaymentMethodSubType>,
- pub payment_method_issuer: Option<String>,
- pub payment_method_issuer_code: Option<storage_enums::PaymentMethodIssuerCode>,
- pub accepted_currency: Option<Vec<storage_enums::Currency>>,
- pub scheme: Option<String>,
- pub token: Option<String>,
- pub cardholder_name: Option<Secret<String>>,
- pub issuer_name: Option<String>,
- pub issuer_country: Option<String>,
- pub payer_country: Option<Vec<String>>,
- pub is_stored: Option<bool>,
- pub swift_code: Option<String>,
- pub direct_debit_token: Option<String>,
- pub network_transaction_id: Option<String>,
- pub created_at: PrimitiveDateTime,
- pub last_modified: PrimitiveDateTime,
-}
-
-impl Default for PaymentMethodNew {
- fn default() -> Self {
- let now = common_utils::date_time::now();
-
- Self {
- customer_id: String::default(),
- merchant_id: String::default(),
- payment_method_id: String::default(),
- payment_method: storage_enums::PaymentMethodType::default(),
- payment_method_type: Option::default(),
- payment_method_issuer: Option::default(),
- payment_method_issuer_code: Option::default(),
- accepted_currency: Option::default(),
- scheme: Option::default(),
- token: Option::default(),
- cardholder_name: Option::default(),
- issuer_name: Option::default(),
- issuer_country: Option::default(),
- payer_country: Option::default(),
- is_stored: Option::default(),
- swift_code: Option::default(),
- direct_debit_token: Option::default(),
- network_transaction_id: Option::default(),
- created_at: now,
- last_modified: now,
- }
- }
-}
+pub use storage_models::payment_method::{PaymentMethod, PaymentMethodNew};
diff --git a/crates/router/src/types/storage/process_tracker.rs b/crates/router/src/types/storage/process_tracker.rs
index 42c0b410614..883c69d69c7 100644
--- a/crates/router/src/types/storage/process_tracker.rs
+++ b/crates/router/src/types/storage/process_tracker.rs
@@ -1,48 +1,49 @@
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
use error_stack::ResultExt;
-use serde::{Deserialize, Serialize};
+use serde::Serialize;
+pub use storage_models::process_tracker::{
+ Milliseconds, ProcessData, ProcessTracker, ProcessTrackerNew, ProcessTrackerUpdate,
+ ProcessTrackerUpdateInternal, SchedulerOptions,
+};
use time::PrimitiveDateTime;
use crate::{
- core::errors, db::StorageInterface, scheduler::metrics, schema::process_tracker,
- types::storage::enums as storage_enums,
+ core::errors, db::StorageInterface, scheduler::metrics, types::storage::enums as storage_enums,
};
-#[derive(
- Clone,
- Debug,
- Eq,
- PartialEq,
- Deserialize,
- Identifiable,
- Queryable,
- Serialize,
- router_derive::DebugAsDisplay,
-)]
-#[diesel(table_name = process_tracker)]
-pub struct ProcessTracker {
- pub id: String,
- pub name: Option<String>,
- #[diesel(deserialize_as = super::DieselArray<String>)]
- pub tag: Vec<String>,
- pub runner: Option<String>,
- pub retry_count: i32,
- pub schedule_time: Option<PrimitiveDateTime>,
- pub rule: String,
- pub tracking_data: serde_json::Value,
- pub business_status: String,
- pub status: storage_enums::ProcessTrackerStatus,
- #[diesel(deserialize_as = super::DieselArray<String>)]
- pub event: Vec<String>,
- pub created_at: PrimitiveDateTime,
- pub updated_at: PrimitiveDateTime,
+#[async_trait::async_trait]
+pub trait ProcessTrackerExt {
+ fn is_valid_business_status(&self, valid_statuses: &[&str]) -> bool;
+
+ fn make_process_tracker_new<'a, T>(
+ process_tracker_id: String,
+ task: &'a str,
+ runner: &'a str,
+ tracking_data: T,
+ schedule_time: PrimitiveDateTime,
+ ) -> Result<ProcessTrackerNew, errors::ProcessTrackerError>
+ where
+ T: Serialize;
+
+ async fn retry(
+ self,
+ db: &dyn StorageInterface,
+ schedule_time: PrimitiveDateTime,
+ ) -> Result<(), errors::ProcessTrackerError>;
+
+ async fn finish_with_status(
+ self,
+ db: &dyn StorageInterface,
+ status: String,
+ ) -> Result<(), errors::ProcessTrackerError>;
}
-impl ProcessTracker {
- pub fn is_valid_business_status(&self, valid_statuses: &[&str]) -> bool {
+#[async_trait::async_trait]
+impl ProcessTrackerExt for ProcessTracker {
+ fn is_valid_business_status(&self, valid_statuses: &[&str]) -> bool {
valid_statuses.iter().any(|x| x == &self.business_status)
}
- pub fn make_process_tracker_new<'a, T>(
+
+ fn make_process_tracker_new<'a, T>(
process_tracker_id: String,
task: &'a str,
runner: &'a str,
@@ -71,7 +72,7 @@ impl ProcessTracker {
})
}
- pub async fn retry(
+ async fn retry(
self,
db: &dyn StorageInterface,
schedule_time: PrimitiveDateTime,
@@ -89,7 +90,7 @@ impl ProcessTracker {
Ok(())
}
- pub async fn finish_with_status(
+ async fn finish_with_status(
self,
db: &dyn StorageInterface,
status: String,
@@ -107,135 +108,3 @@ impl ProcessTracker {
Ok(())
}
}
-
-#[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = process_tracker)]
-pub struct ProcessTrackerNew {
- pub id: String,
- pub name: Option<String>,
- pub tag: Vec<String>,
- pub runner: Option<String>,
- pub retry_count: i32,
- pub schedule_time: Option<PrimitiveDateTime>,
- pub rule: String,
- pub tracking_data: serde_json::Value,
- pub business_status: String,
- pub status: storage_enums::ProcessTrackerStatus,
- pub event: Vec<String>,
- pub created_at: PrimitiveDateTime,
- pub updated_at: PrimitiveDateTime,
-}
-
-#[derive(Debug)]
-pub enum ProcessTrackerUpdate {
- Update {
- name: Option<String>,
- retry_count: Option<i32>,
- schedule_time: Option<PrimitiveDateTime>,
- tracking_data: Option<serde_json::Value>,
- business_status: Option<String>,
- status: Option<storage_enums::ProcessTrackerStatus>,
- updated_at: Option<PrimitiveDateTime>,
- },
- StatusUpdate {
- status: storage_enums::ProcessTrackerStatus,
- business_status: Option<String>,
- },
- StatusRetryUpdate {
- status: storage_enums::ProcessTrackerStatus,
- retry_count: i32,
- schedule_time: PrimitiveDateTime,
- },
-}
-
-#[derive(Debug, Clone, AsChangeset, router_derive::DebugAsDisplay)]
-#[diesel(table_name = process_tracker)]
-pub(super) struct ProcessTrackerUpdateInternal {
- name: Option<String>,
- retry_count: Option<i32>,
- schedule_time: Option<PrimitiveDateTime>,
- tracking_data: Option<serde_json::Value>,
- business_status: Option<String>,
- status: Option<storage_enums::ProcessTrackerStatus>,
- updated_at: Option<PrimitiveDateTime>,
-}
-
-impl Default for ProcessTrackerUpdateInternal {
- fn default() -> Self {
- Self {
- name: Option::default(),
- retry_count: Option::default(),
- schedule_time: Option::default(),
- tracking_data: Option::default(),
- business_status: Option::default(),
- status: Option::default(),
- updated_at: Some(common_utils::date_time::now()),
- }
- }
-}
-
-impl From<ProcessTrackerUpdate> for ProcessTrackerUpdateInternal {
- fn from(process_tracker_update: ProcessTrackerUpdate) -> Self {
- match process_tracker_update {
- ProcessTrackerUpdate::Update {
- name,
- retry_count,
- schedule_time,
- tracking_data,
- business_status,
- status,
- updated_at,
- } => Self {
- name,
- retry_count,
- schedule_time,
- tracking_data,
- business_status,
- status,
- updated_at,
- },
- ProcessTrackerUpdate::StatusUpdate {
- status,
- business_status,
- } => Self {
- status: Some(status),
- business_status,
- ..Default::default()
- },
- ProcessTrackerUpdate::StatusRetryUpdate {
- status,
- retry_count,
- schedule_time,
- } => Self {
- status: Some(status),
- retry_count: Some(retry_count),
- schedule_time: Some(schedule_time),
- ..Default::default()
- },
- }
- }
-}
-
-// TODO: Move this to a utility module?
-pub struct Milliseconds(i32);
-
-#[allow(dead_code)]
-pub struct SchedulerOptions {
- looper_interval: Milliseconds,
- db_name: String,
- cache_name: String,
- schema_name: String,
- cache_expiry: i32,
- runners: Vec<String>,
- fetch_limit: i32,
- fetch_limit_product_factor: i32,
- query_order: String,
-}
-
-#[derive(Debug, Clone)]
-#[allow(dead_code)]
-pub struct ProcessData {
- db_name: String,
- cache_name: String,
- process_tracker: ProcessTracker,
-}
diff --git a/crates/router/src/types/storage/query.rs b/crates/router/src/types/storage/query.rs
index d28e004d2d4..0dd8b43b5d2 100644
--- a/crates/router/src/types/storage/query.rs
+++ b/crates/router/src/types/storage/query.rs
@@ -1,16 +1 @@
-mod address;
-mod configs;
-mod connector_response;
-mod customers;
-mod events;
-mod generics;
-mod locker_mock_up;
-mod mandate;
-mod merchant_account;
-mod merchant_connector_account;
-mod payment_attempt;
-mod payment_intent;
-mod payment_method;
-mod process_tracker;
-mod refund;
-mod temp_card;
+pub use storage_models::query::*;
diff --git a/crates/router/src/types/storage/query/payment_intent.rs b/crates/router/src/types/storage/query/payment_intent.rs
deleted file mode 100644
index c6e17a0b119..00000000000
--- a/crates/router/src/types/storage/query/payment_intent.rs
+++ /dev/null
@@ -1,177 +0,0 @@
-use async_bb8_diesel::AsyncRunQueryDsl;
-use diesel::{associations::HasTable, BoolExpressionMethods, ExpressionMethods, QueryDsl};
-use error_stack::{IntoReport, ResultExt};
-use router_env::tracing::{self, instrument};
-
-#[cfg(not(feature = "kv_store"))]
-use super::generics::{self, ExecuteQuery};
-#[cfg(feature = "kv_store")]
-use super::generics::{self, ExecuteQuery, RawQuery, RawSqlQuery};
-use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
- schema::payment_intent::dsl,
- types::{
- api,
- storage::{
- PaymentIntent, PaymentIntentNew, PaymentIntentUpdate, PaymentIntentUpdateInternal,
- },
- },
-};
-
-impl PaymentIntentNew {
- #[instrument(skip(conn))]
- pub async fn insert_diesel(
- self,
- conn: &PgPooledConn,
- ) -> CustomResult<PaymentIntent, errors::StorageError> {
- generics::generic_insert::<_, _, PaymentIntent, _>(conn, self, ExecuteQuery::new()).await
- }
-
- #[cfg(feature = "kv_store")]
- #[instrument(skip(conn))]
- pub async fn insert_diesel_query(
- self,
- conn: &PgPooledConn,
- ) -> CustomResult<RawSqlQuery, errors::StorageError> {
- generics::generic_insert::<_, _, PaymentIntent, _>(conn, self, RawQuery).await
- }
-}
-
-impl PaymentIntent {
- #[instrument(skip(conn))]
- pub async fn update(
- self,
- conn: &PgPooledConn,
- payment_intent: PaymentIntentUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
- match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
- conn,
- self.id,
- PaymentIntentUpdateInternal::from(payment_intent),
- ExecuteQuery::new(),
- )
- .await
- {
- Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
- Ok(self)
- }
- _ => Err(error),
- },
- result => result,
- }
- }
-
- #[cfg(feature = "kv_store")]
- #[instrument(skip(conn))]
- pub async fn update_query(
- self,
- conn: &PgPooledConn,
- payment_intent: PaymentIntentUpdate,
- ) -> CustomResult<RawSqlQuery, errors::StorageError> {
- generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
- conn,
- self.id,
- PaymentIntentUpdateInternal::from(payment_intent),
- RawQuery,
- )
- .await
- }
-
- #[instrument(skip(conn))]
- pub async fn find_by_payment_id_merchant_id(
- conn: &PgPooledConn,
- payment_id: &str,
- merchant_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
- generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
- conn,
- dsl::merchant_id
- .eq(merchant_id.to_owned())
- .and(dsl::payment_id.eq(payment_id.to_owned())),
- )
- .await
- }
-
- #[instrument(skip(conn))]
- pub async fn find_optional_by_payment_id_merchant_id(
- conn: &PgPooledConn,
- payment_id: &str,
- merchant_id: &str,
- ) -> CustomResult<Option<Self>, errors::StorageError> {
- generics::generic_find_one_optional::<<Self as HasTable>::Table, _, _>(
- conn,
- dsl::merchant_id
- .eq(merchant_id.to_owned())
- .and(dsl::payment_id.eq(payment_id.to_owned())),
- )
- .await
- }
-
- #[instrument(skip(conn))]
- pub async fn filter_by_constraints(
- conn: &PgPooledConn,
- merchant_id: &str,
- pc: &api::PaymentListConstraints,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
- let customer_id = &pc.customer_id;
- let starting_after = &pc.starting_after;
- let ending_before = &pc.ending_before;
-
- //TODO: Replace this with Boxable Expression and pass it into generic filter
- // when https://github.com/rust-lang/rust/issues/52662 becomes stable
-
- let mut filter = <Self as HasTable>::table()
- .filter(dsl::merchant_id.eq(merchant_id.to_owned()))
- .order_by(dsl::id)
- .into_boxed();
-
- if let Some(customer_id) = customer_id {
- filter = filter.filter(dsl::customer_id.eq(customer_id.to_owned()));
- }
- if let Some(created) = pc.created {
- filter = filter.filter(dsl::created_at.eq(created));
- }
- if let Some(created_lt) = pc.created_lt {
- filter = filter.filter(dsl::created_at.lt(created_lt));
- }
- if let Some(created_gt) = pc.created_gt {
- filter = filter.filter(dsl::created_at.gt(created_gt));
- }
- if let Some(created_lte) = pc.created_lte {
- filter = filter.filter(dsl::created_at.le(created_lte));
- }
- if let Some(created_gte) = pc.created_gte {
- filter = filter.filter(dsl::created_at.gt(created_gte));
- }
- if let Some(starting_after) = starting_after {
- let id = Self::find_by_payment_id_merchant_id(conn, starting_after, merchant_id)
- .await?
- .id;
- filter = filter.filter(dsl::id.gt(id));
- }
- if let Some(ending_before) = ending_before {
- let id = Self::find_by_payment_id_merchant_id(conn, ending_before, merchant_id)
- .await?
- .id;
- filter = filter.filter(dsl::id.lt(id.to_owned()));
- }
-
- filter = filter.limit(pc.limit);
-
- crate::logger::debug!(query = %diesel::debug_query::<diesel::pg::Pg, _>(&filter).to_string());
-
- filter
- .get_results_async(conn)
- .await
- .into_report()
- .change_context(errors::StorageError::DatabaseError(
- errors::DatabaseError::NotFound,
- ))
- .attach_printable_lazy(|| "Error filtering records by predicate")
- }
-}
-
-#[cfg(feature = "kv_store")]
-impl crate::utils::storage_partitioning::KvStorePartition for PaymentIntent {}
diff --git a/crates/router/src/types/storage/refund.rs b/crates/router/src/types/storage/refund.rs
index bd01d97560f..26992d18e4d 100644
--- a/crates/router/src/types/storage/refund.rs
+++ b/crates/router/src/types/storage/refund.rs
@@ -1,141 +1,3 @@
-use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
-use serde::{Deserialize, Serialize};
-use time::PrimitiveDateTime;
-
-use crate::{schema::refund, types::storage::enums as storage_enums};
-
-#[derive(Clone, Debug, Eq, Identifiable, Queryable, PartialEq)]
-#[diesel(table_name = refund)]
-pub struct Refund {
- pub id: i32,
- pub internal_reference_id: String,
- pub refund_id: String, //merchant_reference id
- pub payment_id: String,
- pub merchant_id: String,
- pub transaction_id: String,
- pub connector: String,
- pub pg_refund_id: Option<String>,
- pub external_reference_id: Option<String>,
- pub refund_type: storage_enums::RefundType,
- pub total_amount: i32,
- pub currency: storage_enums::Currency,
- pub refund_amount: i32,
- pub refund_status: storage_enums::RefundStatus,
- pub sent_to_gateway: bool,
- pub refund_error_message: Option<String>,
- pub metadata: Option<serde_json::Value>,
- pub refund_arn: Option<String>,
- pub created_at: PrimitiveDateTime,
- pub updated_at: PrimitiveDateTime,
- pub description: Option<String>,
-}
-
-#[derive(Clone, Debug, Default, Eq, PartialEq, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = refund)]
-pub struct RefundNew {
- pub refund_id: String,
- pub payment_id: String,
- pub merchant_id: String,
- pub internal_reference_id: String,
- pub external_reference_id: Option<String>,
- pub transaction_id: String,
- pub connector: String,
- pub pg_refund_id: Option<String>,
- pub refund_type: storage_enums::RefundType,
- pub total_amount: i32,
- pub currency: storage_enums::Currency,
- pub refund_amount: i32,
- pub refund_status: storage_enums::RefundStatus,
- pub sent_to_gateway: bool,
- pub refund_error_message: Option<String>,
- pub metadata: Option<serde_json::Value>,
- pub refund_arn: Option<String>,
- pub created_at: Option<PrimitiveDateTime>,
- pub modified_at: Option<PrimitiveDateTime>,
- pub description: Option<String>,
-}
-
-#[derive(Debug)]
-pub enum RefundUpdate {
- Update {
- pg_refund_id: String,
- refund_status: storage_enums::RefundStatus,
- sent_to_gateway: bool,
- refund_error_message: Option<String>,
- refund_arn: String,
- },
- MetadataUpdate {
- metadata: Option<serde_json::Value>,
- },
- StatusUpdate {
- pg_refund_id: Option<String>,
- sent_to_gateway: bool,
- refund_status: storage_enums::RefundStatus,
- },
- ErrorUpdate {
- refund_status: Option<storage_enums::RefundStatus>,
- refund_error_message: Option<String>,
- },
-}
-
-#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
-#[diesel(table_name = refund)]
-pub(super) struct RefundUpdateInternal {
- pg_refund_id: Option<String>,
- refund_status: Option<storage_enums::RefundStatus>,
- sent_to_gateway: Option<bool>,
- refund_error_message: Option<String>,
- refund_arn: Option<String>,
- metadata: Option<serde_json::Value>,
-}
-
-impl From<RefundUpdate> for RefundUpdateInternal {
- fn from(refund_update: RefundUpdate) -> Self {
- match refund_update {
- RefundUpdate::Update {
- pg_refund_id,
- refund_status,
- sent_to_gateway,
- refund_error_message,
- refund_arn,
- } => Self {
- pg_refund_id: Some(pg_refund_id),
- refund_status: Some(refund_status),
- sent_to_gateway: Some(sent_to_gateway),
- refund_error_message,
- refund_arn: Some(refund_arn),
- ..Default::default()
- },
- RefundUpdate::MetadataUpdate { metadata } => Self {
- metadata,
- ..Default::default()
- },
- RefundUpdate::StatusUpdate {
- pg_refund_id,
- sent_to_gateway,
- refund_status,
- } => Self {
- pg_refund_id,
- sent_to_gateway: Some(sent_to_gateway),
- refund_status: Some(refund_status),
- ..Default::default()
- },
- RefundUpdate::ErrorUpdate {
- refund_status,
- refund_error_message,
- } => Self {
- refund_status,
- refund_error_message,
- ..Default::default()
- },
- }
- }
-}
-
-#[derive(Debug, Eq, PartialEq, Deserialize, Serialize)]
-pub struct RefundCoreWorkflow {
- pub refund_internal_reference_id: String,
- pub transaction_id: String,
- pub merchant_id: String,
- pub payment_id: String,
-}
+pub use storage_models::refund::{
+ Refund, RefundCoreWorkflow, RefundNew, RefundUpdate, RefundUpdateInternal,
+};
diff --git a/crates/router/src/types/storage/temp_card.rs b/crates/router/src/types/storage/temp_card.rs
index 6b036ef8d9c..fba5d4b5180 100644
--- a/crates/router/src/types/storage/temp_card.rs
+++ b/crates/router/src/types/storage/temp_card.rs
@@ -1,23 +1 @@
-use diesel::{Identifiable, Insertable, Queryable};
-use serde_json::Value;
-use time::PrimitiveDateTime;
-
-use crate::schema::temp_card;
-
-#[derive(Clone, Debug, router_derive::DebugAsDisplay, Queryable, Identifiable, Insertable)]
-#[diesel(table_name = temp_card)]
-pub struct TempCard {
- pub id: i32,
- pub date_created: PrimitiveDateTime,
- pub txn_id: Option<String>,
- pub card_info: Option<Value>,
-}
-
-#[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay)]
-#[diesel(table_name = temp_card)]
-pub struct TempCardNew {
- pub id: Option<i32>,
- pub card_info: Option<Value>,
- pub date_created: PrimitiveDateTime,
- pub txn_id: Option<String>,
-}
+pub use storage_models::temp_card::{TempCard, TempCardNew};
diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs
index 60b62867c1d..9b6bad04baa 100644
--- a/crates/router/src/types/transformers.rs
+++ b/crates/router/src/types/transformers.rs
@@ -1,184 +1,366 @@
+use std::convert::TryInto;
+
use api_models::enums as api_enums;
+use storage_models::enums as storage_enums;
+
+use crate::{
+ core::errors,
+ types::{api as api_types, storage},
+};
+
+pub struct Foreign<T>(pub T);
+
+type F<T> = Foreign<T>;
+
+impl<T> From<T> for Foreign<T> {
+ fn from(val: T) -> Self {
+ Self(val)
+ }
+}
+
+pub trait ForeignInto<T> {
+ fn foreign_into(self) -> T;
+}
+
+pub trait ForeignTryInto<T> {
+ type Error;
+
+ fn foreign_try_into(self) -> Result<T, Self::Error>;
+}
+
+pub trait ForeignFrom<F> {
+ fn foreign_from(from: F) -> Self;
+}
+
+pub trait ForeignTryFrom<F>: Sized {
+ type Error;
+
+ fn foreign_try_from(from: F) -> Result<Self, Self::Error>;
+}
+
+impl<F, T> ForeignInto<T> for F
+where
+ Foreign<F>: Into<Foreign<T>>,
+{
+ fn foreign_into(self) -> T {
+ let f_from = Foreign(self);
+ let f_to: Foreign<T> = f_from.into();
+ f_to.0
+ }
+}
+
+impl<F, T> ForeignTryInto<T> for F
+where
+ Foreign<F>: TryInto<Foreign<T>>,
+{
+ type Error = <Foreign<F> as TryInto<Foreign<T>>>::Error;
+
+ fn foreign_try_into(self) -> Result<T, Self::Error> {
+ let f_from = Foreign(self);
+ let f_to: Result<Foreign<T>, Self::Error> = f_from.try_into();
+ f_to.map(|f| f.0)
+ }
+}
+
+impl<F, T> ForeignFrom<F> for T
+where
+ Foreign<T>: From<Foreign<F>>,
+{
+ fn foreign_from(from: F) -> Self {
+ let f_from = Foreign(from);
+ let f_to: Foreign<Self> = f_from.into();
+ f_to.0
+ }
+}
+
+impl<F, T> ForeignTryFrom<F> for T
+where
+ Foreign<T>: TryFrom<Foreign<F>>,
+{
+ type Error = <Foreign<T> as TryFrom<Foreign<F>>>::Error;
-use crate::{core::errors, types::storage::enums as storage_enums};
+ fn foreign_try_from(from: F) -> Result<Self, Self::Error> {
+ let f_from = Foreign(from);
+ let f_to: Result<Foreign<Self>, Self::Error> = f_from.try_into();
+ f_to.map(|f| f.0)
+ }
+}
-impl From<api_enums::RoutingAlgorithm> for storage_enums::RoutingAlgorithm {
- fn from(algo: api_enums::RoutingAlgorithm) -> Self {
- match algo {
- api_enums::RoutingAlgorithm::RoundRobin => Self::RoundRobin,
- api_enums::RoutingAlgorithm::MaxConversion => Self::MaxConversion,
- api_enums::RoutingAlgorithm::MinCost => Self::MinCost,
- api_enums::RoutingAlgorithm::Custom => Self::Custom,
+impl From<F<api_enums::RoutingAlgorithm>> for F<storage_enums::RoutingAlgorithm> {
+ fn from(algo: F<api_enums::RoutingAlgorithm>) -> Self {
+ match algo.0 {
+ api_enums::RoutingAlgorithm::RoundRobin => storage_enums::RoutingAlgorithm::RoundRobin,
+ api_enums::RoutingAlgorithm::MaxConversion => {
+ storage_enums::RoutingAlgorithm::MaxConversion
+ }
+ api_enums::RoutingAlgorithm::MinCost => storage_enums::RoutingAlgorithm::MinCost,
+ api_enums::RoutingAlgorithm::Custom => storage_enums::RoutingAlgorithm::Custom,
}
+ .into()
}
}
-impl From<storage_enums::RoutingAlgorithm> for api_enums::RoutingAlgorithm {
- fn from(algo: storage_enums::RoutingAlgorithm) -> Self {
- match algo {
- storage_enums::RoutingAlgorithm::RoundRobin => Self::RoundRobin,
- storage_enums::RoutingAlgorithm::MaxConversion => Self::MaxConversion,
- storage_enums::RoutingAlgorithm::MinCost => Self::MinCost,
- storage_enums::RoutingAlgorithm::Custom => Self::Custom,
+impl From<F<storage_enums::RoutingAlgorithm>> for F<api_enums::RoutingAlgorithm> {
+ fn from(algo: F<storage_enums::RoutingAlgorithm>) -> Self {
+ match algo.0 {
+ storage_enums::RoutingAlgorithm::RoundRobin => api_enums::RoutingAlgorithm::RoundRobin,
+ storage_enums::RoutingAlgorithm::MaxConversion => {
+ api_enums::RoutingAlgorithm::MaxConversion
+ }
+ storage_enums::RoutingAlgorithm::MinCost => api_enums::RoutingAlgorithm::MinCost,
+ storage_enums::RoutingAlgorithm::Custom => api_enums::RoutingAlgorithm::Custom,
}
+ .into()
}
}
-impl From<api_enums::ConnectorType> for storage_enums::ConnectorType {
- fn from(conn: api_enums::ConnectorType) -> Self {
- match conn {
- api_enums::ConnectorType::PaymentProcessor => Self::PaymentProcessor,
- api_enums::ConnectorType::PaymentVas => Self::PaymentVas,
- api_enums::ConnectorType::FinOperations => Self::FinOperations,
- api_enums::ConnectorType::FizOperations => Self::FizOperations,
- api_enums::ConnectorType::Networks => Self::Networks,
- api_enums::ConnectorType::BankingEntities => Self::BankingEntities,
- api_enums::ConnectorType::NonBankingFinance => Self::NonBankingFinance,
+impl From<F<api_enums::ConnectorType>> for F<storage_enums::ConnectorType> {
+ fn from(conn: F<api_enums::ConnectorType>) -> Self {
+ match conn.0 {
+ api_enums::ConnectorType::PaymentProcessor => {
+ storage_enums::ConnectorType::PaymentProcessor
+ }
+ api_enums::ConnectorType::PaymentVas => storage_enums::ConnectorType::PaymentVas,
+ api_enums::ConnectorType::FinOperations => storage_enums::ConnectorType::FinOperations,
+ api_enums::ConnectorType::FizOperations => storage_enums::ConnectorType::FizOperations,
+ api_enums::ConnectorType::Networks => storage_enums::ConnectorType::Networks,
+ api_enums::ConnectorType::BankingEntities => {
+ storage_enums::ConnectorType::BankingEntities
+ }
+ api_enums::ConnectorType::NonBankingFinance => {
+ storage_enums::ConnectorType::NonBankingFinance
+ }
}
+ .into()
}
}
-impl From<storage_enums::ConnectorType> for api_enums::ConnectorType {
- fn from(conn: storage_enums::ConnectorType) -> Self {
- match conn {
- storage_enums::ConnectorType::PaymentProcessor => Self::PaymentProcessor,
- storage_enums::ConnectorType::PaymentVas => Self::PaymentVas,
- storage_enums::ConnectorType::FinOperations => Self::FinOperations,
- storage_enums::ConnectorType::FizOperations => Self::FizOperations,
- storage_enums::ConnectorType::Networks => Self::Networks,
- storage_enums::ConnectorType::BankingEntities => Self::BankingEntities,
- storage_enums::ConnectorType::NonBankingFinance => Self::NonBankingFinance,
+impl From<F<storage_enums::ConnectorType>> for F<api_enums::ConnectorType> {
+ fn from(conn: F<storage_enums::ConnectorType>) -> Self {
+ match conn.0 {
+ storage_enums::ConnectorType::PaymentProcessor => {
+ api_enums::ConnectorType::PaymentProcessor
+ }
+ storage_enums::ConnectorType::PaymentVas => api_enums::ConnectorType::PaymentVas,
+ storage_enums::ConnectorType::FinOperations => api_enums::ConnectorType::FinOperations,
+ storage_enums::ConnectorType::FizOperations => api_enums::ConnectorType::FizOperations,
+ storage_enums::ConnectorType::Networks => api_enums::ConnectorType::Networks,
+ storage_enums::ConnectorType::BankingEntities => {
+ api_enums::ConnectorType::BankingEntities
+ }
+ storage_enums::ConnectorType::NonBankingFinance => {
+ api_enums::ConnectorType::NonBankingFinance
+ }
}
+ .into()
}
}
-impl From<storage_enums::MandateStatus> for api_enums::MandateStatus {
- fn from(status: storage_enums::MandateStatus) -> Self {
- match status {
- storage_enums::MandateStatus::Active => Self::Active,
- storage_enums::MandateStatus::Inactive => Self::Inactive,
- storage_enums::MandateStatus::Pending => Self::Pending,
- storage_enums::MandateStatus::Revoked => Self::Revoked,
+impl From<F<storage_enums::MandateStatus>> for F<api_enums::MandateStatus> {
+ fn from(status: F<storage_enums::MandateStatus>) -> Self {
+ match status.0 {
+ storage_enums::MandateStatus::Active => api_enums::MandateStatus::Active,
+ storage_enums::MandateStatus::Inactive => api_enums::MandateStatus::Inactive,
+ storage_enums::MandateStatus::Pending => api_enums::MandateStatus::Pending,
+ storage_enums::MandateStatus::Revoked => api_enums::MandateStatus::Revoked,
}
+ .into()
}
}
-impl From<api_enums::PaymentMethodType> for storage_enums::PaymentMethodType {
- fn from(pm_type: api_enums::PaymentMethodType) -> Self {
- match pm_type {
- api_enums::PaymentMethodType::Card => Self::Card,
- api_enums::PaymentMethodType::PaymentContainer => Self::PaymentContainer,
- api_enums::PaymentMethodType::BankTransfer => Self::BankTransfer,
- api_enums::PaymentMethodType::BankDebit => Self::BankDebit,
- api_enums::PaymentMethodType::PayLater => Self::PayLater,
- api_enums::PaymentMethodType::Netbanking => Self::Netbanking,
- api_enums::PaymentMethodType::Upi => Self::Upi,
- api_enums::PaymentMethodType::OpenBanking => Self::OpenBanking,
- api_enums::PaymentMethodType::ConsumerFinance => Self::ConsumerFinance,
- api_enums::PaymentMethodType::Wallet => Self::Wallet,
- api_enums::PaymentMethodType::Klarna => Self::Klarna,
- api_enums::PaymentMethodType::Paypal => Self::Paypal,
+impl From<F<api_enums::PaymentMethodType>> for F<storage_enums::PaymentMethodType> {
+ fn from(pm_type: F<api_enums::PaymentMethodType>) -> Self {
+ match pm_type.0 {
+ api_enums::PaymentMethodType::Card => storage_enums::PaymentMethodType::Card,
+ api_enums::PaymentMethodType::PaymentContainer => {
+ storage_enums::PaymentMethodType::PaymentContainer
+ }
+ api_enums::PaymentMethodType::BankTransfer => {
+ storage_enums::PaymentMethodType::BankTransfer
+ }
+ api_enums::PaymentMethodType::BankDebit => storage_enums::PaymentMethodType::BankDebit,
+ api_enums::PaymentMethodType::PayLater => storage_enums::PaymentMethodType::PayLater,
+ api_enums::PaymentMethodType::Netbanking => {
+ storage_enums::PaymentMethodType::Netbanking
+ }
+ api_enums::PaymentMethodType::Upi => storage_enums::PaymentMethodType::Upi,
+ api_enums::PaymentMethodType::OpenBanking => {
+ storage_enums::PaymentMethodType::OpenBanking
+ }
+ api_enums::PaymentMethodType::ConsumerFinance => {
+ storage_enums::PaymentMethodType::ConsumerFinance
+ }
+ api_enums::PaymentMethodType::Wallet => storage_enums::PaymentMethodType::Wallet,
+ api_enums::PaymentMethodType::Klarna => storage_enums::PaymentMethodType::Klarna,
+ api_enums::PaymentMethodType::Paypal => storage_enums::PaymentMethodType::Paypal,
}
+ .into()
}
}
-impl From<storage_enums::PaymentMethodType> for api_enums::PaymentMethodType {
- fn from(pm_type: storage_enums::PaymentMethodType) -> Self {
- match pm_type {
- storage_enums::PaymentMethodType::Card => Self::Card,
- storage_enums::PaymentMethodType::PaymentContainer => Self::PaymentContainer,
- storage_enums::PaymentMethodType::BankTransfer => Self::BankTransfer,
- storage_enums::PaymentMethodType::BankDebit => Self::BankDebit,
- storage_enums::PaymentMethodType::PayLater => Self::PayLater,
- storage_enums::PaymentMethodType::Netbanking => Self::Netbanking,
- storage_enums::PaymentMethodType::Upi => Self::Upi,
- storage_enums::PaymentMethodType::OpenBanking => Self::OpenBanking,
- storage_enums::PaymentMethodType::ConsumerFinance => Self::ConsumerFinance,
- storage_enums::PaymentMethodType::Wallet => Self::Wallet,
- storage_enums::PaymentMethodType::Klarna => Self::Klarna,
- storage_enums::PaymentMethodType::Paypal => Self::Paypal,
+impl From<F<storage_enums::PaymentMethodType>> for F<api_enums::PaymentMethodType> {
+ fn from(pm_type: F<storage_enums::PaymentMethodType>) -> Self {
+ match pm_type.0 {
+ storage_enums::PaymentMethodType::Card => api_enums::PaymentMethodType::Card,
+ storage_enums::PaymentMethodType::PaymentContainer => {
+ api_enums::PaymentMethodType::PaymentContainer
+ }
+ storage_enums::PaymentMethodType::BankTransfer => {
+ api_enums::PaymentMethodType::BankTransfer
+ }
+ storage_enums::PaymentMethodType::BankDebit => api_enums::PaymentMethodType::BankDebit,
+ storage_enums::PaymentMethodType::PayLater => api_enums::PaymentMethodType::PayLater,
+ storage_enums::PaymentMethodType::Netbanking => {
+ api_enums::PaymentMethodType::Netbanking
+ }
+ storage_enums::PaymentMethodType::Upi => api_enums::PaymentMethodType::Upi,
+ storage_enums::PaymentMethodType::OpenBanking => {
+ api_enums::PaymentMethodType::OpenBanking
+ }
+ storage_enums::PaymentMethodType::ConsumerFinance => {
+ api_enums::PaymentMethodType::ConsumerFinance
+ }
+ storage_enums::PaymentMethodType::Wallet => api_enums::PaymentMethodType::Wallet,
+ storage_enums::PaymentMethodType::Klarna => api_enums::PaymentMethodType::Klarna,
+ storage_enums::PaymentMethodType::Paypal => api_enums::PaymentMethodType::Paypal,
}
+ .into()
}
}
-impl From<api_enums::PaymentMethodSubType> for storage_enums::PaymentMethodSubType {
- fn from(pm_subtype: api_enums::PaymentMethodSubType) -> Self {
- match pm_subtype {
- api_enums::PaymentMethodSubType::Credit => Self::Credit,
- api_enums::PaymentMethodSubType::Debit => Self::Debit,
- api_enums::PaymentMethodSubType::UpiIntent => Self::UpiIntent,
- api_enums::PaymentMethodSubType::UpiCollect => Self::UpiCollect,
- api_enums::PaymentMethodSubType::CreditCardInstallments => Self::CreditCardInstallments,
- api_enums::PaymentMethodSubType::PayLaterInstallments => Self::PayLaterInstallments,
+impl From<F<api_enums::PaymentMethodSubType>> for F<storage_enums::PaymentMethodSubType> {
+ fn from(pm_subtype: F<api_enums::PaymentMethodSubType>) -> Self {
+ match pm_subtype.0 {
+ api_enums::PaymentMethodSubType::Credit => storage_enums::PaymentMethodSubType::Credit,
+ api_enums::PaymentMethodSubType::Debit => storage_enums::PaymentMethodSubType::Debit,
+ api_enums::PaymentMethodSubType::UpiIntent => {
+ storage_enums::PaymentMethodSubType::UpiIntent
+ }
+ api_enums::PaymentMethodSubType::UpiCollect => {
+ storage_enums::PaymentMethodSubType::UpiCollect
+ }
+ api_enums::PaymentMethodSubType::CreditCardInstallments => {
+ storage_enums::PaymentMethodSubType::CreditCardInstallments
+ }
+ api_enums::PaymentMethodSubType::PayLaterInstallments => {
+ storage_enums::PaymentMethodSubType::PayLaterInstallments
+ }
}
+ .into()
}
}
-impl From<storage_enums::PaymentMethodSubType> for api_enums::PaymentMethodSubType {
- fn from(pm_subtype: storage_enums::PaymentMethodSubType) -> Self {
- match pm_subtype {
- storage_enums::PaymentMethodSubType::Credit => Self::Credit,
- storage_enums::PaymentMethodSubType::Debit => Self::Debit,
- storage_enums::PaymentMethodSubType::UpiIntent => Self::UpiIntent,
- storage_enums::PaymentMethodSubType::UpiCollect => Self::UpiCollect,
+impl From<F<storage_enums::PaymentMethodSubType>> for F<api_enums::PaymentMethodSubType> {
+ fn from(pm_subtype: F<storage_enums::PaymentMethodSubType>) -> Self {
+ match pm_subtype.0 {
+ storage_enums::PaymentMethodSubType::Credit => api_enums::PaymentMethodSubType::Credit,
+ storage_enums::PaymentMethodSubType::Debit => api_enums::PaymentMethodSubType::Debit,
+ storage_enums::PaymentMethodSubType::UpiIntent => {
+ api_enums::PaymentMethodSubType::UpiIntent
+ }
+ storage_enums::PaymentMethodSubType::UpiCollect => {
+ api_enums::PaymentMethodSubType::UpiCollect
+ }
storage_enums::PaymentMethodSubType::CreditCardInstallments => {
- Self::CreditCardInstallments
+ api_enums::PaymentMethodSubType::CreditCardInstallments
+ }
+ storage_enums::PaymentMethodSubType::PayLaterInstallments => {
+ api_enums::PaymentMethodSubType::PayLaterInstallments
}
- storage_enums::PaymentMethodSubType::PayLaterInstallments => Self::PayLaterInstallments,
}
+ .into()
}
}
-impl From<storage_enums::PaymentMethodIssuerCode> for api_enums::PaymentMethodIssuerCode {
- fn from(issuer_code: storage_enums::PaymentMethodIssuerCode) -> Self {
- match issuer_code {
- storage_enums::PaymentMethodIssuerCode::JpHdfc => Self::JpHdfc,
- storage_enums::PaymentMethodIssuerCode::JpIcici => Self::JpIcici,
- storage_enums::PaymentMethodIssuerCode::JpGooglepay => Self::JpGooglepay,
- storage_enums::PaymentMethodIssuerCode::JpApplepay => Self::JpApplepay,
- storage_enums::PaymentMethodIssuerCode::JpPhonepay => Self::JpPhonepay,
- storage_enums::PaymentMethodIssuerCode::JpWechat => Self::JpWechat,
- storage_enums::PaymentMethodIssuerCode::JpSofort => Self::JpSofort,
- storage_enums::PaymentMethodIssuerCode::JpGiropay => Self::JpGiropay,
- storage_enums::PaymentMethodIssuerCode::JpSepa => Self::JpSepa,
- storage_enums::PaymentMethodIssuerCode::JpBacs => Self::JpBacs,
+impl From<F<storage_enums::PaymentMethodIssuerCode>> for F<api_enums::PaymentMethodIssuerCode> {
+ fn from(issuer_code: F<storage_enums::PaymentMethodIssuerCode>) -> Self {
+ match issuer_code.0 {
+ storage_enums::PaymentMethodIssuerCode::JpHdfc => {
+ api_enums::PaymentMethodIssuerCode::JpHdfc
+ }
+ storage_enums::PaymentMethodIssuerCode::JpIcici => {
+ api_enums::PaymentMethodIssuerCode::JpIcici
+ }
+ storage_enums::PaymentMethodIssuerCode::JpGooglepay => {
+ api_enums::PaymentMethodIssuerCode::JpGooglepay
+ }
+ storage_enums::PaymentMethodIssuerCode::JpApplepay => {
+ api_enums::PaymentMethodIssuerCode::JpApplepay
+ }
+ storage_enums::PaymentMethodIssuerCode::JpPhonepay => {
+ api_enums::PaymentMethodIssuerCode::JpPhonepay
+ }
+ storage_enums::PaymentMethodIssuerCode::JpWechat => {
+ api_enums::PaymentMethodIssuerCode::JpWechat
+ }
+ storage_enums::PaymentMethodIssuerCode::JpSofort => {
+ api_enums::PaymentMethodIssuerCode::JpSofort
+ }
+ storage_enums::PaymentMethodIssuerCode::JpGiropay => {
+ api_enums::PaymentMethodIssuerCode::JpGiropay
+ }
+ storage_enums::PaymentMethodIssuerCode::JpSepa => {
+ api_enums::PaymentMethodIssuerCode::JpSepa
+ }
+ storage_enums::PaymentMethodIssuerCode::JpBacs => {
+ api_enums::PaymentMethodIssuerCode::JpBacs
+ }
}
+ .into()
}
}
-impl From<storage_enums::IntentStatus> for api_enums::IntentStatus {
- fn from(status: storage_enums::IntentStatus) -> Self {
- match status {
- storage_enums::IntentStatus::Succeeded => Self::Succeeded,
- storage_enums::IntentStatus::Failed => Self::Failed,
- storage_enums::IntentStatus::Cancelled => Self::Cancelled,
- storage_enums::IntentStatus::Processing => Self::Processing,
- storage_enums::IntentStatus::RequiresCustomerAction => Self::RequiresCustomerAction,
- storage_enums::IntentStatus::RequiresPaymentMethod => Self::RequiresPaymentMethod,
- storage_enums::IntentStatus::RequiresConfirmation => Self::RequiresConfirmation,
- storage_enums::IntentStatus::RequiresCapture => Self::RequiresCapture,
+impl From<F<storage_enums::IntentStatus>> for F<api_enums::IntentStatus> {
+ fn from(status: F<storage_enums::IntentStatus>) -> Self {
+ match status.0 {
+ storage_enums::IntentStatus::Succeeded => api_enums::IntentStatus::Succeeded,
+ storage_enums::IntentStatus::Failed => api_enums::IntentStatus::Failed,
+ storage_enums::IntentStatus::Cancelled => api_enums::IntentStatus::Cancelled,
+ storage_enums::IntentStatus::Processing => api_enums::IntentStatus::Processing,
+ storage_enums::IntentStatus::RequiresCustomerAction => {
+ api_enums::IntentStatus::RequiresCustomerAction
+ }
+ storage_enums::IntentStatus::RequiresPaymentMethod => {
+ api_enums::IntentStatus::RequiresPaymentMethod
+ }
+ storage_enums::IntentStatus::RequiresConfirmation => {
+ api_enums::IntentStatus::RequiresConfirmation
+ }
+ storage_enums::IntentStatus::RequiresCapture => {
+ api_enums::IntentStatus::RequiresCapture
+ }
}
+ .into()
}
}
-impl From<api_enums::IntentStatus> for storage_enums::IntentStatus {
- fn from(status: api_enums::IntentStatus) -> Self {
- match status {
- api_enums::IntentStatus::Succeeded => Self::Succeeded,
- api_enums::IntentStatus::Failed => Self::Failed,
- api_enums::IntentStatus::Cancelled => Self::Cancelled,
- api_enums::IntentStatus::Processing => Self::Processing,
- api_enums::IntentStatus::RequiresCustomerAction => Self::RequiresCustomerAction,
- api_enums::IntentStatus::RequiresPaymentMethod => Self::RequiresPaymentMethod,
- api_enums::IntentStatus::RequiresConfirmation => Self::RequiresConfirmation,
- api_enums::IntentStatus::RequiresCapture => Self::RequiresCapture,
+impl From<F<api_enums::IntentStatus>> for F<storage_enums::IntentStatus> {
+ fn from(status: F<api_enums::IntentStatus>) -> Self {
+ match status.0 {
+ api_enums::IntentStatus::Succeeded => storage_enums::IntentStatus::Succeeded,
+ api_enums::IntentStatus::Failed => storage_enums::IntentStatus::Failed,
+ api_enums::IntentStatus::Cancelled => storage_enums::IntentStatus::Cancelled,
+ api_enums::IntentStatus::Processing => storage_enums::IntentStatus::Processing,
+ api_enums::IntentStatus::RequiresCustomerAction => {
+ storage_enums::IntentStatus::RequiresCustomerAction
+ }
+ api_enums::IntentStatus::RequiresPaymentMethod => {
+ storage_enums::IntentStatus::RequiresPaymentMethod
+ }
+ api_enums::IntentStatus::RequiresConfirmation => {
+ storage_enums::IntentStatus::RequiresConfirmation
+ }
+ api_enums::IntentStatus::RequiresCapture => {
+ storage_enums::IntentStatus::RequiresCapture
+ }
}
+ .into()
}
}
-impl From<storage_enums::AttemptStatus> for storage_enums::IntentStatus {
- fn from(s: storage_enums::AttemptStatus) -> Self {
- match s {
+impl From<F<storage_enums::AttemptStatus>> for F<storage_enums::IntentStatus> {
+ fn from(s: F<storage_enums::AttemptStatus>) -> Self {
+ match s.0 {
storage_enums::AttemptStatus::Charged | storage_enums::AttemptStatus::AutoRefunded => {
storage_enums::IntentStatus::Succeeded
}
@@ -214,206 +396,271 @@ impl From<storage_enums::AttemptStatus> for storage_enums::IntentStatus {
| storage_enums::AttemptStatus::Failure => storage_enums::IntentStatus::Failed,
storage_enums::AttemptStatus::Voided => storage_enums::IntentStatus::Cancelled,
}
+ .into()
}
}
-impl TryFrom<api_enums::IntentStatus> for storage_enums::EventType {
+impl TryFrom<F<api_enums::IntentStatus>> for F<storage_enums::EventType> {
type Error = errors::ValidationError;
- fn try_from(value: api_enums::IntentStatus) -> Result<Self, Self::Error> {
- match value {
- api_enums::IntentStatus::Succeeded => Ok(Self::PaymentSucceeded),
+ fn try_from(value: F<api_enums::IntentStatus>) -> Result<Self, Self::Error> {
+ match value.0 {
+ api_enums::IntentStatus::Succeeded => Ok(storage_enums::EventType::PaymentSucceeded),
_ => Err(errors::ValidationError::IncorrectValueProvided {
field_name: "intent_status",
}),
}
+ .map(Into::into)
}
}
-impl From<storage_enums::EventType> for api_enums::EventType {
- fn from(event_type: storage_enums::EventType) -> Self {
- match event_type {
+impl From<F<storage_enums::EventType>> for F<api_enums::EventType> {
+ fn from(event_type: F<storage_enums::EventType>) -> Self {
+ match event_type.0 {
storage_enums::EventType::PaymentSucceeded => api_enums::EventType::PaymentSucceeded,
}
+ .into()
}
}
-impl From<api_enums::FutureUsage> for storage_enums::FutureUsage {
- fn from(future_usage: api_enums::FutureUsage) -> Self {
- match future_usage {
- api_enums::FutureUsage::OnSession => Self::OnSession,
- api_enums::FutureUsage::OffSession => Self::OffSession,
+impl From<F<api_enums::FutureUsage>> for F<storage_enums::FutureUsage> {
+ fn from(future_usage: F<api_enums::FutureUsage>) -> Self {
+ match future_usage.0 {
+ api_enums::FutureUsage::OnSession => storage_enums::FutureUsage::OnSession,
+ api_enums::FutureUsage::OffSession => storage_enums::FutureUsage::OffSession,
}
+ .into()
}
}
-impl From<storage_enums::FutureUsage> for api_enums::FutureUsage {
- fn from(future_usage: storage_enums::FutureUsage) -> Self {
- match future_usage {
- storage_enums::FutureUsage::OnSession => Self::OnSession,
- storage_enums::FutureUsage::OffSession => Self::OffSession,
+impl From<F<storage_enums::FutureUsage>> for F<api_enums::FutureUsage> {
+ fn from(future_usage: F<storage_enums::FutureUsage>) -> Self {
+ match future_usage.0 {
+ storage_enums::FutureUsage::OnSession => api_enums::FutureUsage::OnSession,
+ storage_enums::FutureUsage::OffSession => api_enums::FutureUsage::OffSession,
}
+ .into()
}
}
-impl From<storage_enums::RefundStatus> for api_enums::RefundStatus {
- fn from(status: storage_enums::RefundStatus) -> Self {
- match status {
- storage_enums::RefundStatus::Failure => Self::Failure,
- storage_enums::RefundStatus::ManualReview => Self::ManualReview,
- storage_enums::RefundStatus::Pending => Self::Pending,
- storage_enums::RefundStatus::Success => Self::Success,
- storage_enums::RefundStatus::TransactionFailure => Self::TransactionFailure,
+impl From<F<storage_enums::RefundStatus>> for F<api_enums::RefundStatus> {
+ fn from(status: F<storage_enums::RefundStatus>) -> Self {
+ match status.0 {
+ storage_enums::RefundStatus::Failure => api_enums::RefundStatus::Failure,
+ storage_enums::RefundStatus::ManualReview => api_enums::RefundStatus::ManualReview,
+ storage_enums::RefundStatus::Pending => api_enums::RefundStatus::Pending,
+ storage_enums::RefundStatus::Success => api_enums::RefundStatus::Success,
+ storage_enums::RefundStatus::TransactionFailure => {
+ api_enums::RefundStatus::TransactionFailure
+ }
}
+ .into()
}
}
-impl From<api_enums::CaptureMethod> for storage_enums::CaptureMethod {
- fn from(capture_method: api_enums::CaptureMethod) -> Self {
- match capture_method {
- api_enums::CaptureMethod::Automatic => Self::Automatic,
- api_enums::CaptureMethod::Manual => Self::Manual,
- api_enums::CaptureMethod::ManualMultiple => Self::ManualMultiple,
- api_enums::CaptureMethod::Scheduled => Self::Scheduled,
+impl From<F<api_enums::CaptureMethod>> for F<storage_enums::CaptureMethod> {
+ fn from(capture_method: F<api_enums::CaptureMethod>) -> Self {
+ match capture_method.0 {
+ api_enums::CaptureMethod::Automatic => storage_enums::CaptureMethod::Automatic,
+ api_enums::CaptureMethod::Manual => storage_enums::CaptureMethod::Manual,
+ api_enums::CaptureMethod::ManualMultiple => {
+ storage_enums::CaptureMethod::ManualMultiple
+ }
+ api_enums::CaptureMethod::Scheduled => storage_enums::CaptureMethod::Scheduled,
}
+ .into()
}
}
-impl From<storage_enums::CaptureMethod> for api_enums::CaptureMethod {
- fn from(capture_method: storage_enums::CaptureMethod) -> Self {
- match capture_method {
- storage_enums::CaptureMethod::Automatic => Self::Automatic,
- storage_enums::CaptureMethod::Manual => Self::Manual,
- storage_enums::CaptureMethod::ManualMultiple => Self::ManualMultiple,
- storage_enums::CaptureMethod::Scheduled => Self::Scheduled,
+impl From<F<storage_enums::CaptureMethod>> for F<api_enums::CaptureMethod> {
+ fn from(capture_method: F<storage_enums::CaptureMethod>) -> Self {
+ match capture_method.0 {
+ storage_enums::CaptureMethod::Automatic => api_enums::CaptureMethod::Automatic,
+ storage_enums::CaptureMethod::Manual => api_enums::CaptureMethod::Manual,
+ storage_enums::CaptureMethod::ManualMultiple => {
+ api_enums::CaptureMethod::ManualMultiple
+ }
+ storage_enums::CaptureMethod::Scheduled => api_enums::CaptureMethod::Scheduled,
}
+ .into()
}
}
-impl From<api_enums::AuthenticationType> for storage_enums::AuthenticationType {
- fn from(auth_type: api_enums::AuthenticationType) -> Self {
- match auth_type {
- api_enums::AuthenticationType::ThreeDs => Self::ThreeDs,
- api_enums::AuthenticationType::NoThreeDs => Self::NoThreeDs,
+impl From<F<api_enums::AuthenticationType>> for F<storage_enums::AuthenticationType> {
+ fn from(auth_type: F<api_enums::AuthenticationType>) -> Self {
+ match auth_type.0 {
+ api_enums::AuthenticationType::ThreeDs => storage_enums::AuthenticationType::ThreeDs,
+ api_enums::AuthenticationType::NoThreeDs => {
+ storage_enums::AuthenticationType::NoThreeDs
+ }
}
+ .into()
}
}
-impl From<storage_enums::AuthenticationType> for api_enums::AuthenticationType {
- fn from(auth_type: storage_enums::AuthenticationType) -> Self {
- match auth_type {
- storage_enums::AuthenticationType::ThreeDs => Self::ThreeDs,
- storage_enums::AuthenticationType::NoThreeDs => Self::NoThreeDs,
+impl From<F<storage_enums::AuthenticationType>> for F<api_enums::AuthenticationType> {
+ fn from(auth_type: F<storage_enums::AuthenticationType>) -> Self {
+ match auth_type.0 {
+ storage_enums::AuthenticationType::ThreeDs => api_enums::AuthenticationType::ThreeDs,
+ storage_enums::AuthenticationType::NoThreeDs => {
+ api_enums::AuthenticationType::NoThreeDs
+ }
+ }
+ .into()
+ }
+}
+
+impl From<F<api_enums::Currency>> for F<storage_enums::Currency> {
+ fn from(currency: F<api_enums::Currency>) -> Self {
+ match currency.0 {
+ api_enums::Currency::AED => storage_enums::Currency::AED,
+ api_enums::Currency::ALL => storage_enums::Currency::ALL,
+ api_enums::Currency::AMD => storage_enums::Currency::AMD,
+ api_enums::Currency::ARS => storage_enums::Currency::ARS,
+ api_enums::Currency::AUD => storage_enums::Currency::AUD,
+ api_enums::Currency::AWG => storage_enums::Currency::AWG,
+ api_enums::Currency::AZN => storage_enums::Currency::AZN,
+ api_enums::Currency::BBD => storage_enums::Currency::BBD,
+ api_enums::Currency::BDT => storage_enums::Currency::BDT,
+ api_enums::Currency::BHD => storage_enums::Currency::BHD,
+ api_enums::Currency::BMD => storage_enums::Currency::BMD,
+ api_enums::Currency::BND => storage_enums::Currency::BND,
+ api_enums::Currency::BOB => storage_enums::Currency::BOB,
+ api_enums::Currency::BRL => storage_enums::Currency::BRL,
+ api_enums::Currency::BSD => storage_enums::Currency::BSD,
+ api_enums::Currency::BWP => storage_enums::Currency::BWP,
+ api_enums::Currency::BZD => storage_enums::Currency::BZD,
+ api_enums::Currency::CAD => storage_enums::Currency::CAD,
+ api_enums::Currency::CHF => storage_enums::Currency::CHF,
+ api_enums::Currency::CNY => storage_enums::Currency::CNY,
+ api_enums::Currency::COP => storage_enums::Currency::COP,
+ api_enums::Currency::CRC => storage_enums::Currency::CRC,
+ api_enums::Currency::CUP => storage_enums::Currency::CUP,
+ api_enums::Currency::CZK => storage_enums::Currency::CZK,
+ api_enums::Currency::DKK => storage_enums::Currency::DKK,
+ api_enums::Currency::DOP => storage_enums::Currency::DOP,
+ api_enums::Currency::DZD => storage_enums::Currency::DZD,
+ api_enums::Currency::EGP => storage_enums::Currency::EGP,
+ api_enums::Currency::ETB => storage_enums::Currency::ETB,
+ api_enums::Currency::EUR => storage_enums::Currency::EUR,
+ api_enums::Currency::FJD => storage_enums::Currency::FJD,
+ api_enums::Currency::GBP => storage_enums::Currency::GBP,
+ api_enums::Currency::GHS => storage_enums::Currency::GHS,
+ api_enums::Currency::GIP => storage_enums::Currency::GIP,
+ api_enums::Currency::GMD => storage_enums::Currency::GMD,
+ api_enums::Currency::GTQ => storage_enums::Currency::GTQ,
+ api_enums::Currency::GYD => storage_enums::Currency::GYD,
+ api_enums::Currency::HKD => storage_enums::Currency::HKD,
+ api_enums::Currency::HNL => storage_enums::Currency::HNL,
+ api_enums::Currency::HRK => storage_enums::Currency::HRK,
+ api_enums::Currency::HTG => storage_enums::Currency::HTG,
+ api_enums::Currency::HUF => storage_enums::Currency::HUF,
+ api_enums::Currency::IDR => storage_enums::Currency::IDR,
+ api_enums::Currency::ILS => storage_enums::Currency::ILS,
+ api_enums::Currency::INR => storage_enums::Currency::INR,
+ api_enums::Currency::JMD => storage_enums::Currency::JMD,
+ api_enums::Currency::JOD => storage_enums::Currency::JOD,
+ api_enums::Currency::JPY => storage_enums::Currency::JPY,
+ api_enums::Currency::KES => storage_enums::Currency::KES,
+ api_enums::Currency::KGS => storage_enums::Currency::KGS,
+ api_enums::Currency::KHR => storage_enums::Currency::KHR,
+ api_enums::Currency::KRW => storage_enums::Currency::KRW,
+ api_enums::Currency::KWD => storage_enums::Currency::KWD,
+ api_enums::Currency::KYD => storage_enums::Currency::KYD,
+ api_enums::Currency::KZT => storage_enums::Currency::KZT,
+ api_enums::Currency::LAK => storage_enums::Currency::LAK,
+ api_enums::Currency::LBP => storage_enums::Currency::LBP,
+ api_enums::Currency::LKR => storage_enums::Currency::LKR,
+ api_enums::Currency::LRD => storage_enums::Currency::LRD,
+ api_enums::Currency::LSL => storage_enums::Currency::LSL,
+ api_enums::Currency::MAD => storage_enums::Currency::MAD,
+ api_enums::Currency::MDL => storage_enums::Currency::MDL,
+ api_enums::Currency::MKD => storage_enums::Currency::MKD,
+ api_enums::Currency::MMK => storage_enums::Currency::MMK,
+ api_enums::Currency::MNT => storage_enums::Currency::MNT,
+ api_enums::Currency::MOP => storage_enums::Currency::MOP,
+ api_enums::Currency::MUR => storage_enums::Currency::MUR,
+ api_enums::Currency::MVR => storage_enums::Currency::MVR,
+ api_enums::Currency::MWK => storage_enums::Currency::MWK,
+ api_enums::Currency::MXN => storage_enums::Currency::MXN,
+ api_enums::Currency::MYR => storage_enums::Currency::MYR,
+ api_enums::Currency::NAD => storage_enums::Currency::NAD,
+ api_enums::Currency::NGN => storage_enums::Currency::NGN,
+ api_enums::Currency::NIO => storage_enums::Currency::NIO,
+ api_enums::Currency::NOK => storage_enums::Currency::NOK,
+ api_enums::Currency::NPR => storage_enums::Currency::NPR,
+ api_enums::Currency::NZD => storage_enums::Currency::NZD,
+ api_enums::Currency::OMR => storage_enums::Currency::OMR,
+ api_enums::Currency::PEN => storage_enums::Currency::PEN,
+ api_enums::Currency::PGK => storage_enums::Currency::PGK,
+ api_enums::Currency::PHP => storage_enums::Currency::PHP,
+ api_enums::Currency::PKR => storage_enums::Currency::PKR,
+ api_enums::Currency::PLN => storage_enums::Currency::PLN,
+ api_enums::Currency::QAR => storage_enums::Currency::QAR,
+ api_enums::Currency::RUB => storage_enums::Currency::RUB,
+ api_enums::Currency::SAR => storage_enums::Currency::SAR,
+ api_enums::Currency::SCR => storage_enums::Currency::SCR,
+ api_enums::Currency::SEK => storage_enums::Currency::SEK,
+ api_enums::Currency::SGD => storage_enums::Currency::SGD,
+ api_enums::Currency::SLL => storage_enums::Currency::SLL,
+ api_enums::Currency::SOS => storage_enums::Currency::SOS,
+ api_enums::Currency::SSP => storage_enums::Currency::SSP,
+ api_enums::Currency::SVC => storage_enums::Currency::SVC,
+ api_enums::Currency::SZL => storage_enums::Currency::SZL,
+ api_enums::Currency::THB => storage_enums::Currency::THB,
+ api_enums::Currency::TTD => storage_enums::Currency::TTD,
+ api_enums::Currency::TWD => storage_enums::Currency::TWD,
+ api_enums::Currency::TZS => storage_enums::Currency::TZS,
+ api_enums::Currency::USD => storage_enums::Currency::USD,
+ api_enums::Currency::UYU => storage_enums::Currency::UYU,
+ api_enums::Currency::UZS => storage_enums::Currency::UZS,
+ api_enums::Currency::YER => storage_enums::Currency::YER,
+ api_enums::Currency::ZAR => storage_enums::Currency::ZAR,
}
+ .into()
}
}
-impl From<api_enums::Currency> for storage_enums::Currency {
- fn from(currency: api_enums::Currency) -> Self {
- match currency {
- api_enums::Currency::AED => Self::AED,
- api_enums::Currency::ALL => Self::ALL,
- api_enums::Currency::AMD => Self::AMD,
- api_enums::Currency::ARS => Self::ARS,
- api_enums::Currency::AUD => Self::AUD,
- api_enums::Currency::AWG => Self::AWG,
- api_enums::Currency::AZN => Self::AZN,
- api_enums::Currency::BBD => Self::BBD,
- api_enums::Currency::BDT => Self::BDT,
- api_enums::Currency::BHD => Self::BHD,
- api_enums::Currency::BMD => Self::BMD,
- api_enums::Currency::BND => Self::BND,
- api_enums::Currency::BOB => Self::BOB,
- api_enums::Currency::BRL => Self::BRL,
- api_enums::Currency::BSD => Self::BSD,
- api_enums::Currency::BWP => Self::BWP,
- api_enums::Currency::BZD => Self::BZD,
- api_enums::Currency::CAD => Self::CAD,
- api_enums::Currency::CHF => Self::CHF,
- api_enums::Currency::CNY => Self::CNY,
- api_enums::Currency::COP => Self::COP,
- api_enums::Currency::CRC => Self::CRC,
- api_enums::Currency::CUP => Self::CUP,
- api_enums::Currency::CZK => Self::CZK,
- api_enums::Currency::DKK => Self::DKK,
- api_enums::Currency::DOP => Self::DOP,
- api_enums::Currency::DZD => Self::DZD,
- api_enums::Currency::EGP => Self::EGP,
- api_enums::Currency::ETB => Self::ETB,
- api_enums::Currency::EUR => Self::EUR,
- api_enums::Currency::FJD => Self::FJD,
- api_enums::Currency::GBP => Self::GBP,
- api_enums::Currency::GHS => Self::GHS,
- api_enums::Currency::GIP => Self::GIP,
- api_enums::Currency::GMD => Self::GMD,
- api_enums::Currency::GTQ => Self::GTQ,
- api_enums::Currency::GYD => Self::GYD,
- api_enums::Currency::HKD => Self::HKD,
- api_enums::Currency::HNL => Self::HNL,
- api_enums::Currency::HRK => Self::HRK,
- api_enums::Currency::HTG => Self::HTG,
- api_enums::Currency::HUF => Self::HUF,
- api_enums::Currency::IDR => Self::IDR,
- api_enums::Currency::ILS => Self::ILS,
- api_enums::Currency::INR => Self::INR,
- api_enums::Currency::JMD => Self::JMD,
- api_enums::Currency::JOD => Self::JOD,
- api_enums::Currency::JPY => Self::JPY,
- api_enums::Currency::KES => Self::KES,
- api_enums::Currency::KGS => Self::KGS,
- api_enums::Currency::KHR => Self::KHR,
- api_enums::Currency::KRW => Self::KRW,
- api_enums::Currency::KWD => Self::KWD,
- api_enums::Currency::KYD => Self::KYD,
- api_enums::Currency::KZT => Self::KZT,
- api_enums::Currency::LAK => Self::LAK,
- api_enums::Currency::LBP => Self::LBP,
- api_enums::Currency::LKR => Self::LKR,
- api_enums::Currency::LRD => Self::LRD,
- api_enums::Currency::LSL => Self::LSL,
- api_enums::Currency::MAD => Self::MAD,
- api_enums::Currency::MDL => Self::MDL,
- api_enums::Currency::MKD => Self::MKD,
- api_enums::Currency::MMK => Self::MMK,
- api_enums::Currency::MNT => Self::MNT,
- api_enums::Currency::MOP => Self::MOP,
- api_enums::Currency::MUR => Self::MUR,
- api_enums::Currency::MVR => Self::MVR,
- api_enums::Currency::MWK => Self::MWK,
- api_enums::Currency::MXN => Self::MXN,
- api_enums::Currency::MYR => Self::MYR,
- api_enums::Currency::NAD => Self::NAD,
- api_enums::Currency::NGN => Self::NGN,
- api_enums::Currency::NIO => Self::NIO,
- api_enums::Currency::NOK => Self::NOK,
- api_enums::Currency::NPR => Self::NPR,
- api_enums::Currency::NZD => Self::NZD,
- api_enums::Currency::OMR => Self::OMR,
- api_enums::Currency::PEN => Self::PEN,
- api_enums::Currency::PGK => Self::PGK,
- api_enums::Currency::PHP => Self::PHP,
- api_enums::Currency::PKR => Self::PKR,
- api_enums::Currency::PLN => Self::PLN,
- api_enums::Currency::QAR => Self::QAR,
- api_enums::Currency::RUB => Self::RUB,
- api_enums::Currency::SAR => Self::SAR,
- api_enums::Currency::SCR => Self::SCR,
- api_enums::Currency::SEK => Self::SEK,
- api_enums::Currency::SGD => Self::SGD,
- api_enums::Currency::SLL => Self::SLL,
- api_enums::Currency::SOS => Self::SOS,
- api_enums::Currency::SSP => Self::SSP,
- api_enums::Currency::SVC => Self::SVC,
- api_enums::Currency::SZL => Self::SZL,
- api_enums::Currency::THB => Self::THB,
- api_enums::Currency::TTD => Self::TTD,
- api_enums::Currency::TWD => Self::TWD,
- api_enums::Currency::TZS => Self::TZS,
- api_enums::Currency::USD => Self::USD,
- api_enums::Currency::UYU => Self::UYU,
- api_enums::Currency::UZS => Self::UZS,
- api_enums::Currency::YER => Self::YER,
- api_enums::Currency::ZAR => Self::ZAR,
+impl<'a> From<F<&'a api_types::Address>> for F<storage::AddressUpdate> {
+ fn from(address: F<&api_types::Address>) -> Self {
+ let address = address.0;
+ storage::AddressUpdate::Update {
+ city: address.address.as_ref().and_then(|a| a.city.clone()),
+ country: address.address.as_ref().and_then(|a| a.country.clone()),
+ line1: address.address.as_ref().and_then(|a| a.line1.clone()),
+ line2: address.address.as_ref().and_then(|a| a.line2.clone()),
+ line3: address.address.as_ref().and_then(|a| a.line3.clone()),
+ state: address.address.as_ref().and_then(|a| a.state.clone()),
+ zip: address.address.as_ref().and_then(|a| a.zip.clone()),
+ first_name: address.address.as_ref().and_then(|a| a.first_name.clone()),
+ last_name: address.address.as_ref().and_then(|a| a.last_name.clone()),
+ phone_number: address.phone.as_ref().and_then(|a| a.number.clone()),
+ country_code: address.phone.as_ref().and_then(|a| a.country_code.clone()),
+ }
+ .into()
+ }
+}
+
+impl<'a> From<F<&'a storage::Address>> for F<api_types::Address> {
+ fn from(address: F<&storage::Address>) -> Self {
+ let address = address.0;
+ api_types::Address {
+ address: Some(api_types::AddressDetails {
+ city: address.city.clone(),
+ country: address.country.clone(),
+ line1: address.line1.clone(),
+ line2: address.line2.clone(),
+ line3: address.line3.clone(),
+ state: address.state.clone(),
+ zip: address.zip.clone(),
+ first_name: address.first_name.clone(),
+ last_name: address.last_name.clone(),
+ }),
+ phone: Some(api_types::PhoneDetails {
+ number: address.phone_number.clone(),
+ country_code: address.country_code.clone(),
+ }),
}
+ .into()
}
}
diff --git a/crates/storage_models/Cargo.toml b/crates/storage_models/Cargo.toml
index 89a7c3882c5..620b084f689 100644
--- a/crates/storage_models/Cargo.toml
+++ b/crates/storage_models/Cargo.toml
@@ -6,3 +6,19 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
+async-bb8-diesel = { git = "https://github.com/juspay/async-bb8-diesel", rev = "412663e16802dbc58a1b98bfcbe78fa0090311eb" }
+async-trait = "0.1.57"
+diesel = { git = "https://github.com/juspay/diesel", features = ["postgres", "serde_json", "time"], rev = "22f3f59f1db8a3f61623e4d6b375d64cd7bd3d02" }
+error-stack = "0.2.1"
+hex = "0.4.3"
+serde = { version = "1.0.145", features = ["derive"] }
+serde_json = "1.0.85"
+strum = { version = "0.24.1", features = ["derive"] }
+thiserror = "1.0.37"
+time = { version = "0.3.14", features = ["serde", "serde-well-known", "std"] }
+
+# First party crates
+common_utils = { version = "0.1.0", path = "../common_utils" }
+masking = { version = "0.1.0", path = "../masking" }
+router_derive = { version = "0.1.0", path = "../router_derive" }
+router_env = { version = "0.1.0", path = "../router_env", features = ["log_extra_implicit_fields", "log_custom_entries_to_extra"] }
diff --git a/crates/storage_models/src/address.rs b/crates/storage_models/src/address.rs
new file mode 100644
index 00000000000..af0a5f186b3
--- /dev/null
+++ b/crates/storage_models/src/address.rs
@@ -0,0 +1,148 @@
+use common_utils::{consts, custom_serde, generate_id};
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use masking::Secret;
+use serde::{Deserialize, Serialize};
+use time::{OffsetDateTime, PrimitiveDateTime};
+
+use crate::schema::address;
+
+#[derive(Clone, Debug, Deserialize, Serialize, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = address)]
+#[serde(deny_unknown_fields)]
+pub struct AddressNew {
+ pub address_id: String,
+ pub city: Option<String>,
+ pub country: Option<String>,
+ pub line1: Option<Secret<String>>,
+ pub line2: Option<Secret<String>>,
+ pub line3: Option<Secret<String>>,
+ pub state: Option<Secret<String>>,
+ pub zip: Option<Secret<String>>,
+ pub first_name: Option<Secret<String>>,
+ pub last_name: Option<Secret<String>>,
+ pub phone_number: Option<Secret<String>>,
+ pub country_code: Option<String>,
+ pub customer_id: String,
+ pub merchant_id: String,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize, Identifiable, Queryable)]
+#[diesel(table_name = address)]
+pub struct Address {
+ #[serde(skip_serializing)]
+ pub id: i32,
+ #[serde(skip_serializing)]
+ pub address_id: String,
+ pub city: Option<String>,
+ pub country: Option<String>,
+ pub line1: Option<Secret<String>>,
+ pub line2: Option<Secret<String>>,
+ pub line3: Option<Secret<String>>,
+ pub state: Option<Secret<String>>,
+ pub zip: Option<Secret<String>>,
+ pub first_name: Option<Secret<String>>,
+ pub last_name: Option<Secret<String>>,
+ pub phone_number: Option<Secret<String>>,
+ pub country_code: Option<String>,
+ #[serde(skip_serializing)]
+ #[serde(with = "custom_serde::iso8601")]
+ pub created_at: PrimitiveDateTime,
+ #[serde(skip_serializing)]
+ #[serde(with = "custom_serde::iso8601")]
+ pub modified_at: PrimitiveDateTime,
+ pub customer_id: String,
+ pub merchant_id: String,
+}
+
+#[derive(Debug)]
+pub enum AddressUpdate {
+ Update {
+ city: Option<String>,
+ country: Option<String>,
+ line1: Option<Secret<String>>,
+ line2: Option<Secret<String>>,
+ line3: Option<Secret<String>>,
+ state: Option<Secret<String>>,
+ zip: Option<Secret<String>>,
+ first_name: Option<Secret<String>>,
+ last_name: Option<Secret<String>>,
+ phone_number: Option<Secret<String>>,
+ country_code: Option<String>,
+ },
+}
+
+#[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = address)]
+pub struct AddressUpdateInternal {
+ city: Option<String>,
+ country: Option<String>,
+ line1: Option<Secret<String>>,
+ line2: Option<Secret<String>>,
+ line3: Option<Secret<String>>,
+ state: Option<Secret<String>>,
+ zip: Option<Secret<String>>,
+ first_name: Option<Secret<String>>,
+ last_name: Option<Secret<String>>,
+ phone_number: Option<Secret<String>>,
+ country_code: Option<String>,
+ modified_at: PrimitiveDateTime,
+}
+
+impl From<AddressUpdate> for AddressUpdateInternal {
+ fn from(address_update: AddressUpdate) -> Self {
+ match address_update {
+ AddressUpdate::Update {
+ city,
+ country,
+ line1,
+ line2,
+ line3,
+ state,
+ zip,
+ first_name,
+ last_name,
+ phone_number,
+ country_code,
+ } => Self {
+ city,
+ country,
+ line1,
+ line2,
+ line3,
+ state,
+ zip,
+ first_name,
+ last_name,
+ phone_number,
+ country_code,
+ modified_at: convert_to_pdt(OffsetDateTime::now_utc()),
+ },
+ }
+ }
+}
+
+// TODO: Create utils for this since cane be reused outside address
+fn convert_to_pdt(offset_time: OffsetDateTime) -> PrimitiveDateTime {
+ PrimitiveDateTime::new(offset_time.date(), offset_time.time())
+}
+
+impl Default for AddressNew {
+ fn default() -> Self {
+ Self {
+ address_id: generate_id(consts::ID_LENGTH, "add"),
+ city: None,
+ country: None,
+ line1: None,
+ line2: None,
+ line3: None,
+ state: None,
+ zip: None,
+ first_name: None,
+ last_name: None,
+ phone_number: None,
+ country_code: None,
+ customer_id: String::default(),
+ merchant_id: String::default(),
+ }
+ }
+}
diff --git a/crates/storage_models/src/configs.rs b/crates/storage_models/src/configs.rs
new file mode 100644
index 00000000000..c5564b3be3e
--- /dev/null
+++ b/crates/storage_models/src/configs.rs
@@ -0,0 +1,43 @@
+use std::convert::From;
+
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use serde::{Deserialize, Serialize};
+
+use crate::schema::configs;
+
+#[derive(Default, Clone, Debug, Insertable, Serialize, Deserialize)]
+#[diesel(table_name = configs)]
+
+pub struct ConfigNew {
+ pub key: String,
+ pub config: String,
+}
+
+#[derive(Default, Clone, Debug, Identifiable, Queryable, Deserialize, Serialize)]
+#[diesel(table_name = configs)]
+
+pub struct Config {
+ #[serde(skip_serializing)]
+ pub id: i32,
+ pub key: String,
+ pub config: String,
+}
+
+#[derive(Debug)]
+pub enum ConfigUpdate {
+ Update { config: Option<String> },
+}
+
+#[derive(Clone, Debug, AsChangeset, Default)]
+#[diesel(table_name = configs)]
+pub struct ConfigUpdateInternal {
+ config: Option<String>,
+}
+
+impl From<ConfigUpdate> for ConfigUpdateInternal {
+ fn from(config_update: ConfigUpdate) -> Self {
+ match config_update {
+ ConfigUpdate::Update { config } => Self { config },
+ }
+ }
+}
diff --git a/crates/storage_models/src/connector_response.rs b/crates/storage_models/src/connector_response.rs
new file mode 100644
index 00000000000..01d35d7b23f
--- /dev/null
+++ b/crates/storage_models/src/connector_response.rs
@@ -0,0 +1,88 @@
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use serde::{Deserialize, Serialize};
+use time::PrimitiveDateTime;
+
+use crate::schema::connector_response;
+
+#[derive(Clone, Debug, Deserialize, Serialize, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = connector_response)]
+#[serde(deny_unknown_fields)]
+pub struct ConnectorResponseNew {
+ pub payment_id: String,
+ pub merchant_id: String,
+ pub txn_id: String,
+ pub created_at: PrimitiveDateTime,
+ pub modified_at: PrimitiveDateTime,
+ pub connector_name: Option<String>,
+ pub connector_transaction_id: Option<String>,
+ pub authentication_data: Option<serde_json::Value>,
+ pub encoded_data: Option<String>,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize, Identifiable, Queryable)]
+#[diesel(table_name = connector_response)]
+pub struct ConnectorResponse {
+ #[serde(skip_serializing)]
+ pub id: i32,
+ pub payment_id: String,
+ pub merchant_id: String,
+ pub txn_id: String,
+ pub created_at: PrimitiveDateTime,
+ pub modified_at: PrimitiveDateTime,
+ pub connector_name: Option<String>,
+ pub connector_transaction_id: Option<String>,
+ pub authentication_data: Option<serde_json::Value>,
+ pub encoded_data: Option<String>,
+}
+
+#[derive(Clone, Debug, Deserialize, AsChangeset, Serialize)]
+#[diesel(table_name = connector_response)]
+pub struct ConnectorResponseUpdateInternal {
+ pub connector_transaction_id: Option<String>,
+ pub authentication_data: Option<serde_json::Value>,
+ pub modified_at: PrimitiveDateTime,
+ pub encoded_data: Option<String>,
+ pub connector_name: Option<String>,
+}
+
+#[derive(Debug)]
+pub enum ConnectorResponseUpdate {
+ ResponseUpdate {
+ connector_transaction_id: Option<String>,
+ authentication_data: Option<serde_json::Value>,
+ encoded_data: Option<String>,
+ connector_name: Option<String>,
+ },
+}
+
+impl ConnectorResponseUpdate {
+ pub fn apply_changeset(self, source: ConnectorResponse) -> ConnectorResponse {
+ let connector_response_update: ConnectorResponseUpdateInternal = self.into();
+ ConnectorResponse {
+ modified_at: connector_response_update.modified_at,
+ connector_transaction_id: connector_response_update.connector_transaction_id,
+ authentication_data: connector_response_update.authentication_data,
+ encoded_data: connector_response_update.encoded_data,
+ ..source
+ }
+ }
+}
+
+impl From<ConnectorResponseUpdate> for ConnectorResponseUpdateInternal {
+ fn from(connector_response_update: ConnectorResponseUpdate) -> Self {
+ match connector_response_update {
+ ConnectorResponseUpdate::ResponseUpdate {
+ connector_transaction_id,
+ authentication_data,
+ encoded_data,
+ connector_name,
+ } => Self {
+ connector_transaction_id,
+ authentication_data,
+ encoded_data,
+ modified_at: common_utils::date_time::now(),
+ connector_name,
+ },
+ }
+ }
+}
diff --git a/crates/storage_models/src/customers.rs b/crates/storage_models/src/customers.rs
new file mode 100644
index 00000000000..4ae3c16213b
--- /dev/null
+++ b/crates/storage_models/src/customers.rs
@@ -0,0 +1,79 @@
+use common_utils::pii;
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use masking::Secret;
+use time::PrimitiveDateTime;
+
+use crate::schema::customers;
+
+#[derive(Default, Clone, Debug, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = customers)]
+pub struct CustomerNew {
+ pub customer_id: String,
+ pub merchant_id: String,
+ pub name: Option<String>,
+ pub email: Option<Secret<String, pii::Email>>,
+ pub phone: Option<Secret<String>>,
+ pub description: Option<String>,
+ pub phone_country_code: Option<String>,
+ pub metadata: Option<serde_json::Value>,
+}
+
+#[derive(Clone, Debug, Identifiable, Queryable)]
+#[diesel(table_name = customers)]
+pub struct Customer {
+ pub id: i32,
+ pub customer_id: String,
+ pub merchant_id: String,
+ pub name: Option<String>,
+ pub email: Option<Secret<String, pii::Email>>,
+ pub phone: Option<Secret<String>>,
+ pub phone_country_code: Option<String>,
+ pub description: Option<String>,
+ pub created_at: PrimitiveDateTime,
+ pub metadata: Option<serde_json::Value>,
+}
+
+#[derive(Debug)]
+pub enum CustomerUpdate {
+ Update {
+ name: Option<String>,
+ email: Option<Secret<String, pii::Email>>,
+ phone: Option<Secret<String>>,
+ description: Option<String>,
+ phone_country_code: Option<String>,
+ metadata: Option<serde_json::Value>,
+ },
+}
+
+#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = customers)]
+pub struct CustomerUpdateInternal {
+ name: Option<String>,
+ email: Option<Secret<String, pii::Email>>,
+ phone: Option<Secret<String>>,
+ description: Option<String>,
+ phone_country_code: Option<String>,
+ metadata: Option<serde_json::Value>,
+}
+
+impl From<CustomerUpdate> for CustomerUpdateInternal {
+ fn from(customer_update: CustomerUpdate) -> Self {
+ match customer_update {
+ CustomerUpdate::Update {
+ name,
+ email,
+ phone,
+ description,
+ phone_country_code,
+ metadata,
+ } => Self {
+ name,
+ email,
+ phone,
+ description,
+ phone_country_code,
+ metadata,
+ },
+ }
+ }
+}
diff --git a/crates/storage_models/src/dispute.rs b/crates/storage_models/src/dispute.rs
new file mode 100644
index 00000000000..8b137891791
--- /dev/null
+++ b/crates/storage_models/src/dispute.rs
@@ -0,0 +1 @@
+
diff --git a/crates/storage_models/src/enums.rs b/crates/storage_models/src/enums.rs
new file mode 100644
index 00000000000..a44577fe06d
--- /dev/null
+++ b/crates/storage_models/src/enums.rs
@@ -0,0 +1,657 @@
+#[doc(hidden)]
+pub mod diesel_exports {
+ pub use super::{
+ DbAttemptStatus as AttemptStatus, DbAuthenticationType as AuthenticationType,
+ DbCaptureMethod as CaptureMethod, DbConnectorType as ConnectorType, DbCurrency as Currency,
+ DbEventClass as EventClass, DbEventObjectType as EventObjectType, DbEventType as EventType,
+ DbFutureUsage as FutureUsage, DbIntentStatus as IntentStatus,
+ DbMandateStatus as MandateStatus, DbMandateType as MandateType,
+ DbMerchantStorageScheme as MerchantStorageScheme, DbPaymentFlow as PaymentFlow,
+ DbPaymentMethodIssuerCode as PaymentMethodIssuerCode,
+ DbPaymentMethodSubType as PaymentMethodSubType, DbPaymentMethodType as PaymentMethodType,
+ DbProcessTrackerStatus as ProcessTrackerStatus, DbRefundStatus as RefundStatus,
+ DbRefundType as RefundType, DbRoutingAlgorithm as RoutingAlgorithm,
+ };
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum AttemptStatus {
+ Started,
+ AuthenticationFailed,
+ JuspayDeclined,
+ PendingVbv,
+ VbvSuccessful,
+ Authorized,
+ AuthorizationFailed,
+ Charged,
+ Authorizing,
+ CodInitiated,
+ Voided,
+ VoidInitiated,
+ CaptureInitiated,
+ CaptureFailed,
+ VoidFailed,
+ AutoRefunded,
+ PartialCharged,
+ #[default]
+ Pending,
+ Failure,
+ PaymentMethodAwaited,
+ ConfirmationAwaited,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum AuthenticationType {
+ #[default]
+ ThreeDs,
+ NoThreeDs,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum CaptureMethod {
+ #[default]
+ Automatic,
+ Manual,
+ ManualMultiple,
+ Scheduled,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ PartialEq,
+ strum::Display,
+ strum::EnumString,
+ serde::Deserialize,
+ serde::Serialize,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[strum(serialize_all = "snake_case")]
+#[serde(rename_all = "snake_case")]
+pub enum ConnectorType {
+ /// PayFacs, Acquirers, Gateways, BNPL etc
+ PaymentProcessor,
+ /// Fraud, Currency Conversion, Crypto etc
+ PaymentVas,
+ /// Accounting, Billing, Invoicing, Tax etc
+ FinOperations,
+ /// Inventory, ERP, CRM, KYC etc
+ FizOperations,
+ /// Payment Networks like Visa, MasterCard etc
+ Networks,
+ /// All types of banks including corporate / commercial / personal / neo banks
+ BankingEntities,
+ /// All types of non-banking financial institutions including Insurance, Credit / Lending etc
+ NonBankingFinance,
+}
+
+#[allow(clippy::upper_case_acronyms)]
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ Hash,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+pub enum Currency {
+ AED,
+ ALL,
+ AMD,
+ ARS,
+ AUD,
+ AWG,
+ AZN,
+ BBD,
+ BDT,
+ BHD,
+ BMD,
+ BND,
+ BOB,
+ BRL,
+ BSD,
+ BWP,
+ BZD,
+ CAD,
+ CHF,
+ CNY,
+ COP,
+ CRC,
+ CUP,
+ CZK,
+ DKK,
+ DOP,
+ DZD,
+ EGP,
+ ETB,
+ EUR,
+ FJD,
+ GBP,
+ GHS,
+ GIP,
+ GMD,
+ GTQ,
+ GYD,
+ HKD,
+ HNL,
+ HRK,
+ HTG,
+ HUF,
+ IDR,
+ ILS,
+ INR,
+ JMD,
+ JOD,
+ JPY,
+ KES,
+ KGS,
+ KHR,
+ KRW,
+ KWD,
+ KYD,
+ KZT,
+ LAK,
+ LBP,
+ LKR,
+ LRD,
+ LSL,
+ MAD,
+ MDL,
+ MKD,
+ MMK,
+ MNT,
+ MOP,
+ MUR,
+ MVR,
+ MWK,
+ MXN,
+ MYR,
+ NAD,
+ NGN,
+ NIO,
+ NOK,
+ NPR,
+ NZD,
+ OMR,
+ PEN,
+ PGK,
+ PHP,
+ PKR,
+ PLN,
+ QAR,
+ RUB,
+ SAR,
+ SCR,
+ SEK,
+ SGD,
+ SLL,
+ SOS,
+ SSP,
+ SVC,
+ SZL,
+ THB,
+ TTD,
+ TWD,
+ TZS,
+ #[default]
+ USD,
+ UYU,
+ UZS,
+ YER,
+ ZAR,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum EventClass {
+ Payments,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum EventObjectType {
+ PaymentDetails,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum EventType {
+ PaymentSucceeded,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum IntentStatus {
+ Succeeded,
+ Failed,
+ Cancelled,
+ Processing,
+ RequiresCustomerAction,
+ RequiresPaymentMethod,
+ #[default]
+ RequiresConfirmation,
+ RequiresCapture,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum FutureUsage {
+ #[default]
+ OffSession,
+ OnSession,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum MerchantStorageScheme {
+ #[default]
+ PostgresOnly,
+ RedisKv,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ PartialEq,
+ strum::Display,
+ strum::EnumString,
+ serde::Serialize,
+ serde::Deserialize,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[strum(serialize_all = "snake_case")]
+pub enum PaymentFlow {
+ Vsc,
+ Emi,
+ Otp,
+ UpiIntent,
+ UpiCollect,
+ UpiScanAndPay,
+ Sdk,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ Hash,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[strum(serialize_all = "snake_case")]
+#[serde(rename_all = "snake_case")]
+pub enum PaymentMethodIssuerCode {
+ JpHdfc,
+ JpIcici,
+ JpGooglepay,
+ JpApplepay,
+ JpPhonepay,
+ JpWechat,
+ JpSofort,
+ JpGiropay,
+ JpSepa,
+ JpBacs,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ Hash,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum PaymentMethodSubType {
+ Credit,
+ Debit,
+ UpiIntent,
+ UpiCollect,
+ CreditCardInstallments,
+ PayLaterInstallments,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ Hash,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum PaymentMethodType {
+ Card,
+ PaymentContainer,
+ #[default]
+ BankTransfer,
+ BankDebit,
+ PayLater,
+ Netbanking,
+ Upi,
+ OpenBanking,
+ ConsumerFinance,
+ Wallet,
+ Klarna,
+ Paypal,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ Hash,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "lowercase")]
+#[strum(serialize_all = "lowercase")]
+pub enum WalletIssuer {
+ GooglePay,
+ ApplePay,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum ProcessTrackerStatus {
+ // Picked by the producer
+ Processing,
+ // State when the task is added
+ New,
+ // Send to retry
+ Pending,
+ // Picked by consumer
+ ProcessStarted,
+ // Finished by consumer
+ Finish,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ PartialEq,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[strum(serialize_all = "snake_case")]
+pub enum RefundStatus {
+ Failure,
+ ManualReview,
+ #[default]
+ Pending,
+ Success,
+ TransactionFailure,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Default,
+ Eq,
+ PartialEq,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[strum(serialize_all = "snake_case")]
+pub enum RefundType {
+ InstantRefund,
+ #[default]
+ RegularRefund,
+ RetryRefund,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ PartialEq,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+#[router_derive::diesel_enum]
+pub enum RoutingAlgorithm {
+ RoundRobin,
+ MaxConversion,
+ MinCost,
+ Custom,
+}
+
+// Mandate
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ PartialEq,
+ Default,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum MandateType {
+ SingleUse,
+ #[default]
+ MultiUse,
+}
+
+#[derive(
+ Clone,
+ Copy,
+ Debug,
+ Eq,
+ PartialEq,
+ Default,
+ serde::Deserialize,
+ serde::Serialize,
+ strum::Display,
+ strum::EnumString,
+ router_derive::DieselEnum,
+)]
+#[router_derive::diesel_enum]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum MandateStatus {
+ #[default]
+ Active,
+ Inactive,
+ Pending,
+ Revoked,
+}
diff --git a/crates/storage_models/src/ephemeral_key.rs b/crates/storage_models/src/ephemeral_key.rs
new file mode 100644
index 00000000000..44226d50fd6
--- /dev/null
+++ b/crates/storage_models/src/ephemeral_key.rs
@@ -0,0 +1,16 @@
+pub struct EphemeralKeyNew {
+ pub id: String,
+ pub merchant_id: String,
+ pub customer_id: String,
+ pub secret: String,
+}
+
+#[derive(Debug, serde::Serialize, serde::Deserialize)]
+pub struct EphemeralKey {
+ pub id: String,
+ pub merchant_id: String,
+ pub customer_id: String,
+ pub created_at: i64,
+ pub expires: i64,
+ pub secret: String,
+}
diff --git a/crates/storage_models/src/errors.rs b/crates/storage_models/src/errors.rs
new file mode 100644
index 00000000000..ded9155f3f2
--- /dev/null
+++ b/crates/storage_models/src/errors.rs
@@ -0,0 +1,16 @@
+#[derive(Debug, thiserror::Error)]
+pub enum DatabaseError {
+ #[error("An error occurred when obtaining database connection")]
+ DatabaseConnectionError,
+ #[error("The requested resource was not found in the database")]
+ NotFound,
+ #[error("A unique constraint violation occurred")]
+ UniqueViolation,
+ #[error("No fields were provided to be updated")]
+ NoFieldsToUpdate,
+ #[error("An error occurred when generating raw SQL query")]
+ QueryGenerationFailed,
+ // InsertFailed,
+ #[error("An unknown error occurred")]
+ Others,
+}
diff --git a/crates/storage_models/src/events.rs b/crates/storage_models/src/events.rs
new file mode 100644
index 00000000000..6b1306bfa23
--- /dev/null
+++ b/crates/storage_models/src/events.rs
@@ -0,0 +1,35 @@
+use common_utils::custom_serde;
+use diesel::{Identifiable, Insertable, Queryable};
+use serde::{Deserialize, Serialize};
+use time::PrimitiveDateTime;
+
+use crate::{enums as storage_enums, schema::events};
+
+#[derive(Clone, Debug, Deserialize, Insertable, Serialize, router_derive::DebugAsDisplay)]
+#[diesel(table_name = events)]
+#[serde(deny_unknown_fields)]
+pub struct EventNew {
+ pub event_id: String,
+ pub event_type: storage_enums::EventType,
+ pub event_class: storage_enums::EventClass,
+ pub is_webhook_notified: bool,
+ pub intent_reference_id: Option<String>,
+ pub primary_object_id: String,
+ pub primary_object_type: storage_enums::EventObjectType,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize, Identifiable, Queryable)]
+#[diesel(table_name = events)]
+pub struct Event {
+ #[serde(skip_serializing)]
+ pub id: i32,
+ pub event_id: String,
+ pub event_type: storage_enums::EventType,
+ pub event_class: storage_enums::EventClass,
+ pub is_webhook_notified: bool,
+ pub intent_reference_id: Option<String>,
+ pub primary_object_id: String,
+ pub primary_object_type: storage_enums::EventObjectType,
+ #[serde(with = "custom_serde::iso8601")]
+ pub created_at: PrimitiveDateTime,
+}
diff --git a/crates/storage_models/src/lib.rs b/crates/storage_models/src/lib.rs
index 8b137891791..37c637fccce 100644
--- a/crates/storage_models/src/lib.rs
+++ b/crates/storage_models/src/lib.rs
@@ -1 +1,87 @@
+pub mod address;
+pub mod configs;
+pub mod connector_response;
+pub mod customers;
+pub mod dispute;
+pub mod enums;
+pub mod ephemeral_key;
+pub mod errors;
+pub mod events;
+pub mod locker_mock_up;
+pub mod mandate;
+pub mod merchant_account;
+pub mod merchant_connector_account;
+pub mod payment_attempt;
+pub mod payment_intent;
+pub mod payment_method;
+pub mod process_tracker;
+pub mod query;
+pub mod refund;
+pub mod schema;
+pub mod temp_card;
+use diesel_impl::{DieselArray, OptionalDieselArray};
+
+pub type CustomResult<T, E> = error_stack::Result<T, E>;
+pub type PgPooledConn = async_bb8_diesel::Connection<diesel::PgConnection>;
+
+/// The types and implementations provided by this module are required for the schema generated by
+/// `diesel_cli` 2.0 to work with the types defined in Rust code. This is because
+/// [`diesel`][diesel] 2.0 [changed the nullability of array elements][diesel-2.0-array-nullability],
+/// which causes [`diesel`][diesel] to deserialize arrays as `Vec<Option<T>>`. To prevent declaring
+/// array elements as `Option<T>`, this module provides types and implementations to deserialize
+/// arrays as `Vec<T>`, considering only non-null values (`Some(T)`) among the deserialized
+/// `Option<T>` values.
+///
+/// [diesel-2.0-array-nullability]: https://diesel.rs/guides/migration_guide.html#2-0-0-nullability-of-array-elements
+
+#[doc(hidden)]
+pub(crate) mod diesel_impl {
+ use diesel::{
+ deserialize::FromSql,
+ pg::Pg,
+ sql_types::{Array, Nullable},
+ Queryable,
+ };
+
+ pub struct DieselArray<T>(Vec<Option<T>>);
+
+ impl<T> From<DieselArray<T>> for Vec<T> {
+ fn from(array: DieselArray<T>) -> Self {
+ array.0.into_iter().flatten().collect()
+ }
+ }
+
+ impl<T, U> Queryable<Array<Nullable<U>>, Pg> for DieselArray<T>
+ where
+ T: FromSql<U, Pg>,
+ Vec<Option<T>>: FromSql<Array<Nullable<U>>, Pg>,
+ {
+ type Row = Vec<Option<T>>;
+
+ fn build(row: Self::Row) -> diesel::deserialize::Result<Self> {
+ Ok(DieselArray(row))
+ }
+ }
+
+ pub struct OptionalDieselArray<T>(Option<Vec<Option<T>>>);
+
+ impl<T> From<OptionalDieselArray<T>> for Option<Vec<T>> {
+ fn from(option_array: OptionalDieselArray<T>) -> Self {
+ option_array
+ .0
+ .map(|array| array.into_iter().flatten().collect())
+ }
+ }
+
+ impl<T, U> Queryable<Nullable<Array<Nullable<U>>>, Pg> for OptionalDieselArray<T>
+ where
+ Option<Vec<Option<T>>>: FromSql<Nullable<Array<Nullable<U>>>, Pg>,
+ {
+ type Row = Option<Vec<Option<T>>>;
+
+ fn build(row: Self::Row) -> diesel::deserialize::Result<Self> {
+ Ok(OptionalDieselArray(row))
+ }
+ }
+}
diff --git a/crates/storage_models/src/locker_mock_up.rs b/crates/storage_models/src/locker_mock_up.rs
new file mode 100644
index 00000000000..5df7c60b68f
--- /dev/null
+++ b/crates/storage_models/src/locker_mock_up.rs
@@ -0,0 +1,34 @@
+use diesel::{Identifiable, Insertable, Queryable};
+
+use crate::schema::locker_mock_up;
+
+#[derive(Clone, Debug, Eq, Identifiable, Queryable, PartialEq)]
+#[diesel(table_name = locker_mock_up)]
+pub struct LockerMockUp {
+ pub id: i32,
+ pub card_id: String,
+ pub external_id: String,
+ pub card_fingerprint: String,
+ pub card_global_fingerprint: String,
+ pub merchant_id: String,
+ pub card_number: String,
+ pub card_exp_year: String,
+ pub card_exp_month: String,
+ pub name_on_card: Option<String>,
+ pub nickname: Option<String>,
+ pub customer_id: Option<String>,
+ pub duplicate: Option<bool>,
+}
+
+#[derive(Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = locker_mock_up)]
+pub struct LockerMockUpNew {
+ pub card_id: String,
+ pub external_id: String,
+ pub card_fingerprint: String,
+ pub card_global_fingerprint: String,
+ pub merchant_id: String,
+ pub card_number: String,
+ pub card_exp_year: String,
+ pub card_exp_month: String,
+}
diff --git a/crates/storage_models/src/mandate.rs b/crates/storage_models/src/mandate.rs
new file mode 100644
index 00000000000..62f6101184e
--- /dev/null
+++ b/crates/storage_models/src/mandate.rs
@@ -0,0 +1,103 @@
+use common_utils::pii;
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use masking::Secret;
+use time::PrimitiveDateTime;
+
+use crate::{enums as storage_enums, schema::mandate};
+
+#[derive(Clone, Debug, Identifiable, Queryable)]
+#[diesel(table_name = mandate)]
+pub struct Mandate {
+ pub id: i32,
+ pub mandate_id: String,
+ pub customer_id: String,
+ pub merchant_id: String,
+ pub payment_method_id: String,
+ pub mandate_status: storage_enums::MandateStatus,
+ pub mandate_type: storage_enums::MandateType,
+ pub customer_accepted_at: Option<PrimitiveDateTime>,
+ pub customer_ip_address: Option<Secret<String, pii::IpAddress>>,
+ pub customer_user_agent: Option<String>,
+ pub network_transaction_id: Option<String>,
+ pub previous_transaction_id: Option<String>,
+ pub created_at: PrimitiveDateTime,
+ pub mandate_amount: Option<i32>,
+ pub mandate_currency: Option<storage_enums::Currency>,
+ pub amount_captured: Option<i32>,
+ pub connector: String,
+ pub connector_mandate_id: Option<String>,
+}
+
+#[derive(
+ router_derive::Setter, Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay,
+)]
+#[diesel(table_name = mandate)]
+pub struct MandateNew {
+ pub mandate_id: String,
+ pub customer_id: String,
+ pub merchant_id: String,
+ pub payment_method_id: String,
+ pub mandate_status: storage_enums::MandateStatus,
+ pub mandate_type: storage_enums::MandateType,
+ pub customer_accepted_at: Option<PrimitiveDateTime>,
+ pub customer_ip_address: Option<Secret<String, pii::IpAddress>>,
+ pub customer_user_agent: Option<String>,
+ pub network_transaction_id: Option<String>,
+ pub previous_transaction_id: Option<String>,
+ pub created_at: Option<PrimitiveDateTime>,
+ pub mandate_amount: Option<i32>,
+ pub mandate_currency: Option<storage_enums::Currency>,
+ pub amount_captured: Option<i32>,
+ pub connector: String,
+ pub connector_mandate_id: Option<String>,
+}
+
+#[derive(Debug)]
+pub enum MandateUpdate {
+ StatusUpdate {
+ mandate_status: storage_enums::MandateStatus,
+ },
+ CaptureAmountUpdate {
+ amount_captured: Option<i32>,
+ },
+ ConnectorReferenceUpdate {
+ connector_mandate_id: Option<String>,
+ },
+}
+
+#[derive(Clone, Eq, PartialEq, Copy, Debug, Default, serde::Serialize, serde::Deserialize)]
+pub struct SingleUseMandate {
+ pub amount: i32,
+ pub currency: storage_enums::Currency,
+}
+
+#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = mandate)]
+pub struct MandateUpdateInternal {
+ mandate_status: Option<storage_enums::MandateStatus>,
+ amount_captured: Option<i32>,
+ connector_mandate_id: Option<String>,
+}
+
+impl From<MandateUpdate> for MandateUpdateInternal {
+ fn from(mandate_update: MandateUpdate) -> Self {
+ match mandate_update {
+ MandateUpdate::StatusUpdate { mandate_status } => Self {
+ mandate_status: Some(mandate_status),
+ connector_mandate_id: None,
+ amount_captured: None,
+ },
+ MandateUpdate::CaptureAmountUpdate { amount_captured } => Self {
+ mandate_status: None,
+ amount_captured,
+ connector_mandate_id: None,
+ },
+ MandateUpdate::ConnectorReferenceUpdate {
+ connector_mandate_id,
+ } => Self {
+ connector_mandate_id,
+ ..Default::default()
+ },
+ }
+ }
+}
diff --git a/crates/storage_models/src/merchant_account.rs b/crates/storage_models/src/merchant_account.rs
new file mode 100644
index 00000000000..3f72800dcfd
--- /dev/null
+++ b/crates/storage_models/src/merchant_account.rs
@@ -0,0 +1,121 @@
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use masking::StrongSecret;
+
+use crate::{enums as storage_enums, schema::merchant_account};
+
+#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = merchant_account)]
+pub struct MerchantAccount {
+ pub id: i32,
+ pub merchant_id: String,
+ pub api_key: Option<StrongSecret<String>>,
+ pub return_url: Option<String>,
+ pub enable_payment_response_hash: bool,
+ pub payment_response_hash_key: Option<String>,
+ pub redirect_to_merchant_with_http_post: bool,
+ pub merchant_name: Option<String>,
+ pub merchant_details: Option<serde_json::Value>,
+ pub webhook_details: Option<serde_json::Value>,
+ pub routing_algorithm: Option<storage_enums::RoutingAlgorithm>,
+ pub custom_routing_rules: Option<serde_json::Value>,
+ pub sub_merchants_enabled: Option<bool>,
+ pub parent_merchant_id: Option<String>,
+ pub publishable_key: Option<String>,
+ pub storage_scheme: storage_enums::MerchantStorageScheme,
+}
+
+#[derive(Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = merchant_account)]
+pub struct MerchantAccountNew {
+ pub merchant_id: String,
+ pub merchant_name: Option<String>,
+ pub api_key: Option<StrongSecret<String>>,
+ pub merchant_details: Option<serde_json::Value>,
+ pub return_url: Option<String>,
+ pub webhook_details: Option<serde_json::Value>,
+ pub routing_algorithm: Option<storage_enums::RoutingAlgorithm>,
+ pub custom_routing_rules: Option<serde_json::Value>,
+ pub sub_merchants_enabled: Option<bool>,
+ pub parent_merchant_id: Option<String>,
+ pub enable_payment_response_hash: Option<bool>,
+ pub payment_response_hash_key: Option<String>,
+ pub redirect_to_merchant_with_http_post: Option<bool>,
+ pub publishable_key: Option<String>,
+}
+
+#[derive(Debug)]
+pub enum MerchantAccountUpdate {
+ Update {
+ merchant_id: String,
+ merchant_name: Option<String>,
+ api_key: Option<StrongSecret<String>>,
+ merchant_details: Option<serde_json::Value>,
+ return_url: Option<String>,
+ webhook_details: Option<serde_json::Value>,
+ routing_algorithm: Option<storage_enums::RoutingAlgorithm>,
+ custom_routing_rules: Option<serde_json::Value>,
+ sub_merchants_enabled: Option<bool>,
+ parent_merchant_id: Option<String>,
+ enable_payment_response_hash: Option<bool>,
+ payment_response_hash_key: Option<String>,
+ redirect_to_merchant_with_http_post: Option<bool>,
+ publishable_key: Option<String>,
+ },
+}
+
+#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = merchant_account)]
+pub struct MerchantAccountUpdateInternal {
+ merchant_id: Option<String>,
+ merchant_name: Option<String>,
+ api_key: Option<StrongSecret<String>>,
+ merchant_details: Option<serde_json::Value>,
+ return_url: Option<String>,
+ webhook_details: Option<serde_json::Value>,
+ routing_algorithm: Option<storage_enums::RoutingAlgorithm>,
+ custom_routing_rules: Option<serde_json::Value>,
+ sub_merchants_enabled: Option<bool>,
+ parent_merchant_id: Option<String>,
+ enable_payment_response_hash: Option<bool>,
+ payment_response_hash_key: Option<String>,
+ redirect_to_merchant_with_http_post: Option<bool>,
+ publishable_key: Option<String>,
+}
+
+impl From<MerchantAccountUpdate> for MerchantAccountUpdateInternal {
+ fn from(merchant_account_update: MerchantAccountUpdate) -> Self {
+ match merchant_account_update {
+ MerchantAccountUpdate::Update {
+ merchant_id,
+ merchant_name,
+ api_key,
+ merchant_details,
+ return_url,
+ webhook_details,
+ routing_algorithm,
+ custom_routing_rules,
+ sub_merchants_enabled,
+ parent_merchant_id,
+ enable_payment_response_hash,
+ payment_response_hash_key,
+ redirect_to_merchant_with_http_post,
+ publishable_key,
+ } => Self {
+ merchant_id: Some(merchant_id),
+ merchant_name,
+ api_key,
+ merchant_details,
+ return_url,
+ webhook_details,
+ routing_algorithm,
+ custom_routing_rules,
+ sub_merchants_enabled,
+ parent_merchant_id,
+ enable_payment_response_hash,
+ payment_response_hash_key,
+ redirect_to_merchant_with_http_post,
+ publishable_key,
+ },
+ }
+ }
+}
diff --git a/crates/storage_models/src/merchant_connector_account.rs b/crates/storage_models/src/merchant_connector_account.rs
new file mode 100644
index 00000000000..963e44749e3
--- /dev/null
+++ b/crates/storage_models/src/merchant_connector_account.rs
@@ -0,0 +1,84 @@
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use masking::Secret;
+
+use crate::{enums as storage_enums, schema::merchant_connector_account};
+
+#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = merchant_connector_account)]
+pub struct MerchantConnectorAccount {
+ pub id: i32,
+ pub merchant_id: String,
+ pub connector_name: String,
+ pub connector_account_details: serde_json::Value,
+ pub test_mode: Option<bool>,
+ pub disabled: Option<bool>,
+ pub merchant_connector_id: i32,
+ #[diesel(deserialize_as = super::OptionalDieselArray<serde_json::Value>)]
+ pub payment_methods_enabled: Option<Vec<serde_json::Value>>,
+ pub connector_type: storage_enums::ConnectorType,
+}
+
+#[derive(Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = merchant_connector_account)]
+pub struct MerchantConnectorAccountNew {
+ pub merchant_id: Option<String>,
+ pub connector_type: Option<storage_enums::ConnectorType>,
+ pub connector_name: Option<String>,
+ pub connector_account_details: Option<Secret<serde_json::Value>>,
+ pub test_mode: Option<bool>,
+ pub disabled: Option<bool>,
+ pub merchant_connector_id: Option<i32>,
+ pub payment_methods_enabled: Option<Vec<serde_json::Value>>,
+}
+
+#[derive(Debug)]
+pub enum MerchantConnectorAccountUpdate {
+ Update {
+ merchant_id: Option<String>,
+ connector_type: Option<storage_enums::ConnectorType>,
+ connector_name: Option<String>,
+ connector_account_details: Option<Secret<serde_json::Value>>,
+ test_mode: Option<bool>,
+ disabled: Option<bool>,
+ merchant_connector_id: Option<i32>,
+ payment_methods_enabled: Option<Vec<serde_json::Value>>,
+ },
+}
+#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = merchant_connector_account)]
+pub struct MerchantConnectorAccountUpdateInternal {
+ merchant_id: Option<String>,
+ connector_type: Option<storage_enums::ConnectorType>,
+ connector_name: Option<String>,
+ connector_account_details: Option<Secret<serde_json::Value>>,
+ test_mode: Option<bool>,
+ disabled: Option<bool>,
+ merchant_connector_id: Option<i32>,
+ payment_methods_enabled: Option<Vec<serde_json::Value>>,
+}
+
+impl From<MerchantConnectorAccountUpdate> for MerchantConnectorAccountUpdateInternal {
+ fn from(merchant_connector_account_update: MerchantConnectorAccountUpdate) -> Self {
+ match merchant_connector_account_update {
+ MerchantConnectorAccountUpdate::Update {
+ merchant_id,
+ connector_type,
+ connector_name,
+ connector_account_details,
+ test_mode,
+ disabled,
+ merchant_connector_id,
+ payment_methods_enabled,
+ } => Self {
+ merchant_id,
+ connector_type,
+ connector_name,
+ connector_account_details,
+ test_mode,
+ disabled,
+ merchant_connector_id,
+ payment_methods_enabled,
+ },
+ }
+ }
+}
diff --git a/crates/storage_models/src/payment_attempt.rs b/crates/storage_models/src/payment_attempt.rs
new file mode 100644
index 00000000000..a779d7a10e5
--- /dev/null
+++ b/crates/storage_models/src/payment_attempt.rs
@@ -0,0 +1,236 @@
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use serde::{Deserialize, Serialize};
+use time::PrimitiveDateTime;
+
+use crate::{enums as storage_enums, schema::payment_attempt};
+
+#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable, Serialize, Deserialize)]
+#[diesel(table_name = payment_attempt)]
+pub struct PaymentAttempt {
+ pub id: i32,
+ pub payment_id: String,
+ pub merchant_id: String,
+ pub txn_id: String,
+ pub status: storage_enums::AttemptStatus,
+ pub amount: i32,
+ pub currency: Option<storage_enums::Currency>,
+ pub save_to_locker: Option<bool>,
+ pub connector: Option<String>,
+ pub error_message: Option<String>,
+ pub offer_amount: Option<i32>,
+ pub surcharge_amount: Option<i32>,
+ pub tax_amount: Option<i32>,
+ pub payment_method_id: Option<String>,
+ pub payment_method: Option<storage_enums::PaymentMethodType>,
+ pub payment_flow: Option<storage_enums::PaymentFlow>,
+ pub redirect: Option<bool>,
+ pub connector_transaction_id: Option<String>,
+ pub capture_method: Option<storage_enums::CaptureMethod>,
+ pub capture_on: Option<PrimitiveDateTime>,
+ pub confirm: bool,
+ pub authentication_type: Option<storage_enums::AuthenticationType>,
+ pub created_at: PrimitiveDateTime,
+ pub modified_at: PrimitiveDateTime,
+ pub last_synced: Option<PrimitiveDateTime>,
+ pub cancellation_reason: Option<String>,
+ pub amount_to_capture: Option<i32>,
+ pub mandate_id: Option<String>,
+ pub browser_info: Option<serde_json::Value>,
+}
+
+#[derive(Clone, Debug, Default, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = payment_attempt)]
+pub struct PaymentAttemptNew {
+ pub payment_id: String,
+ pub merchant_id: String,
+ pub txn_id: String,
+ pub status: storage_enums::AttemptStatus,
+ pub amount: i32,
+ pub currency: Option<storage_enums::Currency>,
+ // pub auto_capture: Option<bool>,
+ pub save_to_locker: Option<bool>,
+ pub connector: Option<String>,
+ pub error_message: Option<String>,
+ pub offer_amount: Option<i32>,
+ pub surcharge_amount: Option<i32>,
+ pub tax_amount: Option<i32>,
+ pub payment_method_id: Option<String>,
+ pub payment_method: Option<storage_enums::PaymentMethodType>,
+ pub payment_flow: Option<storage_enums::PaymentFlow>,
+ pub redirect: Option<bool>,
+ pub connector_transaction_id: Option<String>,
+ pub capture_method: Option<storage_enums::CaptureMethod>,
+ pub capture_on: Option<PrimitiveDateTime>,
+ pub confirm: bool,
+ pub authentication_type: Option<storage_enums::AuthenticationType>,
+ pub created_at: Option<PrimitiveDateTime>,
+ pub modified_at: Option<PrimitiveDateTime>,
+ pub last_synced: Option<PrimitiveDateTime>,
+ pub cancellation_reason: Option<String>,
+ pub amount_to_capture: Option<i32>,
+ pub mandate_id: Option<String>,
+ pub browser_info: Option<serde_json::Value>,
+}
+
+#[derive(Debug, Clone)]
+pub enum PaymentAttemptUpdate {
+ Update {
+ amount: i32,
+ currency: storage_enums::Currency,
+ status: storage_enums::AttemptStatus,
+ authentication_type: Option<storage_enums::AuthenticationType>,
+ payment_method: Option<storage_enums::PaymentMethodType>,
+ },
+ AuthenticationTypeUpdate {
+ authentication_type: storage_enums::AuthenticationType,
+ },
+ ConfirmUpdate {
+ status: storage_enums::AttemptStatus,
+ payment_method: Option<storage_enums::PaymentMethodType>,
+ browser_info: Option<serde_json::Value>,
+ connector: Option<String>,
+ },
+ VoidUpdate {
+ status: storage_enums::AttemptStatus,
+ cancellation_reason: Option<String>,
+ },
+ ResponseUpdate {
+ status: storage_enums::AttemptStatus,
+ connector_transaction_id: Option<String>,
+ authentication_type: Option<storage_enums::AuthenticationType>,
+ payment_method_id: Option<Option<String>>,
+ redirect: Option<bool>,
+ mandate_id: Option<String>,
+ },
+ StatusUpdate {
+ status: storage_enums::AttemptStatus,
+ },
+ ErrorUpdate {
+ status: storage_enums::AttemptStatus,
+ error_message: Option<String>,
+ },
+}
+
+#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = payment_attempt)]
+pub struct PaymentAttemptUpdateInternal {
+ amount: Option<i32>,
+ currency: Option<storage_enums::Currency>,
+ status: Option<storage_enums::AttemptStatus>,
+ connector_transaction_id: Option<String>,
+ connector: Option<String>,
+ authentication_type: Option<storage_enums::AuthenticationType>,
+ payment_method: Option<storage_enums::PaymentMethodType>,
+ error_message: Option<String>,
+ payment_method_id: Option<Option<String>>,
+ cancellation_reason: Option<String>,
+ modified_at: Option<PrimitiveDateTime>,
+ redirect: Option<bool>,
+ mandate_id: Option<String>,
+ browser_info: Option<serde_json::Value>,
+}
+
+impl PaymentAttemptUpdate {
+ pub fn apply_changeset(self, source: PaymentAttempt) -> PaymentAttempt {
+ let pa_update: PaymentAttemptUpdateInternal = self.into();
+ PaymentAttempt {
+ amount: pa_update.amount.unwrap_or(source.amount),
+ currency: pa_update.currency.or(source.currency),
+ status: pa_update.status.unwrap_or(source.status),
+ connector_transaction_id: pa_update
+ .connector_transaction_id
+ .or(source.connector_transaction_id),
+ authentication_type: pa_update.authentication_type.or(source.authentication_type),
+ payment_method: pa_update.payment_method.or(source.payment_method),
+ error_message: pa_update.error_message.or(source.error_message),
+ payment_method_id: pa_update
+ .payment_method_id
+ .unwrap_or(source.payment_method_id),
+ browser_info: pa_update.browser_info,
+ modified_at: common_utils::date_time::now(),
+ ..source
+ }
+ }
+}
+
+impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal {
+ fn from(payment_attempt_update: PaymentAttemptUpdate) -> Self {
+ match payment_attempt_update {
+ PaymentAttemptUpdate::Update {
+ amount,
+ currency,
+ status,
+ // connector_transaction_id,
+ authentication_type,
+ payment_method,
+ } => Self {
+ amount: Some(amount),
+ currency: Some(currency),
+ status: Some(status),
+ // connector_transaction_id,
+ authentication_type,
+ payment_method,
+ modified_at: Some(common_utils::date_time::now()),
+ ..Default::default()
+ },
+ PaymentAttemptUpdate::AuthenticationTypeUpdate {
+ authentication_type,
+ } => Self {
+ authentication_type: Some(authentication_type),
+ modified_at: Some(common_utils::date_time::now()),
+ ..Default::default()
+ },
+ PaymentAttemptUpdate::ConfirmUpdate {
+ status,
+ payment_method,
+ browser_info,
+ connector,
+ } => Self {
+ status: Some(status),
+ payment_method,
+ modified_at: Some(common_utils::date_time::now()),
+ browser_info,
+ connector,
+ ..Default::default()
+ },
+ PaymentAttemptUpdate::VoidUpdate {
+ status,
+ cancellation_reason,
+ } => Self {
+ status: Some(status),
+ cancellation_reason,
+ ..Default::default()
+ },
+ PaymentAttemptUpdate::ResponseUpdate {
+ status,
+ connector_transaction_id,
+ authentication_type,
+ payment_method_id,
+ redirect,
+ mandate_id,
+ } => Self {
+ status: Some(status),
+ connector_transaction_id,
+ authentication_type,
+ payment_method_id,
+ modified_at: Some(common_utils::date_time::now()),
+ redirect,
+ mandate_id,
+ ..Default::default()
+ },
+ PaymentAttemptUpdate::ErrorUpdate {
+ status,
+ error_message,
+ } => Self {
+ status: Some(status),
+ error_message,
+ modified_at: Some(common_utils::date_time::now()),
+ ..Default::default()
+ },
+ PaymentAttemptUpdate::StatusUpdate { status } => Self {
+ status: Some(status),
+ ..Default::default()
+ },
+ }
+ }
+}
diff --git a/crates/storage_models/src/payment_intent.rs b/crates/storage_models/src/payment_intent.rs
new file mode 100644
index 00000000000..14b2b53a49f
--- /dev/null
+++ b/crates/storage_models/src/payment_intent.rs
@@ -0,0 +1,233 @@
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use serde::{Deserialize, Serialize};
+use time::PrimitiveDateTime;
+
+use crate::{enums as storage_enums, schema::payment_intent};
+
+#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable, Serialize, Deserialize)]
+#[diesel(table_name = payment_intent)]
+pub struct PaymentIntent {
+ pub id: i32,
+ pub payment_id: String,
+ pub merchant_id: String,
+ pub status: storage_enums::IntentStatus,
+ pub amount: i32,
+ pub currency: Option<storage_enums::Currency>,
+ pub amount_captured: Option<i32>,
+ pub customer_id: Option<String>,
+ pub description: Option<String>,
+ pub return_url: Option<String>,
+ pub metadata: Option<serde_json::Value>,
+ pub connector_id: Option<String>,
+ pub shipping_address_id: Option<String>,
+ pub billing_address_id: Option<String>,
+ pub statement_descriptor_name: Option<String>,
+ pub statement_descriptor_suffix: Option<String>,
+ pub created_at: PrimitiveDateTime,
+ pub modified_at: PrimitiveDateTime,
+ pub last_synced: Option<PrimitiveDateTime>, // FIXME: this is optional
+ pub setup_future_usage: Option<storage_enums::FutureUsage>,
+ pub off_session: Option<bool>,
+ pub client_secret: Option<String>,
+}
+
+#[derive(Clone, Debug, Default, Eq, PartialEq, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = payment_intent)]
+pub struct PaymentIntentNew {
+ pub payment_id: String,
+ pub merchant_id: String,
+ pub status: storage_enums::IntentStatus,
+ pub amount: i32,
+ pub currency: Option<storage_enums::Currency>,
+ pub amount_captured: Option<i32>,
+ pub customer_id: Option<String>,
+ pub description: Option<String>,
+ pub return_url: Option<String>,
+ pub metadata: Option<serde_json::Value>,
+ pub connector_id: Option<String>,
+ pub shipping_address_id: Option<String>,
+ pub billing_address_id: Option<String>,
+ pub statement_descriptor_name: Option<String>,
+ pub statement_descriptor_suffix: Option<String>,
+ pub created_at: Option<PrimitiveDateTime>,
+ pub modified_at: Option<PrimitiveDateTime>,
+ pub last_synced: Option<PrimitiveDateTime>,
+ pub client_secret: Option<String>,
+ pub setup_future_usage: Option<storage_enums::FutureUsage>,
+ pub off_session: Option<bool>,
+}
+
+#[derive(Debug, Clone)]
+pub enum PaymentIntentUpdate {
+ ResponseUpdate {
+ status: storage_enums::IntentStatus,
+ amount_captured: Option<i32>,
+ return_url: Option<String>,
+ },
+ MetadataUpdate {
+ metadata: serde_json::Value,
+ },
+ ReturnUrlUpdate {
+ return_url: Option<String>,
+ status: Option<storage_enums::IntentStatus>,
+ customer_id: Option<String>,
+ shipping_address_id: Option<String>,
+ billing_address_id: Option<String>,
+ },
+ MerchantStatusUpdate {
+ status: storage_enums::IntentStatus,
+ shipping_address_id: Option<String>,
+ billing_address_id: Option<String>,
+ },
+ PGStatusUpdate {
+ status: storage_enums::IntentStatus,
+ },
+ Update {
+ amount: i32,
+ currency: storage_enums::Currency,
+ status: storage_enums::IntentStatus,
+ customer_id: Option<String>,
+ shipping_address_id: Option<String>,
+ billing_address_id: Option<String>,
+ },
+}
+
+#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = payment_intent)]
+
+pub struct PaymentIntentUpdateInternal {
+ pub amount: Option<i32>,
+ pub currency: Option<storage_enums::Currency>,
+ pub status: Option<storage_enums::IntentStatus>,
+ pub amount_captured: Option<i32>,
+ pub customer_id: Option<String>,
+ pub return_url: Option<String>,
+ pub setup_future_usage: Option<storage_enums::FutureUsage>,
+ pub off_session: Option<bool>,
+ pub metadata: Option<serde_json::Value>,
+ pub client_secret: Option<Option<String>>,
+ pub billing_address_id: Option<String>,
+ pub shipping_address_id: Option<String>,
+ pub modified_at: Option<PrimitiveDateTime>,
+}
+
+impl PaymentIntentUpdate {
+ pub fn apply_changeset(self, source: PaymentIntent) -> PaymentIntent {
+ let internal_update: PaymentIntentUpdateInternal = self.into();
+ PaymentIntent {
+ amount: internal_update.amount.unwrap_or(source.amount),
+ currency: internal_update.currency.or(source.currency),
+ status: internal_update.status.unwrap_or(source.status),
+ amount_captured: internal_update.amount_captured.or(source.amount_captured),
+ customer_id: internal_update.customer_id.or(source.customer_id),
+ return_url: internal_update.return_url.or(source.return_url),
+ setup_future_usage: internal_update
+ .setup_future_usage
+ .or(source.setup_future_usage),
+ off_session: internal_update.off_session.or(source.off_session),
+ metadata: internal_update.metadata.or(source.metadata),
+ client_secret: internal_update
+ .client_secret
+ .unwrap_or(source.client_secret),
+ billing_address_id: internal_update
+ .billing_address_id
+ .or(source.billing_address_id),
+ shipping_address_id: internal_update
+ .shipping_address_id
+ .or(source.shipping_address_id),
+ modified_at: common_utils::date_time::now(),
+ ..source
+ }
+ }
+}
+
+impl From<PaymentIntentUpdate> for PaymentIntentUpdateInternal {
+ fn from(payment_intent_update: PaymentIntentUpdate) -> Self {
+ match payment_intent_update {
+ PaymentIntentUpdate::Update {
+ amount,
+ currency,
+ status,
+ customer_id,
+ shipping_address_id,
+ billing_address_id,
+ } => Self {
+ amount: Some(amount),
+ currency: Some(currency),
+ status: Some(status),
+ customer_id,
+ client_secret: make_client_secret_null_if_success(Some(status)),
+ shipping_address_id,
+ billing_address_id,
+ modified_at: Some(common_utils::date_time::now()),
+ ..Default::default()
+ },
+ PaymentIntentUpdate::MetadataUpdate { metadata } => Self {
+ metadata: Some(metadata),
+ modified_at: Some(common_utils::date_time::now()),
+ ..Default::default()
+ },
+ PaymentIntentUpdate::ReturnUrlUpdate {
+ return_url,
+ status,
+ customer_id,
+ shipping_address_id,
+ billing_address_id,
+ } => Self {
+ return_url,
+ status,
+ client_secret: make_client_secret_null_if_success(status),
+ customer_id,
+ shipping_address_id,
+ billing_address_id,
+ modified_at: Some(common_utils::date_time::now()),
+ ..Default::default()
+ },
+ PaymentIntentUpdate::PGStatusUpdate { status } => Self {
+ status: Some(status),
+ modified_at: Some(common_utils::date_time::now()),
+ ..Default::default()
+ },
+ PaymentIntentUpdate::MerchantStatusUpdate {
+ status,
+ shipping_address_id,
+ billing_address_id,
+ } => Self {
+ status: Some(status),
+ client_secret: make_client_secret_null_if_success(Some(status)),
+ shipping_address_id,
+ billing_address_id,
+ modified_at: Some(common_utils::date_time::now()),
+ ..Default::default()
+ },
+ PaymentIntentUpdate::ResponseUpdate {
+ // amount,
+ // currency,
+ status,
+ amount_captured,
+ // customer_id,
+ return_url,
+ } => Self {
+ // amount,
+ // currency: Some(currency),
+ status: Some(status),
+ amount_captured,
+ // customer_id,
+ return_url,
+ client_secret: make_client_secret_null_if_success(Some(status)),
+ modified_at: Some(common_utils::date_time::now()),
+ ..Default::default()
+ },
+ }
+ }
+}
+
+fn make_client_secret_null_if_success(
+ status: Option<storage_enums::IntentStatus>,
+) -> Option<Option<String>> {
+ if status == Some(storage_enums::IntentStatus::Succeeded) {
+ Option::<Option<String>>::Some(None)
+ } else {
+ None
+ }
+}
diff --git a/crates/storage_models/src/payment_method.rs b/crates/storage_models/src/payment_method.rs
new file mode 100644
index 00000000000..2e02a727c5e
--- /dev/null
+++ b/crates/storage_models/src/payment_method.rs
@@ -0,0 +1,87 @@
+use diesel::{Identifiable, Insertable, Queryable};
+use masking::Secret;
+use time::PrimitiveDateTime;
+
+use crate::{enums as storage_enums, schema::payment_methods};
+
+#[derive(Clone, Debug, Eq, PartialEq, Identifiable, Queryable)]
+#[diesel(table_name = payment_methods)]
+pub struct PaymentMethod {
+ pub id: i32,
+ pub customer_id: String,
+ pub merchant_id: String,
+ pub payment_method_id: String,
+ #[diesel(deserialize_as = super::OptionalDieselArray<storage_enums::Currency>)]
+ pub accepted_currency: Option<Vec<storage_enums::Currency>>,
+ pub scheme: Option<String>,
+ pub token: Option<String>,
+ pub cardholder_name: Option<Secret<String>>,
+ pub issuer_name: Option<String>,
+ pub issuer_country: Option<String>,
+ #[diesel(deserialize_as = super::OptionalDieselArray<String>)]
+ pub payer_country: Option<Vec<String>>,
+ pub is_stored: Option<bool>,
+ pub swift_code: Option<String>,
+ pub direct_debit_token: Option<String>,
+ pub network_transaction_id: Option<String>,
+ pub created_at: PrimitiveDateTime,
+ pub last_modified: PrimitiveDateTime,
+ pub payment_method: storage_enums::PaymentMethodType,
+ pub payment_method_type: Option<storage_enums::PaymentMethodSubType>,
+ pub payment_method_issuer: Option<String>,
+ pub payment_method_issuer_code: Option<storage_enums::PaymentMethodIssuerCode>,
+}
+
+#[derive(Clone, Debug, Eq, PartialEq, Insertable, Queryable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = payment_methods)]
+pub struct PaymentMethodNew {
+ pub customer_id: String,
+ pub merchant_id: String,
+ pub payment_method_id: String,
+ pub payment_method: storage_enums::PaymentMethodType,
+ pub payment_method_type: Option<storage_enums::PaymentMethodSubType>,
+ pub payment_method_issuer: Option<String>,
+ pub payment_method_issuer_code: Option<storage_enums::PaymentMethodIssuerCode>,
+ pub accepted_currency: Option<Vec<storage_enums::Currency>>,
+ pub scheme: Option<String>,
+ pub token: Option<String>,
+ pub cardholder_name: Option<Secret<String>>,
+ pub issuer_name: Option<String>,
+ pub issuer_country: Option<String>,
+ pub payer_country: Option<Vec<String>>,
+ pub is_stored: Option<bool>,
+ pub swift_code: Option<String>,
+ pub direct_debit_token: Option<String>,
+ pub network_transaction_id: Option<String>,
+ pub created_at: PrimitiveDateTime,
+ pub last_modified: PrimitiveDateTime,
+}
+
+impl Default for PaymentMethodNew {
+ fn default() -> Self {
+ let now = common_utils::date_time::now();
+
+ Self {
+ customer_id: String::default(),
+ merchant_id: String::default(),
+ payment_method_id: String::default(),
+ payment_method: storage_enums::PaymentMethodType::default(),
+ payment_method_type: Option::default(),
+ payment_method_issuer: Option::default(),
+ payment_method_issuer_code: Option::default(),
+ accepted_currency: Option::default(),
+ scheme: Option::default(),
+ token: Option::default(),
+ cardholder_name: Option::default(),
+ issuer_name: Option::default(),
+ issuer_country: Option::default(),
+ payer_country: Option::default(),
+ is_stored: Option::default(),
+ swift_code: Option::default(),
+ direct_debit_token: Option::default(),
+ network_transaction_id: Option::default(),
+ created_at: now,
+ last_modified: now,
+ }
+ }
+}
diff --git a/crates/storage_models/src/process_tracker.rs b/crates/storage_models/src/process_tracker.rs
new file mode 100644
index 00000000000..40c5d402b1d
--- /dev/null
+++ b/crates/storage_models/src/process_tracker.rs
@@ -0,0 +1,167 @@
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use serde::{Deserialize, Serialize};
+use time::PrimitiveDateTime;
+
+use crate::{enums as storage_enums, schema::process_tracker};
+
+#[derive(
+ Clone,
+ Debug,
+ Eq,
+ PartialEq,
+ Deserialize,
+ Identifiable,
+ Queryable,
+ Serialize,
+ router_derive::DebugAsDisplay,
+)]
+#[diesel(table_name = process_tracker)]
+pub struct ProcessTracker {
+ pub id: String,
+ pub name: Option<String>,
+ #[diesel(deserialize_as = super::DieselArray<String>)]
+ pub tag: Vec<String>,
+ pub runner: Option<String>,
+ pub retry_count: i32,
+ pub schedule_time: Option<PrimitiveDateTime>,
+ pub rule: String,
+ pub tracking_data: serde_json::Value,
+ pub business_status: String,
+ pub status: storage_enums::ProcessTrackerStatus,
+ #[diesel(deserialize_as = super::DieselArray<String>)]
+ pub event: Vec<String>,
+ pub created_at: PrimitiveDateTime,
+ pub updated_at: PrimitiveDateTime,
+}
+
+#[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = process_tracker)]
+pub struct ProcessTrackerNew {
+ pub id: String,
+ pub name: Option<String>,
+ pub tag: Vec<String>,
+ pub runner: Option<String>,
+ pub retry_count: i32,
+ pub schedule_time: Option<PrimitiveDateTime>,
+ pub rule: String,
+ pub tracking_data: serde_json::Value,
+ pub business_status: String,
+ pub status: storage_enums::ProcessTrackerStatus,
+ pub event: Vec<String>,
+ pub created_at: PrimitiveDateTime,
+ pub updated_at: PrimitiveDateTime,
+}
+
+#[derive(Debug)]
+pub enum ProcessTrackerUpdate {
+ Update {
+ name: Option<String>,
+ retry_count: Option<i32>,
+ schedule_time: Option<PrimitiveDateTime>,
+ tracking_data: Option<serde_json::Value>,
+ business_status: Option<String>,
+ status: Option<storage_enums::ProcessTrackerStatus>,
+ updated_at: Option<PrimitiveDateTime>,
+ },
+ StatusUpdate {
+ status: storage_enums::ProcessTrackerStatus,
+ business_status: Option<String>,
+ },
+ StatusRetryUpdate {
+ status: storage_enums::ProcessTrackerStatus,
+ retry_count: i32,
+ schedule_time: PrimitiveDateTime,
+ },
+}
+
+#[derive(Debug, Clone, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = process_tracker)]
+pub struct ProcessTrackerUpdateInternal {
+ name: Option<String>,
+ retry_count: Option<i32>,
+ schedule_time: Option<PrimitiveDateTime>,
+ tracking_data: Option<serde_json::Value>,
+ business_status: Option<String>,
+ status: Option<storage_enums::ProcessTrackerStatus>,
+ updated_at: Option<PrimitiveDateTime>,
+}
+
+impl Default for ProcessTrackerUpdateInternal {
+ fn default() -> Self {
+ Self {
+ name: Option::default(),
+ retry_count: Option::default(),
+ schedule_time: Option::default(),
+ tracking_data: Option::default(),
+ business_status: Option::default(),
+ status: Option::default(),
+ updated_at: Some(common_utils::date_time::now()),
+ }
+ }
+}
+
+impl From<ProcessTrackerUpdate> for ProcessTrackerUpdateInternal {
+ fn from(process_tracker_update: ProcessTrackerUpdate) -> Self {
+ match process_tracker_update {
+ ProcessTrackerUpdate::Update {
+ name,
+ retry_count,
+ schedule_time,
+ tracking_data,
+ business_status,
+ status,
+ updated_at,
+ } => Self {
+ name,
+ retry_count,
+ schedule_time,
+ tracking_data,
+ business_status,
+ status,
+ updated_at,
+ },
+ ProcessTrackerUpdate::StatusUpdate {
+ status,
+ business_status,
+ } => Self {
+ status: Some(status),
+ business_status,
+ ..Default::default()
+ },
+ ProcessTrackerUpdate::StatusRetryUpdate {
+ status,
+ retry_count,
+ schedule_time,
+ } => Self {
+ status: Some(status),
+ retry_count: Some(retry_count),
+ schedule_time: Some(schedule_time),
+ ..Default::default()
+ },
+ }
+ }
+}
+
+// TODO: Move this to a utility module?
+pub struct Milliseconds(i32);
+
+#[allow(dead_code)]
+pub struct SchedulerOptions {
+ looper_interval: Milliseconds,
+ db_name: String,
+ cache_name: String,
+ schema_name: String,
+ cache_expiry: i32,
+ runners: Vec<String>,
+ fetch_limit: i32,
+ fetch_limit_product_factor: i32,
+ query_order: String,
+}
+
+#[derive(Debug, Clone)]
+#[allow(dead_code)]
+pub struct ProcessData {
+ db_name: String,
+ cache_name: String,
+ process_tracker: ProcessTracker,
+}
diff --git a/crates/storage_models/src/query.rs b/crates/storage_models/src/query.rs
new file mode 100644
index 00000000000..196cc169436
--- /dev/null
+++ b/crates/storage_models/src/query.rs
@@ -0,0 +1,16 @@
+pub mod address;
+pub mod configs;
+pub mod connector_response;
+pub mod customers;
+pub mod events;
+pub mod generics;
+pub mod locker_mock_up;
+pub mod mandate;
+pub mod merchant_account;
+pub mod merchant_connector_account;
+pub mod payment_attempt;
+pub mod payment_intent;
+pub mod payment_method;
+pub mod process_tracker;
+pub mod refund;
+pub mod temp_card;
diff --git a/crates/router/src/types/storage/query/address.rs b/crates/storage_models/src/query/address.rs
similarity index 78%
rename from crates/router/src/types/storage/query/address.rs
rename to crates/storage_models/src/query/address.rs
index fbfc894d081..4b9b74cc9fd 100644
--- a/crates/router/src/types/storage/query/address.rs
+++ b/crates/storage_models/src/query/address.rs
@@ -3,15 +3,15 @@ use router_env::{tracing, tracing::instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult, DatabaseError},
+ address::{Address, AddressNew, AddressUpdate, AddressUpdateInternal},
+ errors,
schema::address::dsl,
- types::storage::{Address, AddressNew, AddressUpdate, AddressUpdateInternal},
+ CustomResult, PgPooledConn,
};
impl AddressNew {
#[instrument(skip(conn))]
- pub async fn insert(self, conn: &PgPooledConn) -> CustomResult<Address, errors::StorageError> {
+ pub async fn insert(self, conn: &PgPooledConn) -> CustomResult<Address, errors::DatabaseError> {
generics::generic_insert::<_, _, Address, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -22,7 +22,7 @@ impl Address {
conn: &PgPooledConn,
address_id: String,
address: AddressUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
address_id.clone(),
@@ -32,10 +32,10 @@ impl Address {
.await
{
Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(DatabaseError::NotFound) => {
+ errors::DatabaseError::NotFound => {
Err(error.attach_printable("Address with the given ID doesn't exist"))
}
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
+ errors::DatabaseError::NoFieldsToUpdate => {
generics::generic_find_by_id::<<Self as HasTable>::Table, _, _>(
conn,
address_id.clone(),
@@ -52,7 +52,7 @@ impl Address {
pub async fn delete_by_address_id(
conn: &PgPooledConn,
address_id: &str,
- ) -> CustomResult<bool, errors::StorageError> {
+ ) -> CustomResult<bool, errors::DatabaseError> {
generics::generic_delete::<<Self as HasTable>::Table, _, _>(
conn,
dsl::address_id.eq(address_id.to_owned()),
@@ -65,7 +65,7 @@ impl Address {
pub async fn find_by_address_id<'a>(
conn: &PgPooledConn,
address_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_by_id::<<Self as HasTable>::Table, _, _>(conn, address_id.to_owned())
.await
}
@@ -74,7 +74,7 @@ impl Address {
pub async fn find_optional_by_address_id<'a>(
conn: &PgPooledConn,
address_id: &str,
- ) -> CustomResult<Option<Self>, errors::StorageError> {
+ ) -> CustomResult<Option<Self>, errors::DatabaseError> {
generics::generic_find_by_id_optional::<<Self as HasTable>::Table, _, _>(
conn,
address_id.to_owned(),
diff --git a/crates/router/src/types/storage/query/configs.rs b/crates/storage_models/src/query/configs.rs
similarity index 78%
rename from crates/router/src/types/storage/query/configs.rs
rename to crates/storage_models/src/query/configs.rs
index ce6c1a4225e..d86e4f08de7 100644
--- a/crates/router/src/types/storage/query/configs.rs
+++ b/crates/storage_models/src/query/configs.rs
@@ -3,14 +3,13 @@ use router_env::tracing::{self, instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
- types::storage::{Config, ConfigNew, ConfigUpdate, ConfigUpdateInternal},
+ configs::{Config, ConfigNew, ConfigUpdate, ConfigUpdateInternal},
+ errors, CustomResult, PgPooledConn,
};
impl ConfigNew {
#[instrument(skip(conn))]
- pub async fn insert(self, conn: &PgPooledConn) -> CustomResult<Config, errors::StorageError> {
+ pub async fn insert(self, conn: &PgPooledConn) -> CustomResult<Config, errors::DatabaseError> {
generics::generic_insert::<_, _, Config, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -20,7 +19,7 @@ impl Config {
pub async fn find_by_key(
conn: &PgPooledConn,
key: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_by_id::<<Self as HasTable>::Table, _, _>(conn, key.to_owned()).await
}
@@ -29,7 +28,7 @@ impl Config {
conn: &PgPooledConn,
key: &str,
config_update: ConfigUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
key.to_owned(),
@@ -39,7 +38,7 @@ impl Config {
.await
{
Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
+ errors::DatabaseError::NoFieldsToUpdate => {
generics::generic_find_by_id::<<Self as HasTable>::Table, _, _>(
conn,
key.to_owned(),
diff --git a/crates/router/src/types/storage/query/connector_response.rs b/crates/storage_models/src/query/connector_response.rs
similarity index 80%
rename from crates/router/src/types/storage/query/connector_response.rs
rename to crates/storage_models/src/query/connector_response.rs
index cdd20cf1ae0..38febb82fa2 100644
--- a/crates/router/src/types/storage/query/connector_response.rs
+++ b/crates/storage_models/src/query/connector_response.rs
@@ -3,13 +3,13 @@ use router_env::{tracing, tracing::instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
- schema::connector_response::dsl,
- types::storage::{
+ connector_response::{
ConnectorResponse, ConnectorResponseNew, ConnectorResponseUpdate,
ConnectorResponseUpdateInternal,
},
+ errors,
+ schema::connector_response::dsl,
+ CustomResult, PgPooledConn,
};
impl ConnectorResponseNew {
@@ -17,7 +17,7 @@ impl ConnectorResponseNew {
pub async fn insert(
self,
conn: &PgPooledConn,
- ) -> CustomResult<ConnectorResponse, errors::StorageError> {
+ ) -> CustomResult<ConnectorResponse, errors::DatabaseError> {
generics::generic_insert::<_, _, ConnectorResponse, _>(conn, self, ExecuteQuery::new())
.await
}
@@ -29,7 +29,7 @@ impl ConnectorResponse {
self,
conn: &PgPooledConn,
connector_response: ConnectorResponseUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
self.id,
@@ -39,9 +39,7 @@ impl ConnectorResponse {
.await
{
Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
- Ok(self)
- }
+ errors::DatabaseError::NoFieldsToUpdate => Ok(self),
_ => Err(error),
},
result => result,
@@ -54,7 +52,7 @@ impl ConnectorResponse {
payment_id: &str,
merchant_id: &str,
transaction_id: &str,
- ) -> CustomResult<ConnectorResponse, errors::StorageError> {
+ ) -> CustomResult<ConnectorResponse, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id.eq(merchant_id.to_owned()).and(
diff --git a/crates/router/src/types/storage/query/customers.rs b/crates/storage_models/src/query/customers.rs
similarity index 82%
rename from crates/router/src/types/storage/query/customers.rs
rename to crates/storage_models/src/query/customers.rs
index 405781c5f00..61c29e079ed 100644
--- a/crates/router/src/types/storage/query/customers.rs
+++ b/crates/storage_models/src/query/customers.rs
@@ -3,10 +3,10 @@ use router_env::{tracing, tracing::instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
+ customers::{Customer, CustomerNew, CustomerUpdate, CustomerUpdateInternal},
+ errors,
schema::customers::dsl,
- types::storage::{Customer, CustomerNew, CustomerUpdate, CustomerUpdateInternal},
+ CustomResult, PgPooledConn,
};
impl CustomerNew {
@@ -14,7 +14,7 @@ impl CustomerNew {
pub async fn insert_diesel(
self,
conn: &PgPooledConn,
- ) -> CustomResult<Customer, errors::StorageError> {
+ ) -> CustomResult<Customer, errors::DatabaseError> {
generics::generic_insert::<_, _, Customer, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -26,7 +26,7 @@ impl Customer {
customer_id: String,
merchant_id: String,
customer: CustomerUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
(customer_id.clone(), merchant_id.clone()),
@@ -36,7 +36,7 @@ impl Customer {
.await
{
Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
+ errors::DatabaseError::NoFieldsToUpdate => {
generics::generic_find_by_id::<<Self as HasTable>::Table, _, _>(
conn,
(customer_id, merchant_id),
@@ -54,7 +54,7 @@ impl Customer {
conn: &PgPooledConn,
customer_id: &str,
merchant_id: &str,
- ) -> CustomResult<bool, errors::StorageError> {
+ ) -> CustomResult<bool, errors::DatabaseError> {
generics::generic_delete::<<Self as HasTable>::Table, _, _>(
conn,
dsl::customer_id
@@ -70,7 +70,7 @@ impl Customer {
conn: &PgPooledConn,
customer_id: &str,
merchant_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_by_id::<<Self as HasTable>::Table, _, _>(
conn,
(customer_id.to_owned(), merchant_id.to_owned()),
@@ -83,7 +83,7 @@ impl Customer {
conn: &PgPooledConn,
customer_id: &str,
merchant_id: &str,
- ) -> CustomResult<Option<Self>, errors::StorageError> {
+ ) -> CustomResult<Option<Self>, errors::DatabaseError> {
generics::generic_find_by_id_optional::<<Self as HasTable>::Table, _, _>(
conn,
(customer_id.to_owned(), merchant_id.to_owned()),
diff --git a/crates/router/src/types/storage/query/events.rs b/crates/storage_models/src/query/events.rs
similarity index 68%
rename from crates/router/src/types/storage/query/events.rs
rename to crates/storage_models/src/query/events.rs
index 777f009af88..341d029d2d8 100644
--- a/crates/router/src/types/storage/query/events.rs
+++ b/crates/storage_models/src/query/events.rs
@@ -2,14 +2,14 @@ use router_env::tracing::{self, instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
- types::storage::{Event, EventNew},
+ errors,
+ events::{Event, EventNew},
+ CustomResult, PgPooledConn,
};
impl EventNew {
#[instrument(skip(conn))]
- pub async fn insert(self, conn: &PgPooledConn) -> CustomResult<Event, errors::StorageError> {
+ pub async fn insert(self, conn: &PgPooledConn) -> CustomResult<Event, errors::DatabaseError> {
generics::generic_insert::<_, _, Event, _>(conn, self, ExecuteQuery::new()).await
}
}
diff --git a/crates/router/src/types/storage/query/generics.rs b/crates/storage_models/src/query/generics.rs
similarity index 79%
rename from crates/router/src/types/storage/query/generics.rs
rename to crates/storage_models/src/query/generics.rs
index 1695115c663..df72cf3d7bf 100644
--- a/crates/router/src/types/storage/query/generics.rs
+++ b/crates/storage_models/src/query/generics.rs
@@ -20,25 +20,19 @@ use diesel::{
Insertable, QuerySource, Table,
};
use error_stack::{report, IntoReport, ResultExt};
-use router_env::{tracing, tracing::instrument};
+use router_env::{logger, tracing, tracing::instrument};
-use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
- logger,
-};
+use crate::{errors, CustomResult, PgPooledConn};
-#[cfg(feature = "kv_store")]
#[derive(Debug)]
pub struct RawSqlQuery {
- pub(crate) sql: String,
+ pub sql: String,
// The inner `Vec<u8>` can be considered to be byte array
- pub(crate) binds: Vec<Option<Vec<u8>>>,
+ pub binds: Vec<Option<Vec<u8>>>,
}
-#[cfg(feature = "kv_store")]
impl RawSqlQuery {
- pub(crate) fn to_field_value_pairs(&self) -> Vec<(&str, String)> {
+ pub fn to_field_value_pairs(&self) -> Vec<(&str, String)> {
vec![
("sql", self.sql.clone()),
(
@@ -56,19 +50,24 @@ impl RawSqlQuery {
}
}
-pub(super) struct ExecuteQuery<R>(PhantomData<R>);
+pub struct ExecuteQuery<R>(PhantomData<R>);
impl<R> ExecuteQuery<R> {
- pub(super) fn new() -> Self {
+ pub fn new() -> Self {
Self(PhantomData)
}
}
-#[cfg(feature = "kv_store")]
-pub(super) struct RawQuery;
+impl<R> Default for ExecuteQuery<R> {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+pub struct RawQuery;
#[async_trait]
-pub(super) trait QueryExecutionMode<Q>
+pub trait QueryExecutionMode<Q>
where
Q: QueryFragment<Pg> + Send + 'static,
{
@@ -85,7 +84,7 @@ where
conn: &PgPooledConn,
query: Q,
debug_values: String,
- ) -> CustomResult<Self::InsertOutput, errors::StorageError>
+ ) -> CustomResult<Self::InsertOutput, errors::DatabaseError>
where
Q: AsQuery + QueryFragment<Pg> + RunQueryDsl<PgConnection>;
@@ -94,7 +93,7 @@ where
conn: &PgPooledConn,
query: Q,
debug_values: String,
- ) -> CustomResult<Self::UpdateOutput, errors::StorageError>
+ ) -> CustomResult<Self::UpdateOutput, errors::DatabaseError>
where
Q: QueryId;
@@ -103,14 +102,14 @@ where
conn: &PgPooledConn,
query: Q,
debug_values: String,
- ) -> CustomResult<Self::UpdateWithResultsOutput, errors::StorageError>;
+ ) -> CustomResult<Self::UpdateWithResultsOutput, errors::DatabaseError>;
async fn update_by_id(
&self,
conn: &PgPooledConn,
query: Q,
debug_values: String,
- ) -> CustomResult<Self::UpdateByIdOutput, errors::StorageError>
+ ) -> CustomResult<Self::UpdateByIdOutput, errors::DatabaseError>
where
Q: Clone;
@@ -118,7 +117,7 @@ where
&self,
conn: &PgPooledConn,
query: Q,
- ) -> CustomResult<Self::DeleteOutput, errors::StorageError>
+ ) -> CustomResult<Self::DeleteOutput, errors::DatabaseError>
where
Q: QueryId;
@@ -126,13 +125,13 @@ where
&self,
conn: &PgPooledConn,
query: Q,
- ) -> CustomResult<Self::DeleteWithResultsOutput, errors::StorageError>;
+ ) -> CustomResult<Self::DeleteWithResultsOutput, errors::DatabaseError>;
async fn delete_one_with_result(
&self,
conn: &PgPooledConn,
query: Q,
- ) -> CustomResult<Self::DeleteOneWithResultOutput, errors::StorageError>;
+ ) -> CustomResult<Self::DeleteOneWithResultOutput, errors::DatabaseError>;
}
#[async_trait]
@@ -154,7 +153,7 @@ where
conn: &PgPooledConn,
query: Q,
debug_values: String,
- ) -> CustomResult<Self::InsertOutput, errors::StorageError>
+ ) -> CustomResult<Self::InsertOutput, errors::DatabaseError>
where
Q: AsQuery + QueryFragment<Pg> + RunQueryDsl<PgConnection>,
{
@@ -164,9 +163,8 @@ where
ConnectionError::Query(DieselError::DatabaseError(
diesel::result::DatabaseErrorKind::UniqueViolation,
_,
- )) => Err(report!(error))
- .change_context(errors::DatabaseError::UniqueViolation.into()),
- _ => Err(report!(error)).change_context(errors::DatabaseError::Others.into()),
+ )) => Err(report!(error)).change_context(errors::DatabaseError::UniqueViolation),
+ _ => Err(report!(error)).change_context(errors::DatabaseError::Others),
}
.attach_printable_lazy(|| format!("Error while inserting {}", debug_values)),
}
@@ -177,7 +175,7 @@ where
conn: &PgPooledConn,
query: Q,
debug_values: String,
- ) -> CustomResult<Self::UpdateOutput, errors::StorageError>
+ ) -> CustomResult<Self::UpdateOutput, errors::DatabaseError>
where
Q: QueryId,
{
@@ -185,7 +183,7 @@ where
.execute_async(conn)
.await
.into_report()
- .change_context(errors::DatabaseError::Others.into())
+ .change_context(errors::DatabaseError::Others)
.attach_printable_lazy(|| format!("Error while updating {}", debug_values))
}
@@ -194,12 +192,12 @@ where
conn: &PgPooledConn,
query: Q,
debug_values: String,
- ) -> CustomResult<Self::UpdateWithResultsOutput, errors::StorageError> {
+ ) -> CustomResult<Self::UpdateWithResultsOutput, errors::DatabaseError> {
query
.get_results_async(conn)
.await
.into_report()
- .change_context(errors::DatabaseError::Others.into())
+ .change_context(errors::DatabaseError::Others)
.attach_printable_lazy(|| format!("Error while updating {}", debug_values))
}
@@ -208,7 +206,7 @@ where
conn: &PgPooledConn,
query: Q,
debug_values: String,
- ) -> CustomResult<Self::UpdateByIdOutput, errors::StorageError>
+ ) -> CustomResult<Self::UpdateByIdOutput, errors::DatabaseError>
where
Q: Clone,
{
@@ -220,12 +218,13 @@ where
}
Err(error) => match error {
// Failed to generate query, no fields were provided to be updated
- ConnectionError::Query(DieselError::QueryBuilderError(_)) => Err(report!(error))
- .change_context(errors::DatabaseError::NoFieldsToUpdate.into()),
+ ConnectionError::Query(DieselError::QueryBuilderError(_)) => {
+ Err(report!(error)).change_context(errors::DatabaseError::NoFieldsToUpdate)
+ }
ConnectionError::Query(DieselError::NotFound) => {
- Err(report!(error)).change_context(errors::DatabaseError::NotFound.into())
+ Err(report!(error)).change_context(errors::DatabaseError::NotFound)
}
- _ => Err(report!(error)).change_context(errors::DatabaseError::Others.into()),
+ _ => Err(report!(error)).change_context(errors::DatabaseError::Others),
}
.attach_printable_lazy(|| format!("Error while updating by ID {}", debug_values)),
}
@@ -235,7 +234,7 @@ where
&self,
conn: &PgPooledConn,
query: Q,
- ) -> CustomResult<Self::DeleteOutput, errors::StorageError>
+ ) -> CustomResult<Self::DeleteOutput, errors::DatabaseError>
where
Q: QueryId,
{
@@ -243,17 +242,17 @@ where
.execute_async(conn)
.await
.into_report()
- .change_context(errors::DatabaseError::Others.into())
+ .change_context(errors::DatabaseError::Others)
.attach_printable("Error while deleting")
.and_then(|result| match result {
n if n > 0 => {
logger::debug!("{n} records deleted");
Ok(true)
}
- 0 => Err(report!(errors::StorageError::DatabaseError(
- errors::DatabaseError::NotFound
- ))
- .attach_printable("No records deleted")),
+ 0 => {
+ Err(report!(errors::DatabaseError::NotFound)
+ .attach_printable("No records deleted"))
+ }
_ => Ok(true), // n is usize, rustc requires this for exhaustive check
})
}
@@ -262,12 +261,12 @@ where
&self,
conn: &PgPooledConn,
query: Q,
- ) -> CustomResult<Self::DeleteWithResultsOutput, errors::StorageError> {
+ ) -> CustomResult<Self::DeleteWithResultsOutput, errors::DatabaseError> {
query
.get_results_async(conn)
.await
.into_report()
- .change_context(errors::DatabaseError::Others.into())
+ .change_context(errors::DatabaseError::Others)
.attach_printable("Error while deleting")
}
@@ -275,21 +274,20 @@ where
&self,
conn: &PgPooledConn,
query: Q,
- ) -> CustomResult<Self::DeleteOneWithResultOutput, errors::StorageError> {
+ ) -> CustomResult<Self::DeleteOneWithResultOutput, errors::DatabaseError> {
match query.get_result_async(conn).await {
Ok(value) => Ok(value),
Err(error) => match error {
ConnectionError::Query(DieselError::NotFound) => {
- Err(report!(error)).change_context(errors::DatabaseError::NotFound.into())
+ Err(report!(error)).change_context(errors::DatabaseError::NotFound)
}
- _ => Err(report!(error)).change_context(errors::DatabaseError::Others.into()),
+ _ => Err(report!(error)).change_context(errors::DatabaseError::Others),
}
.attach_printable("Error while deleting"),
}
}
}
-#[cfg(feature = "kv_store")]
#[async_trait]
impl<Q> QueryExecutionMode<Q> for RawQuery
where
@@ -308,7 +306,7 @@ where
_conn: &PgPooledConn,
query: Q,
_debug_values: String,
- ) -> CustomResult<Self::InsertOutput, errors::StorageError>
+ ) -> CustomResult<Self::InsertOutput, errors::DatabaseError>
where
Q: AsQuery + QueryFragment<Pg> + RunQueryDsl<PgConnection>,
{
@@ -320,7 +318,7 @@ where
_conn: &PgPooledConn,
query: Q,
_debug_values: String,
- ) -> CustomResult<Self::UpdateOutput, errors::StorageError>
+ ) -> CustomResult<Self::UpdateOutput, errors::DatabaseError>
where
Q: QueryId,
{
@@ -332,7 +330,7 @@ where
_conn: &PgPooledConn,
query: Q,
_debug_values: String,
- ) -> CustomResult<Self::UpdateWithResultsOutput, errors::StorageError> {
+ ) -> CustomResult<Self::UpdateWithResultsOutput, errors::DatabaseError> {
generate_raw_query(query)
}
@@ -341,7 +339,7 @@ where
_conn: &PgPooledConn,
query: Q,
_debug_values: String,
- ) -> CustomResult<Self::UpdateByIdOutput, errors::StorageError>
+ ) -> CustomResult<Self::UpdateByIdOutput, errors::DatabaseError>
where
Q: Clone,
{
@@ -352,7 +350,7 @@ where
&self,
_conn: &PgPooledConn,
query: Q,
- ) -> CustomResult<Self::DeleteOutput, errors::StorageError>
+ ) -> CustomResult<Self::DeleteOutput, errors::DatabaseError>
where
Q: QueryId,
{
@@ -363,7 +361,7 @@ where
&self,
_conn: &PgPooledConn,
query: Q,
- ) -> CustomResult<Self::DeleteWithResultsOutput, errors::StorageError> {
+ ) -> CustomResult<Self::DeleteWithResultsOutput, errors::DatabaseError> {
generate_raw_query(query)
}
@@ -371,19 +369,18 @@ where
&self,
_conn: &PgPooledConn,
query: Q,
- ) -> CustomResult<Self::DeleteOneWithResultOutput, errors::StorageError> {
+ ) -> CustomResult<Self::DeleteOneWithResultOutput, errors::DatabaseError> {
generate_raw_query(query)
}
}
-#[cfg(feature = "kv_store")]
-fn generate_raw_query<Q>(query: Q) -> CustomResult<RawSqlQuery, errors::StorageError>
+pub fn generate_raw_query<Q>(query: Q) -> CustomResult<RawSqlQuery, errors::DatabaseError>
where
Q: QueryFragment<Pg>,
{
let raw_query = diesel::query_builder::raw_query(&query)
.into_report()
- .change_context(errors::DatabaseError::QueryGenerationFailed.into())?;
+ .change_context(errors::DatabaseError::QueryGenerationFailed)?;
Ok(RawSqlQuery {
sql: raw_query.raw_sql,
@@ -392,11 +389,11 @@ where
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_insert<T, V, R, Q>(
+pub async fn generic_insert<T, V, R, Q>(
conn: &PgPooledConn,
values: V,
execution_mode: Q,
-) -> CustomResult<Q::InsertOutput, errors::StorageError>
+) -> CustomResult<Q::InsertOutput, errors::DatabaseError>
where
T: HasTable<Table = T> + Table + 'static,
V: Debug + Insertable<T>,
@@ -417,12 +414,12 @@ where
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_update<T, V, P, Q>(
+pub async fn generic_update<T, V, P, Q>(
conn: &PgPooledConn,
predicate: P,
values: V,
execution_mode: Q,
-) -> CustomResult<Q::UpdateOutput, errors::StorageError>
+) -> CustomResult<Q::UpdateOutput, errors::DatabaseError>
where
T: FilterDsl<P> + HasTable<Table = T> + Table + 'static,
V: AsChangeset<Target = <<T as FilterDsl<P>>::Output as HasTable>::Table> + Debug,
@@ -450,12 +447,12 @@ where
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_update_with_results<T, V, P, R, Q>(
+pub async fn generic_update_with_results<T, V, P, R, Q>(
conn: &PgPooledConn,
predicate: P,
values: V,
execution_mode: Q,
-) -> CustomResult<Q::UpdateWithResultsOutput, errors::StorageError>
+) -> CustomResult<Q::UpdateWithResultsOutput, errors::DatabaseError>
where
T: FilterDsl<P> + HasTable<Table = T> + Table + 'static,
V: AsChangeset<Target = <<T as FilterDsl<P>>::Output as HasTable>::Table> + Debug + 'static,
@@ -486,12 +483,12 @@ where
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_update_by_id<T, V, Pk, R, Q>(
+pub async fn generic_update_by_id<T, V, Pk, R, Q>(
conn: &PgPooledConn,
id: Pk,
values: V,
execution_mode: Q,
-) -> CustomResult<Q::UpdateByIdOutput, errors::StorageError>
+) -> CustomResult<Q::UpdateByIdOutput, errors::DatabaseError>
where
T: FindDsl<Pk> + HasTable<Table = T> + LimitDsl + Table + 'static,
V: AsChangeset<Target = <<T as FindDsl<Pk>>::Output as HasTable>::Table> + Debug,
@@ -529,11 +526,11 @@ where
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_delete<T, P, Q>(
+pub async fn generic_delete<T, P, Q>(
conn: &PgPooledConn,
predicate: P,
execution_mode: Q,
-) -> CustomResult<Q::DeleteOutput, errors::StorageError>
+) -> CustomResult<Q::DeleteOutput, errors::DatabaseError>
where
T: FilterDsl<P> + HasTable<Table = T> + Table + 'static,
<T as FilterDsl<P>>::Output: IntoUpdateTarget,
@@ -557,11 +554,11 @@ where
#[allow(dead_code)]
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_delete_with_results<T, P, R, Q>(
+pub async fn generic_delete_with_results<T, P, R, Q>(
conn: &PgPooledConn,
predicate: P,
execution_mode: Q,
-) -> CustomResult<Q::DeleteWithResultsOutput, errors::StorageError>
+) -> CustomResult<Q::DeleteWithResultsOutput, errors::DatabaseError>
where
T: FilterDsl<P> + HasTable<Table = T> + Table + 'static,
<T as FilterDsl<P>>::Output: IntoUpdateTarget,
@@ -585,11 +582,11 @@ where
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_delete_one_with_result<T, P, R, Q>(
+pub async fn generic_delete_one_with_result<T, P, R, Q>(
conn: &PgPooledConn,
predicate: P,
execution_mode: Q,
-) -> CustomResult<Q::DeleteOneWithResultOutput, errors::StorageError>
+) -> CustomResult<Q::DeleteOneWithResultOutput, errors::DatabaseError>
where
T: FilterDsl<P> + HasTable<Table = T> + Table + 'static,
<T as FilterDsl<P>>::Output: IntoUpdateTarget,
@@ -616,7 +613,7 @@ where
async fn generic_find_by_id_core<T, Pk, R>(
conn: &PgPooledConn,
id: Pk,
-) -> CustomResult<R, errors::StorageError>
+) -> CustomResult<R, errors::DatabaseError>
where
T: FindDsl<Pk> + HasTable<Table = T> + LimitDsl + Table + 'static,
<T as FindDsl<Pk>>::Output: QueryFragment<Pg> + RunQueryDsl<PgConnection> + Send + 'static,
@@ -631,22 +628,20 @@ where
match query.first_async(conn).await.into_report() {
Ok(value) => Ok(value),
Err(err) => match err.current_context() {
- ConnectionError::Query(DieselError::NotFound) => Err(err).change_context(
- errors::StorageError::DatabaseError(errors::DatabaseError::NotFound),
- ),
- _ => Err(err).change_context(errors::StorageError::DatabaseError(
- errors::DatabaseError::Others,
- )),
+ ConnectionError::Query(DieselError::NotFound) => {
+ Err(err).change_context(errors::DatabaseError::NotFound)
+ }
+ _ => Err(err).change_context(errors::DatabaseError::Others),
},
}
.attach_printable_lazy(|| format!("Error finding record by primary key: {:?}", id))
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_find_by_id<T, Pk, R>(
+pub async fn generic_find_by_id<T, Pk, R>(
conn: &PgPooledConn,
id: Pk,
-) -> CustomResult<R, errors::StorageError>
+) -> CustomResult<R, errors::DatabaseError>
where
T: FindDsl<Pk> + HasTable<Table = T> + LimitDsl + Table + 'static,
<T as FindDsl<Pk>>::Output: QueryFragment<Pg> + RunQueryDsl<PgConnection> + Send + 'static,
@@ -659,10 +654,10 @@ where
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_find_by_id_optional<T, Pk, R>(
+pub async fn generic_find_by_id_optional<T, Pk, R>(
conn: &PgPooledConn,
id: Pk,
-) -> CustomResult<Option<R>, errors::StorageError>
+) -> CustomResult<Option<R>, errors::DatabaseError>
where
T: FindDsl<Pk> + HasTable<Table = T> + LimitDsl + Table + 'static,
<T as HasTable>::Table: FindDsl<Pk>,
@@ -680,7 +675,7 @@ where
async fn generic_find_one_core<T, P, R>(
conn: &PgPooledConn,
predicate: P,
-) -> CustomResult<R, errors::StorageError>
+) -> CustomResult<R, errors::DatabaseError>
where
T: FilterDsl<P> + HasTable<Table = T> + Table + 'static,
<T as FilterDsl<P>>::Output:
@@ -695,21 +690,19 @@ where
.await
.into_report()
.map_err(|err| match err.current_context() {
- ConnectionError::Query(DieselError::NotFound) => err.change_context(
- errors::StorageError::DatabaseError(errors::DatabaseError::NotFound),
- ),
- _ => err.change_context(errors::StorageError::DatabaseError(
- errors::DatabaseError::Others,
- )),
+ ConnectionError::Query(DieselError::NotFound) => {
+ err.change_context(errors::DatabaseError::NotFound)
+ }
+ _ => err.change_context(errors::DatabaseError::Others),
})
.attach_printable_lazy(|| "Error finding record by predicate")
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_find_one<T, P, R>(
+pub async fn generic_find_one<T, P, R>(
conn: &PgPooledConn,
predicate: P,
-) -> CustomResult<R, errors::StorageError>
+) -> CustomResult<R, errors::DatabaseError>
where
T: FilterDsl<P> + HasTable<Table = T> + Table + 'static,
<T as FilterDsl<P>>::Output:
@@ -720,10 +713,10 @@ where
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_find_one_optional<T, P, R>(
+pub async fn generic_find_one_optional<T, P, R>(
conn: &PgPooledConn,
predicate: P,
-) -> CustomResult<Option<R>, errors::StorageError>
+) -> CustomResult<Option<R>, errors::DatabaseError>
where
T: FilterDsl<P> + HasTable<Table = T> + Table + 'static,
<T as FilterDsl<P>>::Output:
@@ -734,11 +727,11 @@ where
}
#[instrument(level = "DEBUG", skip_all)]
-pub(super) async fn generic_filter<T, P, R>(
+pub async fn generic_filter<T, P, R>(
conn: &PgPooledConn,
predicate: P,
limit: Option<i64>,
-) -> CustomResult<Vec<R>, errors::StorageError>
+) -> CustomResult<Vec<R>, errors::DatabaseError>
where
T: FilterDsl<P> + HasTable<Table = T> + Table + 'static,
<T as FilterDsl<P>>::Output: LoadQuery<'static, PgConnection, R> + QueryFragment<Pg>,
@@ -762,19 +755,17 @@ where
}
.await
.into_report()
- .change_context(errors::StorageError::DatabaseError(
- errors::DatabaseError::NotFound,
- ))
+ .change_context(errors::DatabaseError::NotFound)
.attach_printable_lazy(|| "Error filtering records by predicate")
}
-fn to_optional<T>(
- arg: CustomResult<T, errors::StorageError>,
-) -> CustomResult<Option<T>, errors::StorageError> {
+pub fn to_optional<T>(
+ arg: CustomResult<T, errors::DatabaseError>,
+) -> CustomResult<Option<T>, errors::DatabaseError> {
match arg {
Ok(value) => Ok(Some(value)),
Err(err) => match err.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NotFound) => Ok(None),
+ errors::DatabaseError::NotFound => Ok(None),
_ => Err(err),
},
}
diff --git a/crates/router/src/types/storage/query/locker_mock_up.rs b/crates/storage_models/src/query/locker_mock_up.rs
similarity index 75%
rename from crates/router/src/types/storage/query/locker_mock_up.rs
rename to crates/storage_models/src/query/locker_mock_up.rs
index 8e59dea04b8..af0cf1d46b4 100644
--- a/crates/router/src/types/storage/query/locker_mock_up.rs
+++ b/crates/storage_models/src/query/locker_mock_up.rs
@@ -3,10 +3,10 @@ use router_env::{tracing, tracing::instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
+ errors,
+ locker_mock_up::{LockerMockUp, LockerMockUpNew},
schema::locker_mock_up::dsl,
- types::storage::{LockerMockUp, LockerMockUpNew},
+ CustomResult, PgPooledConn,
};
impl LockerMockUpNew {
@@ -14,7 +14,7 @@ impl LockerMockUpNew {
pub async fn insert(
self,
conn: &PgPooledConn,
- ) -> CustomResult<LockerMockUp, errors::StorageError> {
+ ) -> CustomResult<LockerMockUp, errors::DatabaseError> {
generics::generic_insert::<_, _, LockerMockUp, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -24,7 +24,7 @@ impl LockerMockUp {
pub async fn find_by_card_id(
conn: &PgPooledConn,
card_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::card_id.eq(card_id.to_owned()),
diff --git a/crates/router/src/types/storage/query/mandate.rs b/crates/storage_models/src/query/mandate.rs
similarity index 69%
rename from crates/router/src/types/storage/query/mandate.rs
rename to crates/storage_models/src/query/mandate.rs
index 7dda03cf96e..868e5644bdf 100644
--- a/crates/router/src/types/storage/query/mandate.rs
+++ b/crates/storage_models/src/query/mandate.rs
@@ -3,20 +3,12 @@ use error_stack::report;
use router_env::tracing::{self, instrument};
use super::generics::{self, ExecuteQuery};
-use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
- schema::mandate::dsl,
- types::storage::{self, mandate::*},
-};
+use crate::{errors, mandate::*, schema::mandate::dsl, CustomResult, PgPooledConn};
impl MandateNew {
#[instrument(skip(conn))]
- pub async fn insert(
- self,
- conn: &PgPooledConn,
- ) -> CustomResult<storage::Mandate, errors::StorageError> {
- generics::generic_insert::<_, _, storage::Mandate, _>(conn, self, ExecuteQuery::new()).await
+ pub async fn insert(self, conn: &PgPooledConn) -> CustomResult<Mandate, errors::DatabaseError> {
+ generics::generic_insert::<_, _, Mandate, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -25,7 +17,7 @@ impl Mandate {
conn: &PgPooledConn,
merchant_id: &str,
mandate_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -39,7 +31,7 @@ impl Mandate {
conn: &PgPooledConn,
merchant_id: &str,
customer_id: &str,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
generics::generic_filter::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -55,7 +47,7 @@ impl Mandate {
merchant_id: &str,
mandate_id: &str,
mandate: MandateUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
dsl::merchant_id
@@ -68,10 +60,8 @@ impl Mandate {
.first()
.cloned()
.ok_or_else(|| {
- report!(errors::StorageError::DatabaseError(
- errors::DatabaseError::NotFound
- ))
- .attach_printable("Error while updating mandate")
+ report!(errors::DatabaseError::NotFound)
+ .attach_printable("Error while updating mandate")
})
}
}
diff --git a/crates/router/src/types/storage/query/merchant_account.rs b/crates/storage_models/src/query/merchant_account.rs
similarity index 80%
rename from crates/router/src/types/storage/query/merchant_account.rs
rename to crates/storage_models/src/query/merchant_account.rs
index 3a4b3c72bd2..0c0a07bab3a 100644
--- a/crates/router/src/types/storage/query/merchant_account.rs
+++ b/crates/storage_models/src/query/merchant_account.rs
@@ -3,12 +3,12 @@ use router_env::tracing::{self, instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
- schema::merchant_account::dsl,
- types::storage::{
+ errors,
+ merchant_account::{
MerchantAccount, MerchantAccountNew, MerchantAccountUpdate, MerchantAccountUpdateInternal,
},
+ schema::merchant_account::dsl,
+ CustomResult, PgPooledConn,
};
impl MerchantAccountNew {
@@ -16,7 +16,7 @@ impl MerchantAccountNew {
pub async fn insert_diesel(
self,
conn: &PgPooledConn,
- ) -> CustomResult<MerchantAccount, errors::StorageError> {
+ ) -> CustomResult<MerchantAccount, errors::DatabaseError> {
generics::generic_insert::<_, _, MerchantAccount, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -27,7 +27,7 @@ impl MerchantAccount {
self,
conn: &PgPooledConn,
merchant_account: MerchantAccountUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
self.id,
@@ -37,9 +37,7 @@ impl MerchantAccount {
.await
{
Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
- Ok(self)
- }
+ errors::DatabaseError::NoFieldsToUpdate => Ok(self),
_ => Err(error),
},
result => result,
@@ -49,7 +47,7 @@ impl MerchantAccount {
pub async fn delete_by_merchant_id(
conn: &PgPooledConn,
merchant_id: &str,
- ) -> CustomResult<bool, errors::StorageError> {
+ ) -> CustomResult<bool, errors::DatabaseError> {
generics::generic_delete::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id.eq(merchant_id.to_owned()),
@@ -62,7 +60,7 @@ impl MerchantAccount {
pub async fn find_by_merchant_id(
conn: &PgPooledConn,
merchant_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id.eq(merchant_id.to_owned()),
@@ -74,7 +72,7 @@ impl MerchantAccount {
pub async fn find_by_api_key(
conn: &PgPooledConn,
api_key: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::api_key.eq(api_key.to_owned()),
@@ -86,7 +84,7 @@ impl MerchantAccount {
pub async fn find_by_publishable_key(
conn: &PgPooledConn,
publishable_key: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::publishable_key.eq(publishable_key.to_owned()),
diff --git a/crates/router/src/types/storage/query/merchant_connector_account.rs b/crates/storage_models/src/query/merchant_connector_account.rs
similarity index 83%
rename from crates/router/src/types/storage/query/merchant_connector_account.rs
rename to crates/storage_models/src/query/merchant_connector_account.rs
index 5c967cd3590..7767f26f921 100644
--- a/crates/router/src/types/storage/query/merchant_connector_account.rs
+++ b/crates/storage_models/src/query/merchant_connector_account.rs
@@ -3,13 +3,13 @@ use router_env::tracing::{self, instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
- schema::merchant_connector_account::dsl,
- types::storage::{
+ errors,
+ merchant_connector_account::{
MerchantConnectorAccount, MerchantConnectorAccountNew, MerchantConnectorAccountUpdate,
MerchantConnectorAccountUpdateInternal,
},
+ schema::merchant_connector_account::dsl,
+ CustomResult, PgPooledConn,
};
impl MerchantConnectorAccountNew {
@@ -17,7 +17,7 @@ impl MerchantConnectorAccountNew {
pub async fn insert_diesel(
self,
conn: &PgPooledConn,
- ) -> CustomResult<MerchantConnectorAccount, errors::StorageError> {
+ ) -> CustomResult<MerchantConnectorAccount, errors::DatabaseError> {
generics::generic_insert::<_, _, MerchantConnectorAccount, _>(
conn,
self,
@@ -33,7 +33,7 @@ impl MerchantConnectorAccount {
self,
conn: &PgPooledConn,
merchant_connector_account: MerchantConnectorAccountUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
self.id,
@@ -43,9 +43,7 @@ impl MerchantConnectorAccount {
.await
{
Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
- Ok(self)
- }
+ errors::DatabaseError::NoFieldsToUpdate => Ok(self),
_ => Err(error),
},
result => result,
@@ -56,7 +54,7 @@ impl MerchantConnectorAccount {
conn: &PgPooledConn,
merchant_id: &str,
merchant_connector_id: &i32,
- ) -> CustomResult<bool, errors::StorageError> {
+ ) -> CustomResult<bool, errors::DatabaseError> {
generics::generic_delete::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -72,7 +70,7 @@ impl MerchantConnectorAccount {
conn: &PgPooledConn,
merchant_id: &str,
connector: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -87,7 +85,7 @@ impl MerchantConnectorAccount {
conn: &PgPooledConn,
merchant_id: &str,
merchant_connector_id: &i32,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -101,7 +99,7 @@ impl MerchantConnectorAccount {
pub async fn find_by_merchant_id(
conn: &PgPooledConn,
merchant_id: &str,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
generics::generic_filter::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id.eq(merchant_id.to_owned()),
diff --git a/crates/router/src/types/storage/query/payment_attempt.rs b/crates/storage_models/src/query/payment_attempt.rs
similarity index 78%
rename from crates/router/src/types/storage/query/payment_attempt.rs
rename to crates/storage_models/src/query/payment_attempt.rs
index e7d17d0b314..e3a44deb004 100644
--- a/crates/router/src/types/storage/query/payment_attempt.rs
+++ b/crates/storage_models/src/query/payment_attempt.rs
@@ -3,21 +3,19 @@ use diesel::{
associations::HasTable, debug_query, pg::Pg, BoolExpressionMethods, ExpressionMethods, QueryDsl,
};
use error_stack::{IntoReport, ResultExt};
-use router_env::tracing::{self, instrument};
+use router_env::{
+ logger::debug,
+ tracing::{self, instrument},
+};
-#[cfg(not(feature = "kv_store"))]
-use super::generics::{self, ExecuteQuery};
-#[cfg(feature = "kv_store")]
use super::generics::{self, ExecuteQuery, RawQuery, RawSqlQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
- logger::debug,
- schema::payment_attempt::dsl,
- types::storage::{
- enums, PaymentAttempt, PaymentAttemptNew, PaymentAttemptUpdate,
- PaymentAttemptUpdateInternal,
+ enums, errors,
+ payment_attempt::{
+ PaymentAttempt, PaymentAttemptNew, PaymentAttemptUpdate, PaymentAttemptUpdateInternal,
},
+ schema::payment_attempt::dsl,
+ CustomResult, PgPooledConn,
};
impl PaymentAttemptNew {
@@ -25,16 +23,15 @@ impl PaymentAttemptNew {
pub async fn insert_diesel(
self,
conn: &PgPooledConn,
- ) -> CustomResult<PaymentAttempt, errors::StorageError> {
+ ) -> CustomResult<PaymentAttempt, errors::DatabaseError> {
generics::generic_insert::<_, _, PaymentAttempt, _>(conn, self, ExecuteQuery::new()).await
}
- #[cfg(feature = "kv_store")]
#[instrument(skip(conn))]
pub async fn insert_diesel_query(
self,
conn: &PgPooledConn,
- ) -> CustomResult<RawSqlQuery, errors::StorageError> {
+ ) -> CustomResult<RawSqlQuery, errors::DatabaseError> {
generics::generic_insert::<_, _, PaymentAttempt, _>(conn, self, RawQuery).await
}
}
@@ -45,7 +42,7 @@ impl PaymentAttempt {
self,
conn: &PgPooledConn,
payment_attempt: PaymentAttemptUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
self.id,
@@ -55,22 +52,19 @@ impl PaymentAttempt {
.await
{
Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
- Ok(self)
- }
+ errors::DatabaseError::NoFieldsToUpdate => Ok(self),
_ => Err(error),
},
result => result,
}
}
- #[cfg(feature = "kv_store")]
#[instrument(skip(conn))]
pub async fn update_query(
self,
conn: &PgPooledConn,
payment_attempt: PaymentAttemptUpdate,
- ) -> CustomResult<RawSqlQuery, errors::StorageError> {
+ ) -> CustomResult<RawSqlQuery, errors::DatabaseError> {
generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
self.id,
@@ -85,7 +79,7 @@ impl PaymentAttempt {
conn: &PgPooledConn,
payment_id: &str,
merchant_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -100,7 +94,7 @@ impl PaymentAttempt {
conn: &PgPooledConn,
payment_id: &str,
merchant_id: &str,
- ) -> CustomResult<Option<Self>, errors::StorageError> {
+ ) -> CustomResult<Option<Self>, errors::DatabaseError> {
generics::generic_find_one_optional::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -116,7 +110,7 @@ impl PaymentAttempt {
transaction_id: &str,
payment_id: &str,
merchant_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::connector_transaction_id
@@ -133,7 +127,7 @@ impl PaymentAttempt {
conn: &PgPooledConn,
payment_id: &str,
merchant_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
let query = Self::table()
.filter(
dsl::payment_id
@@ -148,9 +142,7 @@ impl PaymentAttempt {
.get_result_async(conn)
.await
.into_report()
- .change_context(errors::StorageError::DatabaseError(
- errors::DatabaseError::NotFound,
- ))
+ .change_context(errors::DatabaseError::NotFound)
.attach_printable("Error while finding last successful payment attempt")
}
@@ -159,7 +151,7 @@ impl PaymentAttempt {
conn: &PgPooledConn,
merchant_id: &str,
connector_txn_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -174,7 +166,7 @@ impl PaymentAttempt {
conn: &PgPooledConn,
merchant_id: &str,
txn_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -184,6 +176,3 @@ impl PaymentAttempt {
.await
}
}
-
-#[cfg(feature = "kv_store")]
-impl crate::utils::storage_partitioning::KvStorePartition for PaymentAttempt {}
diff --git a/crates/storage_models/src/query/payment_intent.rs b/crates/storage_models/src/query/payment_intent.rs
new file mode 100644
index 00000000000..fab006e06b3
--- /dev/null
+++ b/crates/storage_models/src/query/payment_intent.rs
@@ -0,0 +1,99 @@
+use diesel::{associations::HasTable, BoolExpressionMethods, ExpressionMethods};
+use router_env::tracing::{self, instrument};
+
+use super::generics::{self, ExecuteQuery, RawQuery, RawSqlQuery};
+use crate::{
+ errors,
+ payment_intent::{
+ PaymentIntent, PaymentIntentNew, PaymentIntentUpdate, PaymentIntentUpdateInternal,
+ },
+ schema::payment_intent::dsl,
+ CustomResult, PgPooledConn,
+};
+
+impl PaymentIntentNew {
+ #[instrument(skip(conn))]
+ pub async fn insert_diesel(
+ self,
+ conn: &PgPooledConn,
+ ) -> CustomResult<PaymentIntent, errors::DatabaseError> {
+ generics::generic_insert::<_, _, PaymentIntent, _>(conn, self, ExecuteQuery::new()).await
+ }
+
+ #[instrument(skip(conn))]
+ pub async fn insert_diesel_query(
+ self,
+ conn: &PgPooledConn,
+ ) -> CustomResult<RawSqlQuery, errors::DatabaseError> {
+ generics::generic_insert::<_, _, PaymentIntent, _>(conn, self, RawQuery).await
+ }
+}
+
+impl PaymentIntent {
+ #[instrument(skip(conn))]
+ pub async fn update(
+ self,
+ conn: &PgPooledConn,
+ payment_intent: PaymentIntentUpdate,
+ ) -> CustomResult<Self, errors::DatabaseError> {
+ match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
+ conn,
+ self.id,
+ PaymentIntentUpdateInternal::from(payment_intent),
+ ExecuteQuery::new(),
+ )
+ .await
+ {
+ Err(error) => match error.current_context() {
+ errors::DatabaseError::NoFieldsToUpdate => Ok(self),
+ _ => Err(error),
+ },
+ result => result,
+ }
+ }
+
+ #[instrument(skip(conn))]
+ pub async fn update_query(
+ self,
+ conn: &PgPooledConn,
+ payment_intent: PaymentIntentUpdate,
+ ) -> CustomResult<RawSqlQuery, errors::DatabaseError> {
+ generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
+ conn,
+ self.id,
+ PaymentIntentUpdateInternal::from(payment_intent),
+ RawQuery,
+ )
+ .await
+ }
+
+ #[instrument(skip(conn))]
+ pub async fn find_by_payment_id_merchant_id(
+ conn: &PgPooledConn,
+ payment_id: &str,
+ merchant_id: &str,
+ ) -> CustomResult<Self, errors::DatabaseError> {
+ generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
+ conn,
+ dsl::merchant_id
+ .eq(merchant_id.to_owned())
+ .and(dsl::payment_id.eq(payment_id.to_owned())),
+ )
+ .await
+ }
+
+ #[instrument(skip(conn))]
+ pub async fn find_optional_by_payment_id_merchant_id(
+ conn: &PgPooledConn,
+ payment_id: &str,
+ merchant_id: &str,
+ ) -> CustomResult<Option<Self>, errors::DatabaseError> {
+ generics::generic_find_one_optional::<<Self as HasTable>::Table, _, _>(
+ conn,
+ dsl::merchant_id
+ .eq(merchant_id.to_owned())
+ .and(dsl::payment_id.eq(payment_id.to_owned())),
+ )
+ .await
+ }
+}
diff --git a/crates/router/src/types/storage/query/payment_method.rs b/crates/storage_models/src/query/payment_method.rs
similarity index 84%
rename from crates/router/src/types/storage/query/payment_method.rs
rename to crates/storage_models/src/query/payment_method.rs
index 7ff79efd5a0..f14be344211 100644
--- a/crates/router/src/types/storage/query/payment_method.rs
+++ b/crates/storage_models/src/query/payment_method.rs
@@ -4,10 +4,10 @@ use router_env::tracing::{self, instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
+ errors,
+ payment_method::{PaymentMethod, PaymentMethodNew},
schema::payment_methods::dsl,
- types::storage::payment_method::{PaymentMethod, PaymentMethodNew},
+ CustomResult, PgPooledConn,
};
impl PaymentMethodNew {
@@ -15,7 +15,7 @@ impl PaymentMethodNew {
pub async fn insert(
self,
conn: &PgPooledConn,
- ) -> CustomResult<PaymentMethod, errors::StorageError> {
+ ) -> CustomResult<PaymentMethod, errors::DatabaseError> {
generics::generic_insert::<_, _, PaymentMethod, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -25,7 +25,7 @@ impl PaymentMethod {
pub async fn delete_by_payment_method_id(
conn: &PgPooledConn,
payment_method_id: String,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
let result =
generics::generic_delete_one_with_result::<<Self as HasTable>::Table, _, Self, _>(
conn,
@@ -42,7 +42,7 @@ impl PaymentMethod {
conn: &PgPooledConn,
merchant_id: &str,
payment_method_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
let result =
generics::generic_delete_one_with_result::<<Self as HasTable>::Table, _, Self, _>(
conn,
@@ -60,7 +60,7 @@ impl PaymentMethod {
pub async fn find_by_payment_method_id(
conn: &PgPooledConn,
payment_method_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::payment_method_id.eq(payment_method_id.to_owned()),
@@ -72,7 +72,7 @@ impl PaymentMethod {
pub async fn find_by_merchant_id(
conn: &PgPooledConn,
merchant_id: &str,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
generics::generic_filter::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id.eq(merchant_id.to_owned()),
@@ -86,7 +86,7 @@ impl PaymentMethod {
conn: &PgPooledConn,
customer_id: &str,
merchant_id: &str,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
generics::generic_filter::<<Self as HasTable>::Table, _, _>(
conn,
dsl::customer_id
diff --git a/crates/router/src/types/storage/query/process_tracker.rs b/crates/storage_models/src/query/process_tracker.rs
similarity index 80%
rename from crates/router/src/types/storage/query/process_tracker.rs
rename to crates/storage_models/src/query/process_tracker.rs
index c8de65d221c..4962f45db61 100644
--- a/crates/router/src/types/storage/query/process_tracker.rs
+++ b/crates/storage_models/src/query/process_tracker.rs
@@ -3,19 +3,20 @@ use diesel::{
associations::HasTable, debug_query, pg::Pg, BoolExpressionMethods, ExpressionMethods, QueryDsl,
};
use error_stack::{IntoReport, ResultExt};
-use router_env::tracing::{self, instrument};
+use router_env::{
+ logger::debug,
+ tracing::{self, instrument},
+};
use time::PrimitiveDateTime;
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::{PgPool, PgPooledConn},
- core::errors::{self, CustomResult},
- logger::debug,
- schema::process_tracker::dsl,
- types::storage::{
- enums, ProcessTracker, ProcessTrackerNew, ProcessTrackerUpdate,
- ProcessTrackerUpdateInternal,
+ enums, errors,
+ process_tracker::{
+ ProcessTracker, ProcessTrackerNew, ProcessTrackerUpdate, ProcessTrackerUpdateInternal,
},
+ schema::process_tracker::dsl,
+ CustomResult, PgPooledConn,
};
impl ProcessTrackerNew {
@@ -23,7 +24,7 @@ impl ProcessTrackerNew {
pub async fn insert_process(
self,
conn: &PgPooledConn,
- ) -> CustomResult<ProcessTracker, errors::StorageError> {
+ ) -> CustomResult<ProcessTracker, errors::DatabaseError> {
generics::generic_insert::<_, _, ProcessTracker, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -34,7 +35,7 @@ impl ProcessTracker {
self,
conn: &PgPooledConn,
process: ProcessTrackerUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
self.id.clone(),
@@ -44,9 +45,7 @@ impl ProcessTracker {
.await
{
Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
- Ok(self)
- }
+ errors::DatabaseError::NoFieldsToUpdate => Ok(self),
_ => Err(error),
},
result => result,
@@ -58,7 +57,7 @@ impl ProcessTracker {
conn: &PgPooledConn,
task_ids: Vec<String>,
task_update: ProcessTrackerUpdate,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
// TODO: Possible optimization: Instead of returning updated values from database, update
// the values in code and return them, if database query executed successfully.
generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, Self, _>(
@@ -74,7 +73,7 @@ impl ProcessTracker {
pub async fn find_process_by_id(
conn: &PgPooledConn,
id: &str,
- ) -> CustomResult<Option<Self>, errors::StorageError> {
+ ) -> CustomResult<Option<Self>, errors::DatabaseError> {
generics::generic_find_by_id_optional::<<Self as HasTable>::Table, _, _>(
conn,
id.to_owned(),
@@ -89,7 +88,7 @@ impl ProcessTracker {
time_upper_limit: PrimitiveDateTime,
status: enums::ProcessTrackerStatus,
limit: Option<i64>,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
generics::generic_filter::<<Self as HasTable>::Table, _, _>(
conn,
dsl::schedule_time
@@ -103,12 +102,12 @@ impl ProcessTracker {
// FIXME with generics
#[instrument(skip(pool))]
pub async fn find_processes_to_clean(
- pool: &PgPool,
+ pool: &PgPooledConn,
time_lower_limit: PrimitiveDateTime,
time_upper_limit: PrimitiveDateTime,
runner: &str,
limit: i64,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
let query = Self::table()
.filter(dsl::schedule_time.between(time_lower_limit, time_upper_limit))
.filter(dsl::status.eq(enums::ProcessTrackerStatus::ProcessStarted))
@@ -121,9 +120,7 @@ impl ProcessTracker {
.get_results_async(pool)
.await
.into_report()
- .change_context(errors::StorageError::DatabaseError(
- errors::DatabaseError::NotFound,
- ))
+ .change_context(errors::DatabaseError::NotFound)
.attach_printable_lazy(|| "Error finding processes to clean")
}
@@ -132,7 +129,7 @@ impl ProcessTracker {
conn: &PgPooledConn,
ids: Vec<String>,
schedule_time: PrimitiveDateTime,
- ) -> CustomResult<usize, errors::StorageError> {
+ ) -> CustomResult<usize, errors::DatabaseError> {
generics::generic_update::<<Self as HasTable>::Table, _, _, _>(
conn,
dsl::status
diff --git a/crates/router/src/types/storage/query/refund.rs b/crates/storage_models/src/query/refund.rs
similarity index 82%
rename from crates/router/src/types/storage/query/refund.rs
rename to crates/storage_models/src/query/refund.rs
index 0e9f50d5f7c..2ab12e637b8 100644
--- a/crates/router/src/types/storage/query/refund.rs
+++ b/crates/storage_models/src/query/refund.rs
@@ -3,17 +3,17 @@ use router_env::{tracing, tracing::instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
+ errors,
+ refund::{Refund, RefundNew, RefundUpdate, RefundUpdateInternal},
schema::refund::dsl,
- types::storage::{Refund, RefundNew, RefundUpdate, RefundUpdateInternal},
+ CustomResult, PgPooledConn,
};
// FIXME: Find by partition key
impl RefundNew {
#[instrument(skip(conn))]
- pub async fn insert(self, conn: &PgPooledConn) -> CustomResult<Refund, errors::StorageError> {
+ pub async fn insert(self, conn: &PgPooledConn) -> CustomResult<Refund, errors::DatabaseError> {
generics::generic_insert::<_, _, Refund, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -24,7 +24,7 @@ impl Refund {
self,
conn: &PgPooledConn,
refund: RefundUpdate,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
match generics::generic_update_by_id::<<Self as HasTable>::Table, _, _, Self, _>(
conn,
self.id,
@@ -34,9 +34,7 @@ impl Refund {
.await
{
Err(error) => match error.current_context() {
- errors::StorageError::DatabaseError(errors::DatabaseError::NoFieldsToUpdate) => {
- Ok(self)
- }
+ errors::DatabaseError::NoFieldsToUpdate => Ok(self),
_ => Err(error),
},
result => result,
@@ -49,7 +47,7 @@ impl Refund {
conn: &PgPooledConn,
merchant_id: &str,
refund_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -64,7 +62,7 @@ impl Refund {
conn: &PgPooledConn,
internal_reference_id: &str,
merchant_id: &str,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -79,7 +77,7 @@ impl Refund {
conn: &PgPooledConn,
merchant_id: &str,
txn_id: &str,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
generics::generic_filter::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
@@ -95,7 +93,7 @@ impl Refund {
conn: &PgPooledConn,
payment_id: &str,
merchant_id: &str,
- ) -> CustomResult<Vec<Self>, errors::StorageError> {
+ ) -> CustomResult<Vec<Self>, errors::DatabaseError> {
generics::generic_filter::<<Self as HasTable>::Table, _, _>(
conn,
dsl::merchant_id
diff --git a/crates/router/src/types/storage/query/temp_card.rs b/crates/storage_models/src/query/temp_card.rs
similarity index 78%
rename from crates/router/src/types/storage/query/temp_card.rs
rename to crates/storage_models/src/query/temp_card.rs
index 33b1643fa85..1d5335254f9 100644
--- a/crates/router/src/types/storage/query/temp_card.rs
+++ b/crates/storage_models/src/query/temp_card.rs
@@ -3,10 +3,10 @@ use router_env::tracing::{self, instrument};
use super::generics::{self, ExecuteQuery};
use crate::{
- connection::PgPooledConn,
- core::errors::{self, CustomResult},
+ errors,
schema::temp_card::dsl,
- types::storage::{TempCard, TempCardNew},
+ temp_card::{TempCard, TempCardNew},
+ CustomResult, PgPooledConn,
};
impl TempCardNew {
@@ -14,7 +14,7 @@ impl TempCardNew {
pub async fn insert_diesel(
self,
conn: &PgPooledConn,
- ) -> CustomResult<TempCard, errors::StorageError> {
+ ) -> CustomResult<TempCard, errors::DatabaseError> {
generics::generic_insert::<_, _, TempCard, _>(conn, self, ExecuteQuery::new()).await
}
}
@@ -24,7 +24,7 @@ impl TempCard {
pub async fn insert_with_token(
self,
conn: &PgPooledConn,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_insert::<_, _, TempCard, _>(conn, self, ExecuteQuery::new()).await
}
@@ -32,7 +32,7 @@ impl TempCard {
pub async fn find_by_transaction_id(
conn: &PgPooledConn,
transaction_id: &str,
- ) -> CustomResult<Option<TempCard>, errors::StorageError> {
+ ) -> CustomResult<Option<TempCard>, errors::DatabaseError> {
generics::generic_find_one_optional::<<Self as HasTable>::Table, _, _>(
conn,
dsl::txn_id.eq(transaction_id.to_owned()),
@@ -44,7 +44,7 @@ impl TempCard {
pub async fn find_by_token(
conn: &PgPooledConn,
token: &i32,
- ) -> CustomResult<Self, errors::StorageError> {
+ ) -> CustomResult<Self, errors::DatabaseError> {
generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
conn,
dsl::id.eq(token.to_owned()),
diff --git a/crates/storage_models/src/refund.rs b/crates/storage_models/src/refund.rs
new file mode 100644
index 00000000000..adf189665a4
--- /dev/null
+++ b/crates/storage_models/src/refund.rs
@@ -0,0 +1,141 @@
+use diesel::{AsChangeset, Identifiable, Insertable, Queryable};
+use serde::{Deserialize, Serialize};
+use time::PrimitiveDateTime;
+
+use crate::{enums as storage_enums, schema::refund};
+
+#[derive(Clone, Debug, Eq, Identifiable, Queryable, PartialEq)]
+#[diesel(table_name = refund)]
+pub struct Refund {
+ pub id: i32,
+ pub internal_reference_id: String,
+ pub refund_id: String, //merchant_reference id
+ pub payment_id: String,
+ pub merchant_id: String,
+ pub transaction_id: String,
+ pub connector: String,
+ pub pg_refund_id: Option<String>,
+ pub external_reference_id: Option<String>,
+ pub refund_type: storage_enums::RefundType,
+ pub total_amount: i32,
+ pub currency: storage_enums::Currency,
+ pub refund_amount: i32,
+ pub refund_status: storage_enums::RefundStatus,
+ pub sent_to_gateway: bool,
+ pub refund_error_message: Option<String>,
+ pub metadata: Option<serde_json::Value>,
+ pub refund_arn: Option<String>,
+ pub created_at: PrimitiveDateTime,
+ pub updated_at: PrimitiveDateTime,
+ pub description: Option<String>,
+}
+
+#[derive(Clone, Debug, Default, Eq, PartialEq, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = refund)]
+pub struct RefundNew {
+ pub refund_id: String,
+ pub payment_id: String,
+ pub merchant_id: String,
+ pub internal_reference_id: String,
+ pub external_reference_id: Option<String>,
+ pub transaction_id: String,
+ pub connector: String,
+ pub pg_refund_id: Option<String>,
+ pub refund_type: storage_enums::RefundType,
+ pub total_amount: i32,
+ pub currency: storage_enums::Currency,
+ pub refund_amount: i32,
+ pub refund_status: storage_enums::RefundStatus,
+ pub sent_to_gateway: bool,
+ pub refund_error_message: Option<String>,
+ pub metadata: Option<serde_json::Value>,
+ pub refund_arn: Option<String>,
+ pub created_at: Option<PrimitiveDateTime>,
+ pub modified_at: Option<PrimitiveDateTime>,
+ pub description: Option<String>,
+}
+
+#[derive(Debug)]
+pub enum RefundUpdate {
+ Update {
+ pg_refund_id: String,
+ refund_status: storage_enums::RefundStatus,
+ sent_to_gateway: bool,
+ refund_error_message: Option<String>,
+ refund_arn: String,
+ },
+ MetadataUpdate {
+ metadata: Option<serde_json::Value>,
+ },
+ StatusUpdate {
+ pg_refund_id: Option<String>,
+ sent_to_gateway: bool,
+ refund_status: storage_enums::RefundStatus,
+ },
+ ErrorUpdate {
+ refund_status: Option<storage_enums::RefundStatus>,
+ refund_error_message: Option<String>,
+ },
+}
+
+#[derive(Clone, Debug, Default, AsChangeset, router_derive::DebugAsDisplay)]
+#[diesel(table_name = refund)]
+pub struct RefundUpdateInternal {
+ pg_refund_id: Option<String>,
+ refund_status: Option<storage_enums::RefundStatus>,
+ sent_to_gateway: Option<bool>,
+ refund_error_message: Option<String>,
+ refund_arn: Option<String>,
+ metadata: Option<serde_json::Value>,
+}
+
+impl From<RefundUpdate> for RefundUpdateInternal {
+ fn from(refund_update: RefundUpdate) -> Self {
+ match refund_update {
+ RefundUpdate::Update {
+ pg_refund_id,
+ refund_status,
+ sent_to_gateway,
+ refund_error_message,
+ refund_arn,
+ } => Self {
+ pg_refund_id: Some(pg_refund_id),
+ refund_status: Some(refund_status),
+ sent_to_gateway: Some(sent_to_gateway),
+ refund_error_message,
+ refund_arn: Some(refund_arn),
+ ..Default::default()
+ },
+ RefundUpdate::MetadataUpdate { metadata } => Self {
+ metadata,
+ ..Default::default()
+ },
+ RefundUpdate::StatusUpdate {
+ pg_refund_id,
+ sent_to_gateway,
+ refund_status,
+ } => Self {
+ pg_refund_id,
+ sent_to_gateway: Some(sent_to_gateway),
+ refund_status: Some(refund_status),
+ ..Default::default()
+ },
+ RefundUpdate::ErrorUpdate {
+ refund_status,
+ refund_error_message,
+ } => Self {
+ refund_status,
+ refund_error_message,
+ ..Default::default()
+ },
+ }
+ }
+}
+
+#[derive(Debug, Eq, PartialEq, Deserialize, Serialize)]
+pub struct RefundCoreWorkflow {
+ pub refund_internal_reference_id: String,
+ pub transaction_id: String,
+ pub merchant_id: String,
+ pub payment_id: String,
+}
diff --git a/crates/router/src/schema.rs b/crates/storage_models/src/schema.rs
similarity index 92%
rename from crates/router/src/schema.rs
rename to crates/storage_models/src/schema.rs
index 218c2305bc5..85b5be3ee5a 100644
--- a/crates/router/src/schema.rs
+++ b/crates/storage_models/src/schema.rs
@@ -2,7 +2,7 @@
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
address (address_id) {
id -> Int4,
@@ -27,7 +27,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
configs (key) {
id -> Int4,
@@ -38,7 +38,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
connector_response (id) {
id -> Int4,
@@ -56,7 +56,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
customers (customer_id, merchant_id) {
id -> Int4,
@@ -74,7 +74,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
events (id) {
id -> Int4,
@@ -91,7 +91,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
locker_mock_up (id) {
id -> Int4,
@@ -112,7 +112,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
mandate (id) {
id -> Int4,
@@ -138,7 +138,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
merchant_account (id) {
id -> Int4,
@@ -162,7 +162,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
merchant_connector_account (id) {
id -> Int4,
@@ -179,7 +179,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
payment_attempt (id) {
id -> Int4,
@@ -216,7 +216,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
payment_intent (id) {
id -> Int4,
@@ -246,7 +246,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
payment_methods (id) {
id -> Int4,
@@ -275,7 +275,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
process_tracker (id) {
id -> Varchar,
@@ -296,7 +296,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
refund (id) {
id -> Int4,
@@ -325,7 +325,7 @@ diesel::table! {
diesel::table! {
use diesel::sql_types::*;
- use crate::types::storage::enums::diesel_exports::*;
+ use crate::enums::diesel_exports::*;
temp_card (id) {
id -> Int4,
diff --git a/crates/storage_models/src/temp_card.rs b/crates/storage_models/src/temp_card.rs
new file mode 100644
index 00000000000..6b036ef8d9c
--- /dev/null
+++ b/crates/storage_models/src/temp_card.rs
@@ -0,0 +1,23 @@
+use diesel::{Identifiable, Insertable, Queryable};
+use serde_json::Value;
+use time::PrimitiveDateTime;
+
+use crate::schema::temp_card;
+
+#[derive(Clone, Debug, router_derive::DebugAsDisplay, Queryable, Identifiable, Insertable)]
+#[diesel(table_name = temp_card)]
+pub struct TempCard {
+ pub id: i32,
+ pub date_created: PrimitiveDateTime,
+ pub txn_id: Option<String>,
+ pub card_info: Option<Value>,
+}
+
+#[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay)]
+#[diesel(table_name = temp_card)]
+pub struct TempCardNew {
+ pub id: Option<i32>,
+ pub card_info: Option<Value>,
+ pub date_created: PrimitiveDateTime,
+ pub txn_id: Option<String>,
+}
diff --git a/diesel.toml b/diesel.toml
index e0e69483d5f..61cc07378a6 100644
--- a/diesel.toml
+++ b/diesel.toml
@@ -2,6 +2,6 @@
# see diesel.rs/guides/configuring-diesel-cli
[print_schema]
-file = "crates/router/src/schema.rs"
-import_types = ["diesel::sql_types::*", "crate::types::storage::enums::diesel_exports::*"]
+file = "crates/storage_models/src/schema.rs"
+import_types = ["diesel::sql_types::*", "crate::enums::diesel_exports::*"]
generate_missing_sql_type_definitions = false
|
refactor
|
move db models into separate crate and refactoring around it (#125)
|
b6b9e4f912e1c61cd31ab91be587ffb08c9f3a5b
|
2023-11-05 16:21:32
|
Seemebadnekai
|
feat(connector): [Fiserv] Currency Unit Conversion (#2715)
| false
|
diff --git a/crates/router/src/connector/fiserv.rs b/crates/router/src/connector/fiserv.rs
index 70f58ffe6eb..35d40f1a3fb 100644
--- a/crates/router/src/connector/fiserv.rs
+++ b/crates/router/src/connector/fiserv.rs
@@ -104,6 +104,10 @@ impl ConnectorCommon for Fiserv {
"fiserv"
}
+ fn get_currency_unit(&self) -> api::CurrencyUnit {
+ api::CurrencyUnit::Base
+ }
+
fn common_get_content_type(&self) -> &'static str {
"application/json"
}
@@ -400,7 +404,13 @@ impl ConnectorIntegration<api::Capture, types::PaymentsCaptureData, types::Payme
&self,
req: &types::PaymentsCaptureRouterData,
) -> CustomResult<Option<types::RequestBody>, errors::ConnectorError> {
- let connector_request = fiserv::FiservCaptureRequest::try_from(req)?;
+ let router_obj = fiserv::FiservRouterData::try_from((
+ &self.get_currency_unit(),
+ req.request.currency,
+ req.request.amount_to_capture,
+ req,
+ ))?;
+ let connector_request = fiserv::FiservCaptureRequest::try_from(&router_obj)?;
let fiserv_payments_capture_request = types::RequestBody::log_and_get_request_body(
&connector_request,
utils::Encode::<fiserv::FiservCaptureRequest>::encode_to_string_of_json,
@@ -505,7 +515,13 @@ impl ConnectorIntegration<api::Authorize, types::PaymentsAuthorizeData, types::P
&self,
req: &types::PaymentsAuthorizeRouterData,
) -> CustomResult<Option<types::RequestBody>, errors::ConnectorError> {
- let connector_request = fiserv::FiservPaymentsRequest::try_from(req)?;
+ let router_obj = fiserv::FiservRouterData::try_from((
+ &self.get_currency_unit(),
+ req.request.currency,
+ req.request.amount,
+ req,
+ ))?;
+ let connector_request = fiserv::FiservPaymentsRequest::try_from(&router_obj)?;
let fiserv_payments_request = types::RequestBody::log_and_get_request_body(
&connector_request,
utils::Encode::<fiserv::FiservPaymentsRequest>::encode_to_string_of_json,
@@ -592,7 +608,13 @@ impl ConnectorIntegration<api::Execute, types::RefundsData, types::RefundsRespon
&self,
req: &types::RefundsRouterData<api::Execute>,
) -> CustomResult<Option<types::RequestBody>, errors::ConnectorError> {
- let connector_request = fiserv::FiservRefundRequest::try_from(req)?;
+ let router_obj = fiserv::FiservRouterData::try_from((
+ &self.get_currency_unit(),
+ req.request.currency,
+ req.request.refund_amount,
+ req,
+ ))?;
+ let connector_request = fiserv::FiservRefundRequest::try_from(&router_obj)?;
let fiserv_refund_request = types::RequestBody::log_and_get_request_body(
&connector_request,
utils::Encode::<fiserv::FiservRefundRequest>::encode_to_string_of_json,
diff --git a/crates/router/src/connector/fiserv/transformers.rs b/crates/router/src/connector/fiserv/transformers.rs
index ae8eed0af31..2d07da7f47a 100644
--- a/crates/router/src/connector/fiserv/transformers.rs
+++ b/crates/router/src/connector/fiserv/transformers.rs
@@ -9,6 +9,38 @@ use crate::{
types::{self, api, storage::enums},
};
+#[derive(Debug, Serialize)]
+pub struct FiservRouterData<T> {
+ pub amount: String,
+ pub router_data: T,
+}
+
+impl<T>
+ TryFrom<(
+ &types::api::CurrencyUnit,
+ types::storage::enums::Currency,
+ i64,
+ T,
+ )> for FiservRouterData<T>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+
+ fn try_from(
+ (currency_unit, currency, amount, router_data): (
+ &types::api::CurrencyUnit,
+ types::storage::enums::Currency,
+ i64,
+ T,
+ ),
+ ) -> Result<Self, Self::Error> {
+ let amount = utils::get_amount_as_string(currency_unit, amount, currency)?;
+ Ok(Self {
+ amount,
+ router_data,
+ })
+ }
+}
+
#[derive(Debug, Serialize, Eq, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct FiservPaymentsRequest {
@@ -99,23 +131,25 @@ pub enum TransactionInteractionPosConditionCode {
CardNotPresentEcom,
}
-impl TryFrom<&types::PaymentsAuthorizeRouterData> for FiservPaymentsRequest {
+impl TryFrom<&FiservRouterData<&types::PaymentsAuthorizeRouterData>> for FiservPaymentsRequest {
type Error = error_stack::Report<errors::ConnectorError>;
- fn try_from(item: &types::PaymentsAuthorizeRouterData) -> Result<Self, Self::Error> {
- let auth: FiservAuthType = FiservAuthType::try_from(&item.connector_auth_type)?;
+ fn try_from(
+ item: &FiservRouterData<&types::PaymentsAuthorizeRouterData>,
+ ) -> Result<Self, Self::Error> {
+ let auth: FiservAuthType = FiservAuthType::try_from(&item.router_data.connector_auth_type)?;
let amount = Amount {
- total: utils::to_currency_base_unit(item.request.amount, item.request.currency)?,
- currency: item.request.currency.to_string(),
+ total: item.amount.clone(),
+ currency: item.router_data.request.currency.to_string(),
};
let transaction_details = TransactionDetails {
capture_flag: Some(matches!(
- item.request.capture_method,
+ item.router_data.request.capture_method,
Some(enums::CaptureMethod::Automatic) | None
)),
reversal_reason_code: None,
- merchant_transaction_id: item.connector_request_reference_id.clone(),
+ merchant_transaction_id: item.router_data.connector_request_reference_id.clone(),
};
- let metadata = item.get_connector_meta()?;
+ let metadata = item.router_data.get_connector_meta()?;
let session: SessionObject = metadata
.parse_value("SessionObject")
.change_context(errors::ConnectorError::RequestEncodingFailed)?;
@@ -133,7 +167,7 @@ impl TryFrom<&types::PaymentsAuthorizeRouterData> for FiservPaymentsRequest {
//card not present in online transaction
pos_condition_code: TransactionInteractionPosConditionCode::CardNotPresentEcom,
};
- let source = match item.request.payment_method_data.clone() {
+ let source = match item.router_data.request.payment_method_data.clone() {
api::PaymentMethodData::Card(ref ccard) => {
let card = CardData {
card_data: ccard.card_number.clone(),
@@ -389,35 +423,40 @@ pub struct SessionObject {
pub terminal_id: String,
}
-impl TryFrom<&types::PaymentsCaptureRouterData> for FiservCaptureRequest {
+impl TryFrom<&FiservRouterData<&types::PaymentsCaptureRouterData>> for FiservCaptureRequest {
type Error = error_stack::Report<errors::ConnectorError>;
- fn try_from(item: &types::PaymentsCaptureRouterData) -> Result<Self, Self::Error> {
- let auth: FiservAuthType = FiservAuthType::try_from(&item.connector_auth_type)?;
+ fn try_from(
+ item: &FiservRouterData<&types::PaymentsCaptureRouterData>,
+ ) -> Result<Self, Self::Error> {
+ let auth: FiservAuthType = FiservAuthType::try_from(&item.router_data.connector_auth_type)?;
let metadata = item
+ .router_data
.connector_meta_data
.clone()
.ok_or(errors::ConnectorError::RequestEncodingFailed)?;
let session: SessionObject = metadata
.parse_value("SessionObject")
.change_context(errors::ConnectorError::RequestEncodingFailed)?;
- let amount =
- utils::to_currency_base_unit(item.request.amount_to_capture, item.request.currency)?;
Ok(Self {
amount: Amount {
- total: amount,
- currency: item.request.currency.to_string(),
+ total: item.amount.clone(),
+ currency: item.router_data.request.currency.to_string(),
},
transaction_details: TransactionDetails {
capture_flag: Some(true),
reversal_reason_code: None,
- merchant_transaction_id: item.connector_request_reference_id.clone(),
+ merchant_transaction_id: item.router_data.connector_request_reference_id.clone(),
},
merchant_details: MerchantDetails {
merchant_id: auth.merchant_account,
terminal_id: Some(session.terminal_id),
},
reference_transaction_details: ReferenceTransactionDetails {
- reference_transaction_id: item.request.connector_transaction_id.to_string(),
+ reference_transaction_id: item
+ .router_data
+ .request
+ .connector_transaction_id
+ .to_string(),
},
})
}
@@ -477,11 +516,14 @@ pub struct FiservRefundRequest {
reference_transaction_details: ReferenceTransactionDetails,
}
-impl<F> TryFrom<&types::RefundsRouterData<F>> for FiservRefundRequest {
+impl<F> TryFrom<&FiservRouterData<&types::RefundsRouterData<F>>> for FiservRefundRequest {
type Error = error_stack::Report<errors::ConnectorError>;
- fn try_from(item: &types::RefundsRouterData<F>) -> Result<Self, Self::Error> {
- let auth: FiservAuthType = FiservAuthType::try_from(&item.connector_auth_type)?;
+ fn try_from(
+ item: &FiservRouterData<&types::RefundsRouterData<F>>,
+ ) -> Result<Self, Self::Error> {
+ let auth: FiservAuthType = FiservAuthType::try_from(&item.router_data.connector_auth_type)?;
let metadata = item
+ .router_data
.connector_meta_data
.clone()
.ok_or(errors::ConnectorError::RequestEncodingFailed)?;
@@ -490,18 +532,19 @@ impl<F> TryFrom<&types::RefundsRouterData<F>> for FiservRefundRequest {
.change_context(errors::ConnectorError::RequestEncodingFailed)?;
Ok(Self {
amount: Amount {
- total: utils::to_currency_base_unit(
- item.request.refund_amount,
- item.request.currency,
- )?,
- currency: item.request.currency.to_string(),
+ total: item.amount.clone(),
+ currency: item.router_data.request.currency.to_string(),
},
merchant_details: MerchantDetails {
merchant_id: auth.merchant_account,
terminal_id: Some(session.terminal_id),
},
reference_transaction_details: ReferenceTransactionDetails {
- reference_transaction_id: item.request.connector_transaction_id.to_string(),
+ reference_transaction_id: item
+ .router_data
+ .request
+ .connector_transaction_id
+ .to_string(),
},
})
}
|
feat
|
[Fiserv] Currency Unit Conversion (#2715)
|
e2043dee224bac63b4288e53475176f0941c4abb
|
2025-02-14 18:10:25
|
Sakil Mostak
|
feat(connector): [Datatrans] add mandate flow (#7245)
| false
|
diff --git a/crates/hyperswitch_connectors/src/connectors/datatrans.rs b/crates/hyperswitch_connectors/src/connectors/datatrans.rs
index 6c311dd4a98..f06d7be8693 100644
--- a/crates/hyperswitch_connectors/src/connectors/datatrans.rs
+++ b/crates/hyperswitch_connectors/src/connectors/datatrans.rs
@@ -12,6 +12,7 @@ use common_utils::{
};
use error_stack::{report, ResultExt};
use hyperswitch_domain_models::{
+ payment_method_data::PaymentMethodData,
router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData},
router_flow_types::{
access_token_auth::AccessTokenAuth,
@@ -26,7 +27,7 @@ use hyperswitch_domain_models::{
router_response_types::{PaymentsResponseData, RefundsResponseData},
types::{
PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData,
- PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData,
+ PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, SetupMandateRouterData,
},
};
use hyperswitch_interfaces::{
@@ -47,7 +48,10 @@ use transformers as datatrans;
use crate::{
constants::headers,
types::ResponseRouterData,
- utils::{self, convert_amount, RefundsRequestData, RouterData as OtherRouterData},
+ utils::{
+ self, convert_amount, PaymentsAuthorizeRequestData, RefundsRequestData,
+ RouterData as OtherRouterData,
+ },
};
impl api::Payment for Datatrans {}
@@ -191,6 +195,22 @@ impl ConnectorValidation for Datatrans {
}
}
}
+
+ fn validate_mandate_payment(
+ &self,
+ _pm_type: Option<PaymentMethodType>,
+ pm_data: PaymentMethodData,
+ ) -> CustomResult<(), errors::ConnectorError> {
+ let connector = self.id();
+ match pm_data {
+ PaymentMethodData::Card(_) => Ok(()),
+ _ => Err(errors::ConnectorError::NotSupported {
+ message: " mandate payment".to_string(),
+ connector,
+ }
+ .into()),
+ }
+ }
}
impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Datatrans {
@@ -202,6 +222,75 @@ impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken>
impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData>
for Datatrans
{
+ fn get_headers(
+ &self,
+ req: &SetupMandateRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> {
+ self.build_headers(req, connectors)
+ }
+ fn get_content_type(&self) -> &'static str {
+ self.common_get_content_type()
+ }
+ fn get_url(
+ &self,
+ _req: &SetupMandateRouterData,
+ connectors: &Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Ok(format!("{}v1/transactions", self.base_url(connectors)))
+ }
+ fn get_request_body(
+ &self,
+ req: &SetupMandateRouterData,
+ _connectors: &Connectors,
+ ) -> CustomResult<RequestContent, errors::ConnectorError> {
+ let connector_req = datatrans::DatatransPaymentsRequest::try_from(req)?;
+ Ok(RequestContent::Json(Box::new(connector_req)))
+ }
+
+ fn build_request(
+ &self,
+ req: &RouterData<SetupMandate, SetupMandateRequestData, PaymentsResponseData>,
+ connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ Ok(Some(
+ RequestBuilder::new()
+ .method(Method::Post)
+ .url(&types::SetupMandateType::get_url(self, req, connectors)?)
+ .attach_default_headers()
+ .headers(types::SetupMandateType::get_headers(self, req, connectors)?)
+ .set_body(types::SetupMandateType::get_request_body(
+ self, req, connectors,
+ )?)
+ .build(),
+ ))
+ }
+ fn handle_response(
+ &self,
+ data: &SetupMandateRouterData,
+ event_builder: Option<&mut ConnectorEvent>,
+ res: Response,
+ ) -> CustomResult<SetupMandateRouterData, errors::ConnectorError> {
+ let response: datatrans::DatatransResponse = res
+ .response
+ .parse_struct("Datatrans PaymentsAuthorizeResponse")
+ .change_context(errors::ConnectorError::ResponseDeserializationFailed)?;
+ event_builder.map(|i| i.set_response_body(&response));
+ router_env::logger::info!(connector_response=?response);
+ RouterData::try_from(ResponseRouterData {
+ response,
+ data: data.clone(),
+ http_code: res.status_code,
+ })
+ }
+
+ fn get_error_response(
+ &self,
+ res: Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ self.build_error_response(res, event_builder)
+ }
}
impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Datatrans {
@@ -223,10 +312,19 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData
connectors: &Connectors,
) -> CustomResult<String, errors::ConnectorError> {
let base_url = self.base_url(connectors);
- if req.is_three_ds() && req.request.authentication_data.is_none() {
+ if req.request.payment_method_data == PaymentMethodData::MandatePayment {
+ // MIT
+ Ok(format!("{base_url}v1/transactions/authorize"))
+ } else if req.request.is_mandate_payment() {
+ // CIT
Ok(format!("{base_url}v1/transactions"))
} else {
- Ok(format!("{base_url}v1/transactions/authorize"))
+ // Direct
+ if req.is_three_ds() && req.request.authentication_data.is_none() {
+ Ok(format!("{base_url}v1/transactions"))
+ } else {
+ Ok(format!("{base_url}v1/transactions/authorize"))
+ }
}
}
diff --git a/crates/hyperswitch_connectors/src/connectors/datatrans/transformers.rs b/crates/hyperswitch_connectors/src/connectors/datatrans/transformers.rs
index f4c3a8ae099..8a52433275e 100644
--- a/crates/hyperswitch_connectors/src/connectors/datatrans/transformers.rs
+++ b/crates/hyperswitch_connectors/src/connectors/datatrans/transformers.rs
@@ -1,13 +1,16 @@
use std::collections::HashMap;
+use api_models::payments::{self, AdditionalPaymentData};
use common_enums::enums;
use common_utils::{pii::Email, request::Method, types::MinorUnit};
use hyperswitch_domain_models::{
payment_method_data::{Card, PaymentMethodData},
router_data::{ConnectorAuthType, ErrorResponse, RouterData},
router_flow_types::refunds::{Execute, RSync},
- router_request_types::{PaymentsAuthorizeData, ResponseId},
- router_response_types::{PaymentsResponseData, RedirectForm, RefundsResponseData},
+ router_request_types::{PaymentsAuthorizeData, ResponseId, SetupMandateRequestData},
+ router_response_types::{
+ MandateReference, PaymentsResponseData, RedirectForm, RefundsResponseData,
+ },
types,
};
use hyperswitch_interfaces::{
@@ -23,7 +26,7 @@ use crate::{
PaymentsSyncResponseRouterData, RefundsResponseRouterData, ResponseRouterData,
},
utils::{
- get_unimplemented_payment_method_error_message, AddressDetailsData, CardData as _,
+ get_unimplemented_payment_method_error_message, AdditionalCardInfo, CardData as _,
PaymentsAuthorizeRequestData, RouterData as _,
},
};
@@ -50,13 +53,20 @@ pub struct DatatransRouterData<T> {
#[derive(Debug, Serialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct DatatransPaymentsRequest {
- pub amount: MinorUnit,
+ pub amount: Option<MinorUnit>,
pub currency: enums::Currency,
- pub card: PlainCardDetails,
+ pub card: DataTransPaymentDetails,
pub refno: String,
pub auto_settle: bool,
#[serde(skip_serializing_if = "Option::is_none")]
pub redirect: Option<RedirectUrls>,
+ pub option: Option<DataTransCreateAlias>,
+}
+
+#[derive(Debug, Serialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct DataTransCreateAlias {
+ pub create_alias: bool,
}
#[derive(Debug, Serialize, Clone)]
@@ -111,6 +121,13 @@ pub struct SyncResponse {
pub res_type: TransactionType,
pub status: TransactionStatus,
pub detail: SyncDetails,
+ pub card: Option<SyncCardDetails>,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct SyncCardDetails {
+ pub alias: String,
}
#[derive(Serialize, Deserialize, Clone, Debug)]
@@ -125,6 +142,14 @@ pub struct FailDetails {
message: Option<String>,
}
+#[derive(Serialize, Clone, Debug)]
+#[serde(rename_all = "camelCase")]
+#[serde(untagged)]
+pub enum DataTransPaymentDetails {
+ Cards(PlainCardDetails),
+ Mandate(MandateDetails),
+}
+
#[derive(Serialize, Clone, Debug)]
#[serde(rename_all = "camelCase")]
pub struct PlainCardDetails {
@@ -139,6 +164,16 @@ pub struct PlainCardDetails {
pub three_ds: Option<ThreeDSecureData>,
}
+#[derive(Serialize, Clone, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct MandateDetails {
+ #[serde(rename = "type")]
+ pub res_type: String,
+ pub alias: String,
+ pub expiry_month: Secret<String>,
+ pub expiry_year: Secret<String>,
+}
+
#[derive(Serialize, Clone, Debug)]
pub struct ThreedsInfo {
cardholder: CardHolder,
@@ -157,7 +192,7 @@ pub struct ThreeDSData {
pub three_ds_transaction_id: Secret<String>,
pub cavv: Secret<String>,
pub eci: Option<String>,
- pub xid: Secret<String>,
+ pub xid: Option<Secret<String>>,
#[serde(rename = "threeDSVersion")]
pub three_ds_version: String,
#[serde(rename = "authenticationResponse")]
@@ -169,16 +204,6 @@ pub struct ThreeDSData {
pub struct CardHolder {
cardholder_name: Secret<String>,
email: Email,
- #[serde(skip_serializing_if = "Option::is_none")]
- bill_addr_line1: Option<Secret<String>>,
- #[serde(skip_serializing_if = "Option::is_none")]
- bill_addr_post_code: Option<Secret<String>>,
- #[serde(skip_serializing_if = "Option::is_none")]
- bill_addr_city: Option<String>,
- #[serde(skip_serializing_if = "Option::is_none")]
- bill_addr_state: Option<Secret<String>>,
- #[serde(skip_serializing_if = "Option::is_none")]
- bill_addr_country: Option<common_enums::CountryAlpha2>,
}
#[derive(Debug, Clone, Serialize, Default, Deserialize)]
@@ -246,6 +271,61 @@ impl<T> TryFrom<(MinorUnit, T)> for DatatransRouterData<T> {
}
}
+impl TryFrom<&types::SetupMandateRouterData> for DatatransPaymentsRequest {
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(item: &types::SetupMandateRouterData) -> Result<Self, Self::Error> {
+ match item.request.payment_method_data.clone() {
+ PaymentMethodData::Card(req_card) => Ok(Self {
+ amount: None,
+ currency: item.request.currency,
+ card: DataTransPaymentDetails::Cards(PlainCardDetails {
+ res_type: "PLAIN".to_string(),
+ number: req_card.card_number.clone(),
+ expiry_month: req_card.card_exp_month.clone(),
+ expiry_year: req_card.get_card_expiry_year_2_digit()?,
+ cvv: req_card.card_cvc.clone(),
+ three_ds: Some(ThreeDSecureData::Cardholder(ThreedsInfo {
+ cardholder: CardHolder {
+ cardholder_name: item.get_billing_full_name()?,
+ email: item.get_billing_email()?,
+ },
+ })),
+ }),
+ refno: item.connector_request_reference_id.clone(),
+ auto_settle: true, // zero auth doesn't support manual capture
+ option: Some(DataTransCreateAlias { create_alias: true }),
+ redirect: Some(RedirectUrls {
+ success_url: item.request.router_return_url.clone(),
+ cancel_url: item.request.router_return_url.clone(),
+ error_url: item.request.router_return_url.clone(),
+ }),
+ }),
+ PaymentMethodData::Wallet(_)
+ | PaymentMethodData::PayLater(_)
+ | PaymentMethodData::BankRedirect(_)
+ | PaymentMethodData::BankDebit(_)
+ | PaymentMethodData::BankTransfer(_)
+ | PaymentMethodData::MandatePayment
+ | PaymentMethodData::Crypto(_)
+ | PaymentMethodData::Reward
+ | PaymentMethodData::RealTimePayment(_)
+ | PaymentMethodData::MobilePayment(_)
+ | PaymentMethodData::Upi(_)
+ | PaymentMethodData::CardRedirect(_)
+ | PaymentMethodData::Voucher(_)
+ | PaymentMethodData::GiftCard(_)
+ | PaymentMethodData::OpenBanking(_)
+ | PaymentMethodData::CardToken(_)
+ | PaymentMethodData::NetworkToken(_)
+ | PaymentMethodData::CardDetailsForNetworkTransactionId(_) => {
+ Err(errors::ConnectorError::NotImplemented(
+ get_unimplemented_payment_method_error_message("Datatrans"),
+ ))?
+ }
+ }
+ }
+}
+
impl TryFrom<&DatatransRouterData<&types::PaymentsAuthorizeRouterData>>
for DatatransPaymentsRequest
{
@@ -254,14 +334,14 @@ impl TryFrom<&DatatransRouterData<&types::PaymentsAuthorizeRouterData>>
item: &DatatransRouterData<&types::PaymentsAuthorizeRouterData>,
) -> Result<Self, Self::Error> {
match item.router_data.request.payment_method_data.clone() {
- PaymentMethodData::Card(req_card) => Ok(Self {
- amount: item.amount,
- currency: item.router_data.request.currency,
- card: create_card_details(item, &req_card)?,
- refno: item.router_data.connector_request_reference_id.clone(),
- auto_settle: item.router_data.request.is_auto_capture()?,
- redirect: if item.router_data.is_three_ds()
- && item.router_data.request.authentication_data.is_none()
+ PaymentMethodData::Card(req_card) => {
+ let is_mandate_payment = item.router_data.request.is_mandate_payment();
+ let option =
+ is_mandate_payment.then_some(DataTransCreateAlias { create_alias: true });
+ // provides return url for only mandate payment(CIT) or 3ds through datatrans
+ let redirect = if is_mandate_payment
+ || (item.router_data.is_three_ds()
+ && item.router_data.request.authentication_data.is_none())
{
Some(RedirectUrls {
success_url: item.router_data.request.router_return_url.clone(),
@@ -270,15 +350,48 @@ impl TryFrom<&DatatransRouterData<&types::PaymentsAuthorizeRouterData>>
})
} else {
None
- },
- }),
+ };
+ Ok(Self {
+ amount: Some(item.amount),
+ currency: item.router_data.request.currency,
+ card: create_card_details(item, &req_card)?,
+ refno: item.router_data.connector_request_reference_id.clone(),
+ auto_settle: item.router_data.request.is_auto_capture()?,
+ option,
+ redirect,
+ })
+ }
+ PaymentMethodData::MandatePayment => {
+ let additional_payment_data = match item
+ .router_data
+ .request
+ .additional_payment_method_data
+ .clone()
+ .ok_or(errors::ConnectorError::MissingRequiredField {
+ field_name: "additional_payment_method_data",
+ })? {
+ AdditionalPaymentData::Card(card) => *card,
+ _ => Err(errors::ConnectorError::NotSupported {
+ message: "Payment Method Not Supported".to_string(),
+ connector: "DataTrans",
+ })?,
+ };
+ Ok(Self {
+ amount: Some(item.amount),
+ currency: item.router_data.request.currency,
+ card: create_mandate_details(item, &additional_payment_data)?,
+ refno: item.router_data.connector_request_reference_id.clone(),
+ auto_settle: item.router_data.request.is_auto_capture()?,
+ option: None,
+ redirect: None,
+ })
+ }
PaymentMethodData::Wallet(_)
| PaymentMethodData::PayLater(_)
| PaymentMethodData::BankRedirect(_)
| PaymentMethodData::BankDebit(_)
| PaymentMethodData::BankTransfer(_)
| PaymentMethodData::Crypto(_)
- | PaymentMethodData::MandatePayment
| PaymentMethodData::Reward
| PaymentMethodData::RealTimePayment(_)
| PaymentMethodData::MobilePayment(_)
@@ -327,7 +440,7 @@ fn get_status(item: &DatatransResponse, is_auto_capture: bool) -> enums::Attempt
fn create_card_details(
item: &DatatransRouterData<&types::PaymentsAuthorizeRouterData>,
card: &Card,
-) -> Result<PlainCardDetails, error_stack::Report<errors::ConnectorError>> {
+) -> Result<DataTransPaymentDetails, error_stack::Report<errors::ConnectorError>> {
let mut details = PlainCardDetails {
res_type: "PLAIN".to_string(),
number: card.card_number.clone(),
@@ -342,30 +455,36 @@ fn create_card_details(
three_ds_transaction_id: Secret::new(auth_data.threeds_server_transaction_id.clone()),
cavv: Secret::new(auth_data.cavv.clone()),
eci: auth_data.eci.clone(),
- xid: Secret::new(
- auth_data
- .ds_trans_id
- .clone()
- .ok_or(errors::ConnectorError::MissingRequiredField { field_name: "xid" })?,
- ),
+ xid: auth_data.ds_trans_id.clone().map(Secret::new),
three_ds_version: auth_data.message_version.to_string(),
authentication_response: "Y".to_string(),
}));
} else if item.router_data.is_three_ds() {
- let billing = item.router_data.get_billing_address()?;
details.three_ds = Some(ThreeDSecureData::Cardholder(ThreedsInfo {
cardholder: CardHolder {
cardholder_name: item.router_data.get_billing_full_name()?,
- email: item.router_data.request.get_email()?,
- bill_addr_line1: billing.get_line1().ok().cloned(),
- bill_addr_post_code: billing.get_zip().ok().cloned(),
- bill_addr_city: billing.get_city().ok().cloned(),
- bill_addr_state: billing.get_state().ok().cloned(),
- bill_addr_country: billing.get_country().ok().copied(),
+ email: item.router_data.get_billing_email()?,
},
}));
}
- Ok(details)
+ Ok(DataTransPaymentDetails::Cards(details))
+}
+
+fn create_mandate_details(
+ item: &DatatransRouterData<&types::PaymentsAuthorizeRouterData>,
+ additional_card_details: &payments::AdditionalCardInfo,
+) -> Result<DataTransPaymentDetails, error_stack::Report<errors::ConnectorError>> {
+ let alias = item.router_data.request.get_connector_mandate_id()?;
+ Ok(DataTransPaymentDetails::Mandate(MandateDetails {
+ res_type: "ALIAS".to_string(),
+ alias,
+ expiry_month: additional_card_details.card_exp_month.clone().ok_or(
+ errors::ConnectorError::MissingRequiredField {
+ field_name: "card_exp_month",
+ },
+ )?,
+ expiry_year: additional_card_details.get_card_expiry_year_2_digit()?,
+ }))
}
impl From<SyncResponse> for enums::AttemptStatus {
@@ -378,7 +497,15 @@ impl From<SyncResponse> for enums::AttemptStatus {
TransactionStatus::Failed => Self::Failure,
TransactionStatus::Initialized | TransactionStatus::Authenticated => Self::Pending,
},
- TransactionType::Credit | TransactionType::CardCheck => Self::Failure,
+ TransactionType::CardCheck => match item.status {
+ TransactionStatus::Settled
+ | TransactionStatus::Transmitted
+ | TransactionStatus::Authorized => Self::Charged,
+ TransactionStatus::Canceled => Self::Voided,
+ TransactionStatus::Failed => Self::Failure,
+ TransactionStatus::Initialized | TransactionStatus::Authenticated => Self::Pending,
+ },
+ TransactionType::Credit => Self::Failure,
}
}
}
@@ -462,6 +589,75 @@ impl<F>
}
}
+impl<F>
+ TryFrom<ResponseRouterData<F, DatatransResponse, SetupMandateRequestData, PaymentsResponseData>>
+ for RouterData<F, SetupMandateRequestData, PaymentsResponseData>
+{
+ type Error = error_stack::Report<errors::ConnectorError>;
+ fn try_from(
+ item: ResponseRouterData<
+ F,
+ DatatransResponse,
+ SetupMandateRequestData,
+ PaymentsResponseData,
+ >,
+ ) -> Result<Self, Self::Error> {
+ // zero auth doesn't support manual capture
+ let status = get_status(&item.response, true);
+ let response = match &item.response {
+ DatatransResponse::ErrorResponse(error) => Err(ErrorResponse {
+ code: error.code.clone(),
+ message: error.message.clone(),
+ reason: Some(error.message.clone()),
+ attempt_status: None,
+ connector_transaction_id: None,
+ status_code: item.http_code,
+ }),
+ DatatransResponse::TransactionResponse(response) => {
+ Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(
+ response.transaction_id.clone(),
+ ),
+ redirection_data: Box::new(None),
+ mandate_reference: Box::new(None),
+ connector_metadata: None,
+ network_txn_id: None,
+ connector_response_reference_id: None,
+ incremental_authorization_allowed: None,
+ charges: None,
+ })
+ }
+ DatatransResponse::ThreeDSResponse(response) => {
+ let redirection_link = match item.data.test_mode {
+ Some(true) => format!("{}/v1/start", REDIRECTION_SBX_URL),
+ Some(false) | None => format!("{}/v1/start", REDIRECTION_PROD_URL),
+ };
+ Ok(PaymentsResponseData::TransactionResponse {
+ resource_id: ResponseId::ConnectorTransactionId(
+ response.transaction_id.clone(),
+ ),
+ redirection_data: Box::new(Some(RedirectForm::Form {
+ endpoint: format!("{}/{}", redirection_link, response.transaction_id),
+ method: Method::Get,
+ form_fields: HashMap::new(),
+ })),
+ mandate_reference: Box::new(None),
+ connector_metadata: None,
+ network_txn_id: None,
+ connector_response_reference_id: None,
+ incremental_authorization_allowed: None,
+ charges: None,
+ })
+ }
+ };
+ Ok(Self {
+ status,
+ response,
+ ..item.data
+ })
+ }
+}
+
impl<F> TryFrom<&DatatransRouterData<&types::RefundsRouterData<F>>> for DatatransRefundRequest {
type Error = error_stack::Report<errors::ConnectorError>;
fn try_from(
@@ -574,12 +770,19 @@ impl TryFrom<PaymentsSyncResponseRouterData<DatatransSyncResponse>>
connector_transaction_id: None,
})
} else {
+ let mandate_reference =
+ sync_response.card.as_ref().map(|card| MandateReference {
+ connector_mandate_id: Some(card.alias.clone()),
+ payment_method_id: None,
+ mandate_metadata: None,
+ connector_mandate_request_reference_id: None,
+ });
Ok(PaymentsResponseData::TransactionResponse {
resource_id: ResponseId::ConnectorTransactionId(
sync_response.transaction_id.to_string(),
),
redirection_data: Box::new(None),
- mandate_reference: Box::new(None),
+ mandate_reference: Box::new(mandate_reference),
connector_metadata: None,
network_txn_id: None,
connector_response_reference_id: None,
diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs
index af8e89eeced..6c39667de44 100644
--- a/crates/hyperswitch_connectors/src/utils.rs
+++ b/crates/hyperswitch_connectors/src/utils.rs
@@ -1380,6 +1380,27 @@ impl AddressDetailsData for AddressDetails {
}
}
+pub trait AdditionalCardInfo {
+ fn get_card_expiry_year_2_digit(&self) -> Result<Secret<String>, errors::ConnectorError>;
+}
+
+impl AdditionalCardInfo for payments::AdditionalCardInfo {
+ fn get_card_expiry_year_2_digit(&self) -> Result<Secret<String>, errors::ConnectorError> {
+ let binding =
+ self.card_exp_year
+ .clone()
+ .ok_or(errors::ConnectorError::MissingRequiredField {
+ field_name: "card_exp_year",
+ })?;
+ let year = binding.peek();
+ Ok(Secret::new(
+ year.get(year.len() - 2..)
+ .ok_or(errors::ConnectorError::RequestEncodingFailed)?
+ .to_string(),
+ ))
+ }
+}
+
pub trait PhoneDetailsData {
fn get_number(&self) -> Result<Secret<String>, Error>;
fn get_country_code(&self) -> Result<String, Error>;
|
feat
|
[Datatrans] add mandate flow (#7245)
|
a8e2f3ebc9da60ef41459b080d8856d3cadf8c41
|
2024-07-19 14:01:11
|
Shankar Singh C
|
refactor(connector): make the `original_authorized_amount` optional for MITs with `connector_mandate_details` (#5311)
| false
|
diff --git a/crates/router/src/connector/cybersource/transformers.rs b/crates/router/src/connector/cybersource/transformers.rs
index 2f286964e3e..86960b43ca4 100644
--- a/crates/router/src/connector/cybersource/transformers.rs
+++ b/crates/router/src/connector/cybersource/transformers.rs
@@ -589,12 +589,30 @@ impl
Some(payments::MandateReferenceId::ConnectorMandateId(_)) => {
let original_amount = item
.router_data
- .get_recurring_mandate_payment_data()?
- .get_original_payment_amount()?;
+ .recurring_mandate_payment_data
+ .as_ref()
+ .and_then(|recurring_mandate_payment_data| {
+ recurring_mandate_payment_data.original_payment_authorized_amount
+ });
+
let original_currency = item
.router_data
- .get_recurring_mandate_payment_data()?
- .get_original_payment_currency()?;
+ .recurring_mandate_payment_data
+ .as_ref()
+ .and_then(|recurring_mandate_payment_data| {
+ recurring_mandate_payment_data.original_payment_authorized_currency
+ });
+
+ let original_authorized_amount = match original_amount.zip(original_currency) {
+ Some((original_amount, original_currency)) => {
+ Some(utils::get_amount_as_string(
+ &api::CurrencyUnit::Base,
+ original_amount,
+ original_currency,
+ )?)
+ }
+ None => None,
+ };
(
None,
None,
@@ -602,11 +620,7 @@ impl
initiator: None,
merchant_intitiated_transaction: Some(MerchantInitiatedTransaction {
reason: None,
- original_authorized_amount: Some(utils::get_amount_as_string(
- &api::CurrencyUnit::Base,
- original_amount,
- original_currency,
- )?),
+ original_authorized_amount,
previous_transaction_id: None,
}),
}),
@@ -618,7 +632,8 @@ impl
.map(|network| network.to_lowercase())
.as_deref()
{
- Some("discover") => {
+ //This is to make original_authorized_amount mandatory for discover card networks in NetworkMandateId flow
+ Some("004") => {
let original_amount = Some(
item.router_data
.get_recurring_mandate_payment_data()?
@@ -653,12 +668,11 @@ impl
(original_amount, original_currency)
}
};
-
- let original_authorized_amount = match (original_amount, original_currency) {
- (Some(original_amount), Some(original_currency)) => Some(
+ let original_authorized_amount = match original_amount.zip(original_currency) {
+ Some((original_amount, original_currency)) => Some(
utils::to_currency_base_unit(original_amount, original_currency)?,
),
- _ => None,
+ None => None,
};
commerce_indicator = "recurring".to_string();
(
|
refactor
|
make the `original_authorized_amount` optional for MITs with `connector_mandate_details` (#5311)
|
84bed81defce0671274241318204029a2bb30a12
|
2024-06-20 15:54:48
|
Hrithikesh
|
refactor: introduce ConnectorIntegrationNew and add default implementation for each Connector (#4989)
| false
|
diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs
index 00d5929a22a..7771d2db50f 100644
--- a/crates/hyperswitch_domain_models/src/lib.rs
+++ b/crates/hyperswitch_domain_models/src/lib.rs
@@ -6,7 +6,7 @@ pub mod payments;
#[cfg(feature = "payouts")]
pub mod payouts;
pub mod router_data;
-pub mod router_data_new;
+pub mod router_data_v2;
pub mod router_flow_types;
pub mod router_request_types;
pub mod router_response_types;
diff --git a/crates/hyperswitch_domain_models/src/router_data_new.rs b/crates/hyperswitch_domain_models/src/router_data_v2.rs
similarity index 61%
rename from crates/hyperswitch_domain_models/src/router_data_new.rs
rename to crates/hyperswitch_domain_models/src/router_data_v2.rs
index fb5291933b2..68c4f585a4d 100644
--- a/crates/hyperswitch_domain_models/src/router_data_new.rs
+++ b/crates/hyperswitch_domain_models/src/router_data_v2.rs
@@ -2,12 +2,17 @@ pub mod flow_common_types;
use std::{marker::PhantomData, ops::Deref};
-pub use flow_common_types::*;
+#[cfg(feature = "payouts")]
+pub use flow_common_types::PayoutFlowData;
+pub use flow_common_types::{
+ AccessTokenFlowData, DisputesFlowData, ExternalAuthenticationFlowData, FilesFlowData,
+ FrmFlowData, MandateRevokeFlowData, PaymentFlowData, RefundFlowData, WebhookSourceVerifyData,
+};
use crate::router_data::{ConnectorAuthType, ErrorResponse};
#[derive(Debug, Clone)]
-pub struct RouterDataNew<Flow, ResourceCommonData, FlowSpecificRequest, FlowSpecificResponse> {
+pub struct RouterDataV2<Flow, ResourceCommonData, FlowSpecificRequest, FlowSpecificResponse> {
pub flow: PhantomData<Flow>,
pub resource_common_data: ResourceCommonData,
pub connector_auth_type: ConnectorAuthType,
@@ -18,7 +23,7 @@ pub struct RouterDataNew<Flow, ResourceCommonData, FlowSpecificRequest, FlowSpec
}
impl<Flow, ResourceCommonData, FlowSpecificRequest, FlowSpecificResponse> Deref
- for RouterDataNew<Flow, ResourceCommonData, FlowSpecificRequest, FlowSpecificResponse>
+ for RouterDataV2<Flow, ResourceCommonData, FlowSpecificRequest, FlowSpecificResponse>
{
type Target = ResourceCommonData;
fn deref(&self) -> &Self::Target {
diff --git a/crates/hyperswitch_domain_models/src/router_data_new/flow_common_types.rs b/crates/hyperswitch_domain_models/src/router_data_v2/flow_common_types.rs
similarity index 100%
rename from crates/hyperswitch_domain_models/src/router_data_new/flow_common_types.rs
rename to crates/hyperswitch_domain_models/src/router_data_v2/flow_common_types.rs
diff --git a/crates/hyperswitch_interfaces/src/api.rs b/crates/hyperswitch_interfaces/src/api.rs
index ac397cfa075..30dad9acb98 100644
--- a/crates/hyperswitch_interfaces/src/api.rs
+++ b/crates/hyperswitch_interfaces/src/api.rs
@@ -4,13 +4,13 @@ use common_utils::{
errors::CustomResult,
request::{Method, Request, RequestContent},
};
-use hyperswitch_domain_models::router_data::{ErrorResponse, RouterData};
+use hyperswitch_domain_models::router_data::{ConnectorAuthType, ErrorResponse, RouterData};
use masking::Maskable;
use router_env::metrics::add_attributes;
use serde_json::json;
use crate::{
- configs::Connectors, errors, events::connector_api_logs::ConnectorEvent, metrics, types,
+ configs::Connectors, consts, errors, events::connector_api_logs::ConnectorEvent, metrics, types,
};
/// type BoxedConnectorIntegration
@@ -33,7 +33,9 @@ where
}
/// trait ConnectorIntegration
-pub trait ConnectorIntegration<T, Req, Resp>: ConnectorIntegrationAny<T, Req, Resp> + Sync {
+pub trait ConnectorIntegration<T, Req, Resp>:
+ ConnectorIntegrationAny<T, Req, Resp> + Sync + ConnectorCommon
+{
/// fn get_headers
fn get_headers(
&self,
@@ -182,3 +184,73 @@ pub enum CaptureSyncMethod {
/// For syncing multiple captures together
Bulk,
}
+
+/// Connector accepted currency unit as either "Base" or "Minor"
+#[derive(Debug)]
+pub enum CurrencyUnit {
+ /// Base currency unit
+ Base,
+ /// Minor currency unit
+ Minor,
+}
+
+/// The trait that provides the common
+pub trait ConnectorCommon {
+ /// Name of the connector (in lowercase).
+ fn id(&self) -> &'static str;
+
+ /// Connector accepted currency unit as either "Base" or "Minor"
+ fn get_currency_unit(&self) -> CurrencyUnit {
+ CurrencyUnit::Minor // Default implementation should be remove once it is implemented in all connectors
+ }
+
+ /// HTTP header used for authorization.
+ fn get_auth_header(
+ &self,
+ _auth_type: &ConnectorAuthType,
+ ) -> CustomResult<Vec<(String, Maskable<String>)>, errors::ConnectorError> {
+ Ok(Vec::new())
+ }
+
+ /// HTTP `Content-Type` to be used for POST requests.
+ /// Defaults to `application/json`.
+ fn common_get_content_type(&self) -> &'static str {
+ "application/json"
+ }
+
+ // FIXME write doc - think about this
+ // fn headers(&self) -> Vec<(&str, &str)>;
+
+ /// The base URL for interacting with the connector's API.
+ fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str;
+
+ /// common error response for a connector if it is same in all case
+ fn build_error_response(
+ &self,
+ res: types::Response,
+ _event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ Ok(ErrorResponse {
+ status_code: res.status_code,
+ code: consts::NO_ERROR_CODE.to_string(),
+ message: consts::NO_ERROR_MESSAGE.to_string(),
+ reason: None,
+ attempt_status: None,
+ connector_transaction_id: None,
+ })
+ }
+}
+
+/// Extended trait for connector common to allow functions with generic type
+pub trait ConnectorCommonExt<Flow, Req, Resp>:
+ ConnectorCommon + ConnectorIntegration<Flow, Req, Resp>
+{
+ /// common header builder when every request for the connector have same headers
+ fn build_headers(
+ &self,
+ _req: &RouterData<Flow, Req, Resp>,
+ _connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, Maskable<String>)>, errors::ConnectorError> {
+ Ok(Vec::new())
+ }
+}
diff --git a/crates/hyperswitch_interfaces/src/connector_integration_v2.rs b/crates/hyperswitch_interfaces/src/connector_integration_v2.rs
new file mode 100644
index 00000000000..d03dee5f7f3
--- /dev/null
+++ b/crates/hyperswitch_interfaces/src/connector_integration_v2.rs
@@ -0,0 +1,186 @@
+//! definition of the new connector integration trait
+use common_utils::{
+ errors::CustomResult,
+ request::{Method, Request, RequestContent},
+};
+use hyperswitch_domain_models::{router_data::ErrorResponse, router_data_v2::RouterDataV2};
+use masking::Maskable;
+use router_env::metrics::add_attributes;
+use serde_json::json;
+
+use crate::{
+ api::CaptureSyncMethod, configs::Connectors, errors,
+ events::connector_api_logs::ConnectorEvent, metrics, types,
+};
+
+/// alias for Box of a type that implements trait ConnectorIntegrationV2
+pub type BoxedConnectorIntegrationV2<'a, Flow, ResourceCommonData, Req, Resp> =
+ Box<&'a (dyn ConnectorIntegrationV2<Flow, ResourceCommonData, Req, Resp> + Send + Sync)>;
+
+/// trait with a function that returns BoxedConnectorIntegrationV2
+pub trait ConnectorIntegrationAnyV2<Flow, ResourceCommonData, Req, Resp>:
+ Send + Sync + 'static
+{
+ /// function what returns BoxedConnectorIntegrationV2
+ fn get_connector_integration_v2(
+ &self,
+ ) -> BoxedConnectorIntegrationV2<'_, Flow, ResourceCommonData, Req, Resp>;
+}
+
+impl<S, Flow, ResourceCommonData, Req, Resp>
+ ConnectorIntegrationAnyV2<Flow, ResourceCommonData, Req, Resp> for S
+where
+ S: ConnectorIntegrationV2<Flow, ResourceCommonData, Req, Resp> + Send + Sync,
+{
+ fn get_connector_integration_v2(
+ &self,
+ ) -> BoxedConnectorIntegrationV2<'_, Flow, ResourceCommonData, Req, Resp> {
+ Box::new(self)
+ }
+}
+
+/// The new connector integration trait with an additional ResourceCommonData generic parameter
+pub trait ConnectorIntegrationV2<Flow, ResourceCommonData, Req, Resp>:
+ ConnectorIntegrationAnyV2<Flow, ResourceCommonData, Req, Resp> + Sync + super::api::ConnectorCommon
+{
+ /// returns a vec of tuple of header key and value
+ fn get_headers(
+ &self,
+ _req: &RouterDataV2<Flow, ResourceCommonData, Req, Resp>,
+ _connectors: &Connectors,
+ ) -> CustomResult<Vec<(String, Maskable<String>)>, errors::ConnectorError> {
+ Ok(vec![])
+ }
+
+ /// returns content type
+ fn get_content_type(&self) -> &'static str {
+ mime::APPLICATION_JSON.essence_str()
+ }
+
+ /// primarily used when creating signature based on request method of payment flow
+ fn get_http_method(&self) -> Method {
+ Method::Post
+ }
+
+ /// returns url
+ fn get_url(
+ &self,
+ _req: &RouterDataV2<Flow, ResourceCommonData, Req, Resp>,
+ _connectors: &Connectors,
+ ) -> CustomResult<String, errors::ConnectorError> {
+ Ok(String::new())
+ }
+
+ /// returns request body
+ fn get_request_body(
+ &self,
+ _req: &RouterDataV2<Flow, ResourceCommonData, Req, Resp>,
+ _connectors: &Connectors,
+ ) -> CustomResult<RequestContent, errors::ConnectorError> {
+ Ok(RequestContent::Json(Box::new(json!(r#"{}"#))))
+ }
+
+ /// returns form data
+ fn get_request_form_data(
+ &self,
+ _req: &RouterDataV2<Flow, ResourceCommonData, Req, Resp>,
+ ) -> CustomResult<Option<reqwest::multipart::Form>, errors::ConnectorError> {
+ Ok(None)
+ }
+
+ /// builds the request and returns it
+ fn build_request_v2(
+ &self,
+ _req: &RouterDataV2<Flow, ResourceCommonData, Req, Resp>,
+ _connectors: &Connectors,
+ ) -> CustomResult<Option<Request>, errors::ConnectorError> {
+ metrics::UNIMPLEMENTED_FLOW.add(
+ &metrics::CONTEXT,
+ 1,
+ &add_attributes([("connector", self.id())]),
+ );
+ Ok(None)
+ }
+
+ /// accepts the raw api response and decodes it
+ fn handle_response_v2(
+ &self,
+ data: &RouterDataV2<Flow, ResourceCommonData, Req, Resp>,
+ event_builder: Option<&mut ConnectorEvent>,
+ _res: types::Response,
+ ) -> CustomResult<RouterDataV2<Flow, ResourceCommonData, Req, Resp>, errors::ConnectorError>
+ where
+ Flow: Clone,
+ ResourceCommonData: Clone,
+ Req: Clone,
+ Resp: Clone,
+ {
+ event_builder.map(|e| e.set_error(json!({"error": "Not Implemented"})));
+ Ok(data.clone())
+ }
+
+ /// accepts the raw api error response and decodes it
+ fn get_error_response_v2(
+ &self,
+ res: types::Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ event_builder.map(|event| event.set_error(json!({"error": res.response.escape_ascii().to_string(), "status_code": res.status_code})));
+ Ok(ErrorResponse::get_not_implemented())
+ }
+
+ /// accepts the raw 5xx error response and decodes it
+ fn get_5xx_error_response(
+ &self,
+ res: types::Response,
+ event_builder: Option<&mut ConnectorEvent>,
+ ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
+ event_builder.map(|event| event.set_error(json!({"error": res.response.escape_ascii().to_string(), "status_code": res.status_code})));
+ let error_message = match res.status_code {
+ 500 => "internal_server_error",
+ 501 => "not_implemented",
+ 502 => "bad_gateway",
+ 503 => "service_unavailable",
+ 504 => "gateway_timeout",
+ 505 => "http_version_not_supported",
+ 506 => "variant_also_negotiates",
+ 507 => "insufficient_storage",
+ 508 => "loop_detected",
+ 510 => "not_extended",
+ 511 => "network_authentication_required",
+ _ => "unknown_error",
+ };
+ Ok(ErrorResponse {
+ code: res.status_code.to_string(),
+ message: error_message.to_string(),
+ reason: String::from_utf8(res.response.to_vec()).ok(),
+ status_code: res.status_code,
+ attempt_status: None,
+ connector_transaction_id: None,
+ })
+ }
+
+ // whenever capture sync is implemented at the connector side, this method should be overridden
+ /// retunes the capture sync method
+ fn get_multiple_capture_sync_method(
+ &self,
+ ) -> CustomResult<CaptureSyncMethod, errors::ConnectorError> {
+ Err(errors::ConnectorError::NotImplemented("multiple capture sync".into()).into())
+ }
+
+ /// returns certificate string
+ fn get_certificate(
+ &self,
+ _req: &RouterDataV2<Flow, ResourceCommonData, Req, Resp>,
+ ) -> CustomResult<Option<String>, errors::ConnectorError> {
+ Ok(None)
+ }
+
+ /// returns private key string
+ fn get_certificate_key(
+ &self,
+ _req: &RouterDataV2<Flow, ResourceCommonData, Req, Resp>,
+ ) -> CustomResult<Option<String>, errors::ConnectorError> {
+ Ok(None)
+ }
+}
diff --git a/crates/hyperswitch_interfaces/src/consts.rs b/crates/hyperswitch_interfaces/src/consts.rs
new file mode 100644
index 00000000000..4d6c27b7554
--- /dev/null
+++ b/crates/hyperswitch_interfaces/src/consts.rs
@@ -0,0 +1,7 @@
+//! connector integration related const declarations
+
+/// No error message string const
+pub const NO_ERROR_MESSAGE: &str = "No error message";
+
+/// No error code string const
+pub const NO_ERROR_CODE: &str = "No error code";
diff --git a/crates/hyperswitch_interfaces/src/lib.rs b/crates/hyperswitch_interfaces/src/lib.rs
index 7d3b319df83..66403f641b5 100644
--- a/crates/hyperswitch_interfaces/src/lib.rs
+++ b/crates/hyperswitch_interfaces/src/lib.rs
@@ -3,6 +3,9 @@
pub mod api;
pub mod configs;
+/// definition of the new connector integration trait
+pub mod connector_integration_v2;
+pub mod consts;
pub mod encryption_interface;
pub mod errors;
pub mod events;
diff --git a/crates/router/src/consts.rs b/crates/router/src/consts.rs
index 610bc7ca281..73ff7c428e4 100644
--- a/crates/router/src/consts.rs
+++ b/crates/router/src/consts.rs
@@ -1,7 +1,7 @@
#[cfg(feature = "olap")]
pub mod user;
pub mod user_role;
-
+pub use hyperswitch_interfaces::consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE};
// ID generation
pub(crate) const ID_LENGTH: usize = 20;
pub(crate) const MAX_ID_LENGTH: usize = 64;
@@ -31,8 +31,6 @@ pub const DEFAULT_SESSION_EXPIRY: i64 = 15 * 60;
pub const FINGERPRINT_SECRET_LENGTH: usize = 64;
// String literals
-pub(crate) const NO_ERROR_MESSAGE: &str = "No error message";
-pub(crate) const NO_ERROR_CODE: &str = "No error code";
pub(crate) const UNSUPPORTED_ERROR_MESSAGE: &str = "Unsupported response type";
pub(crate) const LOW_BALANCE_ERROR_MESSAGE: &str = "Insufficient balance in the payment method";
pub(crate) const CONNECTOR_UNAUTHORIZED_ERROR: &str = "Authentication Error from the connector";
diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs
index 9e9156992f5..a8fe21796b5 100644
--- a/crates/router/src/core/payments.rs
+++ b/crates/router/src/core/payments.rs
@@ -1,5 +1,6 @@
pub mod access_token;
pub mod conditional_configs;
+pub mod connector_integration_v2_impls;
pub mod customers;
pub mod flows;
pub mod helpers;
diff --git a/crates/router/src/core/payments/connector_integration_v2_impls.rs b/crates/router/src/core/payments/connector_integration_v2_impls.rs
new file mode 100644
index 00000000000..6b3360feb65
--- /dev/null
+++ b/crates/router/src/core/payments/connector_integration_v2_impls.rs
@@ -0,0 +1,2568 @@
+#[cfg(feature = "frm")]
+use crate::types::fraud_check as frm_types;
+use crate::{
+ connector, services,
+ types::{self, api},
+};
+
+#[cfg(feature = "dummy_connector")]
+mod dummy_connector_default_impl {
+ #[cfg(feature = "frm")]
+ use super::frm_types;
+ use super::{api, connector, services, types};
+ impl<const T: u8> api::PaymentV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentAuthorizeV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentAuthorizeSessionTokenV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentSyncV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentVoidV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentApproveV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentRejectV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentCaptureV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentSessionV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::MandateSetupV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentIncrementalAuthorizationV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentsCompleteAuthorizeV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentTokenV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::ConnectorCustomerV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::PaymentsPreProcessingV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Authorize,
+ types::PaymentFlowData,
+ types::PaymentsAuthorizeData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PSync,
+ types::PaymentFlowData,
+ types::PaymentsSyncData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Void,
+ types::PaymentFlowData,
+ types::PaymentsCancelData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Approve,
+ types::PaymentFlowData,
+ types::PaymentsApproveData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Reject,
+ types::PaymentFlowData,
+ types::PaymentsRejectData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Capture,
+ types::PaymentFlowData,
+ types::PaymentsCaptureData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Session,
+ types::PaymentFlowData,
+ types::PaymentsSessionData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::SetupMandate,
+ types::PaymentFlowData,
+ types::SetupMandateRequestData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::IncrementalAuthorization,
+ types::PaymentFlowData,
+ types::PaymentsIncrementalAuthorizationData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::CompleteAuthorize,
+ types::PaymentFlowData,
+ types::CompleteAuthorizeData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PaymentMethodToken,
+ types::PaymentFlowData,
+ types::PaymentMethodTokenizationData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::CreateConnectorCustomer,
+ types::PaymentFlowData,
+ types::ConnectorCustomerData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PreProcessing,
+ types::PaymentFlowData,
+ types::PaymentsPreProcessingData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::AuthorizeSessionToken,
+ types::PaymentFlowData,
+ types::AuthorizeSessionTokenData,
+ types::PaymentsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+ impl<const T: u8> api::RefundV2 for connector::DummyConnector<T> {}
+ impl<const T: u8> api::RefundExecuteV2 for connector::DummyConnector<T> {}
+ impl<const T: u8> api::RefundSyncV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Execute,
+ types::RefundFlowData,
+ types::RefundsData,
+ types::RefundsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::RSync,
+ types::RefundFlowData,
+ types::RefundsData,
+ types::RefundsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+ impl<const T: u8> api::ConnectorAccessTokenV2 for connector::DummyConnector<T> {}
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::AccessTokenAuth,
+ types::AccessTokenFlowData,
+ types::AccessTokenRequestData,
+ types::AccessToken,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::DisputeV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::AcceptDisputeV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Accept,
+ types::DisputesFlowData,
+ types::AcceptDisputeRequestData,
+ types::AcceptDisputeResponse,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::DefendDisputeV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Defend,
+ types::DisputesFlowData,
+ types::DefendDisputeRequestData,
+ types::DefendDisputeResponse,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::SubmitEvidenceV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Evidence,
+ types::DisputesFlowData,
+ types::SubmitEvidenceRequestData,
+ types::SubmitEvidenceResponse,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::FileUploadV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::UploadFileV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Upload,
+ types::FilesFlowData,
+ types::UploadFileRequestData,
+ types::UploadFileResponse,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::RetrieveFileV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Retrieve,
+ types::FilesFlowData,
+ types::RetrieveFileRequestData,
+ types::RetrieveFileResponse,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::PayoutsV2 for connector::DummyConnector<T> {}
+
+ #[cfg(feature = "payouts")]
+ impl<const T: u8> api::PayoutCreateV2 for connector::DummyConnector<T> {}
+
+ #[cfg(feature = "payouts")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PoCreate,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "payouts")]
+ impl<const T: u8> api::PayoutEligibilityV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "payouts")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PoEligibility,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "payouts")]
+ impl<const T: u8> api::PayoutFulfillV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "payouts")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PoFulfill,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "payouts")]
+ impl<const T: u8> api::PayoutCancelV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "payouts")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PoCancel,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "payouts")]
+ impl<const T: u8> api::PayoutQuoteV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "payouts")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PoQuote,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "payouts")]
+ impl<const T: u8> api::PayoutRecipientV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "payouts")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PoRecipient,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "payouts")]
+ impl<const T: u8> api::PayoutRecipientAccountV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "payouts")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PoRecipientAccount,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::ConnectorVerifyWebhookSourceV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::VerifyWebhookSource,
+ types::WebhookSourceVerifyData,
+ types::VerifyWebhookSourceRequestData,
+ types::VerifyWebhookSourceResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::FraudCheckV2 for connector::DummyConnector<T> {}
+
+ #[cfg(feature = "frm")]
+ impl<const T: u8> api::FraudCheckSaleV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "frm")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Sale,
+ types::FrmFlowData,
+ frm_types::FraudCheckSaleData,
+ frm_types::FraudCheckResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "frm")]
+ impl<const T: u8> api::FraudCheckCheckoutV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "frm")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Checkout,
+ types::FrmFlowData,
+ frm_types::FraudCheckCheckoutData,
+ frm_types::FraudCheckResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "frm")]
+ impl<const T: u8> api::FraudCheckTransactionV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "frm")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Transaction,
+ types::FrmFlowData,
+ frm_types::FraudCheckTransactionData,
+ frm_types::FraudCheckResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "frm")]
+ impl<const T: u8> api::FraudCheckFulfillmentV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "frm")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Fulfillment,
+ types::FrmFlowData,
+ frm_types::FraudCheckFulfillmentData,
+ frm_types::FraudCheckResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ #[cfg(feature = "frm")]
+ impl<const T: u8> api::FraudCheckRecordReturnV2 for connector::DummyConnector<T> {}
+ #[cfg(feature = "frm")]
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::RecordReturn,
+ types::FrmFlowData,
+ frm_types::FraudCheckRecordReturnData,
+ frm_types::FraudCheckResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::ConnectorMandateRevokeV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::MandateRevoke,
+ types::MandateRevokeFlowData,
+ types::MandateRevokeRequestData,
+ types::MandateRevokeResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8> api::ExternalAuthenticationV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::ConnectorPreAuthenticationV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::ConnectorPreAuthenticationVersionCallV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::ConnectorAuthenticationV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8> api::ConnectorPostAuthenticationV2 for connector::DummyConnector<T> {}
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::Authentication,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::ConnectorAuthenticationRequestData,
+ types::authentication::AuthenticationResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PreAuthentication,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::PreAuthNRequestData,
+ types::authentication::AuthenticationResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PreAuthenticationVersionCall,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::PreAuthNRequestData,
+ types::authentication::AuthenticationResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+
+ impl<const T: u8>
+ services::ConnectorIntegrationV2<
+ api::PostAuthentication,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::ConnectorPostAuthenticationRequestData,
+ types::authentication::AuthenticationResponseData,
+ > for connector::DummyConnector<T>
+ {
+ }
+}
+
+macro_rules! default_imp_for_new_connector_integration_payment {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::PaymentV2 for $path::$connector{}
+ impl api::PaymentAuthorizeV2 for $path::$connector{}
+ impl api::PaymentAuthorizeSessionTokenV2 for $path::$connector{}
+ impl api::PaymentSyncV2 for $path::$connector{}
+ impl api::PaymentVoidV2 for $path::$connector{}
+ impl api::PaymentApproveV2 for $path::$connector{}
+ impl api::PaymentRejectV2 for $path::$connector{}
+ impl api::PaymentCaptureV2 for $path::$connector{}
+ impl api::PaymentSessionV2 for $path::$connector{}
+ impl api::MandateSetupV2 for $path::$connector{}
+ impl api::PaymentIncrementalAuthorizationV2 for $path::$connector{}
+ impl api::PaymentsCompleteAuthorizeV2 for $path::$connector{}
+ impl api::PaymentTokenV2 for $path::$connector{}
+ impl api::ConnectorCustomerV2 for $path::$connector{}
+ impl api::PaymentsPreProcessingV2 for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::Authorize,types::PaymentFlowData, types::PaymentsAuthorizeData, types::PaymentsResponseData>
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::PSync,types::PaymentFlowData, types::PaymentsSyncData, types::PaymentsResponseData>
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::Void, types::PaymentFlowData, types::PaymentsCancelData, types::PaymentsResponseData>
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::Approve,types::PaymentFlowData, types::PaymentsApproveData, types::PaymentsResponseData>
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::Reject,types::PaymentFlowData, types::PaymentsRejectData, types::PaymentsResponseData>
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::Capture,types::PaymentFlowData, types::PaymentsCaptureData, types::PaymentsResponseData>
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::Session,types::PaymentFlowData, types::PaymentsSessionData, types::PaymentsResponseData>
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::SetupMandate,types::PaymentFlowData, types::SetupMandateRequestData, types::PaymentsResponseData>
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<
+ api::IncrementalAuthorization,
+ types::PaymentFlowData,
+ types::PaymentsIncrementalAuthorizationData,
+ types::PaymentsResponseData,
+ >
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<
+ api::CompleteAuthorize,
+ types::PaymentFlowData,
+ types::CompleteAuthorizeData,
+ types::PaymentsResponseData,
+ > for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PaymentMethodToken,
+ types::PaymentFlowData,
+ types::PaymentMethodTokenizationData,
+ types::PaymentsResponseData,
+ > for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<
+ api::CreateConnectorCustomer,
+ types::PaymentFlowData,
+ types::ConnectorCustomerData,
+ types::PaymentsResponseData,
+ > for $path::$connector{}
+ impl services::ConnectorIntegrationV2<
+ api::PreProcessing,
+ types::PaymentFlowData,
+ types::PaymentsPreProcessingData,
+ types::PaymentsResponseData,
+ > for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<
+ api::AuthorizeSessionToken,
+ types::PaymentFlowData,
+ types::AuthorizeSessionTokenData,
+ types::PaymentsResponseData
+ > for $path::$connector{}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_payment!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_refund {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::RefundV2 for $path::$connector{}
+ impl api::RefundExecuteV2 for $path::$connector{}
+ impl api::RefundSyncV2 for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::Execute, types::RefundFlowData, types::RefundsData, types::RefundsResponseData>
+ for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::RSync, types::RefundFlowData, types::RefundsData, types::RefundsResponseData>
+ for $path::$connector{}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_refund!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_connector_access_token {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::ConnectorAccessTokenV2 for $path::$connector{}
+ impl
+ services::ConnectorIntegrationV2<api::AccessTokenAuth, types::AccessTokenFlowData, types::AccessTokenRequestData, types::AccessToken>
+ for $path::$connector{}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_connector_access_token!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_accept_dispute {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::DisputeV2 for $path::$connector {}
+ impl api::AcceptDisputeV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Accept,
+ types::DisputesFlowData,
+ types::AcceptDisputeRequestData,
+ types::AcceptDisputeResponse,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+macro_rules! default_imp_for_new_connector_integration_submit_evidence {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::SubmitEvidenceV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Evidence,
+ types::DisputesFlowData,
+ types::SubmitEvidenceRequestData,
+ types::SubmitEvidenceResponse,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_accept_dispute!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_defend_dispute {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::DefendDisputeV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Defend,
+ types::DisputesFlowData,
+ types::DefendDisputeRequestData,
+ types::DefendDisputeResponse,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+default_imp_for_new_connector_integration_defend_dispute!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+default_imp_for_new_connector_integration_submit_evidence!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_file_upload {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::FileUploadV2 for $path::$connector {}
+ impl api::UploadFileV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Upload,
+ types::FilesFlowData,
+ types::UploadFileRequestData,
+ types::UploadFileResponse,
+ > for $path::$connector
+ {}
+ impl api::RetrieveFileV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Retrieve,
+ types::FilesFlowData,
+ types::RetrieveFileRequestData,
+ types::RetrieveFileResponse,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_file_upload!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_payouts {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::PayoutsV2 for $path::$connector {}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_payouts!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "payouts")]
+macro_rules! default_imp_for_new_connector_integration_payouts_create {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::PayoutCreateV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PoCreate,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "payouts")]
+default_imp_for_new_connector_integration_payouts_create!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "payouts")]
+macro_rules! default_imp_for_new_connector_integration_payouts_eligibility {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::PayoutEligibilityV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PoEligibility,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "payouts")]
+default_imp_for_new_connector_integration_payouts_eligibility!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "payouts")]
+macro_rules! default_imp_for_new_connector_integration_payouts_fulfill {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::PayoutFulfillV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PoFulfill,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "payouts")]
+default_imp_for_new_connector_integration_payouts_fulfill!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "payouts")]
+macro_rules! default_imp_for_new_connector_integration_payouts_cancel {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::PayoutCancelV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PoCancel,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "payouts")]
+default_imp_for_new_connector_integration_payouts_cancel!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "payouts")]
+macro_rules! default_imp_for_new_connector_integration_payouts_quote {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::PayoutQuoteV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PoQuote,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "payouts")]
+default_imp_for_new_connector_integration_payouts_quote!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "payouts")]
+macro_rules! default_imp_for_new_connector_integration_payouts_recipient {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::PayoutRecipientV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PoRecipient,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "payouts")]
+default_imp_for_new_connector_integration_payouts_recipient!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "payouts")]
+macro_rules! default_imp_for_new_connector_integration_payouts_recipient_account {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::PayoutRecipientAccountV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PoRecipientAccount,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "payouts")]
+default_imp_for_new_connector_integration_payouts_recipient_account!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_webhook_source_verification {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::ConnectorVerifyWebhookSourceV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::VerifyWebhookSource,
+ types::WebhookSourceVerifyData,
+ types::VerifyWebhookSourceRequestData,
+ types::VerifyWebhookSourceResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_webhook_source_verification!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_frm {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::FraudCheckV2 for $path::$connector {}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_frm!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "frm")]
+macro_rules! default_imp_for_new_connector_integration_frm_sale {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::FraudCheckSaleV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Sale,
+ types::FrmFlowData,
+ frm_types::FraudCheckSaleData,
+ frm_types::FraudCheckResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "frm")]
+default_imp_for_new_connector_integration_frm_sale!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "frm")]
+macro_rules! default_imp_for_new_connector_integration_frm_checkout {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::FraudCheckCheckoutV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Checkout,
+ types::FrmFlowData,
+ frm_types::FraudCheckCheckoutData,
+ frm_types::FraudCheckResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "frm")]
+default_imp_for_new_connector_integration_frm_checkout!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "frm")]
+macro_rules! default_imp_for_new_connector_integration_frm_transaction {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::FraudCheckTransactionV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Transaction,
+ types::FrmFlowData,
+ frm_types::FraudCheckTransactionData,
+ frm_types::FraudCheckResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "frm")]
+default_imp_for_new_connector_integration_frm_transaction!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "frm")]
+macro_rules! default_imp_for_new_connector_integration_frm_fulfillment {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::FraudCheckFulfillmentV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Fulfillment,
+ types::FrmFlowData,
+ frm_types::FraudCheckFulfillmentData,
+ frm_types::FraudCheckResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "frm")]
+default_imp_for_new_connector_integration_frm_fulfillment!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+#[cfg(feature = "frm")]
+macro_rules! default_imp_for_new_connector_integration_frm_record_return {
+ ($($path:ident::$connector:ident),*) => {
+ $(
+ impl api::FraudCheckRecordReturnV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::RecordReturn,
+ types::FrmFlowData,
+ frm_types::FraudCheckRecordReturnData,
+ frm_types::FraudCheckResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+#[cfg(feature = "frm")]
+default_imp_for_new_connector_integration_frm_record_return!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_revoking_mandates {
+ ($($path:ident::$connector:ident),*) => {
+ $( impl api::ConnectorMandateRevokeV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::MandateRevoke,
+ types::MandateRevokeFlowData,
+ types::MandateRevokeRequestData,
+ types::MandateRevokeResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_revoking_mandates!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
+
+macro_rules! default_imp_for_new_connector_integration_connector_authentication {
+ ($($path:ident::$connector:ident),*) => {
+ $( impl api::ExternalAuthenticationV2 for $path::$connector {}
+ impl api::ConnectorAuthenticationV2 for $path::$connector {}
+ impl api::ConnectorPreAuthenticationV2 for $path::$connector {}
+ impl api::ConnectorPreAuthenticationVersionCallV2 for $path::$connector {}
+ impl api::ConnectorPostAuthenticationV2 for $path::$connector {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::Authentication,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::ConnectorAuthenticationRequestData,
+ types::authentication::AuthenticationResponseData,
+ > for $path::$connector
+ {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PreAuthentication,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::PreAuthNRequestData,
+ types::authentication::AuthenticationResponseData,
+ > for $path::$connector
+ {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PreAuthenticationVersionCall,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::PreAuthNRequestData,
+ types::authentication::AuthenticationResponseData,
+ > for $path::$connector
+ {}
+ impl
+ services::ConnectorIntegrationV2<
+ api::PostAuthentication,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::ConnectorPostAuthenticationRequestData,
+ types::authentication::AuthenticationResponseData,
+ > for $path::$connector
+ {}
+ )*
+ };
+}
+
+default_imp_for_new_connector_integration_connector_authentication!(
+ connector::Aci,
+ connector::Adyen,
+ connector::Adyenplatform,
+ connector::Airwallex,
+ connector::Authorizedotnet,
+ connector::Bambora,
+ connector::Bankofamerica,
+ connector::Billwerk,
+ connector::Bitpay,
+ connector::Bluesnap,
+ connector::Boku,
+ connector::Braintree,
+ connector::Cashtocode,
+ connector::Checkout,
+ connector::Cryptopay,
+ connector::Coinbase,
+ connector::Cybersource,
+ connector::Dlocal,
+ connector::Ebanx,
+ connector::Fiserv,
+ connector::Forte,
+ connector::Globalpay,
+ connector::Globepay,
+ connector::Gocardless,
+ connector::Gpayments,
+ connector::Helcim,
+ connector::Iatapay,
+ connector::Klarna,
+ connector::Mifinity,
+ connector::Mollie,
+ connector::Multisafepay,
+ connector::Netcetera,
+ connector::Nexinets,
+ connector::Nmi,
+ connector::Noon,
+ connector::Nuvei,
+ connector::Opayo,
+ connector::Opennode,
+ connector::Payeezy,
+ connector::Payme,
+ connector::Payone,
+ connector::Paypal,
+ connector::Payu,
+ connector::Placetopay,
+ connector::Powertranz,
+ connector::Prophetpay,
+ connector::Rapyd,
+ connector::Riskified,
+ connector::Signifyd,
+ connector::Square,
+ connector::Stax,
+ connector::Stripe,
+ connector::Shift4,
+ connector::Trustpay,
+ connector::Threedsecureio,
+ connector::Tsys,
+ connector::Volt,
+ connector::Wise,
+ connector::Worldline,
+ connector::Worldpay,
+ connector::Zen,
+ connector::Zsl
+);
diff --git a/crates/router/src/services.rs b/crates/router/src/services.rs
index f6c89b800dc..58b5b56fd21 100644
--- a/crates/router/src/services.rs
+++ b/crates/router/src/services.rs
@@ -17,6 +17,9 @@ use std::sync::Arc;
use error_stack::ResultExt;
use hyperswitch_domain_models::errors::StorageResult;
+pub use hyperswitch_interfaces::connector_integration_v2::{
+ BoxedConnectorIntegrationV2, ConnectorIntegrationAnyV2, ConnectorIntegrationV2,
+};
use masking::{ExposeInterface, StrongSecret};
#[cfg(feature = "kv_store")]
use storage_impl::KVRouterStore;
diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs
index dcb1b5c1308..4ddfcaf4919 100644
--- a/crates/router/src/services/api.rs
+++ b/crates/router/src/services/api.rs
@@ -25,8 +25,13 @@ use common_utils::{
};
use error_stack::{report, Report, ResultExt};
pub use hyperswitch_domain_models::router_response_types::RedirectForm;
-pub use hyperswitch_interfaces::api::{
- BoxedConnectorIntegration, CaptureSyncMethod, ConnectorIntegration, ConnectorIntegrationAny,
+pub use hyperswitch_interfaces::{
+ api::{
+ BoxedConnectorIntegration, CaptureSyncMethod, ConnectorIntegration, ConnectorIntegrationAny,
+ },
+ connector_integration_v2::{
+ BoxedConnectorIntegrationV2, ConnectorIntegrationAnyV2, ConnectorIntegrationV2,
+ },
};
use masking::{Maskable, PeekInterface};
use router_env::{instrument, metrics::add_attributes, tracing, tracing_actix_web::RequestId, Tag};
diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs
index 38e0bed699f..5d7faa51e2b 100644
--- a/crates/router/src/types.rs
+++ b/crates/router/src/types.rs
@@ -22,10 +22,6 @@ pub use api_models::{enums::Connector, mandates};
#[cfg(feature = "payouts")]
pub use api_models::{enums::PayoutConnectors, payouts as payout_types};
pub use common_utils::{pii, pii::Email, request::RequestContent, types::MinorUnit};
-#[cfg(feature = "payouts")]
-pub use hyperswitch_domain_models::router_request_types::PayoutsData;
-#[cfg(feature = "payouts")]
-pub use hyperswitch_domain_models::router_response_types::PayoutsResponseData;
pub use hyperswitch_domain_models::{
payment_address::PaymentAddress,
router_data::{
@@ -33,6 +29,11 @@ pub use hyperswitch_domain_models::{
ApplePayPredecryptData, ConnectorAuthType, ConnectorResponseData, ErrorResponse,
PaymentMethodBalance, PaymentMethodToken, RecurringMandatePaymentData, RouterData,
},
+ router_data_v2::{
+ AccessTokenFlowData, DisputesFlowData, ExternalAuthenticationFlowData, FilesFlowData,
+ FrmFlowData, MandateRevokeFlowData, PaymentFlowData, RefundFlowData, RouterDataV2,
+ WebhookSourceVerifyData,
+ },
router_request_types::{
AcceptDisputeRequestData, AccessTokenRequestData, AuthorizeSessionTokenData,
BrowserInformation, ChargeRefunds, ChargeRefundsOptions, CompleteAuthorizeData,
@@ -52,6 +53,11 @@ pub use hyperswitch_domain_models::{
VerifyWebhookSourceResponseData, VerifyWebhookStatus,
},
};
+#[cfg(feature = "payouts")]
+pub use hyperswitch_domain_models::{
+ router_data_v2::PayoutFlowData, router_request_types::PayoutsData,
+ router_response_types::PayoutsResponseData,
+};
pub use hyperswitch_interfaces::types::Response;
pub use crate::core::payments::CustomerDetails;
diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs
index f482e90f052..0d1d82e7318 100644
--- a/crates/router/src/types/api.rs
+++ b/crates/router/src/types/api.rs
@@ -26,12 +26,24 @@ pub mod verify_connector;
pub mod webhook_events;
pub mod webhooks;
+pub mod authentication_v2;
+pub mod disputes_v2;
+pub mod files_v2;
+#[cfg(feature = "frm")]
+pub mod fraud_check_v2;
+pub mod payments_v2;
+#[cfg(feature = "payouts")]
+pub mod payouts_v2;
+pub mod refunds_v2;
+
use std::{fmt::Debug, str::FromStr};
use error_stack::{report, ResultExt};
+use hyperswitch_domain_models::router_data_v2::AccessTokenFlowData;
pub use hyperswitch_domain_models::router_flow_types::{
access_token_auth::AccessTokenAuth, webhooks::VerifyWebhookSource,
};
+pub use hyperswitch_interfaces::api::{ConnectorCommon, ConnectorCommonExt, CurrencyUnit};
#[cfg(feature = "frm")]
pub use self::fraud_check::*;
@@ -41,16 +53,17 @@ pub use self::{
admin::*, api_keys::*, authentication::*, configs::*, customers::*, disputes::*, files::*,
payment_link::*, payment_methods::*, payments::*, poll::*, refunds::*, webhooks::*,
};
-use super::ErrorResponse;
use crate::{
configs::settings::Connectors,
- connector, consts,
+ connector,
core::{
errors::{self, CustomResult},
payments::types as payments_types,
},
- events::connector_api_logs::ConnectorEvent,
- services::{request, ConnectorIntegration, ConnectorRedirectResponse, ConnectorValidation},
+ services::{
+ ConnectorIntegration, ConnectorIntegrationV2, ConnectorRedirectResponse,
+ ConnectorValidation,
+ },
types::{self, api::enums as api_enums},
};
pub trait ConnectorAccessToken:
@@ -58,6 +71,16 @@ pub trait ConnectorAccessToken:
{
}
+pub trait ConnectorAccessTokenV2:
+ ConnectorIntegrationV2<
+ AccessTokenAuth,
+ AccessTokenFlowData,
+ types::AccessTokenRequestData,
+ types::AccessToken,
+>
+{
+}
+
#[derive(Clone)]
pub enum ConnectorCallType {
PreDetermined(ConnectorData),
@@ -73,6 +96,15 @@ pub trait ConnectorVerifyWebhookSource:
>
{
}
+pub trait ConnectorVerifyWebhookSourceV2:
+ ConnectorIntegrationV2<
+ VerifyWebhookSource,
+ types::WebhookSourceVerifyData,
+ types::VerifyWebhookSourceRequestData,
+ types::VerifyWebhookSourceResponseData,
+>
+{
+}
#[derive(Clone, Debug)]
pub struct MandateRevoke;
@@ -86,6 +118,16 @@ pub trait ConnectorMandateRevoke:
{
}
+pub trait ConnectorMandateRevokeV2:
+ ConnectorIntegrationV2<
+ MandateRevoke,
+ types::MandateRevokeFlowData,
+ types::MandateRevokeRequestData,
+ types::MandateRevokeResponseData,
+>
+{
+}
+
pub trait ConnectorTransactionId: ConnectorCommon + Sync {
fn connector_transaction_id(
&self,
@@ -95,88 +137,33 @@ pub trait ConnectorTransactionId: ConnectorCommon + Sync {
}
}
-pub enum CurrencyUnit {
- Base,
- Minor,
-}
-
-pub trait ConnectorCommon {
- /// Name of the connector (in lowercase).
- fn id(&self) -> &'static str;
-
- /// Connector accepted currency unit as either "Base" or "Minor"
- fn get_currency_unit(&self) -> CurrencyUnit {
- CurrencyUnit::Minor // Default implementation should be remove once it is implemented in all connectors
- }
-
- /// HTTP header used for authorization.
- fn get_auth_header(
- &self,
- _auth_type: &types::ConnectorAuthType,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
- Ok(Vec::new())
- }
-
- /// HTTP `Content-Type` to be used for POST requests.
- /// Defaults to `application/json`.
- fn common_get_content_type(&self) -> &'static str {
- "application/json"
- }
-
- // FIXME write doc - think about this
- // fn headers(&self) -> Vec<(&str, &str)>;
-
- /// The base URL for interacting with the connector's API.
- fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str;
-
- /// common error response for a connector if it is same in all case
- fn build_error_response(
- &self,
- res: types::Response,
- _event_builder: Option<&mut ConnectorEvent>,
- ) -> CustomResult<ErrorResponse, errors::ConnectorError> {
- Ok(ErrorResponse {
- status_code: res.status_code,
- code: consts::NO_ERROR_CODE.to_string(),
- message: consts::NO_ERROR_MESSAGE.to_string(),
- reason: None,
- attempt_status: None,
- connector_transaction_id: None,
- })
- }
-}
-
-/// Extended trait for connector common to allow functions with generic type
-pub trait ConnectorCommonExt<Flow, Req, Resp>:
- ConnectorCommon + ConnectorIntegration<Flow, Req, Resp>
-{
- /// common header builder when every request for the connector have same headers
- fn build_headers(
- &self,
- _req: &types::RouterData<Flow, Req, Resp>,
- _connectors: &Connectors,
- ) -> CustomResult<Vec<(String, request::Maskable<String>)>, errors::ConnectorError> {
- Ok(Vec::new())
- }
-}
-
pub trait Router {}
pub trait Connector:
Send
+ Refund
+ + RefundV2
+ Payment
+ + PaymentV2
+ ConnectorRedirectResponse
+ IncomingWebhook
+ ConnectorAccessToken
+ + ConnectorAccessTokenV2
+ Dispute
+ + DisputeV2
+ FileUpload
+ + FileUploadV2
+ ConnectorTransactionId
+ Payouts
+ + PayoutsV2
+ ConnectorVerifyWebhookSource
+ + ConnectorVerifyWebhookSourceV2
+ FraudCheck
+ + FraudCheckV2
+ ConnectorMandateRevoke
+ + ConnectorMandateRevokeV2
+ ExternalAuthentication
+ + ExternalAuthenticationV2
{
}
@@ -186,19 +173,29 @@ pub struct Pe;
impl<
T: Refund
+ + RefundV2
+ Payment
+ + PaymentV2
+ ConnectorRedirectResponse
+ Send
+ IncomingWebhook
+ ConnectorAccessToken
+ + ConnectorAccessTokenV2
+ Dispute
+ + DisputeV2
+ FileUpload
+ + FileUploadV2
+ ConnectorTransactionId
+ Payouts
+ + PayoutsV2
+ ConnectorVerifyWebhookSource
+ + ConnectorVerifyWebhookSourceV2
+ FraudCheck
+ + FraudCheckV2
+ ConnectorMandateRevoke
- + ExternalAuthentication,
+ + ConnectorMandateRevokeV2
+ + ExternalAuthentication
+ + ExternalAuthenticationV2,
> Connector for T
{
}
@@ -417,6 +414,9 @@ pub trait FraudCheck:
#[cfg(not(feature = "frm"))]
pub trait FraudCheck {}
+#[cfg(not(feature = "frm"))]
+pub trait FraudCheckV2 {}
+
#[cfg(feature = "payouts")]
pub trait Payouts:
ConnectorCommon
@@ -432,6 +432,9 @@ pub trait Payouts:
#[cfg(not(feature = "payouts"))]
pub trait Payouts {}
+#[cfg(not(feature = "payouts"))]
+pub trait PayoutsV2 {}
+
#[cfg(test)]
mod test {
#![allow(clippy::unwrap_used)]
diff --git a/crates/router/src/types/api/authentication.rs b/crates/router/src/types/api/authentication.rs
index 579e3f89dc1..1d50a17b29c 100644
--- a/crates/router/src/types/api/authentication.rs
+++ b/crates/router/src/types/api/authentication.rs
@@ -5,6 +5,10 @@ use common_utils::errors::CustomResult;
use error_stack::ResultExt;
pub use hyperswitch_domain_models::router_request_types::authentication::MessageCategory;
+pub use super::authentication_v2::{
+ ConnectorAuthenticationV2, ConnectorPostAuthenticationV2, ConnectorPreAuthenticationV2,
+ ConnectorPreAuthenticationVersionCallV2, ExternalAuthenticationV2,
+};
use super::BoxedConnector;
use crate::core::errors;
diff --git a/crates/router/src/types/api/authentication_v2.rs b/crates/router/src/types/api/authentication_v2.rs
new file mode 100644
index 00000000000..f7469dc867d
--- /dev/null
+++ b/crates/router/src/types/api/authentication_v2.rs
@@ -0,0 +1,55 @@
+pub use hyperswitch_domain_models::router_request_types::authentication::MessageCategory;
+
+use super::authentication::{
+ Authentication, PostAuthentication, PreAuthentication, PreAuthenticationVersionCall,
+};
+use crate::{services, types};
+
+pub trait ConnectorAuthenticationV2:
+ services::ConnectorIntegrationV2<
+ Authentication,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::ConnectorAuthenticationRequestData,
+ types::authentication::AuthenticationResponseData,
+>
+{
+}
+
+pub trait ConnectorPreAuthenticationV2:
+ services::ConnectorIntegrationV2<
+ PreAuthentication,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::PreAuthNRequestData,
+ types::authentication::AuthenticationResponseData,
+>
+{
+}
+
+pub trait ConnectorPreAuthenticationVersionCallV2:
+ services::ConnectorIntegrationV2<
+ PreAuthenticationVersionCall,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::PreAuthNRequestData,
+ types::authentication::AuthenticationResponseData,
+>
+{
+}
+
+pub trait ConnectorPostAuthenticationV2:
+ services::ConnectorIntegrationV2<
+ PostAuthentication,
+ types::ExternalAuthenticationFlowData,
+ types::authentication::ConnectorPostAuthenticationRequestData,
+ types::authentication::AuthenticationResponseData,
+>
+{
+}
+
+pub trait ExternalAuthenticationV2:
+ super::ConnectorCommon
+ + ConnectorAuthenticationV2
+ + ConnectorPreAuthenticationV2
+ + ConnectorPreAuthenticationVersionCallV2
+ + ConnectorPostAuthenticationV2
+{
+}
diff --git a/crates/router/src/types/api/disputes.rs b/crates/router/src/types/api/disputes.rs
index a8107fe4c9d..72a899c3b97 100644
--- a/crates/router/src/types/api/disputes.rs
+++ b/crates/router/src/types/api/disputes.rs
@@ -10,6 +10,8 @@ pub struct DisputeId {
pub use hyperswitch_domain_models::router_flow_types::dispute::{Accept, Defend, Evidence};
+pub use super::disputes_v2::{AcceptDisputeV2, DefendDisputeV2, DisputeV2, SubmitEvidenceV2};
+
#[derive(Default, Debug)]
pub struct DisputePayload {
pub amount: String,
diff --git a/crates/router/src/types/api/disputes_v2.rs b/crates/router/src/types/api/disputes_v2.rs
new file mode 100644
index 00000000000..e9df4cc3cdd
--- /dev/null
+++ b/crates/router/src/types/api/disputes_v2.rs
@@ -0,0 +1,41 @@
+use hyperswitch_domain_models::{
+ router_data_v2::DisputesFlowData,
+ router_flow_types::dispute::{Accept, Defend, Evidence},
+};
+
+use crate::{services, types};
+
+pub trait AcceptDisputeV2:
+ services::ConnectorIntegrationV2<
+ Accept,
+ DisputesFlowData,
+ types::AcceptDisputeRequestData,
+ types::AcceptDisputeResponse,
+>
+{
+}
+
+pub trait SubmitEvidenceV2:
+ services::ConnectorIntegrationV2<
+ Evidence,
+ DisputesFlowData,
+ types::SubmitEvidenceRequestData,
+ types::SubmitEvidenceResponse,
+>
+{
+}
+
+pub trait DefendDisputeV2:
+ services::ConnectorIntegrationV2<
+ Defend,
+ DisputesFlowData,
+ types::DefendDisputeRequestData,
+ types::DefendDisputeResponse,
+>
+{
+}
+
+pub trait DisputeV2:
+ super::ConnectorCommon + AcceptDisputeV2 + SubmitEvidenceV2 + DefendDisputeV2
+{
+}
diff --git a/crates/router/src/types/api/files.rs b/crates/router/src/types/api/files.rs
index bef393bf946..fd094014110 100644
--- a/crates/router/src/types/api/files.rs
+++ b/crates/router/src/types/api/files.rs
@@ -3,6 +3,7 @@ pub use hyperswitch_domain_models::router_flow_types::files::{Retrieve, Upload};
use masking::{Deserialize, Serialize};
use serde_with::serde_as;
+pub use super::files_v2::{FileUploadV2, RetrieveFileV2, UploadFileV2};
use super::ConnectorCommon;
use crate::{
core::errors,
diff --git a/crates/router/src/types/api/files_v2.rs b/crates/router/src/types/api/files_v2.rs
new file mode 100644
index 00000000000..9e9ba423e69
--- /dev/null
+++ b/crates/router/src/types/api/files_v2.rs
@@ -0,0 +1,38 @@
+pub use hyperswitch_domain_models::router_flow_types::files::{Retrieve, Upload};
+
+use super::ConnectorCommon;
+use crate::{core::errors, services, types, types::api::FilePurpose};
+
+pub trait UploadFileV2:
+ services::ConnectorIntegrationV2<
+ Upload,
+ types::FilesFlowData,
+ types::UploadFileRequestData,
+ types::UploadFileResponse,
+>
+{
+}
+
+pub trait RetrieveFileV2:
+ services::ConnectorIntegrationV2<
+ Retrieve,
+ types::FilesFlowData,
+ types::RetrieveFileRequestData,
+ types::RetrieveFileResponse,
+>
+{
+}
+
+pub trait FileUploadV2: ConnectorCommon + Sync + UploadFileV2 + RetrieveFileV2 {
+ fn validate_file_upload_v2(
+ &self,
+ _purpose: FilePurpose,
+ _file_size: i32,
+ _file_type: mime::Mime,
+ ) -> common_utils::errors::CustomResult<(), errors::ConnectorError> {
+ Err(errors::ConnectorError::FileValidationFailed {
+ reason: "".to_owned(),
+ }
+ .into())
+ }
+}
diff --git a/crates/router/src/types/api/fraud_check.rs b/crates/router/src/types/api/fraud_check.rs
index 6c50ed9db90..a5beafbefb1 100644
--- a/crates/router/src/types/api/fraud_check.rs
+++ b/crates/router/src/types/api/fraud_check.rs
@@ -7,6 +7,10 @@ pub use hyperswitch_domain_models::router_flow_types::fraud_check::{
Checkout, Fulfillment, RecordReturn, Sale, Transaction,
};
+pub use super::fraud_check_v2::{
+ FraudCheckCheckoutV2, FraudCheckFulfillmentV2, FraudCheckRecordReturnV2, FraudCheckSaleV2,
+ FraudCheckTransactionV2, FraudCheckV2,
+};
use super::{BoxedConnector, ConnectorData, SessionConnectorData};
use crate::{
connector,
diff --git a/crates/router/src/types/api/fraud_check_v2.rs b/crates/router/src/types/api/fraud_check_v2.rs
new file mode 100644
index 00000000000..53dad6d5686
--- /dev/null
+++ b/crates/router/src/types/api/fraud_check_v2.rs
@@ -0,0 +1,70 @@
+pub use hyperswitch_domain_models::router_flow_types::fraud_check::{
+ Checkout, Fulfillment, RecordReturn, Sale, Transaction,
+};
+
+use crate::{
+ services::api,
+ types::{
+ self,
+ fraud_check::{
+ FraudCheckCheckoutData, FraudCheckFulfillmentData, FraudCheckRecordReturnData,
+ FraudCheckResponseData, FraudCheckSaleData, FraudCheckTransactionData,
+ },
+ },
+};
+
+pub trait FraudCheckSaleV2:
+ api::ConnectorIntegrationV2<Sale, types::FrmFlowData, FraudCheckSaleData, FraudCheckResponseData>
+{
+}
+
+pub trait FraudCheckCheckoutV2:
+ api::ConnectorIntegrationV2<
+ Checkout,
+ types::FrmFlowData,
+ FraudCheckCheckoutData,
+ FraudCheckResponseData,
+>
+{
+}
+
+pub trait FraudCheckTransactionV2:
+ api::ConnectorIntegrationV2<
+ Transaction,
+ types::FrmFlowData,
+ FraudCheckTransactionData,
+ FraudCheckResponseData,
+>
+{
+}
+
+pub trait FraudCheckFulfillmentV2:
+ api::ConnectorIntegrationV2<
+ Fulfillment,
+ types::FrmFlowData,
+ FraudCheckFulfillmentData,
+ FraudCheckResponseData,
+>
+{
+}
+
+pub trait FraudCheckRecordReturnV2:
+ api::ConnectorIntegrationV2<
+ RecordReturn,
+ types::FrmFlowData,
+ FraudCheckRecordReturnData,
+ FraudCheckResponseData,
+>
+{
+}
+
+#[cfg(feature = "frm")]
+pub trait FraudCheckV2:
+ types::api::ConnectorCommon
+ + FraudCheckSaleV2
+ + FraudCheckTransactionV2
+ + FraudCheckCheckoutV2
+ + FraudCheckFulfillmentV2
+ + FraudCheckRecordReturnV2
+{
+}
diff --git a/crates/router/src/types/api/payments.rs b/crates/router/src/types/api/payments.rs
index 4c24b78bcdd..d8303831221 100644
--- a/crates/router/src/types/api/payments.rs
+++ b/crates/router/src/types/api/payments.rs
@@ -21,6 +21,12 @@ pub use hyperswitch_domain_models::router_flow_types::payments::{
PreProcessing, Reject, Session, SetupMandate, Void,
};
+pub use super::payments_v2::{
+ ConnectorCustomerV2, MandateSetupV2, PaymentApproveV2, PaymentAuthorizeSessionTokenV2,
+ PaymentAuthorizeV2, PaymentCaptureV2, PaymentIncrementalAuthorizationV2, PaymentRejectV2,
+ PaymentSessionV2, PaymentSyncV2, PaymentTokenV2, PaymentV2, PaymentVoidV2,
+ PaymentsCompleteAuthorizeV2, PaymentsPreProcessingV2,
+};
use crate::{
core::errors,
services::api,
diff --git a/crates/router/src/types/api/payments_v2.rs b/crates/router/src/types/api/payments_v2.rs
new file mode 100644
index 00000000000..fc490ea3d79
--- /dev/null
+++ b/crates/router/src/types/api/payments_v2.rs
@@ -0,0 +1,173 @@
+use hyperswitch_domain_models::{
+ router_data_v2::PaymentFlowData,
+ router_flow_types::payments::{
+ Approve, Authorize, AuthorizeSessionToken, Capture, CompleteAuthorize,
+ CreateConnectorCustomer, IncrementalAuthorization, PSync, PaymentMethodToken,
+ PreProcessing, Reject, Session, SetupMandate, Void,
+ },
+};
+
+use crate::{
+ services::api,
+ types::{self, api as api_types},
+};
+
+pub trait PaymentAuthorizeV2:
+ api::ConnectorIntegrationV2<
+ Authorize,
+ PaymentFlowData,
+ types::PaymentsAuthorizeData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentAuthorizeSessionTokenV2:
+ api::ConnectorIntegrationV2<
+ AuthorizeSessionToken,
+ PaymentFlowData,
+ types::AuthorizeSessionTokenData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentSyncV2:
+ api::ConnectorIntegrationV2<
+ PSync,
+ PaymentFlowData,
+ types::PaymentsSyncData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentVoidV2:
+ api::ConnectorIntegrationV2<
+ Void,
+ PaymentFlowData,
+ types::PaymentsCancelData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentApproveV2:
+ api::ConnectorIntegrationV2<
+ Approve,
+ PaymentFlowData,
+ types::PaymentsApproveData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentRejectV2:
+ api::ConnectorIntegrationV2<
+ Reject,
+ PaymentFlowData,
+ types::PaymentsRejectData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentCaptureV2:
+ api::ConnectorIntegrationV2<
+ Capture,
+ PaymentFlowData,
+ types::PaymentsCaptureData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentSessionV2:
+ api::ConnectorIntegrationV2<
+ Session,
+ PaymentFlowData,
+ types::PaymentsSessionData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait MandateSetupV2:
+ api::ConnectorIntegrationV2<
+ SetupMandate,
+ PaymentFlowData,
+ types::SetupMandateRequestData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentIncrementalAuthorizationV2:
+ api::ConnectorIntegrationV2<
+ IncrementalAuthorization,
+ PaymentFlowData,
+ types::PaymentsIncrementalAuthorizationData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentsCompleteAuthorizeV2:
+ api::ConnectorIntegrationV2<
+ CompleteAuthorize,
+ PaymentFlowData,
+ types::CompleteAuthorizeData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentTokenV2:
+ api::ConnectorIntegrationV2<
+ PaymentMethodToken,
+ PaymentFlowData,
+ types::PaymentMethodTokenizationData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait ConnectorCustomerV2:
+ api::ConnectorIntegrationV2<
+ CreateConnectorCustomer,
+ PaymentFlowData,
+ types::ConnectorCustomerData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentsPreProcessingV2:
+ api::ConnectorIntegrationV2<
+ PreProcessing,
+ PaymentFlowData,
+ types::PaymentsPreProcessingData,
+ types::PaymentsResponseData,
+>
+{
+}
+
+pub trait PaymentV2:
+ api_types::ConnectorCommon
+ + api_types::ConnectorValidation
+ + PaymentAuthorizeV2
+ + PaymentAuthorizeSessionTokenV2
+ + PaymentsCompleteAuthorizeV2
+ + PaymentSyncV2
+ + PaymentCaptureV2
+ + PaymentVoidV2
+ + PaymentApproveV2
+ + PaymentRejectV2
+ + MandateSetupV2
+ + PaymentSessionV2
+ + PaymentTokenV2
+ + PaymentsPreProcessingV2
+ + ConnectorCustomerV2
+ + PaymentIncrementalAuthorizationV2
+{
+}
diff --git a/crates/router/src/types/api/payouts.rs b/crates/router/src/types/api/payouts.rs
index dfe7e949aa1..c911472cd4a 100644
--- a/crates/router/src/types/api/payouts.rs
+++ b/crates/router/src/types/api/payouts.rs
@@ -8,6 +8,10 @@ pub use hyperswitch_domain_models::router_flow_types::payouts::{
PoCancel, PoCreate, PoEligibility, PoFulfill, PoQuote, PoRecipient, PoRecipientAccount,
};
+pub use super::payouts_v2::{
+ PayoutCancelV2, PayoutCreateV2, PayoutEligibilityV2, PayoutFulfillV2, PayoutQuoteV2,
+ PayoutRecipientAccountV2, PayoutRecipientV2, PayoutsV2,
+};
use crate::{services::api, types};
pub trait PayoutCancel:
diff --git a/crates/router/src/types/api/payouts_v2.rs b/crates/router/src/types/api/payouts_v2.rs
new file mode 100644
index 00000000000..ab39f59a195
--- /dev/null
+++ b/crates/router/src/types/api/payouts_v2.rs
@@ -0,0 +1,96 @@
+pub use api_models::payouts::{
+ AchBankTransfer, BacsBankTransfer, Bank as BankPayout, CardPayout, PayoutActionRequest,
+ PayoutCreateRequest, PayoutCreateResponse, PayoutListConstraints, PayoutListFilterConstraints,
+ PayoutListFilters, PayoutListResponse, PayoutMethodData, PayoutRequest, PayoutRetrieveBody,
+ PayoutRetrieveRequest, PixBankTransfer, SepaBankTransfer, Wallet as WalletPayout,
+};
+pub use hyperswitch_domain_models::router_flow_types::payouts::{
+ PoCancel, PoCreate, PoEligibility, PoFulfill, PoQuote, PoRecipient, PoRecipientAccount,
+};
+
+use crate::{
+ services::api,
+ types::{self, api as api_types},
+};
+
+pub trait PayoutCancelV2:
+ api::ConnectorIntegrationV2<
+ PoCancel,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+>
+{
+}
+
+pub trait PayoutCreateV2:
+ api::ConnectorIntegrationV2<
+ PoCreate,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+>
+{
+}
+
+pub trait PayoutEligibilityV2:
+ api::ConnectorIntegrationV2<
+ PoEligibility,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+>
+{
+}
+
+pub trait PayoutFulfillV2:
+ api::ConnectorIntegrationV2<
+ PoFulfill,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+>
+{
+}
+
+pub trait PayoutQuoteV2:
+ api::ConnectorIntegrationV2<
+ PoQuote,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+>
+{
+}
+
+pub trait PayoutRecipientV2:
+ api::ConnectorIntegrationV2<
+ PoRecipient,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+>
+{
+}
+
+pub trait PayoutRecipientAccountV2:
+ api::ConnectorIntegrationV2<
+ PoRecipientAccount,
+ types::PayoutFlowData,
+ types::PayoutsData,
+ types::PayoutsResponseData,
+>
+{
+}
+
+pub trait PayoutsV2:
+ api_types::ConnectorCommon
+ + PayoutCancelV2
+ + PayoutCreateV2
+ + PayoutEligibilityV2
+ + PayoutFulfillV2
+ + PayoutQuoteV2
+ + PayoutRecipientV2
+ + PayoutRecipientAccountV2
+{
+}
diff --git a/crates/router/src/types/api/refunds.rs b/crates/router/src/types/api/refunds.rs
index ac0433080cc..67ca7cbfc45 100644
--- a/crates/router/src/types/api/refunds.rs
+++ b/crates/router/src/types/api/refunds.rs
@@ -4,6 +4,7 @@ pub use api_models::refunds::{
};
pub use hyperswitch_domain_models::router_flow_types::refunds::{Execute, RSync};
+pub use super::refunds_v2::{RefundExecuteV2, RefundSyncV2, RefundV2};
use super::ConnectorCommon;
use crate::{
services::api,
diff --git a/crates/router/src/types/api/refunds_v2.rs b/crates/router/src/types/api/refunds_v2.rs
new file mode 100644
index 00000000000..d0e3e8db29e
--- /dev/null
+++ b/crates/router/src/types/api/refunds_v2.rs
@@ -0,0 +1,18 @@
+use hyperswitch_domain_models::{
+ router_data_v2::flow_common_types::RefundFlowData,
+ router_flow_types::refunds::{Execute, RSync},
+};
+
+use super::ConnectorCommon;
+use crate::{services::api, types};
+pub trait RefundExecuteV2:
+ api::ConnectorIntegrationV2<Execute, RefundFlowData, types::RefundsData, types::RefundsResponseData>
+{
+}
+
+pub trait RefundSyncV2:
+ api::ConnectorIntegrationV2<RSync, RefundFlowData, types::RefundsData, types::RefundsResponseData>
+{
+}
+
+pub trait RefundV2: ConnectorCommon + RefundExecuteV2 + RefundSyncV2 {}
|
refactor
|
introduce ConnectorIntegrationNew and add default implementation for each Connector (#4989)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.