This is the full developer documentation for Ameria vPOS SDK
# Ameria vPOS SDK
> An unofficial, community-built SDK for accepting card payments in Armenia with Ameriabank vPOS — typed, tested, zero dependencies.
* npm
```sh
npm install @ameria/vpos-sdk
```
* pnpm
```sh
pnpm add @ameria/vpos-sdk
```
* yarn
```sh
yarn add @ameria/vpos-sdk
```
checkout.ts
```ts
import { AmeriaClient } from "@ameria/vpos-sdk";
const ameria = new AmeriaClient({
clientId: process.env.AMERIA_CLIENT_ID!,
username: process.env.AMERIA_USERNAME!,
password: process.env.AMERIA_PASSWORD!,
isTest: true,
});
// 1. Register the payment and send the payer to the bank's card page.
const { url, PaymentID } = await ameria.initPayment({
orderId: 2350301,
amount: 10,
currency: "AMD",
description: "Order #1042",
backUrl: "https://shop.example/payment/back",
opaque: "order-1042",
});
console.log("Redirect the payer to", url);
// 2. The payer comes back to backUrl, but that redirect is not signed: anyone can
// open it with a success code and skip paying. So ask the bank, and pass what
// you expect — otherwise a real payment for a cheaper order would also pass.
const { paid, reason } = await ameria.verifyPayment(PaymentID, {
amount: 10,
currency: "AMD",
orderId: 2350301,
});
console.log(paid ? "Paid — fulfil the order" : `Not paid: ${reason}`);
```
Every vPOS endpoint
Payments, two-step confirm and cancel, refunds, saved cards, pending transactions and the national ID check — all eleven-plus REST calls.
Typed end to end
Request and response types follow the bank’s live API reference, including the 2025–26 additions: Apple Pay, Amex, 3-D Secure fields and bank info.
Safe defaults
Credentials never show up in logs, requests time out, redirects are refused and amounts are validated before anything reaches the bank.
Modern runtime
ESM, Node.js 22.12+, Bun and Deno, built-in `fetch`, no runtime dependencies. CommonJS code can still `require()` it.
# Page not found
> This page doesn't exist. It may have moved when the docs were rebuilt for 0.1.
# AmeriaClient
Defined in: [src/client.ts:105](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L105)
Client for the Ameriabank vPOS REST API.
## Example
[Section titled “Example”](#example)
```ts
import { AmeriaClient } from "@ameria/vpos-sdk";
const ameria = new AmeriaClient({
clientId: process.env.AMERIA_CLIENT_ID!,
username: process.env.AMERIA_USERNAME!,
password: process.env.AMERIA_PASSWORD!,
isTest: true,
});
```
## Constructors
[Section titled “Constructors”](#constructors)
### Constructor
[Section titled “Constructor”](#constructor)
> **new AmeriaClient**(`params`): `AmeriaClient`
Defined in: [src/client.ts:116](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L116)
#### Parameters
[Section titled “Parameters”](#parameters)
##### params
[Section titled “params”](#params)
[`AmeriaClientParams`](/ameria-sdk-js/api/interfaces/ameriaclientparams/)
#### Returns
[Section titled “Returns”](#returns)
`AmeriaClient`
## Properties
[Section titled “Properties”](#properties)
### host
[Section titled “host”](#host)
> `readonly` **host**: `string`
Defined in: [src/client.ts:114](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L114)
Base URL of the bank API this client talks to.
## Accessors
[Section titled “Accessors”](#accessors)
### clientId
[Section titled “clientId”](#clientid)
#### Get Signature
[Section titled “Get Signature”](#get-signature)
> **get** **clientId**(): `string`
Defined in: [src/client.ts:131](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L131)
The client ID this client was created with.
##### Returns
[Section titled “Returns”](#returns-1)
`string`
## Methods
[Section titled “Methods”](#methods)
### getUrl()
[Section titled “getUrl()”](#geturl)
> **getUrl**(`paymentId`, `lang?`): `string`
Defined in: [src/client.ts:168](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L168)
Build the bank’s payment page URL for a payment ID. [AmeriaClient.initPayment](/ameria-sdk-js/api/classes/ameriaclient/#initpayment) already returns it as `url`.
#### Parameters
[Section titled “Parameters”](#parameters-1)
##### paymentId
[Section titled “paymentId”](#paymentid)
`string`
##### lang?
[Section titled “lang?”](#lang)
`"en"` | `"am"` | `"hy"` | `"ru"`
#### Returns
[Section titled “Returns”](#returns-2)
`string`
***
### initPayment()
[Section titled “initPayment()”](#initpayment)
> **initPayment**(`params`): `Promise`<[`InitPaymentResponse`](/ameria-sdk-js/api/interfaces/initpaymentresponse/) & `object`>
Defined in: [src/client.ts:186](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L186)
Register a payment and get the URL of the bank’s card page.
Redirect the payer to `url`. After paying they come back to `backUrl`; that redirect is not signed, so confirm the result with [AmeriaClient.verifyPayment](/ameria-sdk-js/api/classes/ameriaclient/#verifypayment) before fulfilling the order.
#### Parameters
[Section titled “Parameters”](#parameters-2)
##### params
[Section titled “params”](#params-1)
[`InitPaymentParams`](/ameria-sdk-js/api/interfaces/initpaymentparams/)
#### Returns
[Section titled “Returns”](#returns-3)
`Promise`<[`InitPaymentResponse`](/ameria-sdk-js/api/interfaces/initpaymentresponse/) & `object`>
The bank’s response plus `url`, which is `null` unless `ResponseCode` is `1`.
***
### getPaymentId()
[Section titled “getPaymentId()”](#getpaymentid)
> **getPaymentId**(`orderId`): `Promise`<[`GetPaymentIdResponse`](/ameria-sdk-js/api/interfaces/getpaymentidresponse/)>
Defined in: [src/client.ts:209](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L209)
Look up the bank’s payment ID for one of your order IDs.
#### Parameters
[Section titled “Parameters”](#parameters-3)
##### orderId
[Section titled “orderId”](#orderid)
`string` | `number`
#### Returns
[Section titled “Returns”](#returns-4)
`Promise`<[`GetPaymentIdResponse`](/ameria-sdk-js/api/interfaces/getpaymentidresponse/)>
***
### confirmPayment()
[Section titled “confirmPayment()”](#confirmpayment)
> **confirmPayment**(`paymentId`, `amount`): `Promise`<[`ConfirmPaymentResponse`](/ameria-sdk-js/api/interfaces/confirmpaymentresponse/)>
Defined in: [src/client.ts:218](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L218)
Deposit a payment that was only approved (two-step payments).
#### Parameters
[Section titled “Parameters”](#parameters-4)
##### paymentId
[Section titled “paymentId”](#paymentid-1)
`string`
##### amount
[Section titled “amount”](#amount)
`number`
Amount to deposit; up to the approved amount.
#### Returns
[Section titled “Returns”](#returns-5)
`Promise`<[`ConfirmPaymentResponse`](/ameria-sdk-js/api/interfaces/confirmpaymentresponse/)>
***
### getPaymentDetails()
[Section titled “getPaymentDetails()”](#getpaymentdetails)
> **getPaymentDetails**(`paymentId`): `Promise`<[`PaymentDetailsResponse`](/ameria-sdk-js/api/interfaces/paymentdetailsresponse/)>
Defined in: [src/client.ts:231](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L231)
Get the raw status and details of a payment. To decide whether to fulfil an order, prefer [AmeriaClient.verifyPayment](/ameria-sdk-js/api/classes/ameriaclient/#verifypayment).
#### Parameters
[Section titled “Parameters”](#parameters-5)
##### paymentId
[Section titled “paymentId”](#paymentid-2)
`string`
#### Returns
[Section titled “Returns”](#returns-6)
`Promise`<[`PaymentDetailsResponse`](/ameria-sdk-js/api/interfaces/paymentdetailsresponse/)>
***
### verifyPayment()
[Section titled “verifyPayment()”](#verifypayment)
> **verifyPayment**(`paymentId`, `expected`): `Promise`<[`PaymentVerification`](/ameria-sdk-js/api/interfaces/paymentverification/)>
Defined in: [src/client.ts:255](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L255)
Ask the bank whether a payment really succeeded for the amount you expect. Use it when the payer comes back to your `backUrl`: that redirect is not signed and can be forged.
`paid` is `true` only if the bank approved the payment, the amount, currency and order ID match what you expect, the money was deposited (or, with `twoStep`, approved) and nothing was refunded.
#### Parameters
[Section titled “Parameters”](#parameters-6)
##### paymentId
[Section titled “paymentId”](#paymentid-3)
`string`
##### expected
[Section titled “expected”](#expected)
[`VerifyPaymentExpected`](/ameria-sdk-js/api/interfaces/verifypaymentexpected/)
#### Returns
[Section titled “Returns”](#returns-7)
`Promise`<[`PaymentVerification`](/ameria-sdk-js/api/interfaces/paymentverification/)>
#### Example
[Section titled “Example”](#example-1)
```ts
const { paid, reason } = await ameria.verifyPayment(paymentId, {
amount: order.total,
currency: "AMD",
orderId: order.id,
});
if (paid) await fulfil(order);
```
***
### getPendingTransactions()
[Section titled “getPendingTransactions()”](#getpendingtransactions)
> **getPendingTransactions**(`params`): `Promise`<[`GetPendingTransactionsResponse`](/ameria-sdk-js/api/type-aliases/getpendingtransactionsresponse/)>
Defined in: [src/client.ts:289](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L289)
List transactions that were started but not completed in a date range.
#### Parameters
[Section titled “Parameters”](#parameters-7)
##### params
[Section titled “params”](#params-2)
[`GetPendingTransactionsParams`](/ameria-sdk-js/api/interfaces/getpendingtransactionsparams/)
#### Returns
[Section titled “Returns”](#returns-8)
`Promise`<[`GetPendingTransactionsResponse`](/ameria-sdk-js/api/type-aliases/getpendingtransactionsresponse/)>
***
### refundPayment()
[Section titled “refundPayment()”](#refundpayment)
> **refundPayment**(`paymentId`, `amount`): `Promise`<[`RefundPaymentResponse`](/ameria-sdk-js/api/interfaces/refundpaymentresponse/)>
Defined in: [src/client.ts:303](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L303)
Refund a completed payment, fully or partly.
#### Parameters
[Section titled “Parameters”](#parameters-8)
##### paymentId
[Section titled “paymentId”](#paymentid-4)
`string`
##### amount
[Section titled “amount”](#amount-1)
`number`
Amount to refund; up to the deposited amount.
#### Returns
[Section titled “Returns”](#returns-9)
`Promise`<[`RefundPaymentResponse`](/ameria-sdk-js/api/interfaces/refundpaymentresponse/)>
***
### cancelPayment()
[Section titled “cancelPayment()”](#cancelpayment)
> **cancelPayment**(`paymentId`): `Promise`<[`CancelPaymentResponse`](/ameria-sdk-js/api/interfaces/cancelpaymentresponse/)>
Defined in: [src/client.ts:316](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L316)
Cancel (reverse) a payment. For two-step payments this releases an approved amount that was never confirmed.
#### Parameters
[Section titled “Parameters”](#parameters-9)
##### paymentId
[Section titled “paymentId”](#paymentid-5)
`string`
#### Returns
[Section titled “Returns”](#returns-10)
`Promise`<[`CancelPaymentResponse`](/ameria-sdk-js/api/interfaces/cancelpaymentresponse/)>
***
### getBindings()
[Section titled “getBindings()”](#getbindings)
> **getBindings**(`paymentType`): `Promise`<[`GetBindingsResponse`](/ameria-sdk-js/api/interfaces/getbindingsresponse/)>
Defined in: [src/client.ts:322](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L322)
List the saved cards (bindings) of your merchant account.
#### Parameters
[Section titled “Parameters”](#parameters-10)
##### paymentType
[Section titled “paymentType”](#paymenttype)
[`PaymentType`](/ameria-sdk-js/api/type-aliases/paymenttype/)
#### Returns
[Section titled “Returns”](#returns-11)
`Promise`<[`GetBindingsResponse`](/ameria-sdk-js/api/interfaces/getbindingsresponse/)>
***
### activateBinding()
[Section titled “activateBinding()”](#activatebinding)
> **activateBinding**(`cardHolderId`, `paymentType`): `Promise`<[`ActivateBindingResponse`](/ameria-sdk-js/api/interfaces/activatebindingresponse/)>
Defined in: [src/client.ts:328](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L328)
Re-enable a saved card that was deactivated.
#### Parameters
[Section titled “Parameters”](#parameters-11)
##### cardHolderId
[Section titled “cardHolderId”](#cardholderid)
`string`
##### paymentType
[Section titled “paymentType”](#paymenttype-1)
[`PaymentType`](/ameria-sdk-js/api/type-aliases/paymenttype/)
#### Returns
[Section titled “Returns”](#returns-12)
`Promise`<[`ActivateBindingResponse`](/ameria-sdk-js/api/interfaces/activatebindingresponse/)>
***
### deactivateBinding()
[Section titled “deactivateBinding()”](#deactivatebinding)
> **deactivateBinding**(`cardHolderId`, `paymentType`): `Promise`<[`DeactivateBindingResponse`](/ameria-sdk-js/api/interfaces/deactivatebindingresponse/)>
Defined in: [src/client.ts:340](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L340)
Disable a saved card so it can no longer be charged.
#### Parameters
[Section titled “Parameters”](#parameters-12)
##### cardHolderId
[Section titled “cardHolderId”](#cardholderid-1)
`string`
##### paymentType
[Section titled “paymentType”](#paymenttype-2)
[`PaymentType`](/ameria-sdk-js/api/type-aliases/paymenttype/)
#### Returns
[Section titled “Returns”](#returns-13)
`Promise`<[`DeactivateBindingResponse`](/ameria-sdk-js/api/interfaces/deactivatebindingresponse/)>
***
### makeBindingPayment()
[Section titled “makeBindingPayment()”](#makebindingpayment)
> **makeBindingPayment**(`params`): `Promise`<[`MakeBindingPaymentResponse`](/ameria-sdk-js/api/interfaces/makebindingpaymentresponse/)>
Defined in: [src/client.ts:357](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L357)
Charge a saved card without the payer entering card details.
If the response has `AcsUrl` set, the card issuer requires 3-D Secure and the payment is not complete until the payer passes it.
#### Parameters
[Section titled “Parameters”](#parameters-13)
##### params
[Section titled “params”](#params-3)
[`MakeBindingPaymentParams`](/ameria-sdk-js/api/interfaces/makebindingpaymentparams/)
#### Returns
[Section titled “Returns”](#returns-14)
`Promise`<[`MakeBindingPaymentResponse`](/ameria-sdk-js/api/interfaces/makebindingpaymentresponse/)>
***
### ssnCheck()
[Section titled “ssnCheck()”](#ssncheck)
> **ssnCheck**(`paymentId`, `ssn`, `identifierType`): `Promise`<[`SsnCheckResponse`](/ameria-sdk-js/api/interfaces/ssncheckresponse/)>
Defined in: [src/client.ts:378](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L378)
Submit the payer’s national identifier for a payment (SSNCheck). The identifier is personal data: do not log it.
#### Parameters
[Section titled “Parameters”](#parameters-14)
##### paymentId
[Section titled “paymentId”](#paymentid-6)
`string`
##### ssn
[Section titled “ssn”](#ssn)
`string`
##### identifierType
[Section titled “identifierType”](#identifiertype)
[`SsnIdentifierType`](/ameria-sdk-js/api/type-aliases/ssnidentifiertype/)
#### Returns
[Section titled “Returns”](#returns-15)
`Promise`<[`SsnCheckResponse`](/ameria-sdk-js/api/interfaces/ssncheckresponse/)>
# AmeriaHttpError
Defined in: [src/errors.ts:4](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/errors.ts#L4)
Thrown when the bank answers with a non-2xx status or a non-JSON body.
## Extends
[Section titled “Extends”](#extends)
* `Error`
## Constructors
[Section titled “Constructors”](#constructors)
### Constructor
[Section titled “Constructor”](#constructor)
> **new AmeriaHttpError**(`endpoint`, `status`, `body`): `AmeriaHttpError`
Defined in: [src/errors.ts:10](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/errors.ts#L10)
#### Parameters
[Section titled “Parameters”](#parameters)
##### endpoint
[Section titled “endpoint”](#endpoint)
[`AmeriaEndpoint`](/ameria-sdk-js/api/type-aliases/ameriaendpoint/)
##### status
[Section titled “status”](#status)
`number`
##### body
[Section titled “body”](#body)
`string`
#### Returns
[Section titled “Returns”](#returns)
`AmeriaHttpError`
#### Overrides
[Section titled “Overrides”](#overrides)
`Error.constructor`
## Properties
[Section titled “Properties”](#properties)
### status
[Section titled “status”](#status-1)
> `readonly` **status**: `number`
Defined in: [src/errors.ts:5](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/errors.ts#L5)
***
### endpoint
[Section titled “endpoint”](#endpoint-1)
> `readonly` **endpoint**: [`AmeriaEndpoint`](/ameria-sdk-js/api/type-aliases/ameriaendpoint/)
Defined in: [src/errors.ts:6](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/errors.ts#L6)
***
### body
[Section titled “body”](#body-1)
> `readonly` **body**: `string`
Defined in: [src/errors.ts:8](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/errors.ts#L8)
First 500 characters of the response body, for debugging.
***
### stackTraceLimit
[Section titled “stackTraceLimit”](#stacktracelimit)
> `static` **stackTraceLimit**: `number`
Defined in: node_modules/@types/node/globals.d.ts:68
The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`).
The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured *after* the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
#### Inherited from
[Section titled “Inherited from”](#inherited-from)
`Error.stackTraceLimit`
***
### cause?
[Section titled “cause?”](#cause)
> `optional` **cause?**: `unknown`
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24
#### Inherited from
[Section titled “Inherited from”](#inherited-from-1)
`Error.cause`
***
### name
[Section titled “name”](#name)
> **name**: `string`
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1074
#### Inherited from
[Section titled “Inherited from”](#inherited-from-2)
`Error.name`
***
### message
[Section titled “message”](#message)
> **message**: `string`
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1075
#### Inherited from
[Section titled “Inherited from”](#inherited-from-3)
`Error.message`
***
### stack?
[Section titled “stack?”](#stack)
> `optional` **stack?**: `string`
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
#### Inherited from
[Section titled “Inherited from”](#inherited-from-4)
`Error.stack`
## Methods
[Section titled “Methods”](#methods)
### captureStackTrace()
[Section titled “captureStackTrace()”](#capturestacktrace)
> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
Defined in: node_modules/@types/node/globals.d.ts:52
Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called.
```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
```
The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`.
The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace.
The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance:
```js
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
```
#### Parameters
[Section titled “Parameters”](#parameters-1)
##### targetObject
[Section titled “targetObject”](#targetobject)
`object`
##### constructorOpt?
[Section titled “constructorOpt?”](#constructoropt)
`Function`
#### Returns
[Section titled “Returns”](#returns-1)
`void`
#### Inherited from
[Section titled “Inherited from”](#inherited-from-5)
`Error.captureStackTrace`
***
### prepareStackTrace()
[Section titled “prepareStackTrace()”](#preparestacktrace)
> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
Defined in: node_modules/@types/node/globals.d.ts:56
#### Parameters
[Section titled “Parameters”](#parameters-2)
##### err
[Section titled “err”](#err)
`Error`
##### stackTraces
[Section titled “stackTraces”](#stacktraces)
`CallSite`\[]
#### Returns
[Section titled “Returns”](#returns-2)
`any`
#### See
[Section titled “See”](#see)
#### Inherited from
[Section titled “Inherited from”](#inherited-from-6)
`Error.prepareStackTrace`
# ActivateBindingResponse
Defined in: [src/types.ts:125](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L125)
## Properties
[Section titled “Properties”](#properties)
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `string`
Defined in: [src/types.ts:126](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L126)
***
### ResponseMessage
[Section titled “ResponseMessage”](#responsemessage)
> **ResponseMessage**: `string`
Defined in: [src/types.ts:127](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L127)
***
### CardHolderID
[Section titled “CardHolderID”](#cardholderid)
> **CardHolderID**: `string`
Defined in: [src/types.ts:128](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L128)
# AmeriaClientParams
Defined in: [src/client.ts:74](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L74)
Options for [AmeriaClient](/ameria-sdk-js/api/classes/ameriaclient/).
## Properties
[Section titled “Properties”](#properties)
### clientId
[Section titled “clientId”](#clientid)
> **clientId**: `string`
Defined in: [src/client.ts:76](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L76)
Client ID issued by Ameriabank.
***
### username
[Section titled “username”](#username)
> **username**: `string`
Defined in: [src/client.ts:77](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L77)
***
### password
[Section titled “password”](#password)
> **password**: `string`
Defined in: [src/client.ts:78](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L78)
***
### isTest?
[Section titled “isTest?”](#istest)
> `optional` **isTest?**: `boolean`
Defined in: [src/client.ts:80](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L80)
Use the bank’s test environment (servicestest.ameriabank.am).
***
### timeoutMs?
[Section titled “timeoutMs?”](#timeoutms)
> `optional` **timeoutMs?**: `number`
Defined in: [src/client.ts:82](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L82)
Abort a request to the bank after this many milliseconds. Default 30000.
***
### fetch?
[Section titled “fetch?”](#fetch)
> `optional` **fetch?**: (`input`, `init?`) => `Promise`<`Response`>
Defined in: [src/client.ts:87](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L87)
`fetch` implementation to use, e.g. one that goes through a proxy. Defaults to the global `fetch`.
#### Parameters
[Section titled “Parameters”](#parameters)
##### input
[Section titled “input”](#input)
`string` | `URL` | `Request`
##### init?
[Section titled “init?”](#init)
`RequestInit`
#### Returns
[Section titled “Returns”](#returns)
`Promise`<`Response`>
# CancelPaymentResponse
Defined in: [src/types.ts:93](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L93)
## Properties
[Section titled “Properties”](#properties)
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `string`
Defined in: [src/types.ts:94](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L94)
***
### ResponseMessage
[Section titled “ResponseMessage”](#responsemessage)
> **ResponseMessage**: `string`
Defined in: [src/types.ts:95](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L95)
***
### Opaque
[Section titled “Opaque”](#opaque)
> **Opaque**: `string`
Defined in: [src/types.ts:96](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L96)
# ConfirmPaymentResponse
Defined in: [src/types.ts:81](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L81)
## Properties
[Section titled “Properties”](#properties)
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `string`
Defined in: [src/types.ts:82](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L82)
***
### ResponseMessage
[Section titled “ResponseMessage”](#responsemessage)
> **ResponseMessage**: `string`
Defined in: [src/types.ts:83](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L83)
***
### Opaque
[Section titled “Opaque”](#opaque)
> **Opaque**: `string`
Defined in: [src/types.ts:84](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L84)
# DeactivateBindingResponse
Defined in: [src/types.ts:131](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L131)
## Properties
[Section titled “Properties”](#properties)
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `string`
Defined in: [src/types.ts:132](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L132)
***
### ResponseMessage
[Section titled “ResponseMessage”](#responsemessage)
> **ResponseMessage**: `string`
Defined in: [src/types.ts:133](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L133)
***
### CardHolderID
[Section titled “CardHolderID”](#cardholderid)
> **CardHolderID**: `string`
Defined in: [src/types.ts:134](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L134)
# GetBindingsResponse
Defined in: [src/types.ts:114](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L114)
## Properties
[Section titled “Properties”](#properties)
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `string`
Defined in: [src/types.ts:115](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L115)
***
### ResponseMessage
[Section titled “ResponseMessage”](#responsemessage)
> **ResponseMessage**: `string`
Defined in: [src/types.ts:116](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L116)
***
### CardBindingFileds
[Section titled “CardBindingFileds”](#cardbindingfileds)
> **CardBindingFileds**: `object`\[]
Defined in: [src/types.ts:117](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L117)
#### CardHolderID
[Section titled “CardHolderID”](#cardholderid)
> **CardHolderID**: `string`
#### CardPan
[Section titled “CardPan”](#cardpan)
> **CardPan**: `string`
#### ExpDate
[Section titled “ExpDate”](#expdate)
> **ExpDate**: `string`
#### IsAvtive
[Section titled “IsAvtive”](#isavtive)
> **IsAvtive**: `boolean`
# GetPaymentIdResponse
Defined in: [src/types.ts:66](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L66)
## Properties
[Section titled “Properties”](#properties)
### PaymentId
[Section titled “PaymentId”](#paymentid)
> **PaymentId**: `string`
Defined in: [src/types.ts:67](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L67)
***
### ResponseMessage
[Section titled “ResponseMessage”](#responsemessage)
> **ResponseMessage**: `string`
Defined in: [src/types.ts:68](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L68)
***
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `string`
Defined in: [src/types.ts:69](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L69)
# GetPendingTransactionsParams
Defined in: [src/client.ts:457](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L457)
Parameters of [AmeriaClient.getPendingTransactions](/ameria-sdk-js/api/classes/ameriaclient/#getpendingtransactions).
## Properties
[Section titled “Properties”](#properties)
### startDate
[Section titled “startDate”](#startdate)
> **startDate**: `Date`
Defined in: [src/client.ts:458](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L458)
***
### endDate
[Section titled “endDate”](#enddate)
> **endDate**: `Date`
Defined in: [src/client.ts:459](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L459)
# InitPaymentParams
Defined in: [src/client.ts:405](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L405)
Parameters of [AmeriaClient.initPayment](/ameria-sdk-js/api/classes/ameriaclient/#initpayment).
## Properties
[Section titled “Properties”](#properties)
### orderId
[Section titled “orderId”](#orderid)
> **orderId**: `string` | `number`
Defined in: [src/client.ts:407](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L407)
Your order ID. In the test environment it must be in the range the bank gave you.
***
### amount
[Section titled “amount”](#amount)
> **amount**: `number`
Defined in: [src/client.ts:409](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L409)
Amount in the payment currency. The test environment only accepts 10 AMD.
***
### currency?
[Section titled “currency?”](#currency)
> `optional` **currency?**: [`Currency`](/ameria-sdk-js/api/type-aliases/currency/)
Defined in: [src/client.ts:411](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L411)
Defaults to AMD. Alphabetic codes are converted to ISO numeric codes.
***
### description
[Section titled “description”](#description)
> **description**: `string`
Defined in: [src/client.ts:413](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L413)
Shown to the payer on the payment page.
***
### backUrl
[Section titled “backUrl”](#backurl)
> **backUrl**: `string`
Defined in: [src/client.ts:415](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L415)
Where the bank sends the payer after the payment page.
***
### opaque?
[Section titled “opaque?”](#opaque)
> `optional` **opaque?**: `string`
Defined in: [src/client.ts:417](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L417)
Free text returned to you with the payment.
***
### cardHolderId?
[Section titled “cardHolderId?”](#cardholderid)
> `optional` **cardHolderId?**: `string`
Defined in: [src/client.ts:419](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L419)
Set to save the card for later [AmeriaClient.makeBindingPayment](/ameria-sdk-js/api/classes/ameriaclient/#makebindingpayment) charges.
***
### lang?
[Section titled “lang?”](#lang)
> `optional` **lang?**: `"en"` | `"am"` | `"hy"` | `"ru"`
Defined in: [src/client.ts:421](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L421)
Payment page language. “hy” is sent as “am”, the bank’s code for Armenian.
***
### timeout?
[Section titled “timeout?”](#timeout)
> `optional` **timeout?**: `number`
Defined in: [src/client.ts:423](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L423)
Seconds the payment page stays valid.
***
### paymentServiceType?
[Section titled “paymentServiceType?”](#paymentservicetype)
> `optional` **paymentServiceType?**: `number`
Defined in: [src/client.ts:425](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L425)
Passed to the bank as-is; the bank does not document its values.
# InitPaymentResponse
Defined in: [src/types.ts:60](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L60)
## Properties
[Section titled “Properties”](#properties)
### PaymentID
[Section titled “PaymentID”](#paymentid)
> **PaymentID**: `string`
Defined in: [src/types.ts:61](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L61)
***
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `1` | `2`
Defined in: [src/types.ts:62](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L62)
***
### ResponseMessage
[Section titled “ResponseMessage”](#responsemessage)
> **ResponseMessage**: `string`
Defined in: [src/types.ts:63](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L63)
# MakeBindingPaymentParams
Defined in: [src/client.ts:463](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L463)
Parameters of [AmeriaClient.makeBindingPayment](/ameria-sdk-js/api/classes/ameriaclient/#makebindingpayment).
## Properties
[Section titled “Properties”](#properties)
### amount
[Section titled “amount”](#amount)
> **amount**: `number`
Defined in: [src/client.ts:464](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L464)
***
### backUrl
[Section titled “backUrl”](#backurl)
> **backUrl**: `string`
Defined in: [src/client.ts:465](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L465)
***
### cardHolderId
[Section titled “cardHolderId”](#cardholderid)
> **cardHolderId**: `string`
Defined in: [src/client.ts:467](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L467)
The `cardHolderId` you passed to [AmeriaClient.initPayment](/ameria-sdk-js/api/classes/ameriaclient/#initpayment) when the card was saved.
***
### currency?
[Section titled “currency?”](#currency)
> `optional` **currency?**: [`Currency`](/ameria-sdk-js/api/type-aliases/currency/)
Defined in: [src/client.ts:468](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L468)
***
### description
[Section titled “description”](#description)
> **description**: `string`
Defined in: [src/client.ts:469](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L469)
***
### opaque?
[Section titled “opaque?”](#opaque)
> `optional` **opaque?**: `string`
Defined in: [src/client.ts:470](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L470)
***
### orderId
[Section titled “orderId”](#orderid)
> **orderId**: `number`
Defined in: [src/client.ts:471](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L471)
***
### paymentType?
[Section titled “paymentType?”](#paymenttype)
> `optional` **paymentType?**: [`PaymentType`](/ameria-sdk-js/api/type-aliases/paymenttype/)
Defined in: [src/client.ts:473](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L473)
Defaults to “BindingMainRest”.
# MakeBindingPaymentResponse
Defined in: [src/types.ts:137](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L137)
## Properties
[Section titled “Properties”](#properties)
### PaymentID
[Section titled “PaymentID”](#paymentid)
> **PaymentID**: `string`
Defined in: [src/types.ts:138](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L138)
***
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `string`
Defined in: [src/types.ts:139](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L139)
***
### Amount
[Section titled “Amount”](#amount)
> **Amount**: `number`
Defined in: [src/types.ts:140](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L140)
***
### ApprovedAmount
[Section titled “ApprovedAmount”](#approvedamount)
> **ApprovedAmount**: `number`
Defined in: [src/types.ts:141](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L141)
***
### ApprovalCode
[Section titled “ApprovalCode”](#approvalcode)
> **ApprovalCode**: `string`
Defined in: [src/types.ts:142](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L142)
***
### CardNumber
[Section titled “CardNumber”](#cardnumber)
> **CardNumber**: `string`
Defined in: [src/types.ts:143](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L143)
***
### ClientName
[Section titled “ClientName”](#clientname)
> **ClientName**: `string`
Defined in: [src/types.ts:144](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L144)
***
### Currency
[Section titled “Currency”](#currency)
> **Currency**: `string`
Defined in: [src/types.ts:145](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L145)
***
### DateTime
[Section titled “DateTime”](#datetime)
> **DateTime**: `string`
Defined in: [src/types.ts:146](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L146)
***
### DepositedAmount
[Section titled “DepositedAmount”](#depositedamount)
> **DepositedAmount**: `number`
Defined in: [src/types.ts:147](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L147)
***
### Description
[Section titled “Description”](#description)
> **Description**: `string`
Defined in: [src/types.ts:148](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L148)
***
### MDOrderID
[Section titled “MDOrderID”](#mdorderid)
> **MDOrderID**: `string`
Defined in: [src/types.ts:149](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L149)
***
### MerchantId
[Section titled “MerchantId”](#merchantid)
> **MerchantId**: `string`
Defined in: [src/types.ts:150](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L150)
***
### TerminalId
[Section titled “TerminalId”](#terminalid)
> **TerminalId**: `string`
Defined in: [src/types.ts:151](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L151)
***
### OrderID
[Section titled “OrderID”](#orderid)
> **OrderID**: `string`
Defined in: [src/types.ts:152](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L152)
***
### PaymentState
[Section titled “PaymentState”](#paymentstate)
> **PaymentState**: `string`
Defined in: [src/types.ts:153](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L153)
***
### PaymentType
[Section titled “PaymentType”](#paymenttype)
> **PaymentType**: [`PaymentTypeCode`](/ameria-sdk-js/api/type-aliases/paymenttypecode/)
Defined in: [src/types.ts:154](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L154)
***
### PrimaryRC
[Section titled “PrimaryRC”](#primaryrc)
> **PrimaryRC**: `string`
Defined in: [src/types.ts:155](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L155)
***
### ExpDate
[Section titled “ExpDate”](#expdate)
> **ExpDate**: `string`
Defined in: [src/types.ts:156](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L156)
***
### ProcessingIP
[Section titled “ProcessingIP”](#processingip)
> **ProcessingIP**: `string`
Defined in: [src/types.ts:157](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L157)
***
### OrderStatus
[Section titled “OrderStatus”](#orderstatus)
> **OrderStatus**: `string`
Defined in: [src/types.ts:158](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L158)
***
### CardHolderID
[Section titled “CardHolderID”](#cardholderid)
> **CardHolderID**: `string`
Defined in: [src/types.ts:159](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L159)
***
### BindingID
[Section titled “BindingID”](#bindingid)
> **BindingID**: `string`
Defined in: [src/types.ts:160](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L160)
***
### RefundedAmount
[Section titled “RefundedAmount”](#refundedamount)
> **RefundedAmount**: `number`
Defined in: [src/types.ts:161](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L161)
***
### Opaque
[Section titled “Opaque”](#opaque)
> **Opaque**: `string`
Defined in: [src/types.ts:162](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L162)
***
### TrxnDescription
[Section titled “TrxnDescription”](#trxndescription)
> **TrxnDescription**: `string`
Defined in: [src/types.ts:163](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L163)
***
### rrn
[Section titled “rrn”](#rrn)
> **rrn**: `string`
Defined in: [src/types.ts:164](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L164)
***
### ActionCode
[Section titled “ActionCode”](#actioncode)
> **ActionCode**: `string`
Defined in: [src/types.ts:165](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L165)
***
### AcsUrl?
[Section titled “AcsUrl?”](#acsurl)
> `optional` **AcsUrl?**: `string` | `null`
Defined in: [src/types.ts:167](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L167)
Set when the issuer asks for 3-D Secure; redirect the payer to AcsUrl.
***
### PaReq?
[Section titled “PaReq?”](#pareq)
> `optional` **PaReq?**: `string` | `null`
Defined in: [src/types.ts:168](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L168)
***
### TermUrl?
[Section titled “TermUrl?”](#termurl)
> `optional` **TermUrl?**: `string` | `null`
Defined in: [src/types.ts:169](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L169)
# PaymentDetailsResponse
Defined in: [src/types.ts:23](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L23)
## Properties
[Section titled “Properties”](#properties)
### Amount
[Section titled “Amount”](#amount)
> **Amount**: `number`
Defined in: [src/types.ts:24](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L24)
***
### ApprovedAmount
[Section titled “ApprovedAmount”](#approvedamount)
> **ApprovedAmount**: `number`
Defined in: [src/types.ts:25](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L25)
***
### ApprovalCode
[Section titled “ApprovalCode”](#approvalcode)
> **ApprovalCode**: `string`
Defined in: [src/types.ts:26](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L26)
***
### CardNumber
[Section titled “CardNumber”](#cardnumber)
> **CardNumber**: `string`
Defined in: [src/types.ts:27](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L27)
***
### ClientName
[Section titled “ClientName”](#clientname)
> **ClientName**: `string`
Defined in: [src/types.ts:28](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L28)
***
### ClientEmail
[Section titled “ClientEmail”](#clientemail)
> **ClientEmail**: `string`
Defined in: [src/types.ts:29](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L29)
***
### Currency
[Section titled “Currency”](#currency)
> **Currency**: `string`
Defined in: [src/types.ts:30](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L30)
***
### DateTime
[Section titled “DateTime”](#datetime)
> **DateTime**: `string`
Defined in: [src/types.ts:31](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L31)
***
### DepositedAmount
[Section titled “DepositedAmount”](#depositedamount)
> **DepositedAmount**: `number`
Defined in: [src/types.ts:32](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L32)
***
### Description
[Section titled “Description”](#description)
> **Description**: `string`
Defined in: [src/types.ts:33](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L33)
***
### MerchantId
[Section titled “MerchantId”](#merchantid)
> **MerchantId**: `string`
Defined in: [src/types.ts:34](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L34)
***
### Opaque
[Section titled “Opaque”](#opaque)
> **Opaque**: `string`
Defined in: [src/types.ts:35](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L35)
***
### OrderID
[Section titled “OrderID”](#orderid)
> **OrderID**: `string`
Defined in: [src/types.ts:36](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L36)
***
### PaymentState
[Section titled “PaymentState”](#paymentstate)
> **PaymentState**: `string`
Defined in: [src/types.ts:37](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L37)
***
### PaymentType
[Section titled “PaymentType”](#paymenttype)
> **PaymentType**: [`PaymentTypeCode`](/ameria-sdk-js/api/type-aliases/paymenttypecode/)
Defined in: [src/types.ts:38](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L38)
***
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `string`
Defined in: [src/types.ts:39](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L39)
***
### rrn
[Section titled “rrn”](#rrn)
> **rrn**: `string`
Defined in: [src/types.ts:40](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L40)
***
### TerminalId
[Section titled “TerminalId”](#terminalid)
> **TerminalId**: `string`
Defined in: [src/types.ts:41](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L41)
***
### TrxnDescription
[Section titled “TrxnDescription”](#trxndescription)
> **TrxnDescription**: `string`
Defined in: [src/types.ts:42](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L42)
***
### OrderStatus
[Section titled “OrderStatus”](#orderstatus)
> **OrderStatus**: `string`
Defined in: [src/types.ts:43](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L43)
***
### RefundedAmount
[Section titled “RefundedAmount”](#refundedamount)
> **RefundedAmount**: `number`
Defined in: [src/types.ts:44](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L44)
***
### CardHolderID
[Section titled “CardHolderID”](#cardholderid)
> **CardHolderID**: `string`
Defined in: [src/types.ts:45](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L45)
***
### MDOrderID
[Section titled “MDOrderID”](#mdorderid)
> **MDOrderID**: `string`
Defined in: [src/types.ts:46](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L46)
***
### PrimaryRC
[Section titled “PrimaryRC”](#primaryrc)
> **PrimaryRC**: `string`
Defined in: [src/types.ts:47](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L47)
***
### ExpDate
[Section titled “ExpDate”](#expdate)
> **ExpDate**: `string`
Defined in: [src/types.ts:48](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L48)
***
### ProcessingIP
[Section titled “ProcessingIP”](#processingip)
> **ProcessingIP**: `string`
Defined in: [src/types.ts:49](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L49)
***
### BindingID
[Section titled “BindingID”](#bindingid)
> **BindingID**: `string`
Defined in: [src/types.ts:50](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L50)
***
### ActionCode
[Section titled “ActionCode”](#actioncode)
> **ActionCode**: `string`
Defined in: [src/types.ts:51](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L51)
***
### ExchangeRate
[Section titled “ExchangeRate”](#exchangerate)
> **ExchangeRate**: `number`
Defined in: [src/types.ts:52](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L52)
***
### BankInfo?
[Section titled “BankInfo?”](#bankinfo)
> `optional` **BankInfo?**: { `BankName`: `string`; `BankCountryCode`: `string`; `BankCountryName`: `string`; } | `null`
Defined in: [src/types.ts:53](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L53)
# PaymentVerification
Defined in: [src/client.ts:441](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L441)
Result of [AmeriaClient.verifyPayment](/ameria-sdk-js/api/classes/ameriaclient/#verifypayment).
## Properties
[Section titled “Properties”](#properties)
### paid
[Section titled “paid”](#paid)
> **paid**: `boolean`
Defined in: [src/client.ts:443](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L443)
`true` only when it is safe to fulfil the order.
***
### reason?
[Section titled “reason?”](#reason)
> `optional` **reason?**: `"declined"` | `"amount_mismatch"` | `"currency_mismatch"` | `"order_mismatch"` | `"refunded"` | `"not_completed"`
Defined in: [src/client.ts:445](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L445)
Why `paid` is `false`.
***
### details
[Section titled “details”](#details)
> **details**: [`PaymentDetailsResponse`](/ameria-sdk-js/api/interfaces/paymentdetailsresponse/)
Defined in: [src/client.ts:453](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L453)
The bank’s full answer, for logging or support.
# RefundPaymentResponse
Defined in: [src/types.ts:87](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L87)
## Properties
[Section titled “Properties”](#properties)
### ResponseCode
[Section titled “ResponseCode”](#responsecode)
> **ResponseCode**: `string`
Defined in: [src/types.ts:88](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L88)
***
### ResponseMessage
[Section titled “ResponseMessage”](#responsemessage)
> **ResponseMessage**: `string`
Defined in: [src/types.ts:89](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L89)
***
### Opaque
[Section titled “Opaque”](#opaque)
> **Opaque**: `string`
Defined in: [src/types.ts:90](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L90)
# ResponseCodeInfo
Defined in: [src/response-codes.ts:1](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/response-codes.ts#L1)
## Properties
[Section titled “Properties”](#properties)
### description
[Section titled “description”](#description)
> **description**: `string`
Defined in: [src/response-codes.ts:2](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/response-codes.ts#L2)
***
### message
[Section titled “message”](#message)
> **message**: `string`
Defined in: [src/response-codes.ts:3](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/response-codes.ts#L3)
# SsnCheckResponse
Defined in: [src/types.ts:179](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L179)
## Properties
[Section titled “Properties”](#properties)
### Status
[Section titled “Status”](#status)
> **Status**: `string`
Defined in: [src/types.ts:180](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L180)
***
### Message
[Section titled “Message”](#message)
> **Message**: `string`
Defined in: [src/types.ts:181](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L181)
# VerifyPaymentExpected
Defined in: [src/client.ts:429](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L429)
What you expect a payment to be, for [AmeriaClient.verifyPayment](/ameria-sdk-js/api/classes/ameriaclient/#verifypayment).
## Properties
[Section titled “Properties”](#properties)
### amount
[Section titled “amount”](#amount)
> **amount**: `number`
Defined in: [src/client.ts:431](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L431)
The order total you charged.
***
### currency?
[Section titled “currency?”](#currency)
> `optional` **currency?**: [`Currency`](/ameria-sdk-js/api/type-aliases/currency/)
Defined in: [src/client.ts:433](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L433)
Defaults to AMD.
***
### orderId?
[Section titled “orderId?”](#orderid)
> `optional` **orderId?**: `string` | `number`
Defined in: [src/client.ts:435](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L435)
Your order ID; checked when given.
***
### twoStep?
[Section titled “twoStep?”](#twostep)
> `optional` **twoStep?**: `boolean`
Defined in: [src/client.ts:437](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L437)
Accept a two-step payment that is approved but not yet confirmed.
# @ameria/vpos-sdk
## Classes
[Section titled “Classes”](#classes)
* [AmeriaClient](/ameria-sdk-js/api/classes/ameriaclient/)
* [AmeriaHttpError](/ameria-sdk-js/api/classes/ameriahttperror/)
## Interfaces
[Section titled “Interfaces”](#interfaces)
* [AmeriaClientParams](/ameria-sdk-js/api/interfaces/ameriaclientparams/)
* [InitPaymentParams](/ameria-sdk-js/api/interfaces/initpaymentparams/)
* [VerifyPaymentExpected](/ameria-sdk-js/api/interfaces/verifypaymentexpected/)
* [PaymentVerification](/ameria-sdk-js/api/interfaces/paymentverification/)
* [GetPendingTransactionsParams](/ameria-sdk-js/api/interfaces/getpendingtransactionsparams/)
* [MakeBindingPaymentParams](/ameria-sdk-js/api/interfaces/makebindingpaymentparams/)
* [ResponseCodeInfo](/ameria-sdk-js/api/interfaces/responsecodeinfo/)
* [PaymentDetailsResponse](/ameria-sdk-js/api/interfaces/paymentdetailsresponse/)
* [InitPaymentResponse](/ameria-sdk-js/api/interfaces/initpaymentresponse/)
* [GetPaymentIdResponse](/ameria-sdk-js/api/interfaces/getpaymentidresponse/)
* [ConfirmPaymentResponse](/ameria-sdk-js/api/interfaces/confirmpaymentresponse/)
* [RefundPaymentResponse](/ameria-sdk-js/api/interfaces/refundpaymentresponse/)
* [CancelPaymentResponse](/ameria-sdk-js/api/interfaces/cancelpaymentresponse/)
* [GetBindingsResponse](/ameria-sdk-js/api/interfaces/getbindingsresponse/)
* [ActivateBindingResponse](/ameria-sdk-js/api/interfaces/activatebindingresponse/)
* [DeactivateBindingResponse](/ameria-sdk-js/api/interfaces/deactivatebindingresponse/)
* [MakeBindingPaymentResponse](/ameria-sdk-js/api/interfaces/makebindingpaymentresponse/)
* [SsnCheckResponse](/ameria-sdk-js/api/interfaces/ssncheckresponse/)
## Type Aliases
[Section titled “Type Aliases”](#type-aliases)
* [~~Client~~](/ameria-sdk-js/api/type-aliases/client/)
* [PaymentType](/ameria-sdk-js/api/type-aliases/paymenttype/)
* [AmeriaEndpoint](/ameria-sdk-js/api/type-aliases/ameriaendpoint/)
* [CurrencyCode](/ameria-sdk-js/api/type-aliases/currencycode/)
* [CurrencyAlpha](/ameria-sdk-js/api/type-aliases/currencyalpha/)
* [Currency](/ameria-sdk-js/api/type-aliases/currency/)
* [GetPendingTransactionsResponse](/ameria-sdk-js/api/type-aliases/getpendingtransactionsresponse/)
* [PaymentTypeCode](/ameria-sdk-js/api/type-aliases/paymenttypecode/)
* [SsnIdentifierType](/ameria-sdk-js/api/type-aliases/ssnidentifiertype/)
## Variables
[Section titled “Variables”](#variables)
* [~~Client~~](/ameria-sdk-js/api/variables/client/)
* [PaymentTypes](/ameria-sdk-js/api/variables/paymenttypes/)
* [RESPONSE_CODES](/ameria-sdk-js/api/variables/response_codes/)
# AmeriaEndpoint
> **AmeriaEndpoint** = `"InitPayment"` | `"GetPaymentId"` | `"GetPendingTransactions"` | `"ConfirmPayment"` | `"GetPaymentDetails"` | `"RefundPayment"` | `"CancelPayment"` | `"GetBindings"` | `"ActivateBinding"` | `"DeactivateBinding"` | `"MakeBindingPayment"` | `"SSNCheck"`
Defined in: [src/types.ts:3](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L3)
# Client
> **Client** = [`AmeriaClient`](/ameria-sdk-js/api/classes/ameriaclient/)
Defined in: [src/client.ts:400](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L400)
Deprecated
Renamed to [AmeriaClient](/ameria-sdk-js/api/classes/ameriaclient/).
# Currency
> **Currency** = [`CurrencyCode`](/ameria-sdk-js/api/type-aliases/currencycode/) | [`CurrencyAlpha`](/ameria-sdk-js/api/type-aliases/currencyalpha/)
Defined in: [src/types.ts:21](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L21)
# CurrencyAlpha
> **CurrencyAlpha** = `"AMD"` | `"EUR"` | `"USD"` | `"RUB"`
Defined in: [src/types.ts:20](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L20)
Alphabetic codes accepted by this SDK and converted to numeric codes.
# CurrencyCode
> **CurrencyCode** = `"051"` | `"978"` | `"840"` | `"643"`
Defined in: [src/types.ts:18](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L18)
ISO 4217 numeric codes, the format the bank documents and echoes back.
# GetPendingTransactionsResponse
> **GetPendingTransactionsResponse** = `object`\[]
Defined in: [src/types.ts:72](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L72)
## Type Declaration
[Section titled “Type Declaration”](#type-declaration)
### OrderId
[Section titled “OrderId”](#orderid)
> **OrderId**: `number`
### ClientName
[Section titled “ClientName”](#clientname)
> **ClientName**: `string`
### CardNumber
[Section titled “CardNumber”](#cardnumber)
> **CardNumber**: `string`
### Amount
[Section titled “Amount”](#amount)
> **Amount**: `number`
### PaymentDate
[Section titled “PaymentDate”](#paymentdate)
> **PaymentDate**: `string`
### ErrorMessage
[Section titled “ErrorMessage”](#errormessage)
> **ErrorMessage**: `string`
# PaymentType
> **PaymentType** = `"None"` | `"Arca"` | `"MasterCard"` | `"Visa"` | `"Reward"` | `"MainRest"` | `"BindingMainRest"` | `"PayPal"` | `"PayX"` | `"MirCard"` | `"ApplePay"` | `"EPGCardApplePay"` | `"Amex"`
Defined in: [src/payment-types.ts:3](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/payment-types.ts#L3)
# PaymentTypeCode
> **PaymentTypeCode** = `0` | `1` | `2` | `3` | `4` | `5` | `6` | `7` | `11` | `12` | `13` | `14` | `17`
Defined in: [src/types.ts:99](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L99)
# SsnIdentifierType
> **SsnIdentifierType** = `1` | `2` | `3` | `4` | `5`
Defined in: [src/types.ts:172](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/types.ts#L172)
# Client
> `const` **Client**: *typeof* [`AmeriaClient`](/ameria-sdk-js/api/classes/ameriaclient/) = `AmeriaClient`
Defined in: [src/client.ts:400](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/client.ts#L400)
Deprecated
Renamed to [AmeriaClient](/ameria-sdk-js/api/classes/ameriaclient/); this alias will be removed in a future version.
# PaymentTypes
> `const` **PaymentTypes**: `Record`<[`PaymentType`](/ameria-sdk-js/api/type-aliases/paymenttype/), [`PaymentTypeCode`](/ameria-sdk-js/api/type-aliases/paymenttypecode/)>
Defined in: [src/payment-types.ts:18](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/payment-types.ts#L18)
# RESPONSE_CODES
> `const` **RESPONSE_CODES**: `Record`<`string`, [`ResponseCodeInfo`](/ameria-sdk-js/api/interfaces/responsecodeinfo/)>
Defined in: [src/response-codes.ts:6](https://github.com/hos/ameria-sdk-js/blob/1be94949a021a3f8a146be80889aa2a69e0f3757/src/response-codes.ts#L6)
# Getting started
> Install the SDK, create a client and take your first payment.
Unofficial
This SDK is a community project, not made, reviewed or supported by Ameriabank. For your merchant account, credentials and the vPOS service itself, contact the bank.
## Requirements
[Section titled “Requirements”](#requirements)
* Node.js **22.12** or later, current **Bun**, or **Deno** 2+ (`import { AmeriaClient } from "npm:@ameria/vpos-sdk"`). The package is ESM; CommonJS code on Node 22.12+ can load it with `require()`.
* A vPOS merchant account with Ameriabank. The bank issues a **client ID**, a **username** and a **password** for the test environment first, and separate ones for production.
## Install
[Section titled “Install”](#install)
```sh
npm install @ameria/vpos-sdk
```
## Create a client
[Section titled “Create a client”](#create-a-client)
Keep the credentials out of your code — environment variables or a secret store.
client.ts
```ts
import { AmeriaClient } from "@ameria/vpos-sdk";
export const ameria = new AmeriaClient({
clientId: process.env.AMERIA_CLIENT_ID!,
username: process.env.AMERIA_USERNAME!,
password: process.env.AMERIA_PASSWORD!,
isTest: process.env.NODE_ENV !== "production",
});
```
`isTest: true` sends requests to `servicestest.ameriabank.am`; leave it out for production. Requests time out after 30 seconds; pass `timeoutMs` to change that.
## Take a payment
[Section titled “Take a payment”](#take-a-payment)
1. **Register the payment.** [`initPayment`](/ameria-sdk-js/api/classes/ameriaclient/#initpayment) returns a `url` to the bank’s card page.
create-payment.ts
```ts
import { ameria } from "./client.js";
const payment = await ameria.initPayment({
orderId: 2350301, // in test, use an ID from the range the bank gave you
amount: 10, // the test environment only accepts 10 AMD
currency: "AMD",
description: "Order #1042",
backUrl: "https://shop.example/payment/back",
opaque: "order-1042",
lang: "en",
});
if (payment.url) {
// Send the payer to the bank's card page.
console.log("Redirect to", payment.url);
} else {
console.error("Bank refused:", payment.ResponseMessage);
}
```
2. **Redirect the payer** to that `url`. They enter their card details on the bank’s page — card data never touches your server.
3. **Verify on return.** The bank sends the payer back to your `backUrl`. That redirect is not signed, so ask the bank for the result before fulfilling the order — see [Accept a payment](/ameria-sdk-js/guides/accept-a-payment/).
## Next
[Section titled “Next”](#next)
* [Test environment](/ameria-sdk-js/testing/) — what the bank’s sandbox accepts.
* [Security](/ameria-sdk-js/security/) — what to check before going live.
Using an AI assistant?
Give it [`llms-full.txt`](https://hos.github.io/ameria-sdk-js/llms-full.txt): the whole documentation, API reference included, as one Markdown file.
# Accept a payment
> The full one-step payment flow, from registering the payment to verifying it.
A vPOS payment has three steps: you register it, the payer pays on the bank’s page, and you verify the result.
## 1. Register the payment
[Section titled “1. Register the payment”](#1-register-the-payment)
create-payment.ts
```ts
import { ameria } from "./client.js";
const payment = await ameria.initPayment({
orderId: 2350301, // in test, use an ID from the range the bank gave you
amount: 10, // the test environment only accepts 10 AMD
currency: "AMD",
description: "Order #1042",
backUrl: "https://shop.example/payment/back",
opaque: "order-1042",
lang: "en",
});
if (payment.url) {
// Send the payer to the bank's card page.
console.log("Redirect to", payment.url);
} else {
console.error("Bank refused:", payment.ResponseMessage);
}
```
`ResponseCode` is `1` when the bank accepted the request; only then is `url` set. Store the returned `PaymentID` with your order.
| Option | Notes |
| -------------- | --------------------------------------------------------------------------------- |
| `orderId` | Unique per payment. In the test environment it must be in your assigned range. |
| `amount` | In the payment currency. |
| `currency` | `"AMD"` (default), `"USD"`, `"EUR"`, `"RUB"` or the ISO numeric code. |
| `backUrl` | Where the payer returns to. |
| `opaque` | Free text you get back with the payment details. |
| `lang` | Payment page language: `"en"`, `"am"` (or `"hy"`), `"ru"`. |
| `timeout` | Seconds the payment page stays valid. |
| `cardHolderId` | Saves the card for later — see [Saved cards](/ameria-sdk-js/guides/saved-cards/). |
## 2. Redirect the payer
[Section titled “2. Redirect the payer”](#2-redirect-the-payer)
Send the payer to `url`. The bank’s page collects the card details and runs 3-D Secure.
## 3. Verify the result
[Section titled “3. Verify the result”](#3-verify-the-result)
The payer returns to your `backUrl` with `orderID`, `paymentID`, `opaque` and a response code in the query string. **That redirect is not signed** — anyone can open your `backUrl` with a success code. Always ask the bank:
verify-payment.ts
```ts
import { ameria } from "./client.js";
/**
* Handle the payer coming back to your backUrl.
* The query string is not signed: never trust it, ask the bank instead.
*/
export async function handleBackUrl(
url: URL,
order: { id: number; total: number },
) {
const paymentId = url.searchParams.get("paymentID");
if (!paymentId) return false;
const { paid, reason } = await ameria.verifyPayment(paymentId, {
amount: order.total,
currency: "AMD",
orderId: order.id,
});
if (!paid) console.warn(`Order ${order.id} not paid: ${reason}`);
return paid;
}
```
[`verifyPayment`](/ameria-sdk-js/api/classes/ameriaclient/#verifypayment) returns `paid: true` only when all of these hold:
* the bank approved the payment (`ResponseCode` is `"00"`);
* the amount, currency and order ID match what you passed;
* the money was deposited (for [two-step payments](/ameria-sdk-js/guides/two-step-payments/), pass `twoStep: true` to accept an approved payment);
* nothing has been refunded.
Otherwise `reason` says which check failed, and `details` holds the bank’s full answer.
Tip
The payer may close the tab before returning. Check payments that never came back with [`getPaymentDetails`](/ameria-sdk-js/api/classes/ameriaclient/#getpaymentdetails) or list them with [`getPendingTransactions`](/ameria-sdk-js/api/classes/ameriaclient/#getpendingtransactions).
# Errors
> The two kinds of failure and how to handle each.
A call can fail in two ways.
* **The bank declines.** The request worked, but `ResponseCode` says no. The call resolves normally; check the code. `initPayment` succeeds with `1`, every other call with `"00"`. The [response codes](/ameria-sdk-js/response-codes/) page lists what each code means, and `RESPONSE_CODES` gives you the same table in code.
* **The request fails.** The SDK throws:
* [`AmeriaHttpError`](/ameria-sdk-js/api/classes/ameriahttperror/) when the bank answers with an HTTP error or a page that is not JSON (maintenance, a proxy error). It carries `endpoint`, `status` and the first 500 characters of `body`.
* An error named `TimeoutError` when the bank does not answer within `timeoutMs`.
* `TypeError` or `RangeError` for invalid input, before any request is sent.
errors.ts
```ts
import { AmeriaHttpError, RESPONSE_CODES } from "@ameria/vpos-sdk";
import { ameria } from "./client.js";
try {
const details = await ameria.getPaymentDetails("PAYMENT-ID");
if (details.ResponseCode !== "00") {
// A business decline: look up what the code means.
const reason = RESPONSE_CODES[details.ResponseCode];
console.log(details.ResponseCode, reason?.description);
}
} catch (error) {
if (error instanceof AmeriaHttpError) {
// The bank answered with an HTTP error or a non-JSON page.
console.error(error.endpoint, error.status, error.body);
} else if (error instanceof Error && error.name === "TimeoutError") {
// No answer within timeoutMs (30 s by default). The payment state is
// unknown: check it again with getPaymentDetails before retrying.
} else {
throw error;
}
}
```
Caution
After a timeout the payment may or may not have gone through. Check it with `getPaymentDetails` before retrying, or you may charge twice.
# Refunds and cancellations
> Return money to the payer, fully or partly.
refund.ts
```ts
import { ameria } from "./client.js";
const result = await ameria.refundPayment("PAYMENT-ID", 5); // partial refund
if (result.ResponseCode !== "00") {
console.error("Refund failed:", result.ResponseMessage);
}
```
* **`refundPayment(paymentId, amount)`** returns money from a completed payment. The amount can be less than the original for a partial refund.
* **`cancelPayment(paymentId)`** reverses a payment. For two-step payments it releases an approval that was never confirmed.
Your client needs the bank’s permission for each: response code `513` means no refund permission, `514` no reversal permission.
# Saved cards
> Charge a returning customer's card without them entering it again.
Saved cards — “binding transactions” in the bank’s terms — let you charge a card again without the payer entering it: subscriptions, recurring payments, one-click checkout.
## Turning it on
[Section titled “Turning it on”](#turning-it-on)
An authorised person at your company, usually the director, applies through Ameriabank’s mobile or internet banking. The feature works once the bank approves it.
## Saving and charging a card
[Section titled “Saving and charging a card”](#saving-and-charging-a-card)
saved-cards.ts
```ts
import { ameria } from "./client.js";
// 1. First payment: pass cardHolderId so the bank saves the card.
await ameria.initPayment({
orderId: 2350302,
amount: 10,
description: "Subscription, first month",
backUrl: "https://shop.example/payment/back",
opaque: "",
cardHolderId: "customer-77",
});
// 2. Later payments: charge the saved card, no payer interaction.
const charge = await ameria.makeBindingPayment({
cardHolderId: "customer-77",
orderId: 2350303,
amount: 10,
description: "Subscription, second month",
backUrl: "https://shop.example/payment/back",
opaque: "",
});
if (charge.AcsUrl) {
// The issuer wants 3-D Secure: the payer has to confirm this payment.
console.log("Send the payer to", charge.AcsUrl);
} else if (charge.ResponseCode === "00") {
console.log("Charged", charge.Amount);
}
// List, disable and re-enable saved cards.
const { CardBindingFileds: cards } =
await ameria.getBindings("BindingMainRest");
console.log(cards.map((c) => c.CardPan));
await ameria.deactivateBinding("customer-77", "BindingMainRest");
await ameria.activateBinding("customer-77", "BindingMainRest");
```
1. Pass your own customer ID as `cardHolderId` to `initPayment`. When that payment succeeds, the bank saves the card under that ID.
2. Charge it later with `makeBindingPayment` and the same ID. `paymentType` defaults to `"BindingMainRest"`.
## 3-D Secure on saved cards
[Section titled “3-D Secure on saved cards”](#3-d-secure-on-saved-cards)
The card issuer can still ask the payer to confirm a charge. Then the response has `AcsUrl` (with `PaReq` and `TermUrl`) set and the payment is **not** complete until the payer passes the check. Handle this case, or the charge silently never happens.
## Managing saved cards
[Section titled “Managing saved cards”](#managing-saved-cards)
`getBindings`, `deactivateBinding` and `activateBinding` list, disable and re-enable saved cards. The bank only accepts `"MainRest"` and `"BindingMainRest"` as payment types for these calls.
# Two-step payments
> Approve a payment first and deposit it later.
With two-step payments, `initPayment` only **approves** the amount — it is held on the payer’s card but not charged. You then deposit it with `confirmPayment` or release it with `cancelPayment`. This suits orders you can only fulfil after checking stock.
two-step.ts
```ts
import { ameria } from "./client.js";
// With two-step payments enabled on your account, initPayment only
// approves (holds) the amount. Later you either deposit it...
await ameria.confirmPayment("PAYMENT-ID", 10);
// ...or release the hold.
await ameria.cancelPayment("PAYMENT-ID");
```
You can confirm less than the approved amount.
## Turning it on
[Section titled “Turning it on”](#turning-it-on)
Two-step is a setting on your API client, not a request option:
* **Test:** ask Ameriabank’s technical support to switch your test client to two-step.
* **Production:** send an application through Ameriabank’s mobile or internet banking.
Caution
Once the bank switches a client to two-step, **every** payment on it is two-step. To offer both kinds, ask the bank for a second client and create one `AmeriaClient` for each.
# Upgrading from 0.0.x
> Breaking changes in 0.1.0.
0.1.0 is the first release since 2021. It modernises the package and fixes several bugs, and it changes a few things you may rely on.
| Change | What to do |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
| Requires **Node.js 22.12+** and ships as **ESM only**. | Upgrade Node. `import` works as before; CommonJS `require("@ameria/vpos-sdk")` works on 22.12+. |
| `client.username` and `client.password` are gone. | Read credentials from your own config, not from the client. `client.clientId` still works. |
| HTTP errors and non-JSON answers **throw** [`AmeriaHttpError`](/ameria-sdk-js/api/classes/ameriahttperror/). They used to resolve with an HTML string. | Wrap calls in `try`/`catch` — see [Errors](/ameria-sdk-js/guides/errors/). |
| Requests time out after 30 s. | Pass `timeoutMs` if you need longer. |
| `currency` is sent as the ISO numeric code (`"051"` for AMD). | Nothing — `"AMD"`, `"USD"`, `"EUR"` and `"RUB"` are still accepted and converted. |
| `lang: "hy"` is sent as `am`, the bank’s code for Armenian. | Nothing; you can also pass `"am"`. |
| Some `getPaymentDetails` field types were corrected: `OrderID` and `OrderStatus` are strings, `RefundedAmount` and `ExchangeRate` are numbers. | Adjust comparisons if you relied on the old types. |
| `Client` is now **`AmeriaClient`**. | Rename the import. `Client` still works but is deprecated. |
| Option names are camelCase: **`orderId`**, **`backUrl`**, **`cardHolderId`** (were `orderID`, `backURL`, `cardHolderID`). | Rename them in `initPayment` and `makeBindingPayment` calls. |
| Type names lost their `I`/`T` prefixes: `IInitPaymentParams` → `InitPaymentParams`, `TCurrency` → `Currency`, `TPaymentEnum` → `PaymentTypeCode`. | Rename type imports. Request body types are no longer exported. |
| Amounts must be positive finite numbers. | Invalid amounts now throw `RangeError` before any request. |
## Fixed
[Section titled “Fixed”](#fixed)
* The payment page URL had `&lang=` in it, so the language never reached the bank.
* `getPendingTransactions` sent the start date as the end date.
* `getBindings("None")` always threw.
* `getPaymentId` was typed as returning payment details.
## Added
[Section titled “Added”](#added)
[`verifyPayment`](/ameria-sdk-js/api/classes/ameriaclient/#verifypayment), which checks a payment’s status, amount, currency and order in one call; a `fetch` option on the client; Payment types `MirCard`, `ApplePay`, `EPGCardApplePay` and `Amex`; `timeout` and `paymentServiceType` on `initPayment`; 3-D Secure fields on `makeBindingPayment`; `BankInfo` on payment details; [`ssnCheck`](/ameria-sdk-js/api/classes/ameriaclient/#ssncheck).
# Response codes
> What each Ameriabank vPOS response code means.
`initPayment` returns `1` for success and `2` for failure. Every other call returns a string code, where `"00"` means success. This table is the `RESPONSE_CODES` object exported by the SDK, so it is always the same as the one in your code.
| Code | Meaning | Bank message |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| `20` | Incorrect Username and Password | Incorrect Username and Password |
| `30` | Incorrect Value of Opaque field of the initial request | Incorrect Value of Opaque field of the initial request |
| `50` | — | Payment sum error |
| `500` | — | Unknown error |
| `510` | — | Incorrect parameters |
| `513` | — | Do not have Refund operation permission |
| `514` | — | Do not have Reverse operation permission |
| `520` | — | Overtime error |
| `550` | System Error | System Error |
| `560` | — | Operation failed |
| `0-1` | Processing center response timeout | sv_unavailable |
| `0-100` | No payment attempts | no_payments_yet |
| `0-2000` | Transaction declined since the card is in the blacklist | Decline. PAN blacklisted |
| `0-2001` | Transaction declined since Client’s IP address is in the blacklist | Decline. IP blacklisted |
| `0-20010` | Transaction declined since payment amount exceeded the limits set by the issuer bank | BLOCKED_BY_LIMIT |
| `0-2002` | Transaction declined since payment amount exceeded the limits (daily turnover limits of the merchant set by the acquiring bank or one card turnover limit of the merchant or one transaction limit of the merchant) | Decline. Payment over limit |
| `0-2004` | Payment through SSL without entering SVС data is forbidden | SSL without CVC forbidden |
| `0-2005` | We failed to check the issuer’s signature, i.e. PARes was readable but was not signed correctly | Decline. 3DSec sign error |
| `0-2006` | Issuer declined authentication | Decline. 3DSec decline |
| `0-2007` | Card data registration timeout starting from the moment of payment registration (timeout will be in 20 minutes) | Decline. Payment time limit |
| `0-2011` | Card is included in 3d secure but the issuer bank is not ready (at that moment) to execute 3ds of transaction | Declined. PaRes status is unknown |
| `0-2012` | This operation is not supported | Operation not supported |
| `0-2013` | Payment attempts expired | Исчерпаны попытки оплаты |
| `0-2015` | VERes of DS contain iReq, due to which payment was declined | Decline by iReq in VERes |
| `0-2016` | Issuer bank is not ready (at that moment) to execute 3ds of transaction (for instance, the bank’s ACS does not function). We cannot define whether the card is included in 3d secure or not. | Declined. VeRes status is unknown |
| `0-2018` | Directory server Visa or MasterCard cannot be reached or “connection failed” error is received in response to request VeReq. This error is the result interaction of payment gateway and MPS servers due to their technical failures. | Declined. DS connection timeout |
| `0-2019` | Issuer’s PARes contains iReq, due to which payment was declined. | Decline by iReq in PARes |
| `0-9000` | Transactions start | Started |
| `00` | Payment successfully completed | Approved. |
| `01` | Order with the given number is already registered in the system | Order already exists |
| `0100` | Issuer bank has forbidden online card transactions | Decline. Card declined |
| `01001` | At the moment of registering the transaction, i.e. when the card details are not entered yet | Decline. Data input timeout |
| `0101` | Card’s validity period has expired | Decline. Expired card |
| `0103` | No connection with the issuer bank, the merchant must call the issuer bank | Decline. Call issuer |
| `0104` | Attempt to make a transaction via blocked account | Decline. Card declined |
| `0107` | It is necessary to call the issuer bank | Decline. Call issuer |
| `0109` | Merchant’s/\*terminal ID is invalid (for completion and preauthorization with different IDs) | Decline. Invalid merchant |
| `0110` | Transaction amount is invalid | Decline. Invalid amount |
| `0111` | Card number is invalid | Decline. No card record on Decline. Wrong PAN |
| `0116` | Transaction amount exceeds the available account balance | Decline. Decline. Not enough money |
| `0120` | Transaction declined since it is not allowed by the issuer Payment network code: 57 Reason for declining the transaction should be clarified from the issuer. | Decline. Not allowed |
| `0121` | Attempt to make a transaction exceeding the daily limit set by the issuer bank | Decline. Excds wdrwl limt |
| `0123` | Limit on the number of transactions is exceeded. Client has made maximum number of transactions within the limit and attempts to make one more transaction | Decline. Excds wdrwl ltmt |
| `0125` | Invalid Card number Attempt to refund an amount exceeding the hold, attempt to refund zero amount | Decline. Card declined |
| `0151017` | 3-D Secure connection error | Decline. 3DSec comm error |
| `0151018` | Processing timeout, failed to send | Decline. Processing timeout |
| `0151019` | Processing timeout, sent but no response received from the bank | Decline. Processing timeout |
| `02001` | Fraudulent transaction ( according to processing or payment network) | Decline. Fraud |
| `02003` | Merchant is not allowed to perform SSL (Not 3d-Secure/SecureCode) transactions | Decline. SSL restricted |
| `02005` | Payment does not comply with the 3ds verification terms | 3DS rule failed |
| `0208` | Card is lost | Decline. Card is lost |
| `0209` | Card limitations are exceeded | Decline. Card limitations exceeded |
| `0341014` | RBS decline error | Decline. General Error |
| `0341041` | Refund error | Decline. Refund failed |
| `05` | Error in request parameters | Incorrect Parameters |
| `071015` | Incorrect card parameters input | Decline. Input error |
| `08204` | Such order has already been registered (check by order number) | Decline. Duplicate order |
| `09001` | Internal code of RBS rejection | RBS internal error |
| `0902` | Cardholder attempts to make a forbidden transaction | Decline. Invalid trans |
| `0903` | Attempt to make a transaction in the amount exceeding the limit set by the issuer bank | Decline. Re-enter trans. |
| `0904` | Error message format according to issuer bank | Decline. Format error |
| `0907` | No connection with the issuer bank. Stand-in authorization is not allowed for the given card number (this mode means that the issuer cannot connect to the payment network, so the transaction is either in offline mode and is then going to be sent to the back office or will be declined) | Decline. Host not avail. |
| `0909` | General system failure fixed by the payment network or the issuer bank | Decline. Call issuer |
| `0910` | Issuer bank is not available | Decline. Host not avail. |
| `0913` | Invalid transaction format according to the network | Decline. Invalid trans |
| `0914` | Transaction is not found (while sending completion, reversal or refund request) | Decline. Orig trans not found |
| `0999` | Transaction authorization did not start. Declined due to fraud or 3dsec error. | Declined by fraud |
| `02` | Order declined due to errors in payment details | Missing message |
| `03` | Unknown (forbidden) currency | Incorrect Currency |
| `04` | Required parameter of the request is missing | Required parameter missed |
| `06` | Unregistered OrderId | Unregistered OrderId |
| `07` | System error | System Error |
# Security
> What the SDK protects, and what is still your job.
## Verify every payment with the bank
[Section titled “Verify every payment with the bank”](#verify-every-payment-with-the-bank)
The redirect back to your `backUrl` carries no signature. A payer — or anyone — can open it with a success code and an order ID of their choice. Treat it only as a hint that the payer is back, then call `verifyPayment` with the amount, currency and order you expect before you ship anything. See [Accept a payment](/ameria-sdk-js/guides/accept-a-payment/#3-verify-the-result).
## Credentials
[Section titled “Credentials”](#credentials)
* Load the client ID, username and password from environment variables or a secret store, never from source code.
* The client keeps them in private class fields: `console.log(client)`, `JSON.stringify(client)` and error reporters do not see them.
* The bank sends them inside every request body over HTTPS. Don’t log request bodies from a proxy or HTTP interceptor in front of the SDK.
* Test and production credentials are different; keep them in separate configs.
## What the SDK does for you
[Section titled “What the SDK does for you”](#what-the-sdk-does-for-you)
* Talks only to `https://services.ameriabank.am` or `https://servicestest.ameriabank.am` over HTTPS, with Node’s default certificate checks.
* Refuses HTTP redirects, so a misrouted request can’t carry credentials elsewhere.
* Times out after 30 seconds instead of hanging.
* Rejects zero, negative and non-numeric amounts before sending them.
* Logs nothing.
* Has no runtime dependencies.
## Card and personal data
[Section titled “Card and personal data”](#card-and-personal-data)
Card numbers are entered on the bank’s page, never on yours. The SDK only sees the masked number the bank returns (`CardNumber`), which is safe to store.
`ssnCheck` sends a national ID number. Don’t log it, and keep it only as long as you must.
# Test environment
> How Ameriabank's vPOS sandbox differs from production.
Create the client with `isTest: true` to use `https://servicestest.ameriabank.am/VPOS`.
The bank sends test credentials, test cards and the details below by email when you apply for vPOS. They are not published, and they differ between merchants.
* **Order IDs must come from your assigned range.** Each merchant gets a block of order IDs (for example `2350301`–`2350400`). An ID outside it, or one used before, is refused.
* **Only 10 AMD is accepted.** Other amounts fail in the sandbox (response code `560`).
* **Two-step payments and saved cards** must be switched on for your test client by the bank’s support team before `confirmPayment` or `makeBindingPayment` work.
Caution
These rules come from other integrators’ reports of the bank’s emailed guide (vPOS 3.1), not from a public document. If the sandbox behaves differently for you, trust the bank’s email.