Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Money movement
  3. Transfers

Retrieve transfer options

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

Read our transfers overview guide to learn more.

To access this endpoint using an access token you’ll need to specify the /accounts/{accountID}/transfers.read scope.

POST
/transfer-options
cURL Go 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

curl -X POST "https://api.moov.io/transfer-options" \
  -H "Authorization: Bearer {token}" \
  --data-raw '{
    "amount": {
      "value": 100,
      "currency": "USD"
    }
    "destination": {
      "accountID": "UUID"
    },
    "source": {
      "accountID": "UUID"
    }
  }'\

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

mc, _ := moov.NewClient()

mc.TransferOptions(ctx, moov.CreateTransferOptions{
		Source: moov.CreateTransferOptionsTarget{
			AccountID: "UUID",
		},
		Destination: moov.CreateTransferOptionsTarget{
			AccountID: "UUID",
		},
		Amount: moov.Amount{
			Currency: "USD",
			Value:    1,
		},
	})
200 400 401 403 422 429 500 504
The request completed successfully.
{
  "destinationOptions": [
    {
      "paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42",
      "paymentMethodType": "moov-wallet",
      "wallet": {
        "walletID": "0eb7d670-c252-422a-892d-002136c358e0"
      }
    }
  ],
  "sourceOptions": [
    {
      "paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42",
      "paymentMethodType": "moov-wallet",
      "wallet": {
        "walletID": "0eb7d670-c252-422a-892d-002136c358e0"
      }
    }
  ]
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
{
  "error": "string"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
{
  "amount": "string",
  "destination": "string",
  "source": "string"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Body

application/json

amount

object required
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64> required

Quantity in the smallest unit of the specified currency.

In USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.

destination

object required
Show child attributes

accountID

string<uuid>

paymentMethodID

string<uuid>

source

object required
Show child attributes

accountID

string<uuid>

paymentMethodID

string<uuid>

Response

application/json

destinationOptions

array

sourceOptions

array