PositivePay

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getPositivePay

post

Retrieve positive pay

Authorizations
Body
PositivePayVendorIndexintegerRequired
Responses
200

Successful operation.

application/json
post
/getPositivePay
POST /nexum/627/2022.01/parameter/getPositivePay HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PositivePayVendorIndex": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PositivePay": {
    "Description": "text",
    "Type": 1,
    "VendorId": "text",
    "VendorIndex": 1,
    "VendorToken": "text",
    "VendorUrl": "text"
  }
}

getPositivePaySelectFields

post

Returns the positive pay with select fields

Authorizations
Body
PositivePayVendorIndexintegerOptional
Responses
200

Successful operation.

application/json
post
/getPositivePaySelectFields
POST /nexum/627/2022.01/parameter/getPositivePaySelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 331

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PositivePayVendorIndex": 1,
  "SelectableFields": {
    "IncludeAllPositivePayFields": true,
    "PositivePayFields": {
      "Description": true,
      "Type": true,
      "VendorId": true,
      "VendorIndex": true,
      "VendorToken": true,
      "VendorUrl": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PositivePay": {
    "Description": "text",
    "Type": 1,
    "VendorId": "text",
    "VendorIndex": 1,
    "VendorToken": "text",
    "VendorUrl": "text"
  }
}

getPositivePayPagedList

post

Returns paged list of positive pay

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPositivePayPagedList
POST /nexum/627/2022.01/parameter/getPositivePayPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PositivePay": [
    {
      "Description": "text",
      "Type": 1,
      "VendorId": "text",
      "VendorIndex": 1,
      "VendorToken": "text",
      "VendorUrl": "text"
    }
  ],
  "Token": "text"
}

getPositivePayListSelectFields

post

Returns the list of positive pay with select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPositivePayListSelectFields
POST /nexum/627/2022.01/parameter/getPositivePayListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 304

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPositivePayFields": true,
    "PositivePayFields": {
      "Description": true,
      "Type": true,
      "VendorId": true,
      "VendorIndex": true,
      "VendorToken": true,
      "VendorUrl": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PositivePayList": {
    "hasReachedMaximumListSize": true,
    "PositivePay": [
      {
        "Description": "text",
        "Type": 1,
        "VendorId": "text",
        "VendorIndex": 1,
        "VendorToken": "text",
        "VendorUrl": "text"
      }
    ]
  }
}

searchPositivePaySelectFields

post

Retrieve a list of select fields for PositivePay settings

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchPositivePaySelectFields
POST /nexum/627/2022.01/parameter/searchPositivePaySelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 336

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPositivePayFields": true,
    "PositivePayFields": {
      "Description": true,
      "Type": true,
      "VendorId": true,
      "VendorIndex": true,
      "VendorToken": true,
      "VendorUrl": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PositivePayList": {
    "hasReachedMaximumListSize": true,
    "PositivePay": [
      {
        "Description": "text",
        "Type": 1,
        "VendorId": "text",
        "VendorIndex": 1,
        "VendorToken": "text",
        "VendorUrl": "text"
      }
    ]
  }
}

getPositivePayPagedListSelectFields

post

Returns paged list of positive pay with select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPositivePayPagedListSelectFields
POST /nexum/627/2022.01/parameter/getPositivePayPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 398

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPositivePayFields": true,
    "PositivePayFields": {
      "Description": true,
      "Type": true,
      "VendorId": true,
      "VendorIndex": true,
      "VendorToken": true,
      "VendorUrl": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PositivePay": [
    {
      "Description": "text",
      "Type": 1,
      "VendorId": "text",
      "VendorIndex": 1,
      "VendorToken": "text",
      "VendorUrl": "text"
    }
  ],
  "Token": "text"
}

searchPositivePayPagedSelectFields

post

Retrieve a paged list of select fields for PositivePay settings

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchPositivePayPagedSelectFields
POST /nexum/627/2022.01/parameter/searchPositivePayPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 413

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPositivePayFields": true,
    "PositivePayFields": {
      "Description": true,
      "Type": true,
      "VendorId": true,
      "VendorIndex": true,
      "VendorToken": true,
      "VendorUrl": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PositivePay": [
    {
      "Description": "text",
      "Type": 1,
      "VendorId": "text",
      "VendorIndex": 1,
      "VendorToken": "text",
      "VendorUrl": "text"
    }
  ],
  "Token": "text"
}

updatePositivePayByID

post

Update positive pay by ID

Authorizations
Body
PositivePayVendorIndexintegerOptional
Responses
200

Successful operation.

application/json
post
/updatePositivePayByID
POST /nexum/627/2022.01/parameter/updatePositivePayByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PositivePayVendorIndex": 1,
  "PositivePayUpdatableFields": {
    "Description": "text",
    "Type": 1,
    "VendorId": "text",
    "VendorToken": "text",
    "VendorUrl": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}
PreviousPmtAppMethodNextPreferenceDefault

Last updated

Was this helpful?