How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Apideck Payments API

A Payment represents money received from a customer, including amount, date, payment method, and allocation to one or more invoices.

Apideck Payments API is one of 54 APIs that Apideck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 10.24.12.

Requests are made against a single base URL, https://unify.apideck.com.

5 operations 2 paths 52 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
10.24.12
Base URL
https://unify.apideck.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Apideck Payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 5

A Payment represents money received from a customer, including amount, date, payment method, and allocation to one or more invoices.

GET
/accounting/payments
Apideck List Payments
paymentsAll 11 params → 200400401402404422default
POST
/accounting/payments
Apideck Create Payment
paymentsAdd 5 params body → 201400401402404422default
GET
/accounting/payments/{id}
Apideck Get Payment
paymentsOne 7 params → 200400401402404422default
PATCH
/accounting/payments/{id}
Apideck Update Payment
paymentsUpdate 6 params body → 200400401402404422default
DELETE
/accounting/payments/{id}
Apideck Delete Payment
paymentsDelete 6 params → 200400401402404422default

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are Payment (32 properties), Address (25 properties), GetPaymentsResponse (9 properties), GetPaymentResponse (7 properties). Each schema is shown below with its type and property counts.

PaymentsSort
object
2 properties
UnauthorizedResponse
object
6 properties
Payment
object
32 properties 3 required
WritableId
stringnull
A unique identifier for an object.
CreatedAt
stringnull
The date and time when the object was created.
DownstreamId
stringnull
The third-party API ID of original entity
Raw
objectnull
Raw response from the integration when raw=true query param is provided
IsReconciled
booleannull
Indicates if the transaction has been reconciled.
GetPaymentResponse
object
7 properties 6 required
Address
object
25 properties
UpdatePaymentResponse
object
7 properties 6 required
NotFoundResponse
object
6 properties
CustomField
object
4 properties
CreatedBy
stringnull
The user who created the object.
AccountingCompanyId
stringnull
The company ID the transaction belongs to
Allocation
object
5 properties
PassThroughBody
array
The passthrough property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
UnexpectedErrorResponse
object
6 properties
DeletePaymentResponse
object
7 properties 6 required
DisplayId
stringnull
Id to be displayed.
PaymentRequiredResponse
object
6 properties
UpdatedAt
stringnull
The date and time when the object was last updated.
PaymentMethod
stringnull
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
PaymentsFilter
object
5 properties
LinkedLedgerAccount
objectnull
6 properties
SortDirection
string
The direction in which to sort the results
LinkedTrackingCategory
objectnull
5 properties
PaymentType
string
Type of payment
TransactionNumber
stringnull
Number associated with the transaction
PaymentMethodReference
stringnull
Optional reference message returned by payment method on processing
PassThroughQuery
object
1 property
UnprocessableResponse
object
6 properties
Id
string
A unique identifier for an object.
CreatePaymentResponse
object
7 properties 6 required
Currency
stringnull
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO4217).
UnifiedId
object
A object containing a unique identifier for the resource that was created, updated, or deleted.
1 property 1 required
TransactionReference
stringnull
Optional transaction reference message ie: Debit remittance detail.
RowVersion
stringnull
A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
PaymentStatus
string
Status of payment
BadRequestResponse
object
7 properties
Links
object
Links to navigate to previous or next pages through the API
3 properties
CustomMappings
objectnull
When custom mappings are configured on the resource, the result is included here.
TotalAmount
numbernull
The total amount of the transaction or record
CurrencyRate
numbernull
Currency Exchange Rate at the time entity was recorded/generated.
GetPaymentsResponse
object
9 properties 6 required
UpdatedBy
stringnull
The user who last updated the object.
TransactionDate
stringnull
The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD
LinkedTrackingCategories
arraynull
A list of linked tracking categories.
DeprecatedLinkedSupplier
objectnull
The supplier this entity is linked to.
5 properties
Meta
object
Response metadata
2 properties
TransactionNote
stringnull
Note associated with the transaction
LinkedCustomer
objectnull
The customer this entity is linked to.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apideck-payments-api-openapi.yml Raw ↑

Other APIs Apideck publishes across the network.

Apideck Activities API
Apideck Aged Creditors API
Apideck Aged Debtors API
Apideck Attachments API
Apideck Balance Sheet API
Apideck Bank Accounts API
Apideck Bank Feed Accounts API
Apideck Bank Feed Statements API
Apideck Bill Payments API
Apideck Bills API
Apideck Categories API
Where this information came from

This is an independent, third-party profile of Apideck Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.