TRANXACT.AI Help

Platform · Payments

Payment Engines

Stripe, PayPal, Adyen, Visa, Mastercard and the rest. The published rate is what the fee is calculated at, and takings post to the clearing account rather than sitting in a table.

Type REST8 operationsBase path /api/platform/payment-providersPublished as /api/v1/payment-providers

Download specification (OpenAPI 3.1) Screen: Payment Engines

Overview

PackagePlatform
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 Platform › 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.
Tableplatform.payment_providers · 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

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

GET/api/platform/payment-providersList 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",
      "code": "COD-000001",
      "name": "Example",
      "provider": "text",
      "mode": "test",
      "merchant_id": "text",
      "public_key": "text",
      "secret_cipher": "text",
      "secret_last4": "text",
      "webhook_secret_cipher": "text",
      "supported_methods": [],
      "supported_currencies": [],
      "percentage_fee": "1250.00",
      "fixed_fee": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "provider": "text",
  "mode": "test",
  "merchant_id": "text",
  "public_key": "text",
  "secret_cipher": "text",
  "secret_last4": "text",
  "webhook_secret_cipher": "text",
  "supported_methods": [],
  "supported_currencies": [],
  "percentage_fee": "1250.00",
  "fixed_fee": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesProvider code
nametextYesName
providertextYesEngine
modetextNoMode — Live means real money. Nothing else about the configuration changes.
Allowed: test live
merchant_idtextNoMerchant ID
public_keytextNoPublishable key
supported_methods_textNoMethods — e.g. card, wallet, bank_transfer, ach
supported_currencies_textNoCurrencies
percentage_feenumericNoPercentage fee
fixed_feenumericNoFixed fee
settlement_daysintegerNoSettlement (days)
clearing_account_iduuidNoClearing account — Where takings land until the payout arrives.
fee_account_iduuidNoFee expense account
cost_center_iduuidNoCost center
is_defaultbooleanNoDefault engine — Only one is default; setting this clears the others.
statustextNoStatus
Allowed: unconfigured configured connected error disabled

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "provider": "text",
  "mode": "test",
  "merchant_id": "text",
  "public_key": "text",
  "supported_methods": []
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "provider": "text",
  "mode": "test",
  "merchant_id": "text",
  "public_key": "text",
  "secret_cipher": "text",
  "secret_last4": "text",
  "webhook_secret_cipher": "text",
  "supported_methods": [],
  "supported_currencies": [],
  "percentage_fee": "1250.00",
  "fixed_fee": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/payment-providers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","provider":"text","mode":"test","merchant_id":"text","public_key":"text","supported_methods":[]}'
PUT/api/platform/payment-providers/{id}Change a payment providers

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
codetextYesProvider code
nametextYesName
providertextYesEngine
modetextNoMode — Live means real money. Nothing else about the configuration changes.
Allowed: test live
merchant_idtextNoMerchant ID
public_keytextNoPublishable key
supported_methods_textNoMethods — e.g. card, wallet, bank_transfer, ach
supported_currencies_textNoCurrencies
percentage_feenumericNoPercentage fee
fixed_feenumericNoFixed fee
settlement_daysintegerNoSettlement (days)
clearing_account_iduuidNoClearing account — Where takings land until the payout arrives.
fee_account_iduuidNoFee expense account
cost_center_iduuidNoCost center
is_defaultbooleanNoDefault engine — Only one is default; setting this clears the others.
statustextNoStatus
Allowed: unconfigured configured connected error disabled

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "provider": "text",
  "mode": "test",
  "merchant_id": "text",
  "public_key": "text",
  "secret_cipher": "text",
  "secret_last4": "text",
  "webhook_secret_cipher": "text",
  "supported_methods": [],
  "supported_currencies": [],
  "percentage_fee": "1250.00",
  "fixed_fee": "1250.00"
}

Sample request

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

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/platform/payment-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/payment-providers/{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/platform/payment-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/platform/payment-providers/{id}/secretSecret

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):

secret*, webhookSecret

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 PUT "https://demo.tranxact.ai/api/platform/payment-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/secret" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"secret":"value","webhookSecret":"value"}'
POST/api/platform/payment-providers/{id}/testTest

Path parameters

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

No body is required.

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/platform/payment-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a payment providers, 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
codetextread, writeProvider code
nametextread, writeName
providertextread, writeEngine
modetextread, writeMode — Live means real money. Nothing else about the configuration changes.
Allowed: test live
merchant_idtextread, writeMerchant ID
public_keytextread, writePublishable key
secret_cipherbytearead onlySecret cipher
secret_last4textread onlySecret last4
webhook_secret_cipherbytearead onlyWebhook secret cipher
supported_methods_textread, writeMethods — e.g. card, wallet, bank_transfer, ach
supported_currencies_textread, writeCurrencies
percentage_feenumericread, writePercentage fee
fixed_feenumericread, writeFixed fee
settlement_daysintegerread, writeSettlement (days)
clearing_account_iduuidread, writeClearing account — Where takings land until the payout arrives.
fee_account_iduuidread, writeFee expense account
cost_center_iduuidread, writeCost center
is_defaultbooleanread, writeDefault engine — Only one is default; setting this clears the others.
statustextread, writeStatus
Allowed: unconfigured configured connected error disabled
last_tested_attimestamp with time zoneread onlyLast tested at
org_unit_iduuidread onlyOrg unit id
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 Platform › 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.