POST /v1/topups

Top up the balance of an account

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
source String No

The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see Testing Top-ups).

description String No

An arbitrary string attached to the object. Often useful for displaying to users.

amount Integer Yes

A positive integer representing how much to transfer.

expand[] Array No

Specifies which fields in the response should be expanded.

metadata No

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

transfer_group String No

A string that identifies this top-up as part of a group.

statement_descriptor String No

Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.

currency String Yes

Three-letter ISO currency code, in lowercase. Must be a supported currency.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.