Update underwriting details (sunsetting) | Moov Documentation
Update underwriting details (sunsetting)
Create or update the account's underwriting.
Read our underwriting guide to learn more.
To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/profile.write scope.
PUT
/accounts/{accountID}/underwriting
Ask
curl -X PUT "https://api.moov.io/accounts/{accountID}/underwriting" \
-H "Authorization: Bearer {token}" \
-H "X-Moov-Version: v2026.07.00" \
-d '{
"averageTransactionSize": 0,
"maxTransactionSize": 0,
"averageMonthlyTransactionVolume": 0,
"volumeByCustomerType": {
"businessToBusinessPercentage": 0,
"consumerToBusinessPercentage": 0
},
"cardVolumeDistribution": {
"ecommercePercentage": 0,
"cardPresentPercentage": 0,
"mailOrPhonePercentage": 0,
"debtRepaymentPercentage": 0
},
"fulfillment": {
"hasPhysicalGoods": true,
"isShippingProduct": true,
"shipmentDurationDays": 0,
"returnPolicy": "none"
}
}'
Ask
mc, _ := moov.NewClient()
var accountID string
update := moov.UpdateUnderwriting{
AverageTransactionSize: 1_500,
MaxTransactionSize: 1_200,
AverageMonthlyTransactionVolume: 11_000,
VolumeByCustomerType: moov.VolumeByCustomerType{
BusinessToBusinessPercentage: 60,
ConsumerToBusinessPercentage: 40,
},
CardVolumeDistribution: moov.CardVolumeDistribution{
EcommercePercentage: 60,
CardPresentPercentage: 40,
MailOrPhonePercentage: 0,
DebtRepaymentPercentage: 0,
},
Fulfillment: moov.Fulfillment{
HasPhysicalGoods: true,
IsShippingProduct: true,
ShipmentDurationDays: 3,
ReturnPolicy: moov.EXCHANGE_ONLY,
},
}
mc.UpsertUnderwriting(ctx, accountID, update)
Ask
import { Moov } from "@moovio/sdk";
const moov = new Moov({
security: {
username: "",
password: "",
},
});
async function run() {
const result = await moov.underwriting.upsert({
accountID: "371bf394-45df-4ba8-a615-ad5483b1f963",
updateUnderwriting: {
averageTransactionSize: 622191,
maxTransactionSize: 123692,
averageMonthlyTransactionVolume: 438164,
volumeByCustomerType: {
businessToBusinessPercentage: 671399,
consumerToBusinessPercentage: 482010,
},
cardVolumeDistribution: {
ecommercePercentage: 47450,
cardPresentPercentage: 146275,
mailOrPhonePercentage: 309315,
debtRepaymentPercentage: 990303,
},
fulfillment: {
hasPhysicalGoods: true,
isShippingProduct: true,
shipmentDurationDays: 388451,
returnPolicy: "other",
},
},
});
console.log(result);
}
run();
Ask
declare(strict_types=1);
require 'vendor/autoload.php';
use Moov o his.request()
class MoovPhp {
public function upsert() {
return ["...etc..."];
}
}
Ask
package hello.world;
import io.moov.sdk.Moov;
import io.moov.sdk.models.components.*;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.errors.UpdateUnderwritingError;
import io.moov.sdk.models.operations.UpsertUnderwritingResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GenericError, UpdateUnderwritingError, Exception {
Moov sdk = Moov.builder()
.security(Security.builder()
.username("")
.password("")
.build())
.build();
UpsertUnderwritingResponse res = sdk.underwriting().upsert()
.accountID("371bf394-45df-4ba8-a615-ad5483b1f963")
.updateUnderwriting(UpdateUnderwriting.builder()
.averageTransactionSize(622191L)
.maxTransactionSize(123692L)
.averageMonthlyTransactionVolume(438164L)
.volumeByCustomerType(VolumeByCustomerType.builder()
.businessToBusinessPercentage(671399)
.consumerToBusinessPercentage(482010)
.build())
.cardVolumeDistribution(CardVolumeDistribution.builder()
.ecommercePercentage(47450)
.cardPresentPercentage(146275)
.mailOrPhonePercentage(309315)
.debtRepaymentPercentage(990303)
.build())
.fulfillment(FulfillmentDetails.builder()
.hasPhysicalGoods(true)
.isShippingProduct(true)
.shipmentDurationDays(388451L)
.returnPolicy(ReturnPolicyType.OTHER)
.build())
.build())
.call();
if (res.underwriting().isPresent()) {
System.out.println(res.underwriting().get());
}
}
}
Ask
from moovio_sdk import Moov
from moovio_sdk.models import components
with Moov(
security=components.Security(
username="",
password="",
),
) as moov:
res = moov.underwriting.upsert(account_id="371bf394-45df-4ba8-a615-ad5483b1f963", average_transaction_size=622191, max_transaction_size=123692, average_monthly_transaction_volume=438164, volume_by_customer_type={
"business_to_business_percentage": 671399,
"consumer_to_business_percentage": 482010,
}, card_volume_distribution={
"ecommerce_percentage": 47450,
"card_present_percentage": 146275,
"mail_or_phone_percentage": 309315,
"debt_repayment_percentage": 990303,
}, fulfillment={
"has_physical_goods": True,
"is_shipping_product": True,
"shipment_duration_days": 388451,
"return_policy": components.ReturnPolicyType.OTHER,
})
# Handle response
print(res)
Ask
require 'moov_ruby'
Models = ::Moov::Models
s = ::Moov::Client.new(
security: Models::Components::Security.new(
username: '',
password: ''
)
)
res = s.underwriting.upsert(account_id: '371bf394-45df-4ba8-a615-ad5483b1f963', update_underwriting: Models::Components::UpdateUnderwriting.new(
average_transaction_size: 622_191,
max_transaction_size: 123_692,
average_monthly_transaction_volume: 438_164,
volume_by_customer_type: Models::Components::VolumeByCustomerType.new(
business_to_business_percentage: 671_399,
consumer_to_business_percentage: 482_010
),
card_volume_distribution: Models::Components::CardVolumeDistribution.new(
ecommerce_percentage: 47_450,
card_present_percentage: 146_275,
mail_or_phone_percentage: 309_315,
debt_repayment_percentage: 990_303
),
fulfillment: Models::Components::FulfillmentDetails.new(
has_physical_goods: true,
is_shipping_product: true,
shipment_duration_days: 388_451,
return_policy: Models::Components::ReturnPolicyType::OTHER
)
))
unless res.underwriting.nil?
# handle response
end
Ask
using Moov.Sdk;
using Moov.Sdk.Models.Components;
var sdk = new MoovClient(security: new Security() {
Username = "",
Password = "",
});
var res = await sdk.Underwriting.UpsertAsync(
accountID: "371bf394-45df-4ba8-a615-ad5483b1f963",
body: new UpdateUnderwriting() {
AverageTransactionSize = 622191,
MaxTransactionSize = 123692,
AverageMonthlyTransactionVolume = 438164,
VolumeByCustomerType = new VolumeByCustomerType() {
BusinessToBusinessPercentage = 671399,
ConsumerToBusinessPercentage = 482010,
},
CardVolumeDistribution = new CardVolumeDistribution() {
EcommercePercentage = 47450,
CardPresentPercentage = 146275,
MailOrPhonePercentage = 309315,
DebtRepaymentPercentage = 990303,
},
Fulfillment = new FulfillmentDetails() {
HasPhysicalGoods = true,
IsShippingProduct = true,
ShipmentDurationDays = 388451,
ReturnPolicy = ReturnPolicyType.Other,
},
}
);
// handle response
The request completed successfully.
Example
Describes underwriting values (in USD) used for card payment acceptance.
{
"averageTransactionSize": 0,
"maxTransactionSize": 0,
"averageMonthlyTransactionVolume": 0,
"status": "approved",
"volumeByCustomerType": {
"businessToBusinessPercentage": 0,
"consumerToBusinessPercentage": 0
},
"cardVolumeDistribution": {
"ecommercePercentage": 0,
"cardPresentPercentage": 0,
"mailOrPhonePercentage": 0,
"debtRepaymentPercentage": 0
},
"fulfillment": {
"hasPhysicalGoods": true,
"isShippingProduct": true,
"shipmentDurationDays": 0,
"returnPolicy": "none"
},
"geographicReach": "international-only",
"businessPresence": "commercial-office",
"pendingLitigation": "bankruptcy-or-insolvency",
"volumeShareByCustomerType": {
"business": 0,
"consumer": 0,
"p2p": 0
},
"collectFunds": {
"ach": {
"estimatedActivity": {
"averageTransactionAmount": 0,
"maximumTransactionAmount": 0,
"monthlyVolumeRange": "under-10k"
}
},
"cardPayments": {
"cardAcceptanceMethods": {
"inPersonPercentage": 0,
"mailOrPhonePercentage": 0,
"onlinePercentage": 0
},
"currentlyAcceptsCards": true,
"estimatedActivity": {
"averageTransactionAmount": 0,
"maximumTransactionAmount": 0,
"monthlyVolumeRange": "under-10k"
},
"fulfillment": {
"method": "bill-or-debt-payment",
"timeframe": "immediate"
},
"refundPolicy": "conditional-refund"
}
},
"moneyTransfer": {
"pullFromCard": {
"estimatedActivity": {
"averageTransactionAmount": 0,
"maximumTransactionAmount": 0,
"monthlyVolumeRange": "under-10k"
}
},
"pushToCard": {
"estimatedActivity": {
"averageTransactionAmount": 0,
"maximumTransactionAmount": 0,
"monthlyVolumeRange": "under-10k"
}
}
},
"sendFunds": {
"ach": {
"estimatedActivity": {
"averageTransactionAmount": 0,
"maximumTransactionAmount": 0,
"monthlyVolumeRange": "under-10k"
}
},
"pushToCard": {
"estimatedActivity": {
"averageTransactionAmount": 0,
"maximumTransactionAmount": 0,
"monthlyVolumeRange": "under-10k"
}
},
"rtp": {
"estimatedActivity": {
"averageTransactionAmount": 0,
"maximumTransactionAmount": 0,
"monthlyVolumeRange": "under-10k"
}
},
"instantBank": {
"estimatedActivity": {
"averageTransactionAmount": 0,
"maximumTransactionAmount": 0,
"monthlyVolumeRange": "under-10k"
}
}
}
}
Response headers
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
Response headers
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
A unique identifier used to trace requests.
The requested resource was not found.
Response headers
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
Response headers
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.
Response headers
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
A unique identifier used to trace requests.
Set this header to v2026.07.00 to use the API described in this specification. When omitted, the server defaults to v2024.01.00, which may not match the behavior documented here.
Possible values:
v2026.07.00
Show child attributes
Show child attributes
Possible values:
none,
exchangeOnly,
withinThirtyDays,
other
Show child attributes
Describes underwriting values (in USD) used for card payment acceptance.
Possible values:
commercial-office,
home-based,
mixed-presence,
mobile-business,
online-only,
retail-storefront
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The low value in each range is included. The high value in each range is excluded.
Possible values:
under-10k,
10k-50k,
50k-100k,
100k-250k,
250k-500k,
500k-1m,
1m-5m,
over-5m
Show child attributes
Describes the distribution of card transactions by payment method.
Show child attributes
Percentage of card transactions that are in-person payments. Minimum value is 0, maximum is 100.
Percentage of card transactions that are mail or phone payments. Minimum value is 0, maximum is 100.
Percentage of card transactions that are online payments. Minimum value is 0, maximum is 100.
Show child attributes
The low value in each range is included. The high value in each range is excluded.
Possible values:
under-10k,
10k-50k,
50k-100k,
100k-250k,
250k-500k,
500k-1m,
1m-5m,
over-5m
Show child attributes
Possible values:
bill-or-debt-payment,
digital-content,
donation,
in-person-service,
local-pickup-or-delivery,
other,
remote-service,
shipped-physical-goods,
subscription-or-membership
Possible values:
immediate,
other,
over-30-days,
pre-order,
recurring-schedule,
schedule-event,
within-30-days,
within-7-days
Possible values:
conditional-refund,
custom-policy,
event-based-policy,
full-refund-extended-window,
full-refund-within-30-days,
no-refunds,
partial-refund,
prorated-refund,
store-credit-only
Show child attributes
Possible values:
none,
exchangeOnly,
withinThirtyDays,
other
Possible values:
international-only,
us-and-international,
us-only
Show child attributes
Show child attributes
Show child attributes
The low value in each range is included. The high value in each range is excluded.
Possible values:
under-10k,
10k-50k,
50k-100k,
100k-250k,
250k-500k,
500k-1m,
1m-5m,
over-5m
Show child attributes
Show child attributes
The low value in each range is included. The high value in each range is excluded.
Possible values:
under-10k,
10k-50k,
50k-100k,
100k-250k,
250k-500k,
500k-1m,
1m-5m,
over-5m
Show child attributes
Show child attributes
The low value in each range is included. The high value in each range is excluded.
Possible values:
under-10k,
10k-50k,
50k-100k,
100k-250k,
250k-500k,
500k-1m,
1m-5m,
over-5m
Possible values:
approved,
rejected,
pendingReview,
pending,
notRequested
Show child attributes
Show child attributes