Payment Methods

Get Payee Payment method by payee payment method id

This method requires the PayeePaymentMethods:Get permission to be associated with your role.

GET

/gl/payee/payment-methods/{payee_payment_method_id}

curl --request GET \
  --url https://api.catch-e.com/gl/payee/payment-methods/{payee_payment_method_id} \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "gl_payees": {
      "payee": "<string>",
      "payee_id": "<string>",
      "status_flag": "active"
    },
    "gl_payment_methods": {
      "payment_method": "<string>",
      "payment_method_id": "<string>",
      "status_flag": "<string>"
    }
  },
  "payee_id": "<string>",
  "payee_payment_method_id": "<string>",
  "payment_method_id": "<string>",
  "process_type": "item",
  "status_flag": "active"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

payee_payment_method_idstringrequired

Payee Payment method Id

Maximum string length: 20

Pattern: ^[1-9]{1}[0-9]*$

Response

Success

_embeddedobject

Show child attributes

payee_idstring

Payee Id

payee_payment_method_idstring

Payee payment method Id

payment_method_idstring

Payment method Id

process_typeenum<string>

Process type

Available options: item, claim, approval, payment, reg_ctp

status_flagenum<string>default:active

Status flag

Available options: active, inactive

Still need help? Ask the team