Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AMCS Group ExternalTransaction API

The ExternalTransaction API from AMCS Group — 12 operation(s) for externaltransaction.

AMCS Group ExternalTransaction API is one of 257 APIs that AMCS Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ExternalTransaction. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 12 paths, and defines 37 schemas. It is described by OpenAPI 3.0.1, at version core.

Requests are made against the base URL https://rstapi-sbx-svc-core.amcsplatform.com/erp/api/integrator/erp.

12 operations 12 paths 37 schemas 2 GET10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
core
Base URL
https://rstapi-sbx-svc-core.amcsplatform.com/erp/api/integrator/erp
Resource Areas
1

Paths & Operations 12

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

ExternalTransaction 12
POST
/ExternalTransaction/OneOff
OneOff Payment
body → 200400401500
POST
/ExternalTransaction/ImmediateOneOff
Immediate OneOff Payment
body → 200400401500
GET
/ExternalTransaction/Poll
Poll Payment
2 params → 200400401404500
GET
/ExternalTransaction/Poll/GetAll
Get All Payment Response Details
3 params → 200400401404500
POST
/ExternalTransaction/Refund
Refund Payment
body → 200400401500
POST
/ExternalTransaction/Vault
Vault Payment
body → 200400401500
POST
/ExternalTransaction/Terminal
Terminal Payment
body → 200400401500
POST
/ExternalTransaction/TerminalAbort
Terminal Payment Abort
body → 200400401500
POST
/ExternalTransaction/DeleteToken
Delete Token
body → 200400401404500
POST
/ExternalTransaction/GetServiceFee
Get ServiceFee
body → 200400401500
POST
/ExternalTransaction/RetryTransaction
Retry Transaction
body → 200400401500
POST
/ExternalTransaction/CreateCustomer
Create Customer
body → 200400500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are AMCSPayPollGetAllPaymentResponse (24 properties), AMCSPayPollPaymentResponse (17 properties), AMCSPayTerminalResponse (15 properties), AMCSPayInitiatePaymentRequest (14 properties). Each schema is shown below with its type and property counts.

AMCSPayGetServiceFeeResponse
object
5 properties
AMCSPayBankInfo
object
2 properties
AMCSPayErrorResponse
object
3 properties
AMCSPayCreateCustomerResponse
object
2 properties
AMCSPayDeleteProfileResponse
object
8 properties
AMCSPayPollGetAllPaymentResponse
object
24 properties
AMCSPayInitiatePaymentResponse
object
4 properties
AMCSPayContact
object
2 properties
AMCSPayAmount
object
The amount associated to the payment.
2 properties 2 required
AMCSPayTerminalRequest
object
8 properties 7 required
AMCS.Pay.Entity.Api.Payments.ExternalTransaction.ApiErrorResponse
object
3 properties
AMCSPayEftBankInfo
object
3 properties
AMCSPayCreatePaymentAccountResponse
object
Details of the customer account and payment account created if isCreatePaymentAccount is set to true in the request.
8 properties
AMCSPayInfoResponse
object
1 property
AMCSPayVaultRequest
object
11 properties 7 required
AMCSPayDeleteProfileRequest
object
8 properties 7 required
AMCSPayCreateCustomerRequest
object
4 properties 3 required
AMCSPayCreateCustomerDetail
object
Contains details about the customer to be created.
2 properties 2 required
AMCSPayRetryTransactionResponse
object
8 properties
AMCSPayImmediatePaymentRequest
object
11 properties 8 required
AMCSPayCustomerInfo
object
5 properties
AMCSPayAddress
object
9 properties
TermsAndConditions
object
The terms and conditions.
3 properties 3 required
AMCSPayRefundResponse
object
10 properties
AMCSPayGetServiceFeeRequest
object
3 properties 3 required
AMCSPayVaultCustomerInfo
object
5 properties 4 required
AMCSPayServiceFeePaymentDetails
object
The service fee details associated to the transaction.
4 properties
AMCSPayInitiatePaymentRequest
object
14 properties 7 required
AMCSPayPaymentAccount
object
Details of the payment account to create if isCreatePaymentAccount is set to true .
3 properties 3 required
AMCSPayRetryTransactionRequest
object
2 properties 2 required
AMCSPayAchBankInfo
object
3 properties
AMCSPayTerminalAbortRequest
object
7 properties 5 required
AMCSPayResult
object
AMCS Pay standardised result code and message returned by the payment provider. Success example: json { "code": "000.000.000", "message": "Transaction succeede…
2 properties
AMCSPayPollPaymentResponse
object
17 properties
AMCSPayTerminalResponse
object
15 properties
AMCSPayVaultResponse
object
10 properties
AMCSPayRefundRequest
object
12 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amcs-group-externaltransaction-api-openapi.yml Raw ↑

Other APIs AMCS Group publishes across the network.

AMCS Group AccessGroup API
AMCS Group AccessPassHistory API
AMCS Group AccountBalance API
AMCS Group AccountCustomer API
AMCS Group AccountingPeriod API
AMCS Group AccountingPeriodInventoryBatch API
AMCS Group AccountingPeriodLock API
AMCS Group Action API
AMCS Group ActionType API
AMCS Group AllContaminationEvent API
AMCS Group AllOverfilledContainerEvent API
AMCS Group ApiConfigurationService API