Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Payment Method

Get Payment Method by Id

Get a Payment Method record given the provided Payment Method ID.

get/financials/payment-methods/{payment_method_id}

Path parameters

payment_method_idinteger required

The payment method identifier

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Response

Payment Method info based on the supplied payment method identifier

idinteger

Payment Method Id

namestring

Name of the Payment Method

client_idinteger

Id of the Client that the Payment Method is for

clientstring

Name of the client the Payment Method is for

owner_client_idinteger

Owner Id of the Payment Method (if shared)

owner_clientstring

Owner of the Payment Method (if shared)

shared_payment_method_idinteger

Id of the shared payment method

payment_account_type_idinteger

Id of the Payment Account Type of the Payment Method

payment_account_typestring

Payment Account Type of the Payment Method

expiration_datestring date

Date the Payment Method expires

is_defaultboolean

Indicates if the Payment Method is the Client's default Payment Method

verification_statusstring

Status of the verification for the Payment Method

is_activeboolean

Determines if the Payment Method is active

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions:

  • an UserException with Abort Transaction = Yes, and a Log Error = No
  • an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

Example response

{
  "id": 1234567891234567,
  "client_id": 1234567891234567,
  "owner_client_id": 1234567891234567,
  "shared_payment_method_id": 1234567891234567,
  "payment_account_type_id": 1234567891234567,
  "expiration_date": "2014-12-31",
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "shared_clients": [
    {
      "client_id": 1234567891234567
    }
  ]
}