Merchant Boarding API Specification

Merchant Boarding API

Agent

Agent related information.

patch /application/agent-assign/key/{externalKey}

Update agent related information by application external key.

Parameters

externalKey required

Type

string

Pattern

^(?!.*/).*$

Range

1 to 50 characters

Example

0aa000a-000a-00a0-00a0-00000aa00a0

Request Schema

agent required

Type

integer

Example

11111

Example Request

{
  "agent": 11111
}

Example Response

200 Return updated enrollment application.

403 Forbidden response.

404 Application not found error response.

415 Invalid content type.

422 Validation errors.

500 Internal Server Error response.

get /enroll/agent/{agentId}/group/list

Get a list of all agent groups by agent ID.

Parameters

agentId required

Type

integer

Example

12345

Example Response

200 Returns a list of all agent group related details.

403 Invalid agent client affiliation response.

422 Unprocessable entity error response.

500 Internal server error response.