Skip to main content
POST
/
miles
/
transfer
/
create
Transfer miles into a Rove account
curl --request POST \
  --url https://api.staging.rovemiles.com/functions/v1/miles/transfer/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "amount": 25000,
  "reference_id": "transfer_1234567890"
}
'
{
  "transaction_id": "01HQXYZ123456789ABCDEFGHIJ",
  "reference_id": "transfer_1234567890",
  "status": "success"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Add your API key to the Authorization header with this format: 'Bearer your_api_key_here'

Body

application/json
​
account_id
string<uuid>
required

Rove Miles account UUID of the recipient (required if phone_number not provided)

​
amount
integer
required

Amount of miles to transfer (min: 1, max: 999,999)

Required range: 1 <= x <= 999999
​
reference_id
string
required

Unique reference ID for the transfer (used for idempotency)

​
phone_number
string

Phone number of the recipient account (required if account_id not provided)

Pattern: ^(\+1|1)[0-9]+$

Response

Success

​
transaction_id
string

Unique ID for the completed miles transfer

​
reference_id
string

The reference ID provided in the request

​
status
enum<string>

Status of the transfer

Available options:
success,
pending,
failed