Prebuilt binaries of the gateway-server server are available on the releases page.

Alternatively, you can build the binary yourself.

The config.toml file must be present in a working directory. Config file should contain following values:

• port - server listening port
• api_key - when set, all requests to gateway server must contain api_key parameter with a correct value, otherwise the server will respond with 503 Forbidden
• network_passphrase - passphrase of the network that will be used with this gateway server, default: Test SDF Network ; September 2015
• horizon - URL to horizon server instance
• assets - array of approved assets codes that this server can authorize and send
• database
  • type - database type (sqlite3, mysql, postgres)
  • url - url to database connection
• accounts
  • authorizing_seed - secret seed of the account to send allow_trust operations
  • issuing_seed - secret seed of the account to send payment operations
  • receiving_account_id - ID of the account to track incoming payments
• hooks
  • receive - URL of the webhook where requests will be sent when a new payment appears in receiving account. WARNING Gateway server can send multiple requests to this webhook for a single payment! You need to be prepared for it. See: Security.
  • error - URL of the webhook where requests will be sent when there is an error with incoming payment

Check config-example.toml.

After creating config.toml file, you need to run DB migrations:

./gateway --migrate-db

Then you can start the server:

./gateway

Content-Type of requests data should be application/x-www-form-urlencoded.

Builds and submits a transaction with a single payment operation built from following parameters.

Check SubmitTransactionResponse struct.

curl -X POST -d \
"source=SBNDIK4N7ZM3ZJKDJJDWDSPSRPHNI2RFL36WNNNEGQEW3G3AH6VJ2QB7&\
amount=1&\
destination=GBIUXI4S27PSL6TTJCJMPYDCF3K6AW2MYORFRTC7QBFE6NNEGVOQK46H&\
asset_code=USD&\
asset_issuer=GASZUHRFAFIZX5LR4WNHBWUXJBZNBEWCHFTR4XZHPF5TMVM5XUZBP5DT&\
memo_type=id&\
memo=125" \
http://localhost:8001/payment

Builds and submits a transaction with a allow_trust operation. The source of this transaction will be the account specified by accounts.authorizing_seed config parameter.

Check SubmitTransactionResponse struct.

Builds and submits a transaction with a payment operation. The source of this transaction will be the account specified by accounts.issuing_seed config parameter.

Check SubmitTransactionResponse struct.

Gateway server listens for payment operations to the account specified by accounts.receiving_account_id. Every time a payment arrives it will send a HTTP POST request to hooks.receive.

The POST request with following parameters will be sent to this hook when a payment arrives.

Warning! This hook can be called multiple times. Please check id parameter and respond with 200 OK in case of duplicate payment.

Response with 200 OK when processing succeeded. Any other status code will be considered an error.

• This server must be set up in an isolated environment (ex. AWS VPC). Please make sure your firewall is properly configured and accepts connections from a trusted IPs only. You can also set api_key config parameter but it's not recommended. If you will not set this properly, an unauthorized person will be able to submit transactions from your accounts!
• Make sure hooks accepts connections from the gateway server IP only.
• Remember that hooks.receive may be called multiple times with the same payment. Check id parameter and ignore requests with the same value (just send 200 OK response).

gb is used for building and testing.

Given you have a running golang installation, you can build the server with:

gb build

After successful completion, you should find bin/gateway is present in the project directory.

gb test