Agreement Management Tutorial

This tutorial will guide you through the steps of creating a new agreement or retrieve an existing agreement.

1

Create An Agreement

In this step, we can create a new agreement. The agreement/create endpoint enables the partner to create a new authorization if there is no prior authorization in place. Client sends either Billing Account Number (BAN) or Foundation Account Number (FAN) and Service Provider AccountId create a new agreement.

Sample Request Data:

Agreement Type
Commercial
Service Type
ACV-Mobile
Agreement Name
ACV-Mobile Agreement
External Reference ID
abcdefghij-1234-5678-abcd-abcdefg1234
BAN
12345678910
Service Provider AccountId
ABCDEF

Send a request to review agreements.

2

Retrieve Agreement

The Agreement Management API enables the partner to inquire if there is a prior authorization. Client sends either Billing Account Number (BAN) or Foundation Account Number (FAN) and Service Provider AccountId to retrieve the existing agreement.

Sample Request Data:

BAN
12345678910
Service Provider AccountId
service_provider_id
Service Type
ACV-Mobile

The response displays the specified agreement and its current status.