Generate credits for testing purposes

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

info

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

Generate a credit

Post/v2/budgets/generate-credit

Request

Use this request to generate a credit.

Sample requestRequest structure

Copy

Copied

curl -i -X POST \
  'https://api-sandbox.equalsmoney.com/v2/budgets/generate-credit?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "thirdPartyReference": "1e3f1734-6f7a-17e5-ae22-11cd18757ef4",
    "budgetId": "fcf1d230-a9d0-4836-9e20-f98f3396e01b",
    "settlementPriceAmount": "200",
    "settlementPriceCurrency": "GBP",
    "remittersName": "William Walker",
    "reference": "REF-123-456",
    "bankIdentifier": "123",
    "remittersAddress": "41 Middle Street, Enfield, EN1 3JY",
    "beneficiaryName": "John Smith",
    "institutionName": "ACME",
    "institutionAddress": "32 Marlborough Street, London, N9 7QD",
    "schemeName": "FasterPayment"
  }'

Copy

Copied

curl -i -X POST \
  'https://api-sandbox.equalsmoney.com/v2/budgets/generate-credit?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "thirdPartyReference": "string",
    "budgetId": "string",
    "settlementPriceAmount": "string",
    "settlementPriceCurrency": "string",
    "remittersName": "string",
    "reference": "string",
    "bankIdentifier": "string",
    "remittersAddress": "string",
    "beneficiaryName": "string",
    "institutionName": "string",
    "institutionAddress": "string",
    "schemeName": "string"
  }'

Request body schema

Parameter	Description
`thirdPartyReference` string	A unique reference provided by your integrating product. Allowable values: A valid string
`budgetId` string (uuid) required	The ID of the budget receiving the credit. Allowable values: An existing `budgetId` (<= 36 characters)
`settlementPriceAmount` string required	The settlement amount. Allowable values: A valid string (`^[0-9]+$`)
`settlementPriceCurrency` string required	The currency of the settlement, in ISO 4217 format. Allowable values: 3 characters
`remittersName` string required	The name of the remitter. Allowable values: A valid string
`reference` string	The reference of the credit. Allowable values: A valid string
`bankIdentifier` string	The bank identifier. Allowable values: A valid string (`^[0-9]+$`)
`remittersAddress` string required	The remitter's address. Allowable values: A valid string
`beneficiaryName` string required	The name of the beneficiary of the credit. Allowable values: A valid string
`institutionName` string	The name of the institution making the credit. Allowable values: <= 35 characters
`institutionAddress` string	The address of the institution making the credit. Allowable values: <= 109 characters
`schemeName` string	The name of the scheme used to process the credit. Allowable values: `FasterPayment`, `BACS`, `CHAPS`, `Swift`, `SEPA`

Response

If your request is successful, you'll receive a 200 response. Your budget will be credited with the settlement amount specified in the request and you'll be able to find the transaction in your transaction activity lists and reports.

Copy

Copied

{
 "boxTransactionId": 3765,
 "balance": {
  "runningBalance": "200.00",
  "availableBalance": "200.00"
 }
}

For more detailed information about this request and its response, see the API reference.