Simulate an incoming deposit

post

https://app-dev.paykeeper.com/api/public/escrow/sandbox/deposits

Sandbox only. Makes money arrive in one of your wallets as though a
payer had sent it, so you can test balances, statements and
disbursements without a bank. Send paymentReference for a payer who
quotes the wallet's reference, or accountNumber for one who sends to
a DEDICATED wallet's own account number without it.

A reference or account number that belongs to one of your wallets
posts the credit to it (outcome: MATCHED_BY_REFERENCE or
MATCHED_BY_ACCOUNT_NUMBER) and returns the transactionId that now
appears on the wallet's statement. Anything else well formed posts
nothing (outcome: UNMATCHED).

Status	`code`	When
400	`missing_field`	Neither `paymentReference` nor `accountNumber` is given.
400	`invalid_field`	`paymentReference` is not a ten-character reference, `accountNumber` is not 4 to 17 digits, both are given, or a field is too long.
400	`invalid_amount`	`amount` is not a positive money value with its `currency`.
400	`invalid_body`	The body is not a JSON object.
400	`idempotency_key_required`	There is no `Idempotency-Key` header. Nothing is created.
400	`invalid_idempotency_key`	The `Idempotency-Key` is longer than 255 characters, is not printable ASCII, or was sent twice.
404	`not_found`	Called outside the sandbox.
409	`idempotency_key_in_use`	A request with this `Idempotency-Key` is still running. Send it again after `Retry-After` seconds.
422	`sandbox_deposit_failed`	The credit could not be posted; try again, and quote the `requestId` if it keeps failing.
422	`idempotency_key_reused`	This `Idempotency-Key` was already used for a different request. Use a new key.
503	`upstream_busy`	PayKeeper's banking provider asked it to slow down. Send it again after `Retry-After` seconds, with the same `Idempotency-Key`.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Send exactly one of paymentReference and accountNumber.

paymentReference

string

^[BCDFGHJKLMNPRSTVWXZ0-9]{10}$

The wallet's payment reference, from its funding instructions. Send this or accountNumber.

accountNumber

string

^[0-9]{4,17}$

A DEDICATED wallet's own account number (virtualAccount.accountNumber), for a payer who sends to it without quoting the reference. Send this or paymentReference.

amount

object

required

Greater than zero.

payerName

string

length ≤ 200

Who the money is from, for the statement line.

description

string

length ≤ 500

The statement line. Defaults to "Sandbox deposit from {payerName}".

rail

string

enum

Defaults to WIRE

How the credit arrives.

Allowed:

remittanceInformation

string

length ≤ 500

The memo or addenda text, as a bank would pass it on. Appears on the statement line.

Headers

Idempotency-Key

string

required

length between 1 and 255

A key you generate for this request (a UUID is best) and send again only to retry it, with the same body. Up to 255 printable ASCII characters. See Retries in the introduction.

Responses

201The simulated credit was processed.

400The request is malformed. param names the field. invalid_actor_headers means the request carried x-user-* headers that do not name a valid user; this API does not use them, so leave them out.

401missing_credentials: no HTTP Basic credentials were sent. invalid_credentials: the organization id or access key secret is wrong or revoked.

403The request is well formed but not allowed, or PayKeeper has not set the API up for your organization yet (public_api_not_enabled, on every path).

404Nothing of yours matches.

409The request conflicts with something that already exists.

422The request is valid but cannot be carried out as it stands.

503PayKeeper could not finish safely just now. No money moved, and sending the request again with the same Idempotency-Key is safe; wait Retry-After seconds when the response has it.