iotoms Docs

Get payment reference data

GET
/api/v1/payments/reference-data

Returns the supported payment context types and the return reason codes, with the scopes each reason applies to. Use it to populate pick-lists before creating returns or payments.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?

The payment context types and return reason codes.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/payments/reference-data'
Example Response
{  "status": "string",  "message": "string",  "data": {    "contextTypes": [      {        "code": "string",        "description": "string"      }    ],    "returnReasonCodes": [      {        "code": "string",        "description": "string",        "supportedScopes": [          "ITEM"        ]      }    ]  }}