Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Merchants
Admin
Dev

Dev-only: simulate an inbound wire onto the merchant refund account via the merchant's fake cross-border provider. Refused in production. Refused if the merchant is not enrolled with a fake provider, so it can never trigger a real TransferMate call.

Dev-only: simulate an inbound wire onto the merchant refund account via the merchant's fake cross-border provider. Refused in production. Refused if the merchant is not enrolled with a fake provider, so it can never trigger a real TransferMate call.

post/api/v1/admin/dev/merchants/{merchantId}/refund-account/simulate-top-up

Path parameters

merchantIdstring uuid required

The merchantId parameter

Request body

amountnumber required

Decimal amount to credit (account currency)

currencystring required

ISO 4217 currency of the merchant refund account to credit

referencestring

Payer reference shown on the activity row

payerstring

Payer display name shown on the activity row

descriptionstring

Free-text description

providerstring

Optional provider name to scope the top-up to (e.g. "transfermate" vs "fake-transfermate" on envs where both are fake-backed).

Example request

{
  "amount": 250,
  "currency": "GBP",
  "provider": "transfermate"
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true
}