Equals Money

https://docs.equalsmoney.com/pages/
Admin
Equals Money provides an API and infrastructure for building financial products, enabling features...
Tokens:379,799
Snippets:1,643
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Create an individual budget request

Source: https://docs.equalsmoney.com/pages/budgets/create-budgets

Use these examples to create an individual budget. The first example shows a sample request, while the second shows the required request structure.

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/budgets?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "parentId": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
    "personaId": "42a27839-7690-486c-8cf4-5084fab52494",
    "features": [
      "payments"
    ],
    "currencies": [
      "USD"
    ],
    "type": "individual"
  }'
```

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/budgets?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "parentId": "string",
    "personaId": "string",
    "name": "string",
    "features": [
      "string"
    ],
    "currencies": [
      "string"
    ],
    "type": "string"
}'
```

--------------------------------

### Create a single-currency payment request

Source: https://docs.equalsmoney.com/pages/payments/create-single-currency-payments

Use these cURL examples to initiate a payment. The first example provides a concrete request, while the second illustrates the required data structure.

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/orders/trade?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": "M35TVZVMB4NYPO",
    "quoteRequestId": "UFTDF36PC1YHKDB61QC4V4324ATF9KCDPV",
    "payments": {
      "amount": 10,
      "currency": {
        "budgetId": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
        "currencyCode": "GBP"
      },
      "recipientId": "7d238pq10",
      "internalReference": "PAYX-123",
      "externalReference": "PAYX-123"
    }
  }'
```

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/orders/trade?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderId": "string",
    "quoteRequestId": "string",
    "payments": {
      "amount": number,
      "currency": {
        "budgetId": "string",
        "currencyCode": "string"
      },
      "recipientId": "string",
      "internalReference": "string",
      "externalReference": "string"
    }
  }'
```

--------------------------------

### Create a Direct Debit mandate request

Source: https://docs.equalsmoney.com/pages/payments/direct-debits/create-direct-debits

Use these examples to construct a POST request for registering a paper mandate. The first example provides a concrete payload, while the second shows the required request structure.

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/budgets/4db84122-9c4e-4607-98f7-84b2bbe02daf/direct-debits?accountId=F12345' \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "reference": "UTILITYCO123456",
    "processingDate": "2024-02-01",
    "originator": {
      "id": "654321",
      "accountName": "Utility Company Ltd",
      "address": {
        "addressType": "ADDR",
        "streetName": "High Street",
        "buildingNumber": "123",
        "postcode": "SW1A 1AA",
        "city": "London",
        "countryCode": "GB"
      }
    }
  }'
```

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/budgets/{budgetId}/direct-debits?accountId={accountId}' \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "reference": "string",
    "processingDate": "YYYY-MM-DD",
    "originator": {
      "id": "string",
      "accountName": "string",
      "address": {
        "addressType": "ADDR | PBOX | HOME | BIZZ | MLTO | DLVY",
        "streetName": "string",
        "buildingNumber": "string",
        "buildingName": "string",
        "postcode": "string",
        "city": "string",
        "countryCode": "string"
      }
    }
  }'
```

--------------------------------

### Create a shared budget request

Source: https://docs.equalsmoney.com/pages/budgets/create-budgets

Use these cURL examples to create a new shared budget. The first example provides a concrete request, while the second shows the required request structure.

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/budgets?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "parentId": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
    "name": "Team Party",
    "features": [
      "payments"
    ],
    "currencies": [
      "USD"
    ],
    "type": "shared",
    "status": "active"
  }'
```

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/budgets?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "parentId": "string",
    "name": "string",
    "features": [
      "string"
    ],
    "currencies": [
      "string"
    ],
    "type": "string",
    "status": "string"
  }'
```

--------------------------------

### POST /v2/onboarding

Source: https://docs.equalsmoney.com/pages/accounts/tutorial/create-accounts-for-cards

Submit details and start onboarding an account with the cards feature enabled.

```APIDOC
## POST /v2/onboarding

### Description
Use this request to submit details and start onboarding an account with the cards feature enabled.

### Method
POST

### Endpoint
https://api.equalsmoney.com/v2/onboarding

### Parameters
#### Request Body
- **market** (string) - Optional - The market relating to the licence that the account operates under. Allowable values: UK, EU
- **features** (array) - Optional - The feature to enable on the account. Defaults to payments if not provided. Allowable values: payments, cards
- **accountType** (string) - Required - The type of account you're onboarding. Allowable values: business, personal
- **affiliateId** (string) - Optional - The affiliate ID (36 characters).
- **companyId** (string) - Optional - The company ID (36 characters).
- **contact** (object) - Required - Details about the contact (primary owner).

### Request Example
{
  "market": "UK",
  "features": ["cards"],
  "accountType": "business",
  "affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  "companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  "contact": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+447123456789",
    "dob": "19/01/1946",
    "address": {
      "addressLine1": "Great Building",
      "addressLine2": "Greater Building",
      "townCity": "My Town",
      "postCode": "SE13UB",
      "countryCode": "GB"
    }
  },
  "account": {
    "companyName": "ACME international",
    "companyNumber": "1111111111",
    "incorporationDate": "1980-01-30",
    "type": "llp",
    "website": "https://www.exampleurl.com",
    "onboardingDetail": "Additional details about the account",
    "address": {
      "addressLine1": "Great Building",
      "addressLine2": "Greater Building",
      "townCity": "My Town",
      "postCode": "SE13UB",
      "countryCode": "GB"
    }
  },
  "kyc": {
    "expectedCardUse": ["advertising_and_marketing", "bills_and_utilities", "client_entertainment"],
    "sourceOfFunds": ["salary"],
    "currenciesRequired": ["GBP", "USD"],
    "averageLoad": "10000_25000",
    "numberOfCards": "11_50",
    "cardFourthLine": "CUSTOMER",
    "employeeCards": true,
    "atmWithdrawals": true
  }
}
```

--------------------------------

### Send onboarding request (Production)

Source: https://docs.equalsmoney.com/pages/accounts/tutorial/step2

Use this cURL command to send an onboarding request to the production environment. Ensure you replace `{apiKey}` with your actual API key. This example creates a business account with payments enabled.

```bash
curl -i -X POST 'https://api.equalsmoney.com/v2/onboarding' \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountType": "business",
    "contact": {
      "firstName": "John",
      "lastName": "Smith",
      "phone": "07700 900391",
      "email": "john.smith@example.com",
      "countryCode": "GB",
      "address": {
        "addressLine1": "223 Glossop Road",
        "townCity": "London",
        "postCode": "N14 4ES",
        "countryCode": "GB"
      }
    },
    "account": {
      "companyName": "ACME",
      "companyNumber": "5250007732",
      "incorporationDate": "2021-06-04",
      "address": {
        "addressLine1": "1556 S. Michigan Avenue",
        "townCity": "London",
        "postCode": "N14 4ES",
        "countryCode": "GB"
      },
      "onboardingDetail": "Directors are John Smith and William Walker",
      "type": "ltd"
    },
    "kyc": {
      "annualVolume": "Less than £10,000",
      "numberOfPayments": "More than 20 payments",
      "mainPurpose": [
        "Investment"
      ],
      "sourceOfFunds": [
        "salary"
      ],
      "destinationOfFunds": [
        "GB"
      ],
      "currenciesRequired": [
        "GBP"
      ]
    }
  }'
```

--------------------------------

### GET /v2/accounts

Source: https://docs.equalsmoney.com/pages/accounts/tutorial/step3

Retrieves a list of all accounts associated with the provided API key. This endpoint is useful for verifying account setup and discovering associated accounts.

```APIDOC
## GET /v2/accounts

### Description
Retrieves a list of all accounts associated with the provided API key.

### Method
GET

### Endpoint
https://api.equalsmoney.com/v2/accounts

### Parameters
#### Headers
- **Authorization** (string) - Required - The API key provided during onboarding, prefixed with 'ApiKey '.

### Response
#### Success Response (200)
- **count** (integer) - The total number of accounts returned.
- **limit** (integer) - The maximum number of results returned.
- **offset** (integer) - The current offset for pagination.
- **rows** (array) - A list of account objects.

#### Response Example
{
  "count": 2,
  "limit": 100,
  "offset": 0,
  "rows": [
    {
      "id": "F12345",
      "status": "active",
      "type": "Business"
    }
  ]
}
```

--------------------------------

### Validate Payment Batch Request

Source: https://docs.equalsmoney.com/pages/payments/create-payment-batch

Example of how to validate a payment batch using a GET request. Ensure you replace placeholders with your actual API key and payment batch ID.

```bash
curl -i -X GET \
  'https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate?accountId=F50091' \
  -H 'Authorization: YOUR_API_KEY_HERE' \

```

--------------------------------

### Send onboarding request (Sandbox)

Source: https://docs.equalsmoney.com/pages/accounts/tutorial/step2

Use this cURL command to send an onboarding request to the sandbox environment. Ensure you replace `{apiKey}` with your actual API key. This example creates a business account with payments enabled.

```bash
curl -i -X POST 'https://api-sandbox.equalsmoney.com/v2/onboarding' \
  -H 'Authorization: ApiKey {apiKey}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountType": "business",
    "contact": {
      "firstName": "John",
      "lastName": "Smith",
      "phone": "07700 900391",
      "email": "john.smith@example.com",
      "countryCode": "GB",
      "address": {
        "addressLine1": "223 Glossop Road",
        "townCity": "London",
        "postCode": "N14 4ES",
        "countryCode": "GB"
      }
    },
    "account": {
      "companyName": "ACME",
      "companyNumber": "5250007732",
      "incorporationDate": "2021-06-04",
      "address": {
        "addressLine1": "1556 S. Michigan Avenue",
        "townCity": "London",
        "postCode": "N14 4ES",
        "countryCode": "GB"
      },
      "onboardingDetail": "Directors are John Smith and William Walker",
      "type": "ltd"
    },
    "kyc": {
      "annualVolume": "Less than £10,000",
      "numberOfPayments": "More than 20 payments",
      "mainPurpose": [
        "Investment"
      ],
      "sourceOfFunds": [
        "salary"
      ],
      "destinationOfFunds": [
        "GB"
      ],
      "currenciesRequired": [
        "GBP"
      ]
    }
  }'
```

--------------------------------

### POST /v2/onboarding

Source: https://docs.equalsmoney.com/pages/accounts/tutorial/create-accounts-for-payments

Initiates the onboarding process for a new account with the payments feature enabled. Requires product-level permissions and webhook setup for account activation notifications.

```APIDOC
## POST /v2/onboarding

### Description
Start onboarding an account with the payments feature enabled. This endpoint is used to submit account details and initiate the onboarding process.

### Method
POST

### Endpoint
/v2/onboarding

### Parameters
#### Request Body
- **market** (string) - Required - The market for the account (e.g., "UK").
- **features** (array of strings) - Required - Features to enable for the account (e.g., ["payments"]).
- **accountType** (string) - Required - The type of account (e.g., "business").
- **affiliateId** (string) - Required - The affiliate ID associated with the account.
- **companyId** (string) - Required - The company ID.
- **contact** (object) - Required - Contact person details.
  - **firstName** (string) - Required - First name of the contact person.
  - **lastName** (string) - Required - Last name of the contact person.
  - **email** (string) - Required - Email address of the contact person.
  - **phone** (string) - Required - Phone number of the contact person.
  - **dob** (string) - Required - Date of birth of the contact person (format: DD/MM/YYYY).
  - **address** (object) - Required - Contact person's address.
    - **addressLine1** (string) - Required - First line of the address.
    - **addressLine2** (string) - Optional - Second line of the address.
    - **townCity** (string) - Required - Town or city.
    - **postCode** (string) - Required - Postal code.
    - **countryCode** (string) - Required - Two-letter country code (e.g., "GB").
- **account** (object) - Required - Account details.
  - **companyName** (string) - Required - The name of the company.
  - **companyNumber** (string) - Optional - The company registration number.
  - **incorporationDate** (string) - Optional - The date of incorporation (format: YYYY-MM-DD).
  - **type** (string) - Optional - The type of company (e.g., "llp").
  - **website** (string) - Optional - The company website URL.
  - **onboardingDetail** (string) - Optional - Additional details for onboarding.
  - **address** (object) - Required - Company's address.
    - **addressLine1** (string) - Required - First line of the address.
    - **addressLine2** (string) - Optional - Second line of the address.
    - **townCity** (string) - Required - Town or city.
    - **postCode** (string) - Required - Postal code.
    - **countryCode** (string) - Required - Two-letter country code (e.g., "GB").
- **kyc** (object) - Required - Know Your Customer (KYC) information.
  - **mainPurpose** (array of strings) - Required - The main purpose of the account.
  - **sourceOfFunds** (array of strings) - Required - The source of funds.
  - **destinationOfFunds** (array of strings) - Required - The destination of funds.
  - **currenciesRequired** (array of strings) - Required - Currencies required for the account.
  - **annualVolume** (string) - Required - Estimated annual transaction volume.
  - **numberOfPayments** (string) - Required - Estimated number of payments per year.

### Request Example
```json
{
  "market": "UK",
  "features": [
    "payments"
  ],
  "accountType": "business",
  "affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  "companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  "contact": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+447123456789",
    "dob": "19/01/1946",
    "address": {
      "addressLine1": "Great Building",
      "addressLine2": "Greater Building",
      "townCity": "My Town",
      "postCode": "SE13UB",
      "countryCode": "GB"
    }
  },
  "account": {
    "companyName": "ACME international",
    "companyNumber": "1111111111",
    "incorporationDate": "1980-01-30",
    "type": "llp",
    "website": "https://www.exampleurl.com",
    "onboardingDetail": "Additional details about the account",
    "address": {
      "addressLine1": "Great Building",
      "addressLine2": "Greater Building",
      "townCity": "My Town",
      "postCode": "SE13UB",
      "countryCode": "GB"
    }
  },
  "kyc": {
    "mainPurpose": [
      "Investment"
    ],
    "sourceOfFunds": [
      "salary"
    ],
    "destinationOfFunds": [
      "GB"
    ],
    "currenciesRequired": [
      "GBP"
    ],
    "annualVolume": "Less than £10,000",
    "numberOfPayments": "More than 20 payments"
  }
}
```

### Response
#### Success Response (200)
- **accountId** (string) - The unique identifier for the newly created account.
- **status** (string) - The current status of the account onboarding process (e.g., "pending_verification").

#### Response Example
```json
{
  "accountId": "acc_12345abcde",
  "status": "pending_verification"
}
```
```

--------------------------------

### Sample Request to Get Webhook Event Type

Source: https://docs.equalsmoney.com/pages/webhooks/get-webhook-event-type-details

Use this sample request to get details about a specific webhook event type. Replace YOUR_API_KEY_HERE with your actual API key.

```bash
curl -i -X GET \
    'https://api.equalsmoney.com/v2/webhooks/event-types/99d77c0c-2c95-4f87-a7a5-ce12898a9672' \
    -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
```

--------------------------------

### Sample Request to Create Account for Payments

Source: https://docs.equalsmoney.com/pages/accounts/tutorial/create-accounts-for-payments

Use this sample request to submit details and start onboarding an account with the payments feature. Ensure you replace 'YOUR_API_KEY_HERE' with your actual API key.

```bash
curl -i -X POST \
    'https://api.equalsmoney.com/v2/onboarding' \
    -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
    -H 'Content-Type: application/json' \
    -d '{
      "market": "UK",
      "features": [
        "payments"
      ],
      "accountType": "business",
      "affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
      "companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
      "contact": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "phone": "+447123456789",
        "dob": "19/01/1946",
        "address": {
          "addressLine1": "Great Building",
          "addressLine2": "Greater Building",
          "townCity": "My Town",
          "postCode": "SE13UB",
          "countryCode": "GB"
        }
      },
      "account": {
        "companyName": "ACME international",
        "companyNumber": "1111111111",
        "incorporationDate": "1980-01-30",
        "type": "llp",
        "website": "https://www.exampleurl.com",
        "onboardingDetail": "Additional details about the account",
        "address": {
          "addressLine1": "Great Building",
          "addressLine2": "Greater Building",
          "townCity": "My Town",
          "postCode": "SE13UB",
          "countryCode": "GB"
        }
      },
      "kyc": {
        "mainPurpose": [
          "Investment"
        ],
        "sourceOfFunds": [
          "salary"
        ],
        "destinationOfFunds": [
          "GB"
        ],
        "currenciesRequired": [
          "GBP"
        ],
        "annualVolume": "Less than £10,000",
        "numberOfPayments": "More than 20 payments"
      }
    }'
```

--------------------------------

### Create Address Request - Sample

Source: https://docs.equalsmoney.com/pages/cards/create-addresses

Use this sample request to create a new address for an account. Ensure you replace 'YOUR_API_KEY_HERE' with your actual API key and provide a valid account ID.

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/addresses?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "office",
    "nickName": "Head Office",
    "addressLine1": "Great Building",
    "addressLine2": "4 Maple Street",
    "addressLine3": "Southwark",
    "addressContact": "Jane Doe",
    "city": "London",
    "postcode": "SE13UB",
    "country": "England"
  }'
```

--------------------------------

### GET /v2/addresses/lookup

Source: https://docs.equalsmoney.com/pages/cards/create-addresses

Look up an address.

```APIDOC
## GET /v2/addresses/lookup

### Description
Look up an address.

### Method
GET

### Endpoint
/v2/addresses/lookup
```

--------------------------------

### GET /v2/cards/{cardId}/access-token

Source: https://docs.equalsmoney.com/pages/cards/get-card-details

Retrieves an access token to get a card's sensitive data (PAN and CVV) using the sensitive data widget service. Access tokens expire after 5 minutes.

```APIDOC
## GET /v2/cards/{cardId}/access-token

### Description
Use this request to retrieve an access token, which you can use to get a card's sensitive date (PAN and CVV) via Marqeta's sensitive data widget service.

Access tokens expire after 5 minutes.

### Method
GET

### Endpoint
`https://api.equalsmoney.com/v2/cards/{cardId}/access-token`

### Parameters
#### Path Parameters
- **cardId** (string) - Required - The ID of the card for which you want to get details. Allowable values: An existing `cardId` (≤ 36 characters)

#### Query Parameters
- **accountId** (string) - Required - The ID of the account that the card is associated with. Allowable values: An existing `accountId`
- **personId** (string) - Optional - The ID of the person that the card belongs to. Allowable values: An existing `personId` (≤ 36 characters)

### Request Example
```bash
curl -i -X GET \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/access-token?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
```

### Response
#### Success Response (200)
- **token** (string) - The access token.

#### Response Example
```json
{
  "token": "b2lsYWdhaW5zdG1vdGhlcmZvZ3B1cGlsY2FtcG5pbmVjcm93ZGZvdWdodGFnYWluc3R0dXJuY2xvdGhzaWxlbnRzYXdjYXJyaWVkbm90aGluZ2Z1bGx5d2hlbmV2ZXJseWluZ2J1dGNoYXB0ZXJzbWlsZWRpc3RhbnRyZXNlYXJjaHN1bW1lcmRhbmNlbGlrZWx5Zml4YWR2aWNlbWFnbmV0cmV0dXJubWFya2V0cGVyZmVjdGJlZ2Fub3V0c2lkZXdlaWdocGFwZXJzaGVub3VuZ2l2ZW5iYXR0bGVtZXRicmVhZHN0ZXBncmFpbmludGVyaW9yc2xlcHRtdXN0YmxhbmtldHNpbGVuY2VicmFuY2hwcm91ZHByb2R1Y2Vsb3dlcnRoZW9yeXN1cHBvcnRuZXdzcGFwZXJvcmdhbml6ZWRjYXJkdHlvdG9tb3Jyb3d2YXBvcmNvbmRpdGlvbnNtb2tlaG93ZXZlcmNhZ2Vyb2NraGlzdG9yeXVzZWhvcGVkaXJ0eW1vdW50YWluZHJlc3NkYW5jZXF1aWNrZWlnaHRkaXZp7c2lvbnRlbXBlcmF0dXJlYW55aW1hZ2luZWNvbXBsZXRlbHlwcmVzZW50c3BlY2lmaWNhYm91dGdyYWRld291bGRnZW50bGVjcm9zc2ZyaWdodGVuYmVlZ2F2ZXNjaWVuY2Vob3JzZXBhbmJlY2F1c2VzaG9ydGxlYXJucmVjZW50bHlkb3plbm15c3RlcmlvdXNzaGVwaWVkaXN0YW50cmVhbGl6ZW5pZ2h0ZmF0aGVyY29tcGxleHJlc3RmdXJ0aGVyZXhwbG9yZWNvbG9ueW1hcG9sZGVycmVjZW50bHlwYW55b3Vyc2VsZmN1cnZlbmVpZ2hib3Job29kc2VudGVuY2VhZHZlbnR1cmVzdGFpcnNtZWV0c2lnaHRwbGF0ZXNkaXZpZGVtaXNzaW5nYmVhdXR5cmFuZ2VuaW5ld3JpdGVyc3RvcnlkaXNjdXNzaW9uZGVwZW5kaGlzaW5jbHVkZXNhdGVsbGl0ZXN0aGVtc2VsdmVzZ2VuZXJhbGJpdGxlZnRmYXJ0aGVyYnJpbmcx" 
}
```
```

--------------------------------

### Retrieve Budget Details (Sandbox)

Source: https://docs.equalsmoney.com/pages/budgets/tutorial/step4

Use this command to fetch budget details from the sandbox environment. Replace placeholders with your actual budget ID, account ID, and API key.

```bash
curl -i -X GET 'https://api-sandbox.equalsmoney.com/v2/budgets/{budgetId}?accountId={accountId}' \
    -H 'Authorization: ApiKey {apiKey}'
```

--------------------------------

### Retrieve Budget Details (Production)

Source: https://docs.equalsmoney.com/pages/budgets/tutorial/step4

Use this command to fetch budget details from the production environment. Replace placeholders with your actual budget ID, account ID, and API key.

```bash
curl -i -X GET 'https://api.equalsmoney.com/v2/budgets/{budgetId}?accountId={accountId}' \
    -H 'Authorization: ApiKey {apiKey}'
```

--------------------------------

### Webhook Update Response Example

Source: https://docs.equalsmoney.com/pages/webhooks/update-webhooks

A successful update request returns a 200 status code with the updated webhook details. This JSON object shows an example response, including fields like `sharedSecret`, `enabled`, `url`, and `authorizationHeader`.

```json
{
  "sharedSecret": "123e4567-e89b-12d3-a456-426614174000",
  "enabled": true,
  "accountId": "F12345",
  "webhookEventTypeId": "da91434a-4026-42ea-84b8-d0317b64af9c",
  "url": "https://api.exampleurl.com",
  "authorizationHeader": "Basic AXVubzpwQDU1dzByYM==",
  "id": "d7d34e0f-c6e9-4cea-8c25-baaffa81714f",
  "productId": "911db6db-ef58-4992-87cd-2fe2cfde05f9",
  "webhookEventTypeName": "OrderCreated",
  "createdAt": "2023-01-30T08:30:00Z",
  "updatedAt": "2023-01-30T08:30:00Z"
}
```

--------------------------------

### Create an account for cards via API

Source: https://docs.equalsmoney.com/pages/accounts/tutorial/create-accounts-for-cards

Submit onboarding details to the /v2/onboarding endpoint. Ensure the features array includes 'cards' to enable card functionality.

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/onboarding' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "market": "UK",
    "features": [
      "cards"
    ],
    "accountType": "business",
    "affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
    "companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
    "contact": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+447123456789",
      "dob": "19/01/1946",
      "address": {
        "addressLine1": "Great Building",
        "addressLine2": "Greater Building",
        "townCity": "My Town",
        "postCode": "SE13UB",
        "countryCode": "GB"
      }
    },
    "account": {
      "companyName": "ACME international",
      "companyNumber": "1111111111",
      "incorporationDate": "1980-01-30",
      "type": "llp",
      "website": "https://www.exampleurl.com",
      "onboardingDetail": "Additional details about the account",
      "address": {
        "addressLine1": "Great Building",
        "addressLine2": "Greater Building",
        "townCity": "My Town",
        "postCode": "SE13UB",
        "countryCode": "GB"
      }
    },
    "kyc": {
      "expectedCardUse": [
        "advertising_and_marketing",
        "bills_and_utilities",
        "client_entertainment"
      ],
      "sourceOfFunds": [
        "salary"
      ],
      "currenciesRequired": [
        "GBP",
        "USD"
      ],
      "averageLoad": "10000_25000",
      "numberOfCards": "11_50",
      "cardFourthLine": "CUSTOMER",
      "employeeCards": true,
      "atmWithdrawals": true
    }
  }'
```

```bash
curl -i -X POST \
  'https://api.equalsmoney.com/v2/onboarding' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "market": "string",
    "features": [
      "string"
    ],
    "accountType": "string",
    "affiliateId": "string",
    "companyId": "string",
    "contact": {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "dob": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "townCity": "string",
        "postCode": "string",
        "countryCode": "string"
      }
    },
    "account": {
      "companyName": "string",
      "companyNumber": "string",
      "incorporationDate": "string",
      "type": "string",
      "website": "string",
      "onboardingDetail": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "townCity": "string",
        "postCode": "string",
        "countryCode": "string"
      }
    },
    "kyc": {
      "expectedCardUse": [
        "string"
      ],
      "sourceOfFunds": [
        "string"
      ],
      "currenciesRequired": [
        "string"
      ],
      "averageLoad": "string",
      "numberOfCards": "string",
      "cardFourthLine": "string",
      "employeeCards": boolean,
      "atmWithdrawals": boolean
    }
  }'
```

--------------------------------

### GET /api/accounts/{id}

Source: https://docs.equalsmoney.com/pages/payments/create-recipients-beta

Retrieves the details of a specific account.

```APIDOC
## GET /api/accounts/{id}

### Description
Retrieves the details of a specific account, including personal information, bank details, and validation status.

### Method
GET

### Endpoint
/api/accounts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the account.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the account.
- **accountId** (string) - The account ID.
- **status** (string) - The current status of the account (e.g., 'unverified').
- **type** (string) - The type of account (e.g., 'individual').
- **name** (string) - The full name associated with the account.
- **displayName** (string) - A display name for the account.
- **subscribedEmails** (array) - A list of subscribed email objects, each containing 'name' (string) and 'email' (string).
- **currencyCode** (string) - The currency code for the account (e.g., 'EUR').
- **accountIdentifier** (string) - The account number or IBAN.
- **bankIdentifier** (string) - The bank's identifier (e.g., SWIFT/BIC).
- **intermediaryBankIdentifier** (string) - The identifier for an intermediary bank, if applicable.
- **paymentPurposeCode** (string) - A code for the payment purpose.
- **defaultPurpose** (string) - A default description for payment purposes.
- **defaultReference** (string) - A default reference for payments.
- **paymentNetwork** (string) - The payment network used (e.g., 'SWIFT').
- **verificationMethod** (string) - The method used for verification (e.g., 'sms_otp').
- **address** (object) - The account holder's address, containing 'countryCode' (string), 'address' (string), 'city' (string), and 'postcode' (string).
- **bankAddress** (object) - The bank's address, containing 'bankName' (string), 'fullBankName' (string), 'countryCode' (string), 'address' (string), 'city' (string), and 'postcode' (string).
- **validation** (object) - Validation results, containing 'nameMatch' (boolean), 'reason' (string), 'reasonCode' (string), 'actualName' (string), and 'displayMessage' (string).
- **dateLastPaid** (string) - The date the account was last paid.
- **createdBy** (string) - Identifier of the user who created the account.
- **createdAt** (string) - Timestamp when the account was created.
- **updatedBy** (string) - Identifier of the user who last updated the account.
- **updatedAt** (string) - Timestamp when the account was last updated.
- **archivedAt** (string) - Timestamp when the account was archived, if applicable.

#### Response Example
```json
{
  "id": "123",
  "accountId": "F60600",
  "status": "unverified",
  "type": "individual",
  "name": "John Frank",
  "displayName": "Electrician",
  "subscribedEmails": [
    {
      "name": "John",
      "email": "example@email.com"
    }
  ],
  "currencyCode": "EUR",
  "accountIdentifier": "GB95SPPV23188424911122",
  "bankIdentifier": "SPPVGB2LXXX",
  "intermediaryBankIdentifier": "QBLCCCCV",
  "paymentPurposeCode": "BKF",
  "defaultPurpose": "Funding my own account",
  "defaultReference": "Paying my savings account",
  "paymentNetwork": "SWIFT",
  "verificationMethod": "sms_otp",
  "address": {
    "countryCode": "GB",
    "address": "123 Main St",
    "city": "London",
    "postcode": "SW1A 1AA"
  },
  "bankAddress": {
    "bankName": "Big Bank",
    "fullBankName": "Big Bank Plc",
    "countryCode": "GB",
    "address": "456 High St",
    "city": "London",
    "postcode": "SW1A 1BB"
  },
  "validation": {
    "nameMatch": false,
    "reason": "String is a close match to the account name",
    "reasonCode": "N200",
    "actualName": "John Frans",
    "displayMessage": "The name provided is a close match to the account name."
  },
  "dateLastPaid": "string",
  "createdBy": "string",
  "createdAt": "string",
  "updatedBy": "string",
  "updatedAt": "string",
  "archivedAt": "string"
}
```
```
Tokens:
Raw