Skip to content

Transfers

A transfer is the movement of money between Moov accounts, from source to destination. Provided you have linked a bank account which has been verified, you can initiate a transfer to another Moov account. All you need to do is note a paymentMethod, the $ amount of the transfer, and a brief description.

Create a transfer

Move money by providing the source, destination, and amount in the request body. The path must indicate the platform account initiating the transfer via the URL parameter accountID.

Parameters

Name Type
transfer transfer
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
const transfer = {
  source: {
    paymentMethodID: "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
  },
  destination: {
    paymentMethodID: "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
  },
  amount: {
    currency: "USD",
    value: 1204
  },
  description: "Pay Instructor for May 15 Class"
};
moov.transfers.create({transfer});

List transfers

List all the transfers associated with a particular Moov account.

Parameters

Name Type
accountID UUID string of facilitating account
1
moov.transfers.list();

Get a transfer

Retrieve transfer details such as the amount, source, and destination.

Parameters

Name Type
transferID UUID string
1
2
const transferID = transferID;
moov.transfers.list({transferID});

Get transfer options

Generate available payment method options for one or multiple transfer participants depending on the accountID or paymentMethodID you supply in the request.

Parameters

Name Type
source source
destination destination
amount amount
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const source = {
    accountID: "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    // or
    paymentMethodID: "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
};
const destination = {
    accountID: "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    // or
    paymentMethodID: "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
};
const amount = {
    currency: "USD",
    value: 1204
};
moov.transfers.getOptions({accountID, source, destination, amount});