Skip to content

Ramp: Post sync status — request body — body

Post sync status: request body, field body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Post sync status — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
failed_syncsarrayOptionalA list of objects that failed to be synced.
Maximum items: 5000
Minimum items: 1
failed_syncs[]ModelEach itemExpand Post sync status — request body — body failed syncs item
idempotency_keystringRequired within parentAn idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. To avoid collisions, we encourage clients to use random generated UUIDs.
mark_ready_to_syncbooleanOptionalMark successful transaction syncs ready before recording completion, clearing their accounting requirements. Only supported for TRANSACTION_SYNC without sync_request_id; failed_syncs are not marked ready. Defaults to false.
successful_syncsarrayOptionalA list of successfully synced objects.
Maximum items: 5000
Minimum items: 1
successful_syncs[]ModelEach itemExpand Post sync status — request body — body successful syncs item
sync_request_idJSONOptional
sync_request_id (anyOf 1)stringAlternativeFor Sync Button flows, provide the sync request ID received from the TRANSACTION_SYNC_REQUESTED, REIMBURSEMENT_SYNC_REQUESTED, or ACCRUAL_SYNC_REQUESTED outbound webhook. Do not provide this value for non-Sync Button flows.
Default: null
Format: uuid
sync_request_id (anyOf 2)nullAlternative
sync_typestringRequired within parentThe type of object to sync.
One of: ACCRUAL_SYNC, BILL_PAYMENT_SYNC, BILL_SYNC, BROKERAGE_ORDER_SYNC, RECOGNITION_SCHEDULE_ENTRY_SYNC, REIMBURSEMENT_SYNC, REPAYMENT_SYNC, STATEMENT_CREDIT_SYNC, TRANSACTION_SYNC, TRANSFER_SYNC, WALLET_TRANSFER_SYNC

Referenced models: Post sync status — request body — body failed syncs item, Post sync status — request body — body successful syncs item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.