AT&T MVNX API

Partially Update a Topup Balance

Version 4.0.0
download iconDownload spec

Endpoint

PATCH
https://serverRoot/tmf-api/prepayBalanceManagement/v4/topupBalance/{msisdn}

This operation partially updates a TopupBalance entity. (TMF 654)

arrowSecurity

oauth2

Get a JWT Token from AT&T's Azure AD
x-amf-settings:
securedBy:
authorizationCode:
scopes:
tokenUrl:https://login.microsoftonline.com/xxxxxxxxxx/oauth2/v2.0/token
authorizationUrl:https://login.microsoftonline.com/xxxxxxxxxx/oauth2/v2.0/token
x-amf-describedBy:
headers:
Authorization:
responses:
200:
body:
application/json:
properties:
token_type:
default:Bearer
example:Bearer
expires_in:
format:int
access_token:
example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
ext_expires_in:
format:int
400:
body:
application/json:
properties:
error:
example:unauthorized_client
trace_id:
example:b82bea2f-5ee3-48a4-9774-4143176a6900
timestamp:
example:2021-06-30 21:12:34Z
error_uri:
example:https://login.microsoftonline.com/error?code=700016
error_codes:
items:
format:int
correlation_id:
example:b57403ef-e775-49f6-b40f-009ba759c301
error_description:
example:AADSTS700016: Application with identifier '6bb2748d-d916-4534-9145-ee8f598d2e01' was not found in the directory 'e741d71c-c6b6-47b0-803c-0f3b32b07556'. This can happen if the application has not been installed by the administrator of the tenant or consented to by any user in the tenant. You may have sent your authentication request to the wrong tenant.\r\nTrace ID: b82bea2f-5ee3-48a4-9774-4143176a6900\r\nCorrelation ID: b57403ef-e775-49f6-b40f-009ba759c301\r\nTimestamp: 2021-06-30 21:12:34Z
arrowRequest

Query Parameters

    Path Parameters

      Header Parameters

                  Body Parameters

                    Responses

                    Success

                    arrowBody

                    application/json

                      REQUEST

                      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
                      curl --request PATCH \
     --url 'https://serverroot/tmf-api/prepayBalanceManagement/v4/topupBalance/string?@type=string' \
     --header 'Accept: string' \
     --header 'Authorization: string' \
     --header 'Content-Length: integer' \
     --header 'X-ATT-ClientId: string' \
     --header 'X-ATT-ConversationId: string' \
     --header 'X-ATT-CorrelationId: string' \
     --header 'content-type: application/json' \
     --data '
{
  "TopupBalance_Update": {
    "airtimeexpiration": "2024-03-14T00:00:00.00Z"
  },
  "TopupBalance_Update_Combined": {
    "isAutoTopup": true,
    "airtimeexpiration": "2024-03-14T00:00:00.00Z",
    "autoRenewExecutionDate": "2024-03-14T00:00:00.00Z"
  },
  "TopupBalance_Update_WithAutoTopup": {
    "isAutoTopup": true,
    "autoRenewExecutionDate": "2024-03-14T00:00:00.00Z"
  }
}
'

                      RESPONSE

                      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
                      {
  "TopupBalanceResponse_Update": {
    "value": {
      "id": "0000000000000000",
      "@type": "ResellerMobileLineAutoTopup",
      "status": "confirmed",
      "logicalResource": {
        "id": "9992220006",
        "@type": "MSISDN",
        "value": "9992220006"
      },
      "airtimeexpiration": "2024-03-14T00:00:00.00Z"
    }
  },
  "TopupBalanceResponse_Update_Combined": {
    "value": {
      "id": "0000000000000000",
      "@type": "ResellerMobileLineAutoTopup",
      "status": "confirmed",
      "isAutoTopup": true,
      "logicalResource": {
        "id": "9992220006",
        "@type": "MSISDN",
        "value": "9992220006"
      },
      "airtimeexpiration": "2024-03-14T00:00:00.00Z",
      "autoRenewExecutionDate": "2024-03-14T00:00:00.00Z"
    }
  },
  "TopupBalanceResponse_Update_WithAutoTopup": {
    "value": {
      "id": "0000000000000000",
      "@type": "ResellerMobileLineAutoTopup",
      "status": "confirmed",
      "isAutoTopup": true,
      "logicalResource": {
        "id": "9992220006",
        "@type": "MSISDN",
        "value": "9992220006"
      },
      "autoRenewExecutionDate": "2024-03-14T00:00:00.00Z"
    }
  }
}