APIs
  1. Alfred API
  2. Sandbox

Simulate a deposit (sandbox only)

post
https://api.sandbox.alfredpay.io/v1/test/customers//deposits/simulate

The only way to originate a pay-in from the client side. It runs the real pipeline: detection, attribution, events, screening, conversion and crediting.

Exists on the sandbox host only. On production the path returns 404 not_found.

Idempotency-Key is required, exactly as on any other POST.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
string
amount
object
required
string

Simulates the payer quoting a reference.

sender
object
Headers
uuid
required

Required on every state-changing POST, simulators included; the only exempt POST is …/verifications/preflight.
Replay (same key, same body) returns the original response with Idempotent-Replayed: true; same key with a
different body → 409 idempotency_conflict. Keys are UUIDs, scoped to the API key, retained for 24 hours.

Responses

Updated 8 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago

Did this page help you?