Skip to content

LOC migration API and webhooks reference

Webhook events

Peach does not fire webhooks during the migration process itself. After migration completes successfully, webhooks begin firing for subsequent loan activity.

EventWhen it fires
loan.migration.succeededMigration completed successfully
loan.migration.failedMigration failed and was rolled back
Events for live activitiesAfter successful migration, webhooks fire for all events created during replay of live activities

API quick reference

ActionMethodEndpoint
Create borrowerPOST/api/people
Create contactPOST/api/people/{personId}/contacts
Create payment instrumentPOST/api/people/{personId}/payment-instruments
Create loan (LOC)POST/api/people/{personId}/loans
List drawsGET/api/people/{personId}/loans/{loanId}/draws
Create drawPOST/api/people/{personId}/loans/{loanId}/draws
Create documentPOST/api/people/{personId}/documents
Upload document contentPOST/api/people/{personId}/documents/{docId}/content
Create past periodsPOST/api/people/{personId}/loans/{loanId}/migration/past-periods
Get past periodsGET/api/people/{personId}/loans/{loanId}/migration/past-periods
Update past periodPUT/api/people/{personId}/loans/{loanId}/migration/past-periods
Delete past periodDELETE/api/people/{personId}/loans/{loanId}/migration/past-periods
Create migration period (LOC)POST/api/people/{personId}/loans/{loanId}/migration/period
Get migration period (LOC)GET/api/people/{personId}/loans/{loanId}/migration/period
Update migration period (LOC)PUT/api/people/{personId}/loans/{loanId}/migration/period
Create migration period (draw)POST/api/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period
Get migration period (draw)GET/api/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period
Update migration period (draw)PUT/api/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period
Update loan statusPUT/api/people/{personId}/loans/{loanId}
Create purchasePOST/api/people/{personId}/loans/{loanId}/draws/{drawId}/purchases
Create past transactionPOST/api/people/{personId}/loans/{loanId}/migration/past-transaction
Get past transactionsGET/api/people/{personId}/loans/{loanId}/migration/past-transaction
Update past transactionPUT/api/people/{personId}/loans/{loanId}/migration/past-transaction/{txnId}
Create transactionPOST/api/people/{personId}/loans/{loanId}/transactions
Create feePOST/api/people/{personId}/loans/{loanId}/fees
Migrate loanPOST/api/people/{personId}/loans/{loanId}/migrate
Get loan (check status)GET/api/people/{personId}/loans/{loanId}
Get balanceGET/api/people/{personId}/loans/{loanId}/balance
Create autopayPOST/api/people/{personId}/loans/{loanId}/autopay
Cancel feePUT/api/people/{personId}/loans/{loanId}/fees/{feeId}/cancel
Reverse transactionPOST/api/people/{personId}/loans/{loanId}/transactions/{txnId}/reverse
Create purchase disputePOST/api/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes
Cancel loanPOST/api/people/{personId}/loans/{loanId}/cancel

See also