Payment Methods

Get payee payment methods

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

GET

/gl/payee/payment-methods

curl --request GET \
  --url 'https://api.catch-e.com/gl/payee/payment-methods?process_type=item&payee_id=%3Cstring%3E&payment_method_id=%3Cstring%3E&status_flag=active&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "gl_payee_payment_methods": [
      {
        "_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"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/gl/payee/payment-methods"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

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

Query Parameters

process_typeenum<string>queryrequired

Process type

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

payee_idstringquery

Payee Id

Maximum string length: 20

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

payment_method_idstringquery

Payment method Id

Maximum string length: 20

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

status_flagenum<string>querydefault:active

Status flag

Available options: active, inactive

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team