TRANXACT.AI Help

India statutory · Records

Payment engines

Read and maintain payment engines records (india.payment_engines).

Type REST6 operationsBase path /api/india/payment-enginesPublished as /api/v1/payment-engines

Download specification (OpenAPI 3.1)

Overview

PackageIndia statutory
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold India statutory › Payment engines on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableindia.payment_engines · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/india/payment-enginesList payment engines

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "engine_kind": "text",
      "android_package": "text",
      "ios_scheme": "text",
      "logo_hint": "text",
      "supports_intent": true,
      "supports_collect": true,
      "supports_qr": true,
      "supports_mandate": true,
      "supports_refund": true,
      "merchant_id": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/india/payment-engines?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/india/payment-engines/{id}Read one payment engines

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "engine_kind": "text",
  "android_package": "text",
  "ios_scheme": "text",
  "logo_hint": "text",
  "supports_intent": true,
  "supports_collect": true,
  "supports_qr": true,
  "supports_mandate": true,
  "supports_refund": true,
  "merchant_id": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/india/payment-engines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/india/payment-enginesCreate a payment engines

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
engine_kindtextYesEngine kind
android_packagetextNoAndroid package
ios_schemetextNoIos scheme
supports_intentbooleanNoSupports intent
supports_collectbooleanNoSupports collect
supports_qrbooleanNoSupports qr
supports_mandatebooleanNoSupports mandate
supports_refundbooleanNoSupports refund
merchant_idtextNoMerchant id
endpointtextNoEndpoint
environmenttextNoEnvironment
min_amountnumericNoMin amount
max_amountnumericNoMax amount
is_defaultbooleanNoIs default
is_activebooleanNoIs active
sort_orderintegerNoSort order
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "engine_kind": "text",
  "android_package": "text",
  "ios_scheme": "text",
  "supports_intent": true,
  "supports_collect": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "engine_kind": "text",
  "android_package": "text",
  "ios_scheme": "text",
  "logo_hint": "text",
  "supports_intent": true,
  "supports_collect": true,
  "supports_qr": true,
  "supports_mandate": true,
  "supports_refund": true,
  "merchant_id": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/payment-engines" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","engine_kind":"text","android_package":"text","ios_scheme":"text","supports_intent":true,"supports_collect":true}'
PUT/api/india/payment-engines/{id}Change a payment engines

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
engine_kindtextYesEngine kind
android_packagetextNoAndroid package
ios_schemetextNoIos scheme
supports_intentbooleanNoSupports intent
supports_collectbooleanNoSupports collect
supports_qrbooleanNoSupports qr
supports_mandatebooleanNoSupports mandate
supports_refundbooleanNoSupports refund
merchant_idtextNoMerchant id
endpointtextNoEndpoint
environmenttextNoEnvironment
min_amountnumericNoMin amount
max_amountnumericNoMax amount
is_defaultbooleanNoIs default
is_activebooleanNoIs active
sort_orderintegerNoSort order
notestextNoNotes

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "engine_kind": "text",
  "android_package": "text",
  "ios_scheme": "text",
  "logo_hint": "text",
  "supports_intent": true,
  "supports_collect": true,
  "supports_qr": true,
  "supports_mandate": true,
  "supports_refund": true,
  "merchant_id": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/india/payment-engines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/india/payment-engines/{id}Delete a payment engines

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/india/payment-engines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/india/payment-engines/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/india/payment-engines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a payment engines, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
engine_kindtextread, writeEngine kind
android_packagetextread, writeAndroid package
ios_schemetextread, writeIos scheme
logo_hinttextread onlyLogo hint
supports_intentbooleanread, writeSupports intent
supports_collectbooleanread, writeSupports collect
supports_qrbooleanread, writeSupports qr
supports_mandatebooleanread, writeSupports mandate
supports_refundbooleanread, writeSupports refund
merchant_idtextread, writeMerchant id
api_key_encbytearead onlyApi key enc
api_secret_encbytearead onlyApi secret enc
webhook_secret_encbytearead onlyWebhook secret enc
secret_last4textread onlySecret last4
endpointtextread, writeEndpoint
environmenttextread, writeEnvironment
min_amountnumericread, writeMin amount
max_amountnumericread, writeMax amount
is_defaultbooleanread, writeIs default
is_activebooleanread, writeIs active
sort_orderintegerread, writeSort order
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold India statutory › Payment engines for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.