Skip to content

Payment types

Payment types provide attributes for payment methods used in sales transactions and/or payments.

Operations

Upload list of payment types

Request

POST https://api.zoined.com/paymentTypes?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
payment_type_idstringrequired

Payment Type ID

Example:"1"
payment_typestringrequired

Payment type name

Example:"credit card"
payment_groupstring

Payment group

Example:"Store"
custom_field_1string

Custom Field 1

Example:"App"
custom_field_2string

Custom Field 2

Example:"App"
custom_field_3string

Custom Field 3

Example:"App"
custom_field_4string

Custom Field 4

Example:"App"
custom_field_5string

Custom Field 5

Example:"App"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/paymentTypes?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_type_id": "1",
    "payment_type": "credit card",
    "payment_group": "Store",
    "custom_field_1": "App",
    "custom_field_2": "App",
    "custom_field_3": "App",
    "custom_field_4": "App",
    "custom_field_5": "App",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}