AMCS Group Payment API
The Payment API from AMCS Group — 3 operation(s) for payment.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amcs-group-payment-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Core AccessGroup Payment API
version: core
servers:
- url: https://rstapi-sbx-svc-core.amcsplatform.com/erp/api/integrator/erp
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Payment
paths:
/accounting/payments/changes:
get:
tags:
- Payment
summary: Retrieve changes
description: "| Property | Description |\n| -------------- | ------------------------------------------------------------ |\n| GUID | The GUID associated to the payment. |\n| RelatedCustomerGuid | The GUID associated to the customer of the payment. Filterable. | \n| PaymentTypeListItem | The GUID and description of the payment type. |\n| PaymentPointListItem | The GUID and description of the payment point. |\n| Amount | The amount associated to the payment. |\n| Reference | The reference associated to the payment. |\n| EndToEndReference | The end to end reference associated to the payment. |\n| Notes | The Notes associated to the payment. |\n| IsBad | The IsBad associated to the payment. |\n| DateBad | The bad date associated to the payment. |\n| DateBadExported | The bad date exported associated to the payment. |\n| DateCleared | The cleared date associated to the payment. |\n| DateExported | The exported date associated to the payment. |\n| DateProcessed | The processed date associated to the payment. |\n| DateInput | The input date associated to the payment. |\n| DateReceived | The received date associated to the payment. |\n| IsAutoAllocated | Whether the payment is auto allocated, null by default. |\n| AccountingPeriodListItem | The GUID and description of the accounting period of the payment. |\n| Allocations | The list of allocations associated to the payment. |\n| Allocations[0].Guid | The GUID associated to the allocation. |\n| Allocations[0].Amount | The Amount associated to the allocation. |\n| Allocations[0].DateInput | The DateInput associated to the allocation. |\n| Allocations[0].AccountingPeriodListItem | The GUID and descriptopn of the accounting period associated to the allocation. |\n| Allocations[0].RelatedInvoiceGuid | The GUID associated to the invoice of the allocation. |\n| Deallocations | The list of deallocations associated to the payment. |\n| Deallocations[0].Guid | The GUID associated to the deallocation. |\n| Deallocations[0].Amount | The amount associated to the deallocation. |\n| Deallocations[0].DateInput | The date input associated to the deallocation. |\n| Deallocations[0].DateDeallocated | The date deallocated associated to the deallocation. |\n| Deallocations[0].AllocationAccountingPeriodListItem | The GUID and descriptopn of the allocation accounting period associated to the deallocation. |\n| Deallocations[0].DeallocationAccountingPeriodListItem | The GUID and descriptopn of the deallocation accounting period associated to the deallocation. |\n| Deallocations[0].RelatedInvoiceGuid | The GUID associated to the invoice of the deallocation. |\n| Deallocations[0].RelatedUserDeallocatedByGuid | The GUID associated to the sysuser of the deallocation. |\n| RelatedInvoiceGuidFilter | Used to filter by the related invoice GUID. |\n| RelatedJobGuids | The list of job GUIDs associated to the payment. |\n| RelatedSysUserGuid | The GUID associated to the sys user of the payment. Filterable. | \n| RelatedJobGuids[0].RelatedJobGuid | The GUID associated to the job. |\n| AccountingPeriodBadListItem | The GUID and description of the bad accounting period of the payment. |\n| ReasonBadListItem | The GUID and description of the bad reason of the payment. |\n| PaymentTransactions | The list of Payment Transactions associated to the payment. |\n| PaymentTransactions[0].Guid| The guid associated to the payment transaction. |\n| PaymentTransactions[0].IsDeleted| Whether the payment transaction is deleted. |\n| PaymentTransactions[0].CardType| The CardType associated to the payment transaction. |\n| PaymentTransactions[0].MaskedCardNumber| The MaskedCardNumber associated to the payment transaction. |\n| PaymentTransactions[0].DateReceived| The DateReceived associated to the payment transaction. |\n| PaymentTransactions[0].PaymentReference| The PaymentReference associated to the payment transaction. |\n| PaymentTransactions[0].Reference| The Reference associated to the payment transaction. |\n| PaymentTransactions[0].PaymentProvider| The PaymentProvider associated to the payment transaction. |\n| PaymentTransactions[0].ResultMessage| The ResultMessage associated to the payment transaction. |\n| PaymentTransactions[0].Notes| The Notes associated to the payment transaction. |\n| PaymentTransactions[0].ResponseCode| The ResponseCode associated to the payment transaction. |\n| PaymentTransactions[0].CurrencyCode| The CurrencyCode associated to the payment transaction. |\n| PaymentTransactions[0].Amount| The Amount associated to the payment transaction. |\n| PaymentTransactions[0].ContactGuid| The Guid associated to the contact of the payment transaction. |\n| PaymentTransactions[0].AmountRefundable | The AmountRefundable associated to the payment transaction. |\n| PaymentTransactions[0].ReasonListItem | The GUID and description of the reason of the payment transaction. |\n| PaymentTransactions[0].PaymentProviderListItem | The GUID and description of the Payment Provider of the payment transaction. |\n| PaymentTransactions[0].PaymentPointListItem | The GUID and description of the Payment Point of the payment transaction. |\n| PaymentTransactions[0].TransactionStatusListItem | The GUID and description of the Transaction Status of the payment transaction. |\n| PaymentTransactions[0].PaymentTypeListItem | The GUID and description of the Payment Type of the payment transaction. |\n| IsRefund | The IsRefund associated to the payment. |\n| TransactionPaymentReferenceFilter | Used to filter by Payment Reference of the Payment Transaction. |\n| TransactionReferenceFilter | Used to filter by Reference of the Payment Transaction. |\n| RelatedRemitLocationGuid | The GUID associated to the Remit Location for this payment. Filterable.| \n| UnallocatedAmount | The unallocated amount associated to the payment. |\n"
operationId: Payment_GetChanges
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges_ApiIntegratorPaymentResource'
/accounting/payments/{guid}:
get:
tags:
- Payment
summary: Find with GUID
description: "| Property | Description |\n| -------------- | ------------------------------------------------------------ |\n| GUID | The GUID associated to the payment. |\n| RelatedCustomerGuid | The GUID associated to the customer of the payment. Filterable. | \n| PaymentTypeListItem | The GUID and description of the payment type. |\n| PaymentPointListItem | The GUID and description of the payment point. |\n| Amount | The amount associated to the payment. |\n| Reference | The reference associated to the payment. |\n| EndToEndReference | The end to end reference associated to the payment. |\n| Notes | The Notes associated to the payment. |\n| IsBad | The IsBad associated to the payment. |\n| DateBad | The bad date associated to the payment. |\n| DateBadExported | The bad date exported associated to the payment. |\n| DateCleared | The cleared date associated to the payment. |\n| DateExported | The exported date associated to the payment. |\n| DateProcessed | The processed date associated to the payment. |\n| DateInput | The input date associated to the payment. |\n| DateReceived | The received date associated to the payment. |\n| IsAutoAllocated | Whether the payment is auto allocated, null by default. |\n| AccountingPeriodListItem | The GUID and description of the accounting period of the payment. |\n| Allocations | The list of allocations associated to the payment. |\n| Allocations[0].Guid | The GUID associated to the allocation. |\n| Allocations[0].Amount | The Amount associated to the allocation. |\n| Allocations[0].DateInput | The DateInput associated to the allocation. |\n| Allocations[0].AccountingPeriodListItem | The GUID and descriptopn of the accounting period associated to the allocation. |\n| Allocations[0].RelatedInvoiceGuid | The GUID associated to the invoice of the allocation. |\n| Deallocations | The list of deallocations associated to the payment. |\n| Deallocations[0].Guid | The GUID associated to the deallocation. |\n| Deallocations[0].Amount | The amount associated to the deallocation. |\n| Deallocations[0].DateInput | The date input associated to the deallocation. |\n| Deallocations[0].DateDeallocated | The date deallocated associated to the deallocation. |\n| Deallocations[0].AllocationAccountingPeriodListItem | The GUID and descriptopn of the allocation accounting period associated to the deallocation. |\n| Deallocations[0].DeallocationAccountingPeriodListItem | The GUID and descriptopn of the deallocation accounting period associated to the deallocation. |\n| Deallocations[0].RelatedInvoiceGuid | The GUID associated to the invoice of the deallocation. |\n| Deallocations[0].RelatedUserDeallocatedByGuid | The GUID associated to the sysuser of the deallocation. |\n| RelatedInvoiceGuidFilter | Used to filter by the related invoice GUID. |\n| RelatedJobGuids | The list of job GUIDs associated to the payment. |\n| RelatedSysUserGuid | The GUID associated to the sys user of the payment. Filterable. | \n| RelatedJobGuids[0].RelatedJobGuid | The GUID associated to the job. |\n| AccountingPeriodBadListItem | The GUID and description of the bad accounting period of the payment. |\n| ReasonBadListItem | The GUID and description of the bad reason of the payment. |\n| PaymentTransactions | The list of Payment Transactions associated to the payment. |\n| PaymentTransactions[0].Guid| The guid associated to the payment transaction. |\n| PaymentTransactions[0].IsDeleted| Whether the payment transaction is deleted. |\n| PaymentTransactions[0].CardType| The CardType associated to the payment transaction. |\n| PaymentTransactions[0].MaskedCardNumber| The MaskedCardNumber associated to the payment transaction. |\n| PaymentTransactions[0].DateReceived| The DateReceived associated to the payment transaction. |\n| PaymentTransactions[0].PaymentReference| The PaymentReference associated to the payment transaction. |\n| PaymentTransactions[0].Reference| The Reference associated to the payment transaction. |\n| PaymentTransactions[0].PaymentProvider| The PaymentProvider associated to the payment transaction. |\n| PaymentTransactions[0].ResultMessage| The ResultMessage associated to the payment transaction. |\n| PaymentTransactions[0].Notes| The Notes associated to the payment transaction. |\n| PaymentTransactions[0].ResponseCode| The ResponseCode associated to the payment transaction. |\n| PaymentTransactions[0].CurrencyCode| The CurrencyCode associated to the payment transaction. |\n| PaymentTransactions[0].Amount| The Amount associated to the payment transaction. |\n| PaymentTransactions[0].ContactGuid| The Guid associated to the contact of the payment transaction. |\n| PaymentTransactions[0].AmountRefundable | The AmountRefundable associated to the payment transaction. |\n| PaymentTransactions[0].ReasonListItem | The GUID and description of the reason of the payment transaction. |\n| PaymentTransactions[0].PaymentProviderListItem | The GUID and description of the Payment Provider of the payment transaction. |\n| PaymentTransactions[0].PaymentPointListItem | The GUID and description of the Payment Point of the payment transaction. |\n| PaymentTransactions[0].TransactionStatusListItem | The GUID and description of the Transaction Status of the payment transaction. |\n| PaymentTransactions[0].PaymentTypeListItem | The GUID and description of the Payment Type of the payment transaction. |\n| IsRefund | The IsRefund associated to the payment. |\n| TransactionPaymentReferenceFilter | Used to filter by Payment Reference of the Payment Transaction. |\n| TransactionReferenceFilter | Used to filter by Reference of the Payment Transaction. |\n| RelatedRemitLocationGuid | The GUID associated to the Remit Location for this payment. Filterable.| \n| UnallocatedAmount | The unallocated amount associated to the payment. |\n"
operationId: Payment_Get
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity_ApiIntegratorPaymentResource'
put:
tags:
- Payment
summary: Partial update
description: '| Property | Description | Required |
| -------------- | ------------------------------------------------------------ | -------- |
| GUID | The GUID associated to the payment. | No |
| RelatedCustomerGuid | The GUID associated to the customer of to the payment. | Yes |
| PaymentTypeListItem | The GUID and description of the payment type. | Yes |
| PaymentPointListItem | The GUID and description of the payment point. | Yes |
| Amount | The amount associated to the payment. | Yes |
| Reference | The reference associated to the payment. | No |
| EndToEndReference | The end to end reference associated to the payment. | No |
| Notes | The Notes associated to the payment. | No |
| IsBad | The IsBad associated to the payment. | No |
| DateBad | The bad date associated to the payment.| No |
| DateBadExported | The bad date exported associated to the payment.| No |
| DateCleared | The cleared date associated to the payment.| No |
| DateExported | The exported date associated to the payment.| No |
| DateProcessed | The processed date associated to the payment.| No |
| DateInput | The input date associated to the payment.| Yes |
| DateReceived | The received date associated to the payment.| Yes |
| IsAutoAllocated | Whether the payment is auto allocated, null by default. | No |
| AccountingPeriodListItem | The GUID and description of the accounting period of the payment. | No |
| Allocations | The list of allocations associated to the payment. | No |
| Allocations[0].Guid | The GUID associated to the allocation. | No |
| Allocations[0].Amount | The Amount associated to the allocation. | Yes |
| Allocations[0].DateInput | The DateInput associated to the allocation. | No |
| Allocations[0].AccountingPeriodListItem | The GUID and description of the accounting period associated to the allocation. | No |
| Allocations[0].RelatedInvoiceGuid | The GUID associated to the invoice of the allocation. | Yes |
| Deallocations | The list of deallocations associated to the payment. | No |
| Deallocations[0].Guid | The GUID associated to the deallocation. | No |
| Deallocations[0].Amount | The amount associated to the deallocation. | Yes |
| Deallocations[0].DateInput | The date input associated to the deallocation. | No |
| Deallocations[0].DateDeallocated | The date deallocated associated to the deallocation. | No |
| Deallocations[0].AllocationAccountingPeriodListItem | The GUID and descriptopn of the allocation accounting period associated to the deallocation. | No |
| Deallocations[0].DeallocationAccountingPeriodListItem | The GUID and descriptopn of the deallocation accounting period associated to the deallocation. | No |
| Deallocations[0].RelatedInvoiceGuid | The GUID associated to the invoice of the deallocation. | Yes |
| Deallocations[0].RelatedUserDeallocatedByGuid | The GUID associated to the sysuser of the deallocation. | Yes |
| RelatedInvoiceGuidFilter | Used to filter by the related invoice GUID. | No |
| RelatedJobGuids | The list of job GUIDs associated to the payment. | No |
| RelatedSysUserGuid | The GUID associated to the sys user of the payment. | Yes |
| RelatedJobGuids[0].RelatedJobGuid | The GUID associated to the job. | No |
| AccountingPeriodBadListItem | The GUID and description of the bad accounting period of the payment. | No |
| ReasonBadListItem | The GUID and description of the bad reason of the payment. | No |
| PaymentTransactions | The list of Payment Transactions associated to the payment. | No |
| PaymentTransactions[0].Guid| The guid associated to the payment transaction. | No |
| PaymentTransactions[0].IsDeleted| Whether the payment transaction is deleted. | No |
| PaymentTransactions[0].CardType| The CardType associated to the payment transaction. | No |
| PaymentTransactions[0].MaskedCardNumber| The MaskedCardNumber associated to the payment transaction. | No |
| PaymentTransactions[0].DateReceived| The DateReceived associated to the payment transaction. | No |
| PaymentTransactions[0].PaymentReference| The PaymentReference associated to the payment transaction. | No |
| PaymentTransactions[0].Reference| The Reference associated to the payment transaction. | No |
| PaymentTransactions[0].PaymentProvider| The PaymentProvider associated to the payment transaction. | No |
| PaymentTransactions[0].ResultMessage| The ResultMessage associated to the payment transaction. | No |
| PaymentTransactions[0].Notes| The Notes associated to the payment transaction. | No |
| PaymentTransactions[0].ResponseCode| The ResponseCode associated to the payment transaction. | No |
| PaymentTransactions[0].CurrencyCode| The CurrencyCode associated to the payment transaction. | No |
| PaymentTransactions[0].Amount| The Amount associated to the payment transaction. | No |
| PaymentTransactions[0].ContactGuid| The Guid associated to the contact of the payment transaction. | No |
| PaymentTransactions[0].AmountRefundable | The AmountRefundable associated to the payment transaction. | No |
| PaymentTransactions[0].ReasonListItem | The GUID and description of the reason of the payment transaction. | No |
| PaymentTransactions[0].PaymentProviderListItem | The GUID and description of the Payment Provider of the payment transaction. | No |
| PaymentTransactions[0].PaymentPointListItem | The GUID and description of the Payment Point of the payment transaction. | No |
| PaymentTransactions[0].TransactionStatusListItem | The GUID and description of the Transaction Status of the payment transaction. | No |
| PaymentTransactions[0].PaymentTypeListItem | The GUID and description of the Payment Type of the payment transaction. | No |
| IsRefund | The IsRefund associated to the payment. | No |
| RelatedRemitLocationGuid | The RemitLocaion GUID associated to the payment(For refund only). | No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| Customer not found with value RelatedCustomerGuid | Failed to retrieve Customer with RelatedCustomerGuid of {value of RelatedCustomerGuid} |
| PaymentType not found with value PaymentTypeListItem.Guid | Failed to retrieve PaymentType with PaymentTypeListItem.Guid of {value of PaymentTypeListItem.Guid} |
| PaymentPoint not found with value PaymentPointListItem.Guid | Failed to retrieve PaymentPoint with PaymentPointListItem.Guid of {value of PaymentPointListItem.Guid} |
| A new value for date received should not provided as part of an update | Request a payment update with an unchanged date received or make a PUT request leaving date received property out of the resource |
| A new value for date input should not provided as part of an update | Request a payment update with an unchanged date input or make a PUT request leaving date input property out of the resource |
| Date cleared must be on or after date received | Request a payment update with date cleared are null or after the date received |
| Date processed must be on or after date received | Request a payment update with date processed are null or after the date received |
| Date bad must be on or after date received | Request a payment update with date bad are null or after the date received |
| Date bad must be provided | Request a payment update with date bad to mark bad export |
| Date bad exported must be on or after date bad | Request a payment update with date bad exported are null or after the date bad |
| Date exported must be on or after date received | Request a payment update with date exported are null or after the date received |
| The accounting period is closed | Failed to save. Payment with AccountingPeriodListItem.GUID of xxxxxx-xxxxxxx is not a valid accounting period because it is closed |
| Deallocations is a read-only property | Request a payment update with deallocations are null or empty |
| Updating a bad payment | Payment is bad. Could not update the payment. Create a new payment rather than attempting to update the payment that has been marked as bad |
| Updating a payment to make it bad if required fields DateBad, ReasonBadListItem, and Accounting PeriodBadListItem are not found | Details for marking a payment as bad missing. Could not update the payment. To mark a payment as bad set the DateBad, ReasonBadListItem, and Accounting PeriodBadListItem |
| AccountingPeriodBadListItem for a closed accounting period | AccountingPeriodBad is closed. Could not mark the payment as bad. Set the AccountingPeriodBadListItem to an open accounting period |
| ReasonBadListItem value from different reason category other than Bad Payment | ReasonListItem must be in one of the following reason categories: BadPayment. |
| ReasonBadListItem with deleted reason value from Bad Payment reason category | The provided ReasonBadListItem is deleted. Could not update the resource. Please check the relevant list end point for the available options. |
| If PaymentTransactions is not null on Update | PaymentTransactions is a read-only property. |
| If the payment is already allocated and IsAutoAllocated is true on update | Failed to save/update Payment because the payment is already allocated. |
| If IsRefund is null or false and RemitLocation has a value | IsRefund flag is false, RelatedRemitLocationGuid can only be supplied for refund payments. |
| If IsRefund is true and RemitLocation doesn''t have a value | IsRefund flag is true, RelatedRemitLocationGuid must be supplied for refund payments. |
| If RelatedRemitLocationGuid doesn''t relate to customer site''s locations | The provided RelatedRemitLocationGuid doesn''t relate to any of the customer sites location. |
| If RelatedSysUserGuid is changed on Update | RelatedSysUserGuid is a read-only property. |
'
operationId: Payment_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorPaymentResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/accounting/payments:
get:
tags:
- Payment
summary: Find with Filters
description: "| Property | Description |\n| -------------- | ------------------------------------------------------------ |\n| GUID | The GUID associated to the payment. |\n| RelatedCustomerGuid | The GUID associated to the customer of the payment. Filterable. | \n| PaymentTypeListItem | The GUID and description of the payment type. |\n| PaymentPointListItem | The GUID and description of the payment point. |\n| Amount | The amount associated to the payment. |\n| Reference | The reference associated to the payment. |\n| EndToEndReference | The end to end reference associated to the payment. |\n| Notes | The Notes associated to the payment. |\n| IsBad | The IsBad associated to the payment. |\n| DateBad | The bad date associated to the payment. |\n| DateBadExported | The bad date exported associated to the payment. |\n| DateCleared | The cleared date associated to the payment. |\n| DateExported | The exported date associated to the payment. |\n| DateProcessed | The processed date associated to the payment. |\n| DateInput | The input date associated to the payment. |\n| DateReceived | The received date associated to the payment. |\n| IsAutoAllocated | Whether the payment is auto allocated, null by default. |\n| AccountingPeriodListItem | The GUID and description of the accounting period of the payment. |\n| Allocations | The list of allocations associated to the payment. |\n| Allocations[0].Guid | The GUID associated to the allocation. |\n| Allocations[0].Amount | The Amount associated to the allocation. |\n| Allocations[0].DateInput | The DateInput associated to the allocation. |\n| Allocations[0].AccountingPeriodListItem | The GUID and descriptopn of the accounting period associated to the allocation. |\n| Allocations[0].RelatedInvoiceGuid | The GUID associated to the invoice of the allocation. |\n| Deallocations | The list of deallocations associated to the payment. |\n| Deallocations[0].Guid | The GUID associated to the deallocation. |\n| Deallocations[0].Amount | The amount associated to the deallocation. |\n| Deallocations[0].DateInput | The date input associated to the deallocation. |\n| Deallocations[0].DateDeallocated | The date deallocated associated to the deallocation. |\n| Deallocations[0].AllocationAccountingPeriodListItem | The GUID and descriptopn of the allocation accounting period associated to the deallocation. |\n| Deallocations[0].DeallocationAccountingPeriodListItem | The GUID and descriptopn of the deallocation accounting period associated to the deallocation. |\n| Deallocations[0].RelatedInvoiceGuid | The GUID associated to the invoice of the deallocation. |\n| Deallocations[0].RelatedUserDeallocatedByGuid | The GUID associated to the sysuser of the deallocation. |\n| RelatedInvoiceGuidFilter | Used to filter by the related invoice GUID. |\n| RelatedJobGuids | The list of job GUIDs associated to the payment. |\n| RelatedSysUserGuid | The GUID associated to the sys user of the payment. Filterable. | \n| RelatedJobGuids[0].RelatedJobGuid | The GUID associated to the job. |\n| AccountingPeriodBadListItem | The GUID and description of the bad accounting period of the payment. |\n| ReasonBadListItem | The GUID and description of the bad reason of the payment. |\n| PaymentTransactions | The list of Payment Transactions associated to the payment. |\n| PaymentTransactions[0].Guid| The guid associated to the payment transaction. |\n| PaymentTransactions[0].IsDeleted| Whether the payment transaction is deleted. |\n| PaymentTransactions[0].CardType| The CardType associated to the payment transaction. |\n| PaymentTransactions[0].MaskedCardNumber| The MaskedCardNumber associated to the payment transaction. |\n| PaymentTransactions[0].DateReceived| The DateReceived associated to the payment transaction. |\n| PaymentTransactions[0].PaymentReference| The PaymentReference associated to the payment transaction. |\n| PaymentTransactions[0].Reference| The Reference associated to the payment transaction. |\n| PaymentTransactions[0].PaymentProvider| The PaymentProvider associated to the payment transaction. |\n| PaymentTransactions[0].ResultMessage| The ResultMessage associated to the payment transaction. |\n| PaymentTransactions[0].Notes| The Notes associated to the payment transaction. |\n| PaymentTransactions[0].ResponseCode| The ResponseCode associated to the payment transaction. |\n| PaymentTransactions[0].CurrencyCode| The CurrencyCode associated to the payment transaction. |\n| PaymentTransactions[0].Amount| The Amount associated to the payment transaction. |\n| PaymentTransactions[0].ContactGuid| The Guid associated to the contact of the payment transaction. |\n| PaymentTransactions[0].AmountRefundable | The AmountRefundable associated to the payment transaction. |\n| PaymentTransactions[0].ReasonListItem | The GUID and description of the reason of the payment transaction. |\n| PaymentTransactions[0].PaymentProviderListItem | The GUID and description of the Payment Provider of the payment transaction. |\n| PaymentTransactions[0].PaymentPointListItem | The GUID and description of the Payment Point of the payment transaction. |\n| PaymentTransactions[0].TransactionStatusListItem | The GUID and description of the Transaction Status of the payment transaction. |\n| PaymentTransactions[0].PaymentTypeListItem | The GUID and description of the Payment Type of the payment transaction. |\n| IsRefund | The IsRefund associated to the payment. |\n| TransactionPaymentReferenceFilter | Used to filter by Payment Reference of the Payment Transaction. |\n| TransactionReferenceFilter | Used to filter by Reference of the Payment Transaction. |\n| RelatedRemitLocationGuid | The GUID associated to the Remit Location for this payment. Filterable.| \n| UnallocatedAmount | The unallocated amount associated to the payment. |\n"
operationId: Payment_GetCollection
parameters:
- name: filter
in: query
schema:
type: string
- name: max
in: query
schema:
type: integer
format: int32
- name: page
in: query
schema:
type: integer
format: int32
- name: includeCount
in: query
schema:
type: boolean
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection_ApiIntegratorPaymentResource'
post:
tags:
- Payment
summary: Create or update
description: '| Property | Description | Required |
| -------------- | ------------------------------------------------------------ | -------- |
| GUID | The GUID associated to the payment. | No |
| RelatedCustomerGuid | The GUID associated to the customer of to the payment. | Yes |
| PaymentTypeListItem | The GUID and description of the payment type. | Yes |
| PaymentPointListItem | The GUID and description of the payment point. | Yes |
| Amount | The amount associated to the payment. | Yes |
| Reference | The reference associated to the payment. | No |
| EndToEndReference | The end to end reference associated to the payment. | No |
| Notes | The Notes associated to the payment. | No |
| IsBad | The IsBad associated to the payment. | No |
| DateBad | The bad date
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-payment-api-openapi.yml