Get Payments

Get payments

get

https://engine-sandbox.nowacash.comhttps://engine.nowacash.com

/api/v1/payments

Get a list of payments sorted by creation date (most recent first)

Authorizations

BearerAuth

AuthorizationstringRequired

The client sends HTTP requests with the Authorization header that contains the word Bearer followed by a space and the Shop Api Key.

Query parameters

offsetinteger · max: 1000000Optional

The number of items to skip before starting to collect the result set. Default is 0.

limitinteger · min: 1 · max: 1000Optional

The numbers of items to return. Default is 50.

created.gtestring · ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)Optional

If passed, return only payments created at or after the specified time

Example: 2021-10-13T10:26:18

created.ltstring · ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)Optional

If passed, return only payments created strictly before the specified time

Example: 2021-10-13T10:39:34

updated.gtestring · ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)Optional

If passed, return only payments updated at or after the specified time

Example: 2021-10-13T10:26:18

updated.ltstring · ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)Optional

If passed, return only payments updated strictly before the specified time

Example: 2021-10-13T10:39:34

referenceId.eqstringOptional

If passed, return only payments with the requested referenceId

Example: order-12345

Responses

200

Payment List Response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

get

/api/v1/payments

HTTPcURLJavaScriptPython

GET /api/v1/payments HTTP/1.1
Host: engine-sandbox.nowacash.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "timestamp": "2020-10-07T13:36:32.595+00:00",
  "status": 200,
  "hasMore": true,
  "result": [
    {
      "id": "91d27876e87f4b22b3ecd53924bf973d",
      "referenceId": "payment-123",
      "created": "2030-12-25T10:11:12",
      "paymentType": "DEPOSIT",
      "state": "PENDING",
      "description": "Deposit via TEST shop",
      "parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
      "paymentMethod": "BASIC_CARD",
      "paymentMethodDetails": {
        "customerAccountNumber": "400000***0002",
        "cardToken": "3529d42227424875af8722cbf54d7073",
        "cardholderName": "John Doe",
        "cardExpiryMonth": "01",
        "cardExpiryYear": "2030",
        "cardBrand": "VISA",
        "cardIssuingCountryCode": "CY"
      },
      "amount": 11.12,
      "currency": "EUR",
      "customerAmount": 15,
      "customerCurrency": "USD",
      "redirectUrl": "http://start/payment/6ccaa03cb2c242a68ce332f38fedfad7",
      "errorCode": "4.01",
      "errorMessage": "Insufficient Funds",
      "externalResultCode": "03",
      "customer": {
        "referenceId": "customer_123",
        "citizenshipCountryCode": "AU",
        "firstName": "John",
        "lastName": "Smith",
        "dateOfBirth": "2001-12-03",
        "email": "[email protected]",
        "phone": "357 123123123",
        "locale": "ru",
        "accountNumber": "text",
        "accountName": "text",
        "accountType": "SAVINGS",
        "bank": "text",
        "bankCode": "text",
        "bankBranch": "text",
        "bankBranchCode": "text",
        "documentType": "BR_CPF",
        "documentNumber": "text",
        "routingGroup": "VIP",
        "kycStatus": true,
        "paymentInstrumentKycStatus": true,
        "dateOfFirstDeposit": "2021-01-01",
        "depositsAmount": 5000,
        "withdrawalsAmount": 1000,
        "depositsCnt": 5000,
        "withdrawalsCnt": 1000,
        "ip": "152.13.130.125"
      },
      "billingAddress": {
        "addressLine1": "7, Sunny street",
        "addressLine2": "Office 3",
        "city": "Limassol",
        "countryCode": "CY",
        "postalCode": "4141",
        "state": "CA"
      },
      "startRecurring": true,
      "preAuth": true,
      "recurringToken": "text",
      "terminalName": "text",
      "externalFeeAmount": 15,
      "externalFeeCurrency": "USD"
    }
  ]
}

Payment processing completed

Publish details of a new processed payment.

Payload

application/json

idstring · max: 32Optional

Payment Id

Example: 91d27876e87f4b22b3ecd53924bf973d

referenceIdstring · max: 256Optional

referenceId from payment request

Example: payment-123

createdstring · ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)Optional

Date and time when this payment was created, in UTC time zone

Example: 2030-12-25T10:11:12

paymentTypestring · enumOptional

Payment Type

Example: DEPOSITPossible values:

statestring · enumOptional

Payment State

Example: PENDINGPossible values:

descriptionstring · max: 512Optional

Description of the transaction

Example: Deposit via TEST shop

parentPaymentIdstring · max: 32Optional

Initial transaction Id from payment request

Example: 91d27876e87f4b22b3ecd53924bf973d

paymentMethodstring · enumOptional

Payment Method

Example: BASIC_CARDPossible values:

amountnumber · min: 0.00001 · max: 1000000000Optional

Amount sent to the payment provider

Example: 11.12

currencystring · ISO 4217 code for FIAT currencies or cryptocurrency symbolOptional

Currency sent to the payment provider

Example: EUR

customerAmountnumberOptional

Amount from payment request. Filled only if the request currency differs from the currency sent to the payment provider.

Example: 15

customerCurrencystring · ISO 4217 code for FIAT currencies or cryptocurrency symbolOptional

Currency from payment request. Filled only if it differs from the currency sent to the payment provider.

Example: USD

redirectUrlstring · max: 256Optional

URL to redirect the customer

Example: http://start/payment/6ccaa03cb2c242a68ce332f38fedfad7

errorCodestringOptional

Check 'Error Codes' section for details

Example: 4.01

errorMessagestringOptional

Check 'Error Codes' section for details

Example: Insufficient Funds

externalResultCodestringOptional

Result code from external provider

Example: 03

startRecurringbooleanOptional

Indicates whether this payment has started a recurring chain

preAuthbooleanOptional

Indicates whether this is a Pre-Authorization request (for 2-phase deposit)

recurringTokenstringOptional

Token that can be used to continue the recurring chain

terminalNamestringOptional

The name of the provider that was used to process this payment

externalFeeAmountnumberOptional

Provider fee. Filled only if supported by the provider.

Example: 15

externalFeeCurrencystring · ISO 4217 code for FIAT currencies or cryptocurrency symbolOptional

Provider fee currency. Filled only if supported by the provider.

Example: USD

Responses

200

Return a 200 status to indicate that the data was received successfully

No content

Payload

{
  "id": "91d27876e87f4b22b3ecd53924bf973d",
  "referenceId": "payment-123",
  "created": "2030-12-25T10:11:12",
  "paymentType": "DEPOSIT",
  "state": "PENDING",
  "description": "Deposit via TEST shop",
  "parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
  "paymentMethod": "BASIC_CARD",
  "paymentMethodDetails": {
    "customerAccountNumber": "400000***0002",
    "cardToken": "3529d42227424875af8722cbf54d7073",
    "cardholderName": "John Doe",
    "cardExpiryMonth": "01",
    "cardExpiryYear": "2030",
    "cardBrand": "VISA",
    "cardIssuingCountryCode": "CY"
  },
  "amount": 11.12,
  "currency": "EUR",
  "customerAmount": 15,
  "customerCurrency": "USD",
  "redirectUrl": "http://start/payment/6ccaa03cb2c242a68ce332f38fedfad7",
  "errorCode": "4.01",
  "errorMessage": "Insufficient Funds",
  "externalResultCode": "03",
  "customer": {
    "referenceId": "customer_123",
    "citizenshipCountryCode": "AU",
    "firstName": "John",
    "lastName": "Smith",
    "dateOfBirth": "2001-12-03",
    "email": "[email protected]",
    "phone": "357 123123123",
    "locale": "ru",
    "accountNumber": "text",
    "accountName": "text",
    "accountType": "SAVINGS",
    "bank": "text",
    "bankCode": "text",
    "bankBranch": "text",
    "bankBranchCode": "text",
    "documentType": "BR_CPF",
    "documentNumber": "text",
    "routingGroup": "VIP",
    "kycStatus": true,
    "paymentInstrumentKycStatus": true,
    "dateOfFirstDeposit": "2021-01-01",
    "depositsAmount": 5000,
    "withdrawalsAmount": 1000,
    "depositsCnt": 5000,
    "withdrawalsCnt": 1000,
    "ip": "152.13.130.125"
  },
  "billingAddress": {
    "addressLine1": "7, Sunny street",
    "addressLine2": "Office 3",
    "city": "Limassol",
    "countryCode": "CY",
    "postalCode": "4141",
    "state": "CA"
  },
  "startRecurring": true,
  "preAuth": true,
  "recurringToken": "text",
  "terminalName": "text",
  "externalFeeAmount": 15,
  "externalFeeCurrency": "USD"
}