Skip to content

Commit

Permalink
[SEP-6] Add location_id to withdrawal (#1433)
Browse files Browse the repository at this point in the history 
* Add location_id

* Updates
  • Loading branch information
@Ifropc
Ifropc authored Feb 21, 2024
1 parent 6565084 commit c521ed4
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions ecosystem/sep-0006.md
View file
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

0 comments on commit c521ed4

Please sign in to comment.