use std::sync::Arc;
use serde::Serialize;
use serde_json::Value;
use crate::core::encoding::{encode_segment, to_json_vec};
use crate::core::error::{DelopayError, Result};
use crate::core::models::common::Address;
use crate::core::models::payment_method::PaymentMethodResponse;
use crate::http::client::Inner;
use crate::http::transport::HttpMethod;
use crate::resources::ValidateRequest;
#[derive(Debug, Clone)]
pub struct PaymentMethods {
inner: Arc<Inner>,
}
impl PaymentMethods {
pub(crate) fn new(inner: Arc<Inner>) -> Self {
Self { inner }
}
pub async fn create(
&self,
params: &PaymentMethodCreateRequest,
) -> Result<PaymentMethodResponse> {
params.validate()?;
let body = to_json_vec(params)?;
self.inner
.request(HttpMethod::Post, "/payment-methods", Some(&body), &[], None)
.await
}
pub async fn retrieve(&self, method_id: &str) -> Result<PaymentMethodResponse> {
let path = format!("/payment-methods/{}", encode_segment(method_id));
self.inner
.request(HttpMethod::Get, &path, None, &[], None)
.await
}
pub async fn update(
&self,
method_id: &str,
params: &PaymentMethodUpdateRequest,
) -> Result<PaymentMethodResponse> {
params.validate()?;
let path = format!("/payment-methods/{}/update", encode_segment(method_id));
let body = to_json_vec(params)?;
self.inner
.request(HttpMethod::Post, &path, Some(&body), &[], None)
.await
}
pub async fn delete(&self, method_id: &str) -> Result<Value> {
let path = format!("/payment-methods/{}", encode_segment(method_id));
self.inner
.request(HttpMethod::Delete, &path, None, &[], None)
.await
}
pub async fn list(
&self,
params: Option<&PaymentMethodListParams>,
) -> Result<Vec<PaymentMethodResponse>> {
let query = params
.map(PaymentMethodListParams::to_query)
.unwrap_or_default();
self.inner
.request(HttpMethod::Get, "/payment-methods", None, &query, None)
.await
}
pub async fn list_for_customer(
&self,
customer_id: &str,
params: Option<&CustomerPaymentMethodsListParams>,
) -> Result<Vec<PaymentMethodResponse>> {
let path = format!("/customers/{}/payment-methods", encode_segment(customer_id));
let query = params
.map(CustomerPaymentMethodsListParams::to_query)
.unwrap_or_default();
self.inner
.request(HttpMethod::Get, &path, None, &query, None)
.await
}
pub async fn set_default(
&self,
customer_id: &str,
method_id: &str,
) -> Result<PaymentMethodResponse> {
let path = format!(
"/customers/{}/payment-methods/{}/default",
encode_segment(customer_id),
encode_segment(method_id)
);
self.inner
.request(HttpMethod::Post, &path, None, &[], None)
.await
}
pub async fn migrate(&self, params: &Value) -> Result<PaymentMethodResponse> {
let body = to_json_vec(params)?;
self.inner
.request(
HttpMethod::Post,
"/payment-methods/migrate",
Some(&body),
&[],
None,
)
.await
}
pub async fn migrate_batch(&self, params: &[Value]) -> Result<Value> {
let body = to_json_vec(¶ms)?;
self.inner
.request(
HttpMethod::Post,
"/payment-methods/migrate-batch",
Some(&body),
&[],
None,
)
.await
}
pub async fn update_batch(&self, params: &[Value]) -> Result<Value> {
let body = to_json_vec(¶ms)?;
self.inner
.request(
HttpMethod::Post,
"/payment-methods/update-batch",
Some(&body),
&[],
None,
)
.await
}
pub async fn batch_retrieve(
&self,
query: &[(&str, String)],
) -> Result<Vec<PaymentMethodResponse>> {
self.inner
.request(HttpMethod::Get, "/payment-methods/batch", None, query, None)
.await
}
pub async fn tokenize_card(&self, params: &Value) -> Result<Value> {
let body = to_json_vec(params)?;
self.inner
.request(
HttpMethod::Post,
"/payment-methods/tokenize-card",
Some(&body),
&[],
None,
)
.await
}
pub async fn tokenize_card_batch(&self, params: &[Value]) -> Result<Value> {
let body = to_json_vec(¶ms)?;
self.inner
.request(
HttpMethod::Post,
"/payment-methods/tokenize-card-batch",
Some(&body),
&[],
None,
)
.await
}
pub async fn collect(&self, params: &Value) -> Result<Value> {
let body = to_json_vec(params)?;
self.inner
.request(
HttpMethod::Post,
"/payment-methods/collect",
Some(&body),
&[],
None,
)
.await
}
pub async fn save(
&self,
method_id: &str,
params: Option<&Value>,
) -> Result<PaymentMethodResponse> {
let path = format!("/payment-methods/{}/save", encode_segment(method_id));
let body: Option<Vec<u8>> = match params {
Some(p) => Some(to_json_vec(p)?),
None => None,
};
self.inner
.request(HttpMethod::Post, &path, body.as_deref(), &[], None)
.await
}
pub async fn create_auth_link(&self, params: &Value) -> Result<Value> {
let body = to_json_vec(params)?;
self.inner
.request(
HttpMethod::Post,
"/payment-methods/auth/link",
Some(&body),
&[],
None,
)
.await
}
pub async fn exchange_auth_token(&self, params: &Value) -> Result<Value> {
let body = to_json_vec(params)?;
self.inner
.request(
HttpMethod::Post,
"/payment-methods/auth/exchange",
Some(&body),
&[],
None,
)
.await
}
pub async fn tokenize_card_for_method(&self, method_id: &str, params: &Value) -> Result<Value> {
let path = format!(
"/payment-methods/{}/tokenize-card",
encode_segment(method_id)
);
let body = to_json_vec(params)?;
self.inner
.request(HttpMethod::Post, &path, Some(&body), &[], None)
.await
}
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct PaymentMethodCreateRequest {
pub payment_method: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_method_type: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_method_issuer: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub card: Option<Value>,
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Value>,
#[serde(skip_serializing_if = "Option::is_none")]
pub customer_id: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub card_network: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub bank_transfer: Option<Value>,
#[serde(skip_serializing_if = "Option::is_none")]
pub wallet: Option<Value>,
#[serde(skip_serializing_if = "Option::is_none")]
pub client_secret: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub billing: Option<Address>,
#[serde(flatten, skip_serializing_if = "serde_json::Map::is_empty")]
pub extra: serde_json::Map<String, Value>,
}
const PAYMENT_METHOD_CREATE_REQUEST_NAMED: &[&str] = &[
"payment_method",
"payment_method_type",
"payment_method_issuer",
"card",
"metadata",
"customer_id",
"card_network",
"bank_transfer",
"wallet",
"client_secret",
"billing",
];
impl ValidateRequest for PaymentMethodCreateRequest {
fn validate(&self) -> Result<()> {
for key in self.extra.keys() {
if PAYMENT_METHOD_CREATE_REQUEST_NAMED.contains(&key.as_str()) {
return Err(DelopayError::InvalidRequest(format!(
"`extra` key `{key}` collides with a named field on PaymentMethodCreateRequest"
)));
}
}
Ok(())
}
}
impl PaymentMethodCreateRequest {
pub fn new(payment_method: impl Into<String>) -> Self {
Self {
payment_method: payment_method.into(),
..Default::default()
}
}
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct CardUpdate {
#[serde(skip_serializing_if = "Option::is_none")]
pub card_exp_month: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub card_exp_year: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub card_holder_name: Option<String>,
}
#[derive(Debug, Clone, Default, Serialize)]
pub struct PaymentMethodUpdateRequest {
#[serde(skip_serializing_if = "Option::is_none")]
pub card: Option<CardUpdate>,
#[serde(skip_serializing_if = "Option::is_none")]
pub wallet: Option<Value>,
#[serde(skip_serializing_if = "Option::is_none")]
pub client_secret: Option<String>,
#[serde(flatten, skip_serializing_if = "serde_json::Map::is_empty")]
pub extra: serde_json::Map<String, Value>,
}
const PAYMENT_METHOD_UPDATE_REQUEST_NAMED: &[&str] = &["card", "wallet", "client_secret"];
impl ValidateRequest for PaymentMethodUpdateRequest {
fn validate(&self) -> Result<()> {
for key in self.extra.keys() {
if PAYMENT_METHOD_UPDATE_REQUEST_NAMED.contains(&key.as_str()) {
return Err(DelopayError::InvalidRequest(format!(
"`extra` key `{key}` collides with a named field on PaymentMethodUpdateRequest"
)));
}
}
Ok(())
}
}
#[derive(Debug, Clone, Default)]
pub struct PaymentMethodListParams {
pub client_secret: Option<String>,
pub country: Option<String>,
}
impl PaymentMethodListParams {
fn to_query(&self) -> Vec<(&'static str, String)> {
let mut q = Vec::new();
if let Some(v) = &self.client_secret {
q.push(("client_secret", v.clone()));
}
if let Some(v) = &self.country {
q.push(("country", v.clone()));
}
q
}
}
#[derive(Debug, Clone, Default)]
pub struct CustomerPaymentMethodsListParams {
pub client_secret: Option<String>,
pub accepted_countries: Option<Vec<String>>,
pub accepted_currencies: Option<Vec<String>>,
pub amount: Option<i64>,
pub recurring_enabled: Option<bool>,
pub installment_payment_enabled: Option<bool>,
pub limit: Option<i64>,
pub card_networks: Option<Vec<String>>,
}
impl CustomerPaymentMethodsListParams {
fn to_query(&self) -> Vec<(&'static str, String)> {
let mut q = Vec::new();
if let Some(v) = &self.client_secret {
q.push(("client_secret", v.clone()));
}
for v in self.accepted_countries.iter().flatten() {
q.push(("accepted_countries", v.clone()));
}
for v in self.accepted_currencies.iter().flatten() {
q.push(("accepted_currencies", v.clone()));
}
if let Some(v) = self.amount {
q.push(("amount", v.to_string()));
}
if let Some(v) = self.recurring_enabled {
q.push(("recurring_enabled", v.to_string()));
}
if let Some(v) = self.installment_payment_enabled {
q.push(("installment_payment_enabled", v.to_string()));
}
if let Some(v) = self.limit {
q.push(("limit", v.to_string()));
}
for v in self.card_networks.iter().flatten() {
q.push(("card_networks", v.clone()));
}
q
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::http::mock::{Step, client_with};
use serde_json::json;
const PM_JSON: &str = r#"{
"merchant_id": "mer_1", "payment_method_id": "pm_1",
"payment_method": "card"
}"#;
fn full_create_request() -> PaymentMethodCreateRequest {
PaymentMethodCreateRequest {
payment_method: "card".to_string(),
payment_method_type: Some("credit".to_string()),
payment_method_issuer: Some("Big Bank".to_string()),
card: Some(json!({"card_number": "4242424242424242"})),
metadata: Some(json!({"k": "v"})),
customer_id: Some("cus_1".to_string()),
card_network: Some("Visa".to_string()),
bank_transfer: Some(json!({"iban": "DE00"})),
wallet: Some(json!({"type": "apple_pay"})),
client_secret: Some("cs_1".to_string()),
billing: Some(Address::default()),
extra: serde_json::Map::new(),
}
}
#[test]
fn create_request_named_fields_are_complete() {
let value = serde_json::to_value(full_create_request()).unwrap();
let obj = value.as_object().expect("serializes to a JSON object");
for key in obj.keys() {
assert!(
PAYMENT_METHOD_CREATE_REQUEST_NAMED.contains(&key.as_str()),
"PAYMENT_METHOD_CREATE_REQUEST_NAMED is missing wire key `{key}` -- \
add it, or the extra-key collision guard silently stops \
covering this field"
);
}
}
fn full_update_request() -> PaymentMethodUpdateRequest {
PaymentMethodUpdateRequest {
card: Some(CardUpdate {
card_exp_month: Some("09".to_string()),
card_exp_year: Some("2030".to_string()),
card_holder_name: Some("Ada".to_string()),
}),
wallet: Some(json!({"type": "apple_pay"})),
client_secret: Some("cs_1".to_string()),
extra: serde_json::Map::new(),
}
}
#[test]
fn update_request_named_fields_are_complete() {
let value = serde_json::to_value(full_update_request()).unwrap();
let obj = value.as_object().expect("serializes to a JSON object");
for key in obj.keys() {
assert!(
PAYMENT_METHOD_UPDATE_REQUEST_NAMED.contains(&key.as_str()),
"PAYMENT_METHOD_UPDATE_REQUEST_NAMED is missing wire key `{key}`"
);
}
}
#[test]
fn create_validate_rejects_colliding_extra_key() {
let mut req = PaymentMethodCreateRequest::new("card");
req.extra.insert("customer_id".to_string(), json!("cus_2"));
assert!(matches!(
req.validate().unwrap_err(),
crate::core::error::DelopayError::InvalidRequest(_)
));
}
#[tokio::test]
async fn create_posts_to_payment_methods() {
let (client, mock) = client_with(vec![Step::ok(PM_JSON)]);
let req = PaymentMethodCreateRequest::new("card");
client.payment_methods().create(&req).await.unwrap();
let seen = mock.seen.lock().unwrap();
assert_eq!(seen[0].method, "POST");
assert_eq!(seen[0].url, "https://api.test/payment-methods");
assert_eq!(seen[0].body_json()["payment_method"], "card");
}
#[tokio::test]
async fn update_posts_to_the_update_path() {
let (client, mock) = client_with(vec![Step::ok(PM_JSON)]);
let req = full_update_request();
client.payment_methods().update("pm_1", &req).await.unwrap();
let seen = mock.seen.lock().unwrap();
assert_eq!(seen[0].method, "POST");
assert_eq!(seen[0].url, "https://api.test/payment-methods/pm_1/update");
assert_eq!(seen[0].body_json()["card"]["card_exp_year"], "2030");
}
#[tokio::test]
async fn list_for_customer_serializes_repeated_array_params() {
let (client, mock) = client_with(vec![Step::ok("[]")]);
let params = CustomerPaymentMethodsListParams {
accepted_currencies: Some(vec!["EUR".to_string(), "USD".to_string()]),
amount: Some(5000),
..Default::default()
};
client
.payment_methods()
.list_for_customer("cus_1", Some(¶ms))
.await
.unwrap();
let seen = mock.seen.lock().unwrap();
assert_eq!(
seen[0].url,
"https://api.test/customers/cus_1/payment-methods\
?accepted_currencies=EUR&accepted_currencies=USD&amount=5000",
"array filters must be repeated keys, not comma-joined"
);
}
#[tokio::test]
async fn list_filters_by_client_secret_and_country() {
let (client, mock) = client_with(vec![Step::ok("[]")]);
let params = PaymentMethodListParams {
client_secret: Some("cs_1".to_string()),
country: Some("DE".to_string()),
};
client.payment_methods().list(Some(¶ms)).await.unwrap();
let seen = mock.seen.lock().unwrap();
assert_eq!(
seen[0].url,
"https://api.test/payment-methods?client_secret=cs_1&country=DE"
);
}
#[tokio::test]
async fn advanced_operations_hit_their_documented_paths() {
let steps = vec![
Step::ok(PM_JSON),
Step::ok(r#"{"migrated":1}"#),
Step::ok(r#"{"updated":1}"#),
Step::ok("[]"),
Step::ok(r#"{"token":"t"}"#),
Step::ok(r#"{"tokens":[]}"#),
Step::ok(r#"{"link":"l"}"#),
Step::ok(PM_JSON),
Step::ok(r#"{"link_token":"lt"}"#),
Step::ok(r#"{"access_token":"at"}"#),
Step::ok(r#"{"token":"t"}"#),
];
let (client, mock) = client_with(steps);
let pm = client.payment_methods();
let body = json!({"k": "v"});
let batch = [json!({"k": "v"})];
pm.migrate(&body).await.unwrap();
pm.migrate_batch(&batch).await.unwrap();
pm.update_batch(&batch).await.unwrap();
pm.batch_retrieve(&[("limit", "10".to_string())])
.await
.unwrap();
pm.tokenize_card(&body).await.unwrap();
pm.tokenize_card_batch(&batch).await.unwrap();
pm.collect(&body).await.unwrap();
pm.save("pm_1", None).await.unwrap();
pm.create_auth_link(&body).await.unwrap();
pm.exchange_auth_token(&body).await.unwrap();
pm.tokenize_card_for_method("pm_1", &body).await.unwrap();
let expected = [
("POST", "https://api.test/payment-methods/migrate"),
("POST", "https://api.test/payment-methods/migrate-batch"),
("POST", "https://api.test/payment-methods/update-batch"),
("GET", "https://api.test/payment-methods/batch?limit=10"),
("POST", "https://api.test/payment-methods/tokenize-card"),
(
"POST",
"https://api.test/payment-methods/tokenize-card-batch",
),
("POST", "https://api.test/payment-methods/collect"),
("POST", "https://api.test/payment-methods/pm_1/save"),
("POST", "https://api.test/payment-methods/auth/link"),
("POST", "https://api.test/payment-methods/auth/exchange"),
(
"POST",
"https://api.test/payment-methods/pm_1/tokenize-card",
),
];
let seen = mock.seen.lock().unwrap();
assert_eq!(seen.len(), expected.len());
for (i, (method, url)) in expected.iter().enumerate() {
assert_eq!(seen[i].method, *method, "wrong verb at call {i}");
assert_eq!(seen[i].url, *url, "wrong URL at call {i}");
}
}
#[tokio::test]
async fn batch_bodies_serialize_as_json_arrays() {
let (client, mock) = client_with(vec![Step::ok(r#"{"ok":true}"#)]);
let batch = [json!({"a": 1}), json!({"a": 2})];
client
.payment_methods()
.migrate_batch(&batch)
.await
.unwrap();
let seen = mock.seen.lock().unwrap();
let body = seen[0].body_json();
assert!(body.is_array(), "body must be a bare JSON array: {body}");
assert_eq!(body[1]["a"], 2);
}
}