---
title: "Endpoint to mock the credit of an account"
method: POST
path: "/credit"
tags: ["Inbound Payments"]
---

# Endpoint to mock the credit of an account

`POST /credit`

Inbound payments - mock (Sandbox only)

## Request body

- InboundpaymentInboundPaymentRequest — Details of credit to the account
  - `accountId` string, required — The account to be credited
  - `payerDetail` InboundpaymentPartyDetailRequest, required
    - `name` string, required — Party name
    - `identifier` InboundpaymentAccountIdentifierDetailRequest, required
      - `type` 'SCAN' | 'IBAN' | 'DD' | 'INTL' | 'ANBRN' | 'AN', required — Account identifier type
      - `accountNumber` string — Account number
      - `sortCode` string — Sortcode
      - `iban` string — IBAN
      - `bic` string — BIC
    - `address` InboundpaymentAddress
      - `addressLine1` string
      - `addressLine2` string
      - `postTown` string
      - `postCode` string
      - `country` string
  - `payeeDetail` InboundpaymentPartyDetailRequest
    - `name` string, required — Party name
    - `identifier` InboundpaymentAccountIdentifierDetailRequest, required
      - `type` 'SCAN' | 'IBAN' | 'DD' | 'INTL' | 'ANBRN' | 'AN', required — Account identifier type
      - `accountNumber` string — Account number
      - `sortCode` string — Sortcode
      - `iban` string — IBAN
      - `bic` string — BIC
    - `address` InboundpaymentAddress
      - `addressLine1` string
      - `addressLine2` string
      - `postTown` string
      - `postCode` string
      - `country` string
  - `description` string, required — Description of the credit
  - `amount` number, required — Amount of the payment in major current Units - '1' = 1.00 GBP
  - `type` 'PI_BACS' | 'PI_DD' | 'PI_FAST' | 'PI_SECT' | 'PI_SEPA_INST' | 'PI_SWIFT', required — Type of credit, values:
  - `transactionDate` string — Date of credit in yyyy-MM-ddTHH:mm:ssZ format
  - `numberOfTransactions` integer — Number of credit transactions to create, defaults to 1
  - `schemeInformation` InboundpaymentSchemeInfoRequest
    - `id` string — unique id that identifies a payment end-to-end within a scheme. If used ensure that its unique

## Response `200`

OK

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/revisions/cbd52524c8ef/schema)