From d9f860f35c957775f3459490103c2e8859683bae Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Thu, 12 Jun 2025 22:34:58 +0200 Subject: [PATCH 01/14] Update sender info for debits --- .../resources/debits/sender_information.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/website/content/gateway/api_reference/resources/debits/sender_information.md b/website/content/gateway/api_reference/resources/debits/sender_information.md index 02890df..e64f7fb 100644 --- a/website/content/gateway/api_reference/resources/debits/sender_information.md +++ b/website/content/gateway/api_reference/resources/debits/sender_information.md @@ -11,12 +11,23 @@ Intra-EEA, mentioned below, includes the United Kingdom and Gibraltar. {{% description_list %}} -{{% description_term %}}sender[name] {{% regex %}}[\x20-\x7E]{2,30} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} -{{% description_details %}}The sender's legal name. +{{% description_term %}}sender[first_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}}The sender's legal first name. -Example: "Doe Jane A." (last name, first name, optional middle initial). +{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% regex_optional %}}Required for intra-EEA and international debits. Also required if any of the address-related parameters are supplied.{{% /regex_optional %}} +{{% /description_details %}} + +{{% description_term %}}sender[middle_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}}The sender's legal middle name in case of any. + +{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% /description_details %}} + +{{% description_term %}}sender[last_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}}The sender's legal last name. -{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete (only first or last name).{{% /regex_optional %}} +{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required for intra-EEA and international debits. Also required if any of the address-related parameters are supplied.{{% /regex_optional %}} {{% /description_details %}} From 0618aa44d3d08bd2a60ea8584b9cf1b291ad68e5 Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Thu, 12 Jun 2025 22:35:12 +0200 Subject: [PATCH 02/14] Update recipient info for debits --- .../api_reference/resources/debits/debits.md | 2 +- .../resources/debits/recipient_information.md | 20 ++++++++++++++----- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/website/content/gateway/api_reference/resources/debits/debits.md b/website/content/gateway/api_reference/resources/debits/debits.md index d45d773..6a53c87 100644 --- a/website/content/gateway/api_reference/resources/debits/debits.md +++ b/website/content/gateway/api_reference/resources/debits/debits.md @@ -11,7 +11,7 @@ POST https://gateway.clearhaus.com/debits ``` Debits support the same parameters and payment methods as [Authorizations](#authorizations), with the exception that amount must be greater than zero. -Information about sender and recipient is required for debits under certain circumstances to be compliant with card scheme rules. See [Sender information](#sender_information) and [Recipient information](#recipient_information). +Information about sender and recipient is required for debits under certain circumstances to be compliant with card scheme rules. See [Sender information](#sender_information) and [Recipient information](#debit_recipient_information). {{% notice %}} **Notice:** Only merchants with selected Merchant Category Codes (MCCs) and assigned Business Application Identifiers (BAIs) (Visa) or Transaction Type Indicators (TTIs) (Mastercard) are able to process a debit; namely exactly those that will result in the debit being a Visa Account Funding Transaction (AFT) or Mastercard Funding Transaction (FT). diff --git a/website/content/gateway/api_reference/resources/debits/recipient_information.md b/website/content/gateway/api_reference/resources/debits/recipient_information.md index 65b9a15..a9cfe1f 100644 --- a/website/content/gateway/api_reference/resources/debits/recipient_information.md +++ b/website/content/gateway/api_reference/resources/debits/recipient_information.md @@ -1,7 +1,7 @@ --- title: "recipient_information" date: 2023-07-20T13:01:49+01:00 -anchor: "recipient_information" +anchor: "debit_recipient_information" weight: 178 --- ##### Recipient information @@ -9,12 +9,22 @@ See the partner guideline for more details. {{% description_list %}} -{{% description_term %}}recipient[name] {{% regex %}}[\x20-\x7E]{2,30} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} -{{% description_details %}}The recipient's legal name. +{{% description_term %}}recipient[first_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}}The recipient's legal first name. -Example: "Doe Jane A." (last name, first name, optional middle initial). +{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% regex_optional %}}Required.{{% /regex_optional %}} +{{% /description_details %}} + +{{% description_term %}}recipient[middle_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}}The recipient's legal middle name in case of any. +{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% /description_details %}} + +{{% description_term %}}recipient[last_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}}The recipient's legal last name. -{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete (only first or last name).{{% /regex_optional %}} +{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required.{{% /regex_optional %}} {{% /description_details %}} From bd81e2f88abf294738159b0628165ec6dd8700ea Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Thu, 12 Jun 2025 22:35:48 +0200 Subject: [PATCH 03/14] Add recipient info to credits And remove card[name] --- .../resources/credits/credits.md | 8 ++--- .../credits/recipient_information.md | 31 +++++++++++++++++++ .../payout_to_cardholder.md | 2 +- 3 files changed, 35 insertions(+), 6 deletions(-) create mode 100644 website/content/gateway/api_reference/resources/credits/recipient_information.md diff --git a/website/content/gateway/api_reference/resources/credits/credits.md b/website/content/gateway/api_reference/resources/credits/credits.md index c6c308d..887f91d 100644 --- a/website/content/gateway/api_reference/resources/credits/credits.md +++ b/website/content/gateway/api_reference/resources/credits/credits.md @@ -9,6 +9,9 @@ To payout (e.g. winnings and not refunds) money to a cardholder’s bank account ```shell POST https://gateway.clearhaus.com/credits ``` + +Information about the recipient is required for credits to be compliant with card scheme rules. See [Recipient information](#credit_recipient_information). + ##### Parameters {{% description_list %}} {{% description_term %}}amount{{% regex %}}[1-9][0-9]{,8}{{% /regex %}}{{% /description_term %}} @@ -49,11 +52,6 @@ POST https://gateway.clearhaus.com/credits {{% regex_optional %}}Optional.{{% /regex_optional %}} {{% /description_details %}} -{{% description_term %}}card[name] {{% regex %}}[A-Za-z0-9 ]{1,30}{{% /regex %}}{{% /description_term %}} -{{% description_details %}}Name on card. -{{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW.{{% /regex_optional %}} -{{% /description_details %}} - {{% /description_list %}} {{% notice %}} diff --git a/website/content/gateway/api_reference/resources/credits/recipient_information.md b/website/content/gateway/api_reference/resources/credits/recipient_information.md new file mode 100644 index 0000000..d8d0a9f --- /dev/null +++ b/website/content/gateway/api_reference/resources/credits/recipient_information.md @@ -0,0 +1,31 @@ +--- +title: "recipient_information" +date: 2023-07-20T13:01:49+01:00 +anchor: "credit_recipient_information" +weight: 181 +--- +##### Recipient information +See the partner guideline for more details. + +{{% description_list %}} + +{{% description_term %}}recipient[first_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}}The recipient's legal first name. + +{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW.{{% /regex_optional %}} +{{% /description_details %}} + +{{% description_term %}}recipient[middle_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}}The recipient's legal middle name in case of any. +{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% /description_details %}} + +{{% description_term %}}recipient[last_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}}The recipient's legal last name. + +{{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW.{{% /regex_optional %}} +{{% /description_details %}} + +{{% /description_list %}} diff --git a/website/content/gateway/examples/payout_to_cardholder/payout_to_cardholder.md b/website/content/gateway/examples/payout_to_cardholder/payout_to_cardholder.md index 6cbe4e9..07dd21d 100644 --- a/website/content/gateway/examples/payout_to_cardholder/payout_to_cardholder.md +++ b/website/content/gateway/examples/payout_to_cardholder/payout_to_cardholder.md @@ -33,5 +33,5 @@ Example response (snippet): } ``` -The field {{% highlight_text %}}card[name]{{% /highlight_text %}} is mandatory for Mastercard Payment of winnings (gaming/gambling merchants). +The field {{% highlight_text %}}recipient[first_name]{{% /highlight_text %}} and {{% highlight_text %}}recipient[last_name]{{% /highlight_text %}} is mandatory for Mastercard Payment of winnings (gaming/gambling merchants). Depending on card scheme and merchant category, the name on the card might be necessary for approval of credits. From d857682ebf9a12f745feda0a854949eee219970a Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Thu, 12 Jun 2025 22:36:06 +0200 Subject: [PATCH 04/14] Add change log entry --- website/content/gateway/api_reference/changes/changes.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/website/content/gateway/api_reference/changes/changes.md b/website/content/gateway/api_reference/changes/changes.md index a3998ea..ede6081 100644 --- a/website/content/gateway/api_reference/changes/changes.md +++ b/website/content/gateway/api_reference/changes/changes.md @@ -10,6 +10,15 @@ Follow coming changes on the [source code repository](https://github.com/clearha Sorted by descending timestamp. +#### Change to name related parameters +Starting XXXX-XX-XX, we will support new name related parameters +`recipient[first_name]`, `recipient[middle_name]`, `recipient[last_name]`, +`sender[first_name]`, `sender[middle_name]` and `sender[last_name]`. This will +in time push for the deprecation of `card[name]`, `recipient[name]` and +`sender[name]`. We will in a grace period allow for both old and new parameters, +but we recommend that you plan the shift as we can't guarantee how long our +upstream provider supports the old fields. + #### Add minimum amount for Visa captures and refunds Starting 2025-05-19, we will enforce a minimum amount of USD 0.005 for captures and refunds made with Visa. This is due to USD 0.005 being half a minor, and From 71e064212d5beae0cceecf6ff2c149758e2d494f Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Fri, 13 Jun 2025 12:27:21 +0200 Subject: [PATCH 05/14] Apply suggestions from code review Co-authored-by: Martin Toft Bay --- .../gateway/api_reference/changes/changes.md | 16 ++++++++-------- .../api_reference/resources/credits/credits.md | 2 +- .../resources/credits/recipient_information.md | 4 ++-- .../payout_to_cardholder/payout_to_cardholder.md | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/website/content/gateway/api_reference/changes/changes.md b/website/content/gateway/api_reference/changes/changes.md index ede6081..41d35ff 100644 --- a/website/content/gateway/api_reference/changes/changes.md +++ b/website/content/gateway/api_reference/changes/changes.md @@ -10,14 +10,14 @@ Follow coming changes on the [source code repository](https://github.com/clearha Sorted by descending timestamp. -#### Change to name related parameters -Starting XXXX-XX-XX, we will support new name related parameters -`recipient[first_name]`, `recipient[middle_name]`, `recipient[last_name]`, -`sender[first_name]`, `sender[middle_name]` and `sender[last_name]`. This will -in time push for the deprecation of `card[name]`, `recipient[name]` and -`sender[name]`. We will in a grace period allow for both old and new parameters, -but we recommend that you plan the shift as we can't guarantee how long our -upstream provider supports the old fields. +#### Add recipient and sender parameters for individual name parts +Starting 2025-XX-XX, the new name-related parameters `recipient[first_name]`, +`recipient[middle_name]`, `recipient[last_name]`, `sender[first_name]`, +`sender[middle_name]` and `sender[last_name]` are supported. +This will in time push for the deprecation of `card[name]`, `recipient[name]` +and `sender[name]`. Both old and new parameters will be supported +in a grace period, however, it is recommended that you plan the shift as we +cannot guarantee how long our upstream provider supports the old fields. #### Add minimum amount for Visa captures and refunds Starting 2025-05-19, we will enforce a minimum amount of USD 0.005 for captures diff --git a/website/content/gateway/api_reference/resources/credits/credits.md b/website/content/gateway/api_reference/resources/credits/credits.md index 887f91d..9fe2f65 100644 --- a/website/content/gateway/api_reference/resources/credits/credits.md +++ b/website/content/gateway/api_reference/resources/credits/credits.md @@ -10,7 +10,7 @@ To payout (e.g. winnings and not refunds) money to a cardholder’s bank account POST https://gateway.clearhaus.com/credits ``` -Information about the recipient is required for credits to be compliant with card scheme rules. See [Recipient information](#credit_recipient_information). +Information about the recipient is required for credits under certain circumstances to be compliant with card scheme rules. See [Recipient information](#credit_recipient_information). ##### Parameters {{% description_list %}} diff --git a/website/content/gateway/api_reference/resources/credits/recipient_information.md b/website/content/gateway/api_reference/resources/credits/recipient_information.md index d8d0a9f..100e920 100644 --- a/website/content/gateway/api_reference/resources/credits/recipient_information.md +++ b/website/content/gateway/api_reference/resources/credits/recipient_information.md @@ -13,7 +13,7 @@ See the partner guideline for more details. {{% description_details %}}The recipient's legal first name. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} -{{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW.{{% /regex_optional %}} +{{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW, i.e. it is only optional for Visa and for Mastercard domestic non-PoW.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}recipient[middle_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} @@ -25,7 +25,7 @@ See the partner guideline for more details. {{% description_details %}}The recipient's legal last name. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} -{{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW.{{% /regex_optional %}} +{{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW, i.e. it is only optional for Visa and for Mastercard domestic non-PoW.{{% /regex_optional %}} {{% /description_details %}} {{% /description_list %}} diff --git a/website/content/gateway/examples/payout_to_cardholder/payout_to_cardholder.md b/website/content/gateway/examples/payout_to_cardholder/payout_to_cardholder.md index 07dd21d..b946890 100644 --- a/website/content/gateway/examples/payout_to_cardholder/payout_to_cardholder.md +++ b/website/content/gateway/examples/payout_to_cardholder/payout_to_cardholder.md @@ -33,5 +33,5 @@ Example response (snippet): } ``` -The field {{% highlight_text %}}recipient[first_name]{{% /highlight_text %}} and {{% highlight_text %}}recipient[last_name]{{% /highlight_text %}} is mandatory for Mastercard Payment of winnings (gaming/gambling merchants). +The fields {{% highlight_text %}}recipient[first_name]{{% /highlight_text %}} and {{% highlight_text %}}recipient[last_name]{{% /highlight_text %}} are required for Mastercard Payment of Winnings (PoW, i.e. gaming/gambling merchants) and for Mastercard cross-border non-PoW. Depending on card scheme and merchant category, the name on the card might be necessary for approval of credits. From 30dd3c029b81ba6394aee4c0c3009b11add1cce5 Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Fri, 13 Jun 2025 12:40:58 +0200 Subject: [PATCH 06/14] Re-add card[name] with deprecation notice --- .../gateway/api_reference/resources/credits/credits.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/content/gateway/api_reference/resources/credits/credits.md b/website/content/gateway/api_reference/resources/credits/credits.md index 9fe2f65..454a7a5 100644 --- a/website/content/gateway/api_reference/resources/credits/credits.md +++ b/website/content/gateway/api_reference/resources/credits/credits.md @@ -52,6 +52,11 @@ Information about the recipient is required for credits under certain circumstan {{% regex_optional %}}Optional.{{% /regex_optional %}} {{% /description_details %}} +{{% description_term %}}{{% strike %}}card[name]{{% /strike %}} {{% regex %}}[A-Za-z0-9 ]{1,30}{{% /regex %}}{{% /description_term %}} +{{% description_details %}} +{{% regex_optional %}}Deprecated, see [Recipient information](#credit_recipient_information) instead.{{% /regex_optional %}} +{{% /description_details %}} + {{% /description_list %}} {{% notice %}} From 82588c61e758bce1f844016657a9eb589942745d Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Fri, 13 Jun 2025 12:47:22 +0200 Subject: [PATCH 07/14] Re-add recipient[name] with deprecation notice --- .../api_reference/resources/debits/recipient_information.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/content/gateway/api_reference/resources/debits/recipient_information.md b/website/content/gateway/api_reference/resources/debits/recipient_information.md index a9cfe1f..3fb97ee 100644 --- a/website/content/gateway/api_reference/resources/debits/recipient_information.md +++ b/website/content/gateway/api_reference/resources/debits/recipient_information.md @@ -9,6 +9,11 @@ See the partner guideline for more details. {{% description_list %}} +{{% description_term %}}{{% strike %}}recipient[name]{{% /strike %}} {{% regex %}}[\x20-\x7E]{2,30} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}} +{{% regex_optional %}}Deprecated, see `recipient[first_name]`, `recipient[middle_name]` and `recipient[last_name]` instead.{{% /regex_optional %}} +{{% /description_details %}} + {{% description_term %}}recipient[first_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}}The recipient's legal first name. From 5fea861468a25c6bf3f57c26c0b9bd4f49fb98b5 Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Fri, 13 Jun 2025 12:49:01 +0200 Subject: [PATCH 08/14] Re-add sender[name] with deprecation notice --- .../api_reference/resources/debits/sender_information.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/content/gateway/api_reference/resources/debits/sender_information.md b/website/content/gateway/api_reference/resources/debits/sender_information.md index e64f7fb..52faf3c 100644 --- a/website/content/gateway/api_reference/resources/debits/sender_information.md +++ b/website/content/gateway/api_reference/resources/debits/sender_information.md @@ -11,6 +11,11 @@ Intra-EEA, mentioned below, includes the United Kingdom and Gibraltar. {{% description_list %}} +{{% description_term %}}{{% strike %}}sender[name]{{% /strike %}} {{% regex %}}[\x20-\x7E]{2,30} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} +{{% description_details %}} +{{% regex_optional %}}Deprecated, see `sender[first_name]`, `sender[middle_name]` and `sender[last_name]` instead.{{% /regex_optional %}} +{{% /description_details %}} + {{% description_term %}}sender[first_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}}The sender's legal first name. From 7b4aff8091b3bfff4fa980e8aee5dcdcdf37cb9e Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Fri, 13 Jun 2025 13:03:45 +0200 Subject: [PATCH 09/14] Update debit recipient with mutual information --- .../resources/debits/recipient_information.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/website/content/gateway/api_reference/resources/debits/recipient_information.md b/website/content/gateway/api_reference/resources/debits/recipient_information.md index 3fb97ee..8d65fd3 100644 --- a/website/content/gateway/api_reference/resources/debits/recipient_information.md +++ b/website/content/gateway/api_reference/resources/debits/recipient_information.md @@ -12,25 +12,30 @@ See the partner guideline for more details. {{% description_term %}}{{% strike %}}recipient[name]{{% /strike %}} {{% regex %}}[\x20-\x7E]{2,30} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}} {{% regex_optional %}}Deprecated, see `recipient[first_name]`, `recipient[middle_name]` and `recipient[last_name]` instead.{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `recipient[first_name]`, `recipient[middle_name]` and `recipient[last_name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}recipient[first_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}}The recipient's legal first name. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} -{{% regex_optional %}}Required.{{% /regex_optional %}} +{{% regex_optional %}}Required, mutually with `recipient[last_name]`{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}recipient[middle_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}}The recipient's legal middle name in case of any. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% regex_optional %}}If set requires `recipient[first_name]` and `recipient[last_name]` to be set.{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}recipient[last_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}}The recipient's legal last name. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} -{{% regex_optional %}}Required.{{% /regex_optional %}} +{{% regex_optional %}}Required, mutually with `recipient[first_name]`{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}recipient[account_number] {{% regex %}}[\x20-\x7E]{1,34} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} From 6fcc07c32d8575273415d89aca99e574611fdac9 Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Fri, 13 Jun 2025 13:06:30 +0200 Subject: [PATCH 10/14] Update debit sender with mutual information --- .../api_reference/resources/debits/sender_information.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/website/content/gateway/api_reference/resources/debits/sender_information.md b/website/content/gateway/api_reference/resources/debits/sender_information.md index 52faf3c..7cc6634 100644 --- a/website/content/gateway/api_reference/resources/debits/sender_information.md +++ b/website/content/gateway/api_reference/resources/debits/sender_information.md @@ -14,6 +14,7 @@ Intra-EEA, mentioned below, includes the United Kingdom and Gibraltar. {{% description_term %}}{{% strike %}}sender[name]{{% /strike %}} {{% regex %}}[\x20-\x7E]{2,30} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}} {{% regex_optional %}}Deprecated, see `sender[first_name]`, `sender[middle_name]` and `sender[last_name]` instead.{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `sender[first_name]`, `sender[middle_name]` and `sender[last_name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}sender[first_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} @@ -21,12 +22,16 @@ Intra-EEA, mentioned below, includes the United Kingdom and Gibraltar. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required for intra-EEA and international debits. Also required if any of the address-related parameters are supplied.{{% /regex_optional %}} +{{% regex_optional %}}Required, mutually with `sender[last_name]`{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `sender[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}sender[middle_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}}The sender's legal middle name in case of any. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% regex_optional %}}If set requires `sender[first_name]` and `sender[last_name]` to be set.{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `sender[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}sender[last_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} @@ -34,6 +39,8 @@ Intra-EEA, mentioned below, includes the United Kingdom and Gibraltar. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required for intra-EEA and international debits. Also required if any of the address-related parameters are supplied.{{% /regex_optional %}} +{{% regex_optional %}}Required, mutually with `sender[first_name]`{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `sender[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}sender[address] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} From cbbe52c1917e5a25149e5efeec6bda2f4baecf9d Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Fri, 13 Jun 2025 13:12:30 +0200 Subject: [PATCH 11/14] Update credit recipient with mutual information --- .../resources/credits/recipient_information.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/website/content/gateway/api_reference/resources/credits/recipient_information.md b/website/content/gateway/api_reference/resources/credits/recipient_information.md index 100e920..42a0f90 100644 --- a/website/content/gateway/api_reference/resources/credits/recipient_information.md +++ b/website/content/gateway/api_reference/resources/credits/recipient_information.md @@ -14,11 +14,15 @@ See the partner guideline for more details. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW, i.e. it is only optional for Visa and for Mastercard domestic non-PoW.{{% /regex_optional %}} +{{% regex_optional %}}Required, mutually with `recipient[last_name]`{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}recipient[middle_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}}The recipient's legal middle name in case of any. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} +{{% regex_optional %}}If set requires `recipient[first_name]` and `recipient[last_name]` to be set.{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}recipient[last_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} @@ -26,6 +30,8 @@ See the partner guideline for more details. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW, i.e. it is only optional for Visa and for Mastercard domestic non-PoW.{{% /regex_optional %}} +{{% regex_optional %}}Required, mutually with `recipient[first_name]`{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% /description_list %}} From 45d20e368ce5abd8109fb353cf0625efd3753a36 Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Fri, 13 Jun 2025 13:14:14 +0200 Subject: [PATCH 12/14] Update credit card[name] with mutual exclusive information --- .../content/gateway/api_reference/resources/credits/credits.md | 1 + 1 file changed, 1 insertion(+) diff --git a/website/content/gateway/api_reference/resources/credits/credits.md b/website/content/gateway/api_reference/resources/credits/credits.md index 454a7a5..0fda740 100644 --- a/website/content/gateway/api_reference/resources/credits/credits.md +++ b/website/content/gateway/api_reference/resources/credits/credits.md @@ -55,6 +55,7 @@ Information about the recipient is required for credits under certain circumstan {{% description_term %}}{{% strike %}}card[name]{{% /strike %}} {{% regex %}}[A-Za-z0-9 ]{1,30}{{% /regex %}}{{% /description_term %}} {{% description_details %}} {{% regex_optional %}}Deprecated, see [Recipient information](#credit_recipient_information) instead.{{% /regex_optional %}} +{{% regex_optional %}}Mutually exclusive with `recipient`.{{% /regex_optional %}} {{% /description_details %}} {{% /description_list %}} From e45d04b88e73036d8db04854f7e6c4f60fba1c88 Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Mon, 16 Jun 2025 20:58:31 +0200 Subject: [PATCH 13/14] Apply suggestions from code review Co-authored-by: Martin Toft Bay --- website/content/gateway/api_reference/changes/changes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/content/gateway/api_reference/changes/changes.md b/website/content/gateway/api_reference/changes/changes.md index 41d35ff..0639cc5 100644 --- a/website/content/gateway/api_reference/changes/changes.md +++ b/website/content/gateway/api_reference/changes/changes.md @@ -13,10 +13,10 @@ Sorted by descending timestamp. #### Add recipient and sender parameters for individual name parts Starting 2025-XX-XX, the new name-related parameters `recipient[first_name]`, `recipient[middle_name]`, `recipient[last_name]`, `sender[first_name]`, -`sender[middle_name]` and `sender[last_name]` are supported. -This will in time push for the deprecation of `card[name]`, `recipient[name]` +`sender[middle_name]` and `sender[last_name]` are supported. +This will in time push for the deprecation of `card[name]`, `recipient[name]` and `sender[name]`. Both old and new parameters will be supported -in a grace period, however, it is recommended that you plan the shift as we +in a grace period, however, it is recommended that you plan the switch as we cannot guarantee how long our upstream provider supports the old fields. #### Add minimum amount for Visa captures and refunds From 6518cd9e8e27ffc1dc1aade64af9be464e63de63 Mon Sep 17 00:00:00 2001 From: Christian Bobach Date: Mon, 16 Jun 2025 21:09:27 +0200 Subject: [PATCH 14/14] Update based on review comments by @mt-clearhaus --- .../resources/credits/recipient_information.md | 4 +--- .../api_reference/resources/debits/recipient_information.md | 6 +++--- .../api_reference/resources/debits/sender_information.md | 4 +--- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/website/content/gateway/api_reference/resources/credits/recipient_information.md b/website/content/gateway/api_reference/resources/credits/recipient_information.md index 42a0f90..c19f7d7 100644 --- a/website/content/gateway/api_reference/resources/credits/recipient_information.md +++ b/website/content/gateway/api_reference/resources/credits/recipient_information.md @@ -14,14 +14,13 @@ See the partner guideline for more details. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW, i.e. it is only optional for Visa and for Mastercard domestic non-PoW.{{% /regex_optional %}} -{{% regex_optional %}}Required, mutually with `recipient[last_name]`{{% /regex_optional %}} {{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}recipient[middle_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}}The recipient's legal middle name in case of any. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} -{{% regex_optional %}}If set requires `recipient[first_name]` and `recipient[last_name]` to be set.{{% /regex_optional %}} +{{% regex_optional %}}If set, it requires `recipient[first_name]` and `recipient[last_name]` to be set.{{% /regex_optional %}} {{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} @@ -30,7 +29,6 @@ See the partner guideline for more details. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required for Mastercard Payment of Winnings (PoW) and for Mastercard cross-border non-PoW, i.e. it is only optional for Visa and for Mastercard domestic non-PoW.{{% /regex_optional %}} -{{% regex_optional %}}Required, mutually with `recipient[first_name]`{{% /regex_optional %}} {{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} diff --git a/website/content/gateway/api_reference/resources/debits/recipient_information.md b/website/content/gateway/api_reference/resources/debits/recipient_information.md index 8d65fd3..1d2ddc0 100644 --- a/website/content/gateway/api_reference/resources/debits/recipient_information.md +++ b/website/content/gateway/api_reference/resources/debits/recipient_information.md @@ -19,14 +19,14 @@ See the partner guideline for more details. {{% description_details %}}The recipient's legal first name. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} -{{% regex_optional %}}Required, mutually with `recipient[last_name]`{{% /regex_optional %}} +{{% regex_optional %}}Required.{{% /regex_optional %}} {{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} {{% description_term %}}recipient[middle_name] {{% regex %}}[\x20-\x7E]{1,35} [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters){{% /regex %}}{{% /description_term %}} {{% description_details %}}The recipient's legal middle name in case of any. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} -{{% regex_optional %}}If set requires `recipient[first_name]` and `recipient[last_name]` to be set.{{% /regex_optional %}} +{{% regex_optional %}}If set, it requires `recipient[first_name]` and `recipient[last_name]` to be set.{{% /regex_optional %}} {{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} @@ -34,7 +34,7 @@ See the partner guideline for more details. {{% description_details %}}The recipient's legal last name. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} -{{% regex_optional %}}Required, mutually with `recipient[first_name]`{{% /regex_optional %}} +{{% regex_optional %}}Required.{{% /regex_optional %}} {{% regex_optional %}}Mutually exclusive with `recipient[name]`.{{% /regex_optional %}} {{% /description_details %}} diff --git a/website/content/gateway/api_reference/resources/debits/sender_information.md b/website/content/gateway/api_reference/resources/debits/sender_information.md index 7cc6634..084e2b0 100644 --- a/website/content/gateway/api_reference/resources/debits/sender_information.md +++ b/website/content/gateway/api_reference/resources/debits/sender_information.md @@ -22,7 +22,6 @@ Intra-EEA, mentioned below, includes the United Kingdom and Gibraltar. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required for intra-EEA and international debits. Also required if any of the address-related parameters are supplied.{{% /regex_optional %}} -{{% regex_optional %}}Required, mutually with `sender[last_name]`{{% /regex_optional %}} {{% regex_optional %}}Mutually exclusive with `sender[name]`.{{% /regex_optional %}} {{% /description_details %}} @@ -30,7 +29,7 @@ Intra-EEA, mentioned below, includes the United Kingdom and Gibraltar. {{% description_details %}}The sender's legal middle name in case of any. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} -{{% regex_optional %}}If set requires `sender[first_name]` and `sender[last_name]` to be set.{{% /regex_optional %}} +{{% regex_optional %}}If set, it requires `sender[first_name]` and `sender[last_name]` to be set.{{% /regex_optional %}} {{% regex_optional %}}Mutually exclusive with `sender[name]`.{{% /regex_optional %}} {{% /description_details %}} @@ -39,7 +38,6 @@ Intra-EEA, mentioned below, includes the United Kingdom and Gibraltar. {{% regex_optional %}}It must not contain special characters (?, @, #, $, &, \*, etc.), be all numeric, be fictious, be a nickname or be incomplete.{{% /regex_optional %}} {{% regex_optional %}}Required for intra-EEA and international debits. Also required if any of the address-related parameters are supplied.{{% /regex_optional %}} -{{% regex_optional %}}Required, mutually with `sender[first_name]`{{% /regex_optional %}} {{% regex_optional %}}Mutually exclusive with `sender[name]`.{{% /regex_optional %}} {{% /description_details %}}