name*yourdomain.com
into account IDs like: GCCVPYFOHY7ZB7557JKENAX62LUAPLMGIWNZJAFV2MITK6T32V37KEJU
. Buds addresses provide an easy way for users to share payment details by using a syntax that interoperates across different domains and providers.name*yourdomain.com
into account IDs like: GCCVPYFOHY7ZB7557JKENAX62LUAPLMGIWNZJAFV2MITK6T32V37KEJU
. Federated addresses provide an easy way for users to share payment details by using a syntax that interoperates across different domains and providers.*
: the username and the domain.*
: the username and the domain.jed*bantu.org
:flarcos*Bantu.network
:flarcos
is the username,Bantu.network
is the domain.@
symbol is allowed in the username. This means you can use email addresses in the username of a Buds address. For example: [email protected]*Bantu.network
.https://YOUR_DOMAIN/.well-known/bantu.toml
. Complete instructions for doing that can be found in the bantu.toml specifciation (aka SEP-1).https://YOUR_DOMAIN/.well-known/Bantu.toml
. Complete instructions for doing that can be found in the Bantu.toml specifciation (aka SEP-1).FEDERATION_SERVER
section to your bantu.toml file that tells other people the URL of your federation endpoint.Buds_SERVER
section to your Bantu.toml file that tells other people the URL of your Buds endpoint.Buds_SERVER="https://api.yourdomain.com/buds"
https
protocol.GET
requests with the following form:?q=<string to look up>&type=<name,forward,id,txid>
https://YOUR_FEDERATION_SERVER/federation?q=jed*bantu.org&type=name
forward
federation request. If you are unable to forward or the other parameters in the request are incorrect you should return an error to this effect. Example request: https://YOUR_FEDERATION_SERVER/federation?type=forward&forward_type=bank_account&swift=BOPBPHMM&acct=2382376
https://YOUR_FEDERATION_SERVER/federation?q=GD6WU64OEP5C4LRBH6NK3MHYIA2ADN6K6II6EXPNVUR3ERBXT4AN4ACD&type=id
https://YOUR_FEDERATION_SERVER/federation?q=c1b368c00e9852351361e07cc58c54277e7a6366580044ab152b8db9cd8ec52a&type=txid
https://YOUR_Buds_SERVER/Buds?q=flarcos*bantu.networ&type=name
forward
Buds request. If you are unable to forward or the other parameters in the request are incorrect you should return an error to this effect. Example request: https://YOUR_Buds_SERVER/Buds?type=forward&forward_type=bank_account&swift=BOPBPHMM&acct=2382376
https://YOUR_Buds_SERVER/Buds?q=GD6WU64OEP5C4LRBH6NK3MHYIA2ADN6K6II6EXPNVUR3ERBXT4AN4ACD&type=id
https://YOUR_Buds_SERVER/Buds?q=c1b368c00e9852351361e07cc58c54277e7a6366580044ab152b8db9cd8ec52a&type=txid
200 OK
http status code and the following JSON body:3xx
http status code and immediately redirect the user to the correct URL using the Location
header.404 Not Found
http status code should be returned.