Simulate credit (sandbox only)

post

https://sandbox.bankingcircleconnect.com/api/v1/payments/simulations/credits

Simulate a credit on a given account (sandbox only)

Body Params

Simulate credit payment request information

creditorAccount

object

required

Account of the creditor

The account currency determines whether the payment should simulate usage of FX:
* Account currency equals amount currency = Simulate non-FX payment
* Account currency not equal amount currency = Simulate FX payment

ultimateBeneficiaryAccount

string | null

Account of the ultimate beneficiary

If provided the payment is simulated as an agency banking payment.

ultimateBeneficiaryFinancialInstitution

string | null

Financial institution of ultimate beneficiary

If provided the payment is simulated as an agency banking payment.

amount

object

An amount

scheme

string

required

The payment scheme to use for the simulated payment

Valid values:
* SEPA_DD (amount currency must be set to EUR)
* BACS_DD (amount currency must be set to GBP)
* SEPA (amount currency must be set to EUR)
* SEPAINST (amount currency must be set to EUR)
* FPS (amount currency must be set to GBP)

Responses

Language

Credentials

Bearer

Response

Choose an example:

application/json

200Success

400Bad Request

404Not Found