Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SEP-6] Add location_id to withdrawal #1433

Merged
merged 6 commits into from
Feb 21, 2024
Merged

[SEP-6] Add location_id to withdrawal #1433

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
30d7862
Add location_id
Ifropc Feb 6, 2024
2ba38f0
Updates
Ifropc Feb 9, 2024
b37ac9f
Merge branch 'master' into SEP-6-extra
Ifropc Feb 9, 2024
c7369e4
Merge remote-tracking branch 'origin/master' into SEP-6-extra
Ifropc Feb 9, 2024
270c164
Merge branch 'master' into SEP-6-extra
Ifropc Feb 12, 2024
5210de9
Merge branch 'master' into SEP-6-extra
Ifropc Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions ecosystem/sep-0006.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Title: Deposit and Withdrawal API
Author: SDF
Status: Active (Interactive components are deprecated in favor of SEP-24)
Created: 2017-10-30
Updated: 2024-01-25
Version 3.25.0
Updated: 2024-02-09
Version 3.26.0
```

## Simple Summary
Expand Down Expand Up @@ -420,6 +420,7 @@ Request Parameters:
| `country_code` | string | (optional) The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code of the user's current address. This field may be necessary for the anchor to determine what KYC information is necessary to collect. |
| `claimable_balance_supported` | string | (optional) `true` if the client supports receiving deposit transactions as a claimable balance, `false` otherwise. |
| `customer_id` | string | (optional) id of an off-chain account (managed by the anchor) associated with this user's Stellar account (identified by the JWT's `sub` field). If the anchor supports [SEP-12], the `customer_id` field should match the [SEP-12] customer's id. `customer_id` should be passed only when the off-chain id is know to the client, but the relationship between this id and the user's Stellar account is not known to the Anchor. |
| `location_id` | string | (optional) optional) id of the chosen location to drop off cash |

The request parameters also must include the required fields from the `/info` endpoint.

Expand Down Expand Up @@ -726,6 +727,7 @@ Request parameters:
| `refund_memo` | string | (optional) The memo the anchor must use when sending refund payments back to the user. If not specified, the anchor should use the same memo used by the user to send the original payment. If specified, `refund_memo_type` must also be specified. |
| `refund_memo_type` | string | (optional) The type of the `refund_memo`. Can be `id`, `text`, or `hash`. See the [memos](https://developers.stellar.org/docs/encyclopedia/memos) documentation for more information. If specified, `refund_memo` must also be specified. |
| `customer_id` | string | (optional) id of an off-chain account (managed by the anchor) associated with this user's Stellar account (identified by the JWT's `sub` field). If the anchor supports [SEP-12], the `customer_id` field should match the [SEP-12] customer's id. `customer_id` should be passed only when the off-chain id is know to the client, but the relationship between this id and the user's Stellar account is not known to the Anchor. |
| `location_id` | string | (optional) id of the chosen location to pick up cash |

The request parameters also must include the required fields from the `/info` endpoint.

Expand Down Expand Up @@ -828,6 +830,7 @@ Request Parameters:
| `country_code` | string | (optional) The [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code of the user's current address. This field may be necessary for the anchor to determine what KYC information is necessary to collect. |
| `claimable_balance_supported` | string | (optional) `true` if the client supports receiving deposit transactions as a claimable balance, `false` otherwise. |
| `customer_id` | string | (optional) id of an off-chain account (managed by the anchor) associated with this user's Stellar account (identified by the JWT's `sub` field). If the anchor supports [SEP-12], the `customer_id` field should match the [SEP-12] customer's id. `customer_id` should be passed only when the off-chain id is know to the client, but the relationship between this id and the user's Stellar account is not known to the Anchor. |
| `location_id` | string | (optional) optional) id of the chosen location to drop off cash |

Examples:

Expand Down Expand Up @@ -882,6 +885,7 @@ Request parameters:
| `refund_memo` | (optional) The memo the anchor must use when sending refund payments back to the user. If not specified, the anchor should use the same memo used by the user to send the original payment. If specified, `refund_memo_type` must also be specified. |
| `refund_memo_type` | (optional) The type of the `refund_memo`. Can be `id`, `text`, or `hash`. See the [memos](https://developers.stellar.org/docs/encyclopedia/memos) documentation for more information. If specified, `refund_memo` must also be specified. |
| `customer_id` | string | (optional) id of an off-chain account (managed by the anchor) associated with this user's Stellar account (identified by the JWT's `sub` field). If the anchor supports [SEP-12], the `customer_id` field should match the [SEP-12] customer's id. `customer_id` should be passed only when the off-chain id is know to the client, but the relationship between this id and the user's Stellar account is not known to the Anchor. |
| `location_id` | string | (optional) id of the chosen location to pick up cash |

Example:

Expand Down Expand Up @@ -1757,6 +1761,7 @@ object containing an error message.

## Changelog

- `v3.26.0`: Add `location_id` to deposit/withdrawal requests ([#1433](https://github.com/stellar/stellar-protocol/pull/1433))
- `v3.25.0` Add `fee_details` field to the transaction object
[#1429](https://github.com/stellar/stellar-protocol/pull/1429)
- `v3.24.1`: Get required KYC fields from transaction object only
Expand Down
Loading