Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Use cases API Changelog
  1. API reference
  2. Moov accounts
  3. Partner billing

Get residuals

Get a residual associated with an account.

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

GET
/accounts/{accountID}/residuals/{residualID}
cURL 
1
2

curl -X GET "https://api.moov.io/accounts/{accountID}/residuals/{residualID}" \
  -H "Authorization: Bearer {token}" \
200 401 403 404 429 500 504
The request completed successfully.
application/json
Example
{
  "residualID": "8df0a983-e21b-44af-a8c4-c35403236f69",
  "partnerAccountID": "c197cd40-7745-4413-8f3b-ec962d1b5225",
  "periodStart": "2019-08-24T14:15:22Z",
  "periodEnd": "2019-08-24T14:15:22Z",
  "merchantFees": {
    "currency": "USD",
    "valueDecimal": "12.987654321"
  },
  "partnerCost": {
    "currency": "USD",
    "valueDecimal": "12.987654321"
  },
  "netIncome": {
    "currency": "USD",
    "valueDecimal": "12.987654321"
  },
  "revenueShare": "2.25",
  "residualAmount": {
    "currency": "USD",
    "valueDecimal": "12.987654321"
  },
  "createdOn": "2019-08-24T14:15:22Z",
  "updatedOn": "2019-08-24T14:15:22Z"
}

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 requested resource was not found.

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

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. When no version is specified, the API defaults to v2024.01.00.

Path parameters

accountID

string <uuid> required

residualID

string <uuid> required
Unique identifier for this residual payment calculation.

Response

application/json

createdOn

string<date-time> required
Timestamp when the residual was created.

merchantFees

object required
Total amount of merchant fees collected during the period. This represents the partner's revenue from merchant fees.
Show child attributes

currency

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

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

netIncome

object required
Net income calculated as merchant fee revenue minus partner costs.
Show child attributes

currency

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

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

partnerAccountID

string<uuid> required
The partner account ID this residual belongs to.

partnerCost

object required
Partner's total cost (buy rate) during the period.
Show child attributes

currency

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

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

periodEnd

string<date-time> required
End date and time of the residual calculation period.

periodStart

string<date-time> required
Start date and time of the residual calculation period.

residualAmount

object required
The amount the partner receives as their share of the net income (netIncome × revenueShare).
Show child attributes

currency

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

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

residualID

string<uuid> required
Unique identifier for this residual payment calculation.

revenueShare

string required
The revenue share percentage the partner receives, expressed as a decimal string (e.g., "25.00" for 25%).

updatedOn

string<date-time> required
Timestamp when the residual was last updated.