API Reference

Create transfer

post
https://api.synapto.construction/v1/accounts//transfers

Required capability: payouts

BETA: This endpoint is subject to change without notice.

Transfers held balance from a parent account to one of its child accounts. Optionally set description and metadata on the transfer.

Returns the created Transfer.

Path Params
string
required
Body Params
string
required

Name of the receiving (child) account.

Example: "accounts/acct_abc123"

string
required

Amount to transfer in the currency's minor unit.

Example: 5000 for £50.00

string
required

ISO-4217 currency code.

Example: "GBP"

string

Optional human-readable description for the transfer. Appears on the balance lines of both sender and recipient.

Example: "April rent"

metadata
object

Client supplied metadata. At most 50 keys with a max length of 40 characters are permitted. Values may be strings up to 500 characters each.

Response

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago