Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Testing credits

Generate credits for testing purposes

Generate a credit (inbound payment) to a budget in sandbox.

This endpoint is for testing purposes only and won't work in production.

post/budgets/generate-credit

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

thirdPartyReferencestring

A unique reference provided by your integrating product.

budgetIdstring uuid required

The ID of the budget to work with.

orderIdstring

The ID of the order used to fulfil the transfer request.

accountIdentifierstring

Identifier of the account, could be iban or account number

settlementPriceAmountstring required

The settlement amount.

settlementPriceCurrency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHN' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWD' required
remittersNamestring required

The name of the remitter.

referencestring

The reference of the credit.

bankIdentifierstring

The bank identifier.

remittersAddressstring required

The remitter's address.

beneficiaryNamestring required

The name of the beneficiary of the credit.

institutionNamestring

The name of the institution making the credit.

institutionAddressstring

The address of the institution making the credit.

schemeName'FasterPayment' | 'BACS' | 'CHAPS' | 'Swift' | 'SEPA'

The name of the scheme used to process the credit.

Example request

{
  "thirdPartyReference": "1e3f1734-6f7a-17e5-ae22-11cd18757ef4",
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "orderId": "string",
  "accountIdentifier": "string",
  "settlementPriceAmount": "string",
  "settlementPriceCurrency": "USD",
  "remittersName": "William Walker",
  "reference": "REF-123-456",
  "bankIdentifier": "string",
  "remittersAddress": "41 Middle Street, Enfield, EN1 3JY",
  "beneficiaryName": "John Smith",
  "institutionName": "string",
  "institutionAddress": "string",
  "schemeName": "FasterPayment"
}

Response

OK

object required

Example response

{}