TRANXACT.AI Help

Platform · Services and actions

Payments

The payments service of Platform: 2 operation(s).

Type REST2 operationsBase path /api/platform/payments

Download specification (OpenAPI 3.1)

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 › Payments 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

POST/api/platform/payments/chargeCharge

Request body

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

providerId, amount*, currency, method, cardBrand, cardLast4, sourceModule, sourceRef, arInvoiceId, customerRef, capture

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/payments/charge" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"providerId":"value","amount":"value","currency":"value","method":"value","cardBrand":"value","cardLast4":"value"}'
POST/api/platform/payments/{id}/refundRefund

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

amount, reason

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/payments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/refund" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount":"value","reason":"value"}'

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 › Payments 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.