AMCS Group ExternalTransaction API
The ExternalTransaction API from AMCS Group — 12 operation(s) for externaltransaction.
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-externaltransaction-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 External Transaction 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: ExternalTransaction
paths:
/ExternalTransaction/OneOff:
post:
tags:
- ExternalTransaction
summary: OneOff Payment
description: 'This endpoint is used to initiate a payment/tokenization request via the Provider''s hosted payments page (HPP).
## Request
| Property | Description |
| ------------------------- | ------------------------------------------------------------------------|
| RequestType |Request Type can be any of "OneOffPayment", "Tokenization". |
| PaymentType | Payment Type can be any of "CARD", "ACH", "EFT". |
| TransactionOrigin | Transaction Origin can be any of "MOTO", "ECOM" |
| CallerIdentifier | The Caller Identification associated to the Payment request. |
| RequestId | The Caller supplied GUID associated to the Payment request. |
| ProviderType |Provide Type can be any of "ACICards", "ACIElectronic", "Heartland", "MerchantPartners", "Payment Express", "Realex" |
| ConfigurationId |The configuration id associated to the Tenant. |
| TransactionAmount |The amount associated to the payment request. |
| TransactionAmount.PrincipalAmount |The base amount associated to the payment request (This field is optional for Tokenization). |
| TransactionAmount.Currency |The currency associated to the payment request. |
| CanStoreProfile | The flag suggests store the profile to vault. |
| CompletionURL | The Completion URL Request associated to the customer mandate for webhooks. |
| RedirectURL | The Redirect URL associated to the customer mandate for redirection. |
| Addresses | The List of addresses associated to the customer mandate for 3ds transaction (Billing address is mandatory for 3ds enabled transaction). |
| Addresses[0].AddressType | The AddressType associated to the address can be any of "Billing", "Shipping". |
| Addresses[0].StreetAddress1 | The StreetAddress Line1 associated to the address. |
| Addresses[0].StreetAddress2 | The StreetAddress Line2 associated to the address. |
| Addresses[0].StreetAddress3 | The StreetAddress Line3 associated to the address (Conditionally required). |
| Addresses[0].City | The City associated to the address. |
| Addresses[0].State | The State associated to the address. |
| Addresses[0].PostCode | The PostCode associated to the address. |
| Addresses[0].Country | The Country associated to the address. |
| Addresses[0].ISO3166Numeric | The ISO3166Numeric associated to the address (Conditionally required). |
| Contacts | The Contacts associated to the customer mandate for 3ds transaction (Contact type ''Mobile'' and ''Email'' are mandatory for 3ds enabled transaction). |
| Contacts[0].ContactType | The Contact Type associated to the contact can be any of type "Email", "Mobile". |
| Contacts[0].ContactValue | The Contact Value associated to the contact type. |
| CustomerInfo | The Details associated to the customer mandate for risk assessment (Conditionally required for making payments using ACI Cards). |
| CustomerInfo.CustomerName | The Customer Name associated to the customer. |
| CustomerInfo.CustomerId | The Customer Id associated to the customer. |
| CustomerInfo.CustomerIP | The Customer Ip associated to the customer. |
| CustomerInfo.CustomerStatus | The Customer Status associated to the customer. |
| CustomerInfo.WebsiteUrl | The Website Url associated to the customer.
## Response
| Property | Description |
| ------------------------- | ------------------------------------------------------------------------|
| HppUrl | The Hosted Payment Page Url to load in a frame/browser. |
| CallerTransactionId | The AMCS generated Request GUID associated to the Payment request. |
| TransactionAmount |The amount associated to the payment request. |
| TransactionAmount.PrincipalAmount |The base amount associated to the payment request (This field is optional for Tokenization). |
| TransactionAmount.Currency |The currency associated to the payment request. |
| TransactionStatus | The Transaction Status associated to the Payment request.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayInitiatePaymentRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayInitiatePaymentResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
/ExternalTransaction/ImmediateOneOff:
post:
tags:
- ExternalTransaction
summary: Immediate OneOff Payment
description: 'This endpoint is used to make an immediate payment/tokenization request.
## Request
| Property | Description |
| ------------------------- | ------------------------------------------------------------------------|
| RequestType |Request Type can be any of "OneOffPayment", "Tokenization". |
| PaymentType | Payment Type can be any of "ACH", "EFT". |
| CallerIdentifier | The Caller Identification associated to the Payment request. |
| RequestId | The Caller supplied GUID associated to the Payment request. |
| ProviderType |Provide Type can be "EftCanada" |
| ConfigurationId |The configuration id associated to the Tenant. |
| TransactionAmount |The amount associated to the payment request. |
| TransactionAmount.PrincipalAmount |The base amount associated to the payment request (This field is optional for Tokenization). |
| TransactionAmount.Currency |The currency associated to the payment request. |
| Addresses | The List of addresses associated to the customer mandate for 3ds transaction (Billing address is mandatory for 3ds enabled transaction). |
| Addresses[0].AddressType | The AddressType associated to the address can be any of "Billing", "Shipping". |
| Addresses[0].StreetAddress1 | The StreetAddress Line1 associated to the address. |
| Addresses[0].StreetAddress2 | The StreetAddress Line2 associated to the address. |
| Addresses[0].StreetAddress3 | The StreetAddress Line3 associated to the address (Conditionally required). |
| Addresses[0].City | The City associated to the address. |
| Addresses[0].State | The State associated to the address. |
| Addresses[0].PostCode | The PostCode associated to the address. |
| Addresses[0].Country | The Country associated to the address. |
| Addresses[0].ISO3166Numeric | The ISO3166Numeric associated to the address (Conditionally required). |
| Contacts | The Contacts associated to the customer mandate for 3ds transaction (Contact type ''Mobile'' and ''Email'' are mandatory for 3ds enabled transaction). |
| Contacts[0].ContactType | The Contact Type associated to the contact can be any of type "Email", "Mobile". |
| Contacts[0].ContactValue | The Contact Value associated to the contact type. |
| CustomerInfo | The Details associated to the customer mandate for risk assessment (Conditionally required for making payments using EftCanada). |
| CustomerInfo.CustomerName | The Customer Name associated to the customer(Conditionally required for making payments using EftCanada). |
| CustomerInfo.CustomerId | The Customer Id associated to the customer. |
| CustomerInfo.CustomerIP | The Customer Ip associated to the customer. |
| CustomerInfo.CustomerStatus | The Customer Status associated to the customer. |
| CustomerInfo.WebsiteUrl | The Website Url associated to the customer. |
| BankInfo | The Bank Info associated to the customer. |
| BankInfo.Ach | The Ach Bank Info associated to the customer (Required when Payment Type is ACH). |
| BankInfo.Ach.AccountNumber | The Ach Account Number associated to the customer. |
| BankInfo.Ach.AccountType | The Ach Account Type associated to the customer and could be one of "PersonalSavings", "PersonalCheckings", "BusinessSavings", "BusinessCheckings". |
| BankInfo.Ach.RoutingNumber | The Ach Routing Number associated to the customer. |
| BankInfo.Eft | The Eft Bank Info associated to the customer (Required when Payment Type is EFT). |
| BankInfo.Eft.AccountNumber | The Eft Account Number associated to the customer. |
| BankInfo.Eft.TransitNumber | The Eft Transit Number associated to the customer. |
| BankInfo.Eft.InstitutionNumber | The Eft Institution Number associated to the customer.
## Response
| Property | Description |
| ------------------------- | ------------------------------------------------------------------------|
|CallerTransactionId | The AMCS generated Request GUID associated to the payments. |
| AMCSPayReferenceId | The AMCS generated Response GUID associated to the Payment request. |
| ProviderReference | The reference number associated to the payment provider. |
| ProviderResponseCode | The response code associated to the payment provider. |
| Notes | More information associated to the payment. |
| ProviderAuthCode | The authorization code associated to the payment provider. |
| ResponseTimeStamp | The Timestamp of the payment response payload. |
| TransactionStatus | The Transaction Status associated to the payment can be any of type "Initiated", "Success", "Failure", "Timeout", "Cancelled". |
| TokenReference | The Token Reference sent by the provider associated to the original payment (Tokenisation Response). |
| HistoryReference | The history reference data sent by the provider associated to the original payment (Tokenisation Response). |
| MaskedProfileNumber | The Profile/Card Number sent by the provider associated to the original payment (Tokenisation Response) (Conditionally required). |
| ProfileType | The Profile/Card Type sent by the provider associated to the original payment (Tokenisation Response). |
| ProfileHolder | The Profile/Card Holder Name sent by the provider associated to the original payment (Tokenisation Response). |
| TransactionAmount |The amount associated to the payment request. |
| TransactionAmount.PrincipalAmount |The base amount associated to the payment request (This field is optional for Tokenization). |
| TransactionAmount.Currency |The currency associated to the payment request. |
| ErrorCondition |The error condition associated to the payment request. '
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayImmediatePaymentRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayPollPaymentResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
/ExternalTransaction/Poll:
get:
tags:
- ExternalTransaction
summary: Poll Payment
description: 'This endpoint is used to poll AmcsPay to ask for query transactions or to read the transaction response back to AmcsPay from the payment provider using CallerTransactionId or RequestId.
## Request
| **Property** | **Description** |
| --- | --- |
| CallerTransactionId | The AMCS generated Request GUID associated to the payments. |
| RequestId | The Caller Supplied Request GUID associated to the payments. |
## Response
| **Property** | **Description** |
| --- | --- |
| CallerTransactionId | The AMCS generated Request GUID associated to the payments. |
| AMCSPayReferenceId | The AMCS generated Response GUID associated to the Payment request. |
| ProviderReference | The reference number associated to the payment provider. |
| ProviderResponseCode | The response code associated to the payment provider. |
| Notes | More information associated to the payment. |
| ProviderAuthCode | The authorization code associated to the payment provider. |
| ResponseTimeStamp | The Timestamp of the payment response payload. |
| TransactionStatus | The Transaction Status associated to the payment can be any of type "Initiated", "Success", "Failure", "Timeout", "Cancelled". |
| TokenReference | The Token Reference sent by the provider associated to the original payment (Tokenisation Response). |
| HistoryReference | The history reference data sent by the provider associated to the original payment (Tokenisation Response). |
| MaskedProfileNumber | The Profile/Card Number sent by the provider associated to the original payment (Tokenisation Response) (Conditionally required). |
| ProfileType | The Profile/Card Type sent by the provider associated to the original payment (Tokenisation Response). |
| ProfileHolder | The Profile/Card Holder Name sent by the provider associated to the original payment (Tokenisation Response). |
| ProfileExpiryDate | The Profile/Card expiry date sent by the provider associated to the original payment in (MM/YY) format. |
| TransactionAmount |The amount associated to the payment request. |
| TransactionAmount.PrincipalAmount |The base amount associated to the payment request (This field is optional for Tokenization). |
| TransactionAmount.Currency |The currency associated to the payment request. |
| ErrorCondition |The error condition associated to the payment request.'
parameters:
- name: callerTransactionId
in: query
required: false
schema:
type: string
format: uuid
example: 827b7e68-2c52-43aa-9820-b02f006fa971
description: Required for all payments.
- name: requestId
in: query
required: false
schema:
type: string
format: uuid
example: 827b7e68-2c52-43aa-9820-b02f006fa971
description: Required for terminal payments if a response is not received.
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayPollPaymentResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'401':
description: Unauthorized
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
/ExternalTransaction/Poll/GetAll:
get:
tags:
- ExternalTransaction
summary: Get All Payment Response Details
description: This endpoint is used to get the payment transaction details based on the set filter criteria.
parameters:
- name: DateFrom
in: query
required: true
schema:
type: string
format: dateTimeOffset
example: '2023-06-28T06:46:32.910Z'
description: Date From is the user input in W3C-DTF Date format [YYYY-MM-DDThh:mm:ss.sTZD]. It cannot be later than the current date.
- name: DateTo
in: query
required: true
schema:
type: string
format: dateTimeOffset
example: '2023-06-28T07:00:00.000Z'
description: Date To is the user input in W3C-DTF Date format [YYYY-MM-DDThh:mm:ss.sTZD]. It cannot be later than the current date or the date from value.
- name: CustomerId
in: query
schema:
type: string
description: The customerId associated to the customer or the ARAccountCode account code used for Accounts Receivable.
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AMCSPayPollGetAllPaymentResponse'
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/AMCSPayPollGetAllPaymentResponse'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/AMCSPayPollGetAllPaymentResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'401':
description: Unauthorized
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
/ExternalTransaction/Refund:
post:
tags:
- ExternalTransaction
summary: Refund Payment
description: "This endpoint is used to request a refund for a Card/ACH payment already processed via AmcsPay.\n\n## Request\n\n| **Property** | **Description** |\n| --- | --- |\n| RequestType | Request Type is \"Refund\". |\n| PaymentType | Payment Type can be any of \"CARD\", \"ACH\", \"EFT\", \"TERMINAL\".| \n| TransactionOrigin | For Refund, transaction origin can only be \"MOTO\". |\n| CallerIdentifier | The identification associated to the calling application.| \n| RequestId | The Caller supplied GUID associated to the Payment request.|\n| CallerIPAddress | The IP Address associated to the the customer's location.|\n| ProviderType | Provide Type can be any of \"ACICards\", \"ACIElectronic\", \"Heartland\", \"MerchantPartners\", \"Payment Express\", \"Realex\", \"EftCanada\", \"TerminalPay\", \"ElavonTerminalPay\".| \n| TransactionAmount | The amount subjected for refund.|\n| OriginalPaymentReference | The reference ID sent by the provider associated to the original payment being refunded.|\n| OriginalAmount | The original amount sent by the provider associated to the original payment being refunded. |\n| TokenValue | The Token value associated to the payment. |\n| ProfileExpiryDate | The Profile/Card expiry date sent by the provider associated to the original payment in (MM/YY) format. |\n| CustomerInfo | The customer details associated to the refund request. |\n\n## Response\n\n| **Property** | **Description** |\n| --- | --- |\n| AMCSPayReferenceId | The AMCS generated Response GUID associated to the Payment request. |\n| ProviderReference | The reference number associated to the payment provider response. |\n| ProviderResponseCode | The status code associated to the payment provider response. |\n| ProviderAuthCode | The authorization code associated to the payment provider. |\n| TransactionAmount |The amount associated to the payment request. |\n| TransactionAmount.PrincipalAmount |The base amount associated to the payment request (This field is optional for Tokenization). |\n| TransactionAmount.Currency |The currency associated to the payment request. |\n| ResponseTimeStamp | The time stamp associated to the response payload. |\n| Notes | More information associated to the payment. |\n| TransactionStatus | The Transaction Status associated to the refund response can be any of type \"Initiated\" or \"Failure\". |\n| CustomerInfo | The customer details associated to the refund response. |"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayRefundRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayRefundResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
/ExternalTransaction/Vault:
post:
tags:
- ExternalTransaction
summary: Vault Payment
description: This endpoint is used to make a payment using the saved profile(Card / ACH) via AmcsPay.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayVaultRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayVaultResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
/ExternalTransaction/Terminal:
post:
tags:
- ExternalTransaction
summary: Terminal Payment
description: 'This endpoint is used to make a card payment using a terminal device.
## Request
| Property | Description |
| --- | --- |
| ProviderType | Provide Type can be any of "TerminalPay", and "ElavonTerminalPay". |
| CallerIdentifier | The Caller Identification associated to the Payment request. |
| RequestId | The Caller supplied Request GUID associated to the Payment request. |
| TerminalId | The Terminal Id is the verifone terminal identity like a device serial number or a friendly name. |
| TransactionAmount | The Amount associated to the payment request. |
| TransactionAmount.PrincipalAmount | The Principal Amount associated to the payment request. |
| TransactionAmount.Currency | The Currency associated to the payment request. |
| CardEntryMode | The Card entry mode of the payment instrument information. |
| EmailAddress | The e-mail address associated to the payment requestor. |
## Response
| **Property** | **Description** |
| --- | --- |
| TransactionStatus | The Transaction Status associated to the payment can be any of type "Success", "Failure", "Partial". For Partial, Check the device if payment is processed, Poll it. |
| AMCSPayReferenceId | The AMCS generated response GUID associated to the Payment request. |
| ProviderReference | The reference number associated to the payment provider. |
| ProviderResponseCode | The response code associated to the payment provider. |
| ProviderAuthCode | The authorization code associated to the payment provider. |
| TokenValue | The Token value associated to the payment. |
| ResponseTimeStamp | The Timestamp of the payment response payload. |
| Notes | More information associated to the payment transaction. |
| TransactionAmount | The Amount associated to the payment response. |
| TransactionAmount.PrincipalAmount | The Principal Amount associated to the payment response. |
| TransactionAmount.Currency | The Currency associated to the payment response. |
| MaskedProfileNumber | The Profile/Card Number sent by the provider associated to the original payment. |
| ProfileHolder | The Profile/Card Holder Name sent by the provider associated to the original payment. |
| ProfileExpiryDate | The Profile/Card expiry date sent by the provider associated to the original payment in (MM/YY) format. |
| CallerTransactionId | The AMCS generated Request GUID associated to the hosted payments page. |
| ErrorCondition |The error condition associated to the payment request. |'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayTerminalRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayTerminalResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
/ExternalTransaction/TerminalAbort:
post:
tags:
- ExternalTransaction
summary: Terminal Payment Abort
description: 'This endpoint is a signal used to abort a card payment requested using a terminal device.
## Request
| Property | Description |
| --- | --- |
| ProviderType | Provide Type can be any of "ElavonTerminalPay" and "TerminalPay". |
| CallerIdentifier | The Caller Identification associated to the Payment request. |
| RequestId | The Caller supplied Request GUID associated to the Payment request. |
| RequestType | Request Type is "Abort". |
| TerminalId | The Terminal Id is the verifone terminal device serial number. |
| EmailAddress | The e-mail address associated to the abort request. |
| Reason | The reason associated to the abort request is conditionally required. |'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayTerminalAbortRequest'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayInfoResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'401':
description: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
/ExternalTransaction/DeleteToken:
post:
tags:
- ExternalTransaction
summary: Delete Token
description: This endpoint is used to delete Card Tokens from the vault for both AMCS Pay and Payment provider gateway.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayDeleteProfileRequest'
text/json:
schema:
$ref: '#/components/schemas/AMCSPayDeleteProfileRequest'
application/*+json:
schema:
$ref: '#/components/schemas/AMCSPayDeleteProfileRequest'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayDeleteProfileResponse'
text/json:
schema:
$ref: '#/components/schemas/AMCSPayDeleteProfileResponse'
application/*+json:
schema:
$ref: '#/components/schemas/AMCSPayDeleteProfileResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'401':
description: Unauthorized
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/AMCSPayErrorResponse'
'500':
description: Internal Server Error
# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-externaltransaction-api-openapi.yml