MICRO-BASE

payment.update

This method is used to get a list of Payment Methods.

Arguments

This method has the path /payment/<version>/payment.list and follows the MicroBase API calling conventions.

Argument Required Type Example Description
id no String List rJGOMDf Comma separated Payment Method ids list.
title no String Credit Title /${title}/i regex expression.
gateway no String stripe Title /${gateway}/i regex expression.
active no Boolean default Active or disabled.
limit no Number 5 Maximum number of documents to return. Defaults to 10
skip no Number 10 Skips over the first specified number of documents. Defaults to 0.

Response

Returns a Payment object:

{
  "ok": true,
  "data": [
    {
      "id" : "ia5RA1W9",
      "title" : "Credit Card",
      "gateway" : "stripe",
      "active" : true
    }
  ]
}

Errors

Expected errors that this method could return. Some errors return additional data.

Error Data Description
validation_error The data causing the error Some validation error

Example

curl --request POST \
  --url http://localhost:3000/services/payment/v1/payment.list \
  --header 'authorization: Bearer xxxxx...' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
      "id": "HJs04P45,GFssj54j" \
      }'

© MicroBase