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

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

thirdPartyReference
string

A unique reference provided by your integrating product.

budgetId
required
string <uuid> <= 36 characters

The ID of the budget to work with.

orderId
string

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

accountIdentifier
string

Identifier of the account, could be iban or account number

settlementPriceAmount
required
string^[0-9]+$

The settlement amount.

settlementPriceCurrency
required
string
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "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"
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

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

post/budgets/generate-credit
Request samples 
        curl -i -X POST         'https://api-sandbox.equalsmoney.com/v2/budgets/generate-credit?accountId=F50072'         -H 'Authorization: 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",
        "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
        "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
{ }