---
title: "Create a direct credit"
method: POST
path: "/direct_credits"
---

# Create a direct credit

`POST /direct_credits`

## Request

- Base URL: `https://gateway.pmnts-sandbox.io/v1.0`
- URL: `https://gateway.pmnts-sandbox.io/v1.0/direct_credits`
- Auth: HTTP basic

## Headers

- `Content-Type` string

## Request body

- object
  - `description` string, required: Recommended to be unique. Max 18 characters, allowed chars are A-Z, 0-9, period, hyphen, ampersand, and underscore. It is recommended you make this descriptive for your customer - e.g. Invoice ABCD123.
  - `amount` number, float, required: Amount. Minimum 0.01, positive only.
  - `bsb` string, required: The destination account's BSB number. Format: ###-###
  - `account_name` string, required: The destination account name. Max 32 characters.
  - `account_number` string, required: The destination account number. Max 9 digits.
  - `account_type` string: Type of the destination bank account.
  - `date` string, date: Date of the direct credit. Optional but recommended. Defaults to the next processing period (current day if before 17:00, next day if after). Must be in the future.
  - `reference` string: Unique reference
  - `metadata` object: Metadata for the direct credit
  - `extra` object: Extended fields, only accepted for merchants configured to support them.
    - `name` string: Sub-merchant name, only accepted for merchants configured as a payment aggregator.
  - `bank_account` string: The Fat Zebra bank account ID to be used in place of account_name, account_number, and bsb. If bank_account is supplied, the other attributes should be omitted.

## Response `201`

201

- object
  - `successful` boolean
  - `response` object
    - `id` string
    - `amount` integer
    - `bsb` string
    - `account_number` string
    - `account_name` string
    - `description` string
    - `reference` string
    - `date` string
    - `process_date` unknown
    - `status` string
    - `result` unknown
    - `metadata` unknown
  - `errors` unknown[]
    - unknown
  - `test` boolean

## Other responses

- `422`: 422

## Changes

- **2026-11-03** `a62ddbae3800`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/fatzebra/apis/gateway/changes/direct_credits/post.md)

---

[API](https://skmtc.dev/fatzebra/apis/gateway.md) - [All operations](https://skmtc.dev/fatzebra/apis/gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/fatzebra/apis/gateway/revisions/a62ddbae3800?raw)