PApaywithlocus
End users

Reverse an allocation

Moves credits from the end user's balance back to the workspace platform pool, reversing an earlier allocation. Send amounts as decimal strings and reuse the same Idempotency-Key when retrying one logical transfer.

post/credits/end-users/{externalUserId}/deallocate

Request

  • Base URL
    https://api.paywithlocus.com/api
  • URL
    https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/deallocate
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

externalUserIdstring required

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Headers

Idempotency-Keystring required

One key per logical transfer; reuse it on retries.

Request body

creditsstring required

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Response

Credits returned to the platform pool

successunknown required
externalUserIdstring required

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

usdstring required

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

creditsstring required

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

poolBalanceUsdstring required

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

endUserBalanceUsdstring required

Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.

Changes

No recorded changes to this operation across all 1 revision of this API.