Simulate Prefund Payment

post

https://partner-api.getpliant.com/api/test-data-generator/organizations/prefund

🔒
Required scope: platform:write
The API credential calling this endpoint must be granted the platform category with read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

Simulate a prefund payment to an existing organizations card account. The payment will appear in the system within 10 minutes after the request was sent.
This endpoint is ONLY available on our sandbox environment and NOT on production. See documentation for details.

Body Params

organizationId

uuid

required

The id of the organization for which the payment should occur.

cardAccountId

uuid | null

The id of the card account of the organization to use. If not provided, the default card account of the organization will be used. If provided, it has precedence over the organizationId parameter.

amount

object

required

The amount to prefund the card account with. The currency must match the currency of the card account.

fromAccount

string | null

If provided, the prefund will be simulated from this account. Example: DE89370400440532013000 (has to be a valid IBAN – to generate an IBAN please check here

transfersAllowedStatus

string | null

enum

Status of the newly added bank account for this prefund payment (when this parameter is given fromAccount will be defined by the system if not given in this request).
Possible statuses are REVIEW, AUTHORIZED, BLOCKED.

REVIEW is a default status that will require manual intervention.
AUTHORIZED will make the payment appear on the balance directly.
BLOCKED will block the account and all current and future payments from it.
Defaults to AUTHORIZED.

Allowed:

Responses

200

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.