Open
Conversation
✅ Deploy Preview for incomparable-tiramisu-91a96a ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
ntombing
reviewed
Feb 16, 2026
| ### Settled status {#settled-status} | ||
|
|
||
| When the `Settled` status is applied to these transactions, it means that a Credit Transfer has been `Booked` on the account to settle the merchant. | ||
| The individual card transactions don't impact the balance. The `Settled` status is final and doesn't affect the balance. Instead, the Credit Transfer impacts the `Booked` balance directly. |
Contributor
There was a problem hiding this comment.
Suggested change
| The individual card transactions don't impact the balance. The `Settled` status is final and doesn't affect the balance. Instead, the Credit Transfer impacts the `Booked` balance directly. | |
| Individual card transactions don't affect the balance. The `Settled` status is final and doesn't affect the balance. Instead, the Credit Transfer affects the `Booked` balance directly. |
ntombing
reviewed
Feb 16, 2026
| For example, one payment might include a capture transaction and a refund transaction, for a total of two transactions. | ||
|
|
||
| These transactions are grouped together in the **merchant payment object**. | ||
| Swan recommends using the merchant payment object in your integration to help merchants match orders, invoices, and sales to the correct object. |
Contributor
There was a problem hiding this comment.
Suggested change
| Swan recommends using the merchant payment object in your integration to help merchants match orders, invoices, and sales to the correct object. | |
| Swan suggests using the merchant payment object in your integration. This helps merchants match orders, invoices, and sales to the right payment.``` |
ntombing
reviewed
Feb 16, 2026
|
|
||
| | Transaction type | Explanation | Possible statuses | | ||
| | --- | --- | --- | | ||
| | `CardInCredit` | Captured payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `CardInCredit` | Captured payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | |
| | `CardInCredit` | Captured payment that will eventually get settled through a separate credit transfer. | `Upcoming`, `Settled` | |
Contributor
There was a problem hiding this comment.
Update Credit Transfer -> credit transfer
ntombing
reviewed
Feb 16, 2026
| | Transaction type | Explanation | Possible statuses | | ||
| | --- | --- | --- | | ||
| | `CardInCredit` | Captured payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | ||
| | `CardInCreditReversal` | Refunded payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `CardInCreditReversal` | Refunded payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | |
| | `CardInCreditReversal` | Refunded payment that will eventually get settled through a separate Credit Transfer. | `Upcoming`, `Settled` | |
ntombing
reviewed
Feb 16, 2026
| | --- | --- | --- | | ||
| | `CardInCredit` | Captured payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | ||
| | `CardInCreditReversal` | Refunded payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | ||
| | `CardInCreditChargeback` | Disputed payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `CardInCreditChargeback` | Disputed payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | |
| | `CardInCreditChargeback` | Disputed payment that will eventually get settled through a separate Credit Transfer. | `Upcoming`, `Settled` | |
ntombing
reviewed
Feb 16, 2026
| | `CardInCredit` | Captured payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | ||
| | `CardInCreditReversal` | Refunded payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | ||
| | `CardInCreditChargeback` | Disputed payment that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | ||
| | `CardInCreditChargebackReversal` | Disputed payment for which the dispute is overturned, that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `CardInCreditChargebackReversal` | Disputed payment for which the dispute is overturned, that will eventually get settled via a separate Credit Transfer. | `Upcoming`, `Settled` | | |
| | `CardInCreditChargebackReversal` | Disputed payment for which the dispute is overturned, that will eventually get settled through a separate Credit Transfer. | `Upcoming`, `Settled` | |
ntombing
reviewed
Feb 16, 2026
|
|
||
| These transactions are grouped together in the **merchant payment object**. | ||
| Swan recommends using the merchant payment object in your integration to help merchants match orders, invoices, and sales to the correct object. | ||
| This provides better traceability and can help reconcile issues more efficiently. |
Contributor
There was a problem hiding this comment.
Suggested change
| This provides better traceability and can help reconcile issues more efficiently. | |
| This makes it easier to track payments and helps reconcile issues more efficiently. |
ntombing
reviewed
Feb 16, 2026
|
|
||
| ### Settled status {#settled-status} | ||
|
|
||
| When the `Settled` status is applied to these transactions, it means that a Credit Transfer has been `Booked` on the account to settle the merchant. |
Contributor
There was a problem hiding this comment.
Maybe more direct/active:
The Settled status indicates that a Credit Transfer was Booked on the account to settle the merchant.
ntombing
reviewed
Feb 16, 2026
| When the `Settled` status is applied to these transactions, it means that a Credit Transfer has been `Booked` on the account to settle the merchant. | ||
| The individual card transactions don't impact the balance. The `Settled` status is final and doesn't affect the balance. Instead, the Credit Transfer impacts the `Booked` balance directly. | ||
|
|
||
| Every `Settled` transaction includes a `settlementTransactionId` field to identify the Credit Transfer impacting the balance. |
Contributor
There was a problem hiding this comment.
Suggested change
| Every `Settled` transaction includes a `settlementTransactionId` field to identify the Credit Transfer impacting the balance. | |
| Every `Settled` transaction has a `settlementTransactionId` to identify the Credit Transfer affecting the balance. |
Contributor
There was a problem hiding this comment.
I don't think we need to use the word "field" in this context.
ntombing
reviewed
Feb 16, 2026
|
|
||
| | Payment object status | Explanation | | ||
| | --- | --- | | ||
| | `Initiated` | The payment has been created on the terminal app and is ready to be taken. | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `Initiated` | The payment has been created on the terminal app and is ready to be taken. | | |
| | `Initiated` | The payment was created on the terminal app and is ready to be taken. | |
ntombing
reviewed
Feb 16, 2026
| Every `Settled` transaction includes a `settlementTransactionId` field to identify the Credit Transfer impacting the balance. | ||
| Additionally, each Credit Transfer received to settle in-person card transactions includes the list of settled transactions. | ||
|
|
||
| ## Payment object statuses {#payment-statuses} |
Contributor
There was a problem hiding this comment.
This could benefit from a mermaid diagram showing the lifecycle. Here's a similar one for SDDs.
ntombing
reviewed
Feb 16, 2026
| The merchant payment object has **distinct balances** to follow a payment's lifecycle. | ||
| Use these balances to understand what actions have been done on a payment, and what actions can be taken (such as canceling or refunding a payment). | ||
|
|
||
| | Payment object balance | Explanation | |
Contributor
There was a problem hiding this comment.
This and the cards "Payment object balances" can be a partial as they're the same. It'll help if you need to make an update later.
ntombing
reviewed
Feb 16, 2026
|
|
||
| ## Settlement process {#settlement} | ||
|
|
||
| For in-person card payments, the settlement comes in the form of a Credit Transfer. |
Contributor
There was a problem hiding this comment.
Suggested change
| For in-person card payments, the settlement comes in the form of a Credit Transfer. | |
| For in-person card payments, the settlement is a credit transfer. |
ntombing
reviewed
Feb 16, 2026
| For in-person card payments, the settlement comes in the form of a Credit Transfer. | ||
|
|
||
| 1. When the merchant payment is created, underlying transactions are created as `Upcoming`. | ||
| 1. When the settlement arrives in the form of a Credit Transfer, the transactions are updated to `Settled`. |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. When the settlement arrives in the form of a Credit Transfer, the transactions are updated to `Settled`. | |
| 1. When the settlement arrives as a Credit Transfer, the transactions are updated to `Settled`. |
ntombing
reviewed
Feb 16, 2026
Contributor
There was a problem hiding this comment.
For consistency, I suggest choosing either "impact" or "affect" when referring to the balance, e.g., affects the booked balance.
ntombing
reviewed
Feb 16, 2026
|
|
||
| 1. When the merchant payment is created, underlying transactions are created as `Upcoming`. | ||
| 1. When the settlement arrives in the form of a Credit Transfer, the transactions are updated to `Settled`. | ||
| 1. The card transactions themselves don't affect any of the account balances. However, the Credit Transfer is immediately `Booked`, affecting the balance, making the corresponding funds available. |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. The card transactions themselves don't affect any of the account balances. However, the Credit Transfer is immediately `Booked`, affecting the balance, making the corresponding funds available. | |
| 1. The credit transfer is immediately `Booked`. It affects the balance and makes the corresponding funds available. Card transactions don't affect any of the account balances. |
Contributor
There was a problem hiding this comment.
Prioritising what happens in the steps.
ntombing
reviewed
Feb 16, 2026
| 1. When the merchant payment is created, underlying transactions are created as `Upcoming`. | ||
| 1. When the settlement arrives in the form of a Credit Transfer, the transactions are updated to `Settled`. | ||
| 1. The card transactions themselves don't affect any of the account balances. However, the Credit Transfer is immediately `Booked`, affecting the balance, making the corresponding funds available. | ||
| 1. Transactions captured on a given day are `Settled` **1 business day** later. No rolling reserve applies on the settlement Credit Transfer. |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. Transactions captured on a given day are `Settled` **1 business day** later. No rolling reserve applies on the settlement Credit Transfer. | |
| 1. Transactions captured on a given day are `Settled` within **one business day** later. No rolling reserve applies to the settlement credit transfer. |
ntombing
reviewed
Feb 16, 2026
|
|
||
| ## Refunds {#refunds} | ||
|
|
||
| import InPersonCardRefundLimitation from '../partials/_in-person-card-refund-limitation.mdx'; |
Contributor
There was a problem hiding this comment.
Update the link in the callout to the support request form. Right now, it leads to the Support Center. Here's the link: https://supportform.swan.io/
ntombing
reviewed
Feb 16, 2026
|
|
||
| ## Chargebacks and disputes {#chargebacks} | ||
|
|
||
| Cardholders might create chargebacks, which opens a dispute. |
Contributor
There was a problem hiding this comment.
Suggested change
| Cardholders might create chargebacks, which opens a dispute. | |
| Cardholders might request a chargeback, which opens a dispute. |
ntombing
reviewed
Feb 16, 2026
| ## Chargebacks and disputes {#chargebacks} | ||
|
|
||
| Cardholders might create chargebacks, which opens a dispute. | ||
| Merchants can view the dispute automatically; the merchant payment object status and balances all change to reflect the dispute. |
Contributor
There was a problem hiding this comment.
Suggested change
| Merchants can view the dispute automatically; the merchant payment object status and balances all change to reflect the dispute. | |
| Merchants can automatically view the dispute; the merchant payment object status and balances are updated to reflect the dispute. |
ntombing
reviewed
Feb 16, 2026
|
|
||
| Cardholders might create chargebacks, which opens a dispute. | ||
| Merchants can view the dispute automatically; the merchant payment object status and balances all change to reflect the dispute. | ||
| However, it's not possible to act on these disputes directly via Swan's APIs or dashboards. |
Contributor
There was a problem hiding this comment.
Suggested change
| However, it's not possible to act on these disputes directly via Swan's APIs or dashboards. | |
| However, it's not possible to act on these disputes directly using Swan's APIs or dashboards. |
ntombing
reviewed
Feb 16, 2026
| Merchants can view the dispute automatically; the merchant payment object status and balances all change to reflect the dispute. | ||
| However, it's not possible to act on these disputes directly via Swan's APIs or dashboards. | ||
|
|
||
| To respond to disputes, ask your merchant to [submit a request](https://support.swan.io) to the Swan Support team. |
Contributor
There was a problem hiding this comment.
Update to support form link: https://supportform.swan.io/
ntombing
reviewed
Feb 16, 2026
| @@ -0,0 +1,4 @@ | |||
| :::caution Refunds not supported | |||
| Refunds are currently not supported for in-person card payments. | |||
| To initiate a refund, ask your merchant to [submit a request](https://support.swan.io) to the Swan Support team. | |||
Contributor
There was a problem hiding this comment.
Suggested change
| To initiate a refund, ask your merchant to [submit a request](https://support.swan.io) to the Swan Support team. | |
| To initiate a refund, ask your merchant to [submit a request](https://supportform.swan.io) to the Swan Support team. |
ntombing
reviewed
Feb 16, 2026
Contributor
There was a problem hiding this comment.
We use sentence case for "Credit transfers" in headings and lowercase "credit transfers" within body text when referring to the payment method generally. We use caps when we're referring to the proper noun e.g. SEPA Credit Transfer. See this page for reference.
ntombing
requested changes
Feb 16, 2026
Contributor
ntombing
left a comment
ntombing
left a comment
There was a problem hiding this comment.
Hello! Great work on this. I've left a few comments and suggestions to polish it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.