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.

SecurityCommonAuth
Request
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50072
Request Body schema: application/json
required
thirdPartyReference
string

A unique reference provided by your integrating product.

budgetId
required
string <uuid>

The ID of the budget receiving the credit.

settlementPriceAmount
required
string^[0-9]+$

The settlement amount.

settlementPriceCurrency
required
string

The currency of the settlement, in ISO 4217 format.

remittersName
required
string

The name of the remitter.

reference
string

The reference of the credit.

bankIdentifier
string^[0-9]+$

The bank identifier.

remittersAddress
required
string

The remitter's address.

beneficiaryName
required
string

The name of the beneficiary of the credit.

institutionName
string <= 35 characters

The name of the institution making the credit.

institutionAddress
string <= 109 characters

The address of the institution making the credit.

schemeName
string

The name of the scheme used to process the credit.

Enum: "FasterPayment" "BACS" "CHAPS" "Swift" "SEPA"
Responses
200

OK

400

Bad request

404

Not found

405

Method not allowed

500

Internal server error

post/budgets/generate-credit
Request samples
application/json
{
  • "thirdPartyReference": "1e3f1734-6f7a-17e5-ae22-11cd18757ef4",
  • "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
  • "settlementPriceAmount": "200",
  • "settlementPriceCurrency": "GBP",
  • "remittersName": "William Walker",
  • "reference": "REF-123-456",
  • "bankIdentifier": "0123",
  • "remittersAddress": "41 Middle Street, Enfield, EN1 3JY",
  • "beneficiaryName": "John Smith",
  • "institutionName": "ACME",
  • "institutionAddress": "32 Marlborough Street, London, N9 7QD",
  • "schemeName": "FasterPayment"
}
Response samples
application/json
{ }