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

Get merchant statement

Retrieve a statement by its ID.

Use the Accept header to specify the format of the response. Supported formats are application/json and application/pdf.

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

GET
/accounts/{accountID}/statements/{statementID}
cURL Python TypeScript Java Ruby (beta) PHP 
1
2

curl -X GET "https://api.moov.io/accounts/{accountID}/statements/{statementID}" \
  -H "Authorization: Bearer {token}" \

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

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    x_moov_version="v2024.01.00",
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.statements.get(account_id="5623ff52-0b05-41ea-b7b3-655835064007", statement_id="9d45acbf-c4fe-4843-846c-eaa43c9ca17f")

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  xMoovVersion: "v2024.01.00",
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.statements.get({
    accountID: "5623ff52-0b05-41ea-b7b3-655835064007",
    statementID: "9d45acbf-c4fe-4843-846c-eaa43c9ca17f",
  });

  console.log(result);
}

run();
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

package hello.world;

import java.lang.Exception;
import org.openapis.openapi.Moov;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.operations.GetStatementResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .xMoovVersion("v2024.01.00")
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        GetStatementResponse res = sdk.statements().get()
                .accountID("5623ff52-0b05-41ea-b7b3-655835064007")
                .statementID("9d45acbf-c4fe-4843-846c-eaa43c9ca17f")
                .call();

        if (res.statement().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
      x_moov_version: 'v2024.01.00',
      security: Models::Components::Security.new(
        username: '',
        password: '',
      ),
    )

res = s.statements.get(account_id: '5623ff52-0b05-41ea-b7b3-655835064007', statement_id: '9d45acbf-c4fe-4843-846c-eaa43c9ca17f')

unless res.statement.nil?
  # handle response
end
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setXMoovVersion('v2024.01.00')
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->statements->get(
    accountID: '5623ff52-0b05-41ea-b7b3-655835064007',
    statementID: '9d45acbf-c4fe-4843-846c-eaa43c9ca17f'

);

if ($response->statement !== null) {
    // handle response
}
200 401 403 404 429 500 504
The request has succeeded.
application/json application/pdf
Example
A billing statement for a Moov account.
{
  "statementID": "77496e4d-d30a-43db-84ae-c3147da377ff",
  "statementName": "string",
  "fileName": "string",
  "fileSize": 0,
  "billingPeriodStartDateTime": "2019-08-24T14:15:22Z",
  "billingPeriodEndDateTime": "2019-08-24T14:15:22Z",
  "subscriptionIDs": [
    "string"
  ],
  "summary": {
    "cardAcquiring": {
      "volumeAmount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "volumeCount": 0,
      "feeAmount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "interchangeFees": {
        "visa": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "mastercard": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "discover": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "americanExpress": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      }
    },
    "ach": {
      "volumeAmount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "volumeCount": 0,
      "feeAmount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "instantPayments": {
      "volumeAmount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "volumeCount": 0,
      "feeAmount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "platformFees": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    },
    "adjustmentFees": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    },
    "otherFees": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    },
    "total": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    }
  },
  "cardAcquiringFees": {
    "visa": {
      "interchange": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "interchangePrograms": [
        {
          "programName": "string",
          "count": 0,
          "percentageRate": 0,
          "perItemRate": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "total": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "transferVolume": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        }
      ],
      "networkPassthrough": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedDomesticOnline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedDomesticInPerson": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedInternationalOnline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedInternationalInPerson": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "declines": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "refunds": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "total": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      }
    },
    "mastercard": {
      "interchange": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "interchangePrograms": [
        {
          "programName": "string",
          "count": 0,
          "percentageRate": 0,
          "perItemRate": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "total": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "transferVolume": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        }
      ],
      "networkPassthrough": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedDomesticOnline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedDomesticInPerson": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedInternationalOnline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedInternationalInPerson": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "declines": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "refunds": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "total": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      }
    },
    "discover": {
      "interchange": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "interchangePrograms": [
        {
          "programName": "string",
          "count": 0,
          "percentageRate": 0,
          "perItemRate": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "total": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "transferVolume": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        }
      ],
      "networkPassthrough": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedDomesticOnline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedDomesticInPerson": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedInternationalOnline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedInternationalInPerson": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "declines": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "refunds": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "total": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      }
    },
    "americanExpress": {
      "interchange": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "interchangePrograms": [
        {
          "programName": "string",
          "count": 0,
          "percentageRate": 0,
          "perItemRate": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "total": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "transferVolume": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        }
      ],
      "networkPassthrough": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedDomesticOnline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedDomesticInPerson": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedInternationalOnline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "completedInternationalInPerson": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "declines": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "refunds": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "total": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      }
    }
  },
  "achFees": {
    "standardCredit": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "sameDayCredit": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "debits": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "return": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "unauthorizedReturn": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "noticeOfChange": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "total": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    }
  },
  "instantPaymentFees": {
    "rtpCreditTransaction": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "rtpDecline": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "pushToCardTransaction": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "pushToCardDecline": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "pullFromCardTransaction": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "pullFromCardDecline": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "pullFromCardRefund": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "total": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    }
  },
  "platformFees": {
    "walletFee": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    },
    "merchantPCIFee": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    },
    "total": {
      "currency": "USD",
      "valueDecimal": "12.987654321"
    }
  },
  "otherCardFees": {
    "disputes": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "cardAccountUpdater": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "cardVerification": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "nameVerification": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "total": {
      "count": 0,
      "amount": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    }
  },
  "createdOn": "2019-08-24T14:15:22Z",
  "updatedOn": "2019-08-24T14:15:22Z"
}
File Response
Returns a file (binary data, application/pdf).

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
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

Path parameters

accountID

string <uuid> required

statementID

string <uuid> required

Response

application/json application/pdf
A billing statement for a Moov account.

billingPeriodEndDateTime

string<date-time> required
The end date and time of the billing period.

billingPeriodStartDateTime

string<date-time> required
The start date and time of the billing period.

createdOn

string<date-time> required
The date and time the statement was created.

fileName

string required
The name of the statement file.

fileSize

integer<int64> required
The size of the statement file in bytes.

statementID

string<uuid> required
The unique identifier for the statement.

statementName

string required
The name of the statement.

subscriptionIDs

array required
List of subscription IDs associated with this statement.

summary

object required
A summary of all fees included in this statement.
A summary of all fees included in a statement.
Show child attributes

ach

object
A summary of ACH volume and fees.
Details of volume and fees for a specific payment method.
Show child attributes

feeAmount

object
The total fee amount.
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'.

volumeAmount

object
The total transaction volume amount.
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'.

volumeCount

integer<int64>
The total number of transactions.

adjustmentFees

object
The total amount of adjustment 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'.

cardAcquiring

object
A summary of card acquiring volume and fees.
Show child attributes

feeAmount

object
The total fee amount.
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'.

interchangeFees

object
A summary of interchange fees by card brand.
A summary of interchange fees by card brand.
Show child attributes

americanExpress

object required
Total interchange fees for American Express.
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'.

discover

object required
Total interchange fees for Discover.
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'.

mastercard

object required
Total interchange fees for Mastercard.
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'.

visa

object required
Total interchange fees for Visa.
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'.

volumeAmount

object
The total transaction volume amount.
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'.

volumeCount

integer<int64>
The total number of transactions.

instantPayments

object
A summary of instant payment volume and fees.
Details of volume and fees for a specific payment method.
Show child attributes

feeAmount

object
The total fee amount.
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'.

volumeAmount

object
The total transaction volume amount.
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'.

volumeCount

integer<int64>
The total number of transactions.

otherFees

object
The total amount of other 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'.

platformFees

object
The total amount of platform 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'.

total

object
The total amount of all 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'.

updatedOn

string<date-time> required
The date and time the statement was last updated.

achFees

object
A detailed breakdown of ACH fees.
A detailed breakdown of ACH fees.
Show child attributes

debits

object required
Fees for debit transfers.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

noticeOfChange

object required
Fees for notices of change.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

return

object required
Fees for authorized returns.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

sameDayCredit

object required
Fees for same-day credit transfers.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

standardCredit

object required
Fees for standard credit transfers.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

total

object required
Total ACH fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

unauthorizedReturn

object required
Fees for unauthorized returns.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

cardAcquiringFees

object
A detailed breakdown of card acquiring fees.
A detailed breakdown of card acquiring fees by card brand.
Show child attributes

americanExpress

object required
Fees associated with American Express transactions.
A detailed breakdown of fees for a specific card brand.
Show child attributes

completedDomesticInPerson

object
Details of completed domestic in-person transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedDomesticOnline

object
Details of completed domestic online transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedInternationalInPerson

object
Details of completed international in-person transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedInternationalOnline

object
Details of completed international online transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

declines

object
Details of declined transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

interchange

object
Details of interchange fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

interchangePrograms

array
A list of interchange program fees.
Show child attributes

count

integer<int64>
The number of transactions for this program.

perItemRate

object
The per-item rate for this program.
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'.

percentageRate

number<decimal>
The percentage rate for this program.

programName

string
The name of the interchange program.

total

object
The total fee amount for this program.
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'.

transferVolume

object
The total transfer volume for this program.
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'.

networkPassthrough

object
Details of network passthrough fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

refunds

object
Details of refunded transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

total

object required
Total fees for this card brand.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

discover

object required
Fees associated with Discover transactions.
A detailed breakdown of fees for a specific card brand.
Show child attributes

completedDomesticInPerson

object
Details of completed domestic in-person transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedDomesticOnline

object
Details of completed domestic online transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedInternationalInPerson

object
Details of completed international in-person transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedInternationalOnline

object
Details of completed international online transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

declines

object
Details of declined transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

interchange

object
Details of interchange fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

interchangePrograms

array
A list of interchange program fees.
Show child attributes

count

integer<int64>
The number of transactions for this program.

perItemRate

object
The per-item rate for this program.
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'.

percentageRate

number<decimal>
The percentage rate for this program.

programName

string
The name of the interchange program.

total

object
The total fee amount for this program.
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'.

transferVolume

object
The total transfer volume for this program.
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'.

networkPassthrough

object
Details of network passthrough fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

refunds

object
Details of refunded transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

total

object required
Total fees for this card brand.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

mastercard

object required
Fees associated with Mastercard transactions.
A detailed breakdown of fees for a specific card brand.
Show child attributes

completedDomesticInPerson

object
Details of completed domestic in-person transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedDomesticOnline

object
Details of completed domestic online transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedInternationalInPerson

object
Details of completed international in-person transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedInternationalOnline

object
Details of completed international online transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

declines

object
Details of declined transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

interchange

object
Details of interchange fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

interchangePrograms

array
A list of interchange program fees.
Show child attributes

count

integer<int64>
The number of transactions for this program.

perItemRate

object
The per-item rate for this program.
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'.

percentageRate

number<decimal>
The percentage rate for this program.

programName

string
The name of the interchange program.

total

object
The total fee amount for this program.
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'.

transferVolume

object
The total transfer volume for this program.
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'.

networkPassthrough

object
Details of network passthrough fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

refunds

object
Details of refunded transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

total

object required
Total fees for this card brand.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

visa

object required
Fees associated with Visa transactions.
A detailed breakdown of fees for a specific card brand.
Show child attributes

completedDomesticInPerson

object
Details of completed domestic in-person transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedDomesticOnline

object
Details of completed domestic online transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedInternationalInPerson

object
Details of completed international in-person transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

completedInternationalOnline

object
Details of completed international online transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

declines

object
Details of declined transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

interchange

object
Details of interchange fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

interchangePrograms

array
A list of interchange program fees.
Show child attributes

count

integer<int64>
The number of transactions for this program.

perItemRate

object
The per-item rate for this program.
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'.

percentageRate

number<decimal>
The percentage rate for this program.

programName

string
The name of the interchange program.

total

object
The total fee amount for this program.
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'.

transferVolume

object
The total transfer volume for this program.
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'.

networkPassthrough

object
Details of network passthrough fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

refunds

object
Details of refunded transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

total

object required
Total fees for this card brand.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

instantPaymentFees

object
A detailed breakdown of instant payment fees.
A detailed breakdown of instant payment fees.
Show child attributes

pullFromCardDecline

object
Fees for pull-from-card declines.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

pullFromCardRefund

object
Fees for pull-from-card refunds.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

pullFromCardTransaction

object required
Fees for pull-from-card transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

pushToCardDecline

object
Fees for push-to-card declines.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

pushToCardTransaction

object required
Fees for push-to-card transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

rtpCreditTransaction

object required
Fees for RTP credit transactions.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

rtpDecline

object
Fees for RTP declines.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

total

object required
Total instant payment fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

otherCardFees

object
A detailed breakdown of other card-related fees.
A detailed breakdown of other card-related fees.
Show child attributes

cardAccountUpdater

object required
Fees for card account updater services.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

cardVerification

object required
Fees for card verification.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

disputes

object required
Fees for disputes.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

nameVerification

object required
Fees for name verification.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

total

object required
Total other card fees.
Represents a count of items and their total amount.
Show child attributes

amount

object required
The total amount.
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'.

count

integer<int64> required
The number of items.

platformFees

object
A detailed breakdown of platform fees.
A detailed breakdown of platform fees.
Show child attributes

merchantPCIFee

object required
Fees for PCI compliance.
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'.

total

object required
Total platform 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'.

walletFee

object required
Fees associated with wallet services.
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'.

Returns a file (binary data, application/pdf).