Account Management Biz Api

/settlementAccount [POST]

This operation creates a customer's billing profile entity.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

https://[localhost]:[port]/tmf-api/accountManagement/v4/{businessId}/settlementAccount

URL PARAMS

Header

Security Headers

Body

{
  "paymentPlan": [
      {
      "paymentFrequency": "POR ADELANTADO",
      "planType": "MENSUAL",
      "paymentMethod":
        {
          "id": "COBRADOR"
        }
      }
  ],
  "characteristic": [
    {
      "name": "lob",
      "value": "FIXED"
    },
    {
      "name": "billingAddress",
      "value": "1-HG45L"
    }
  ],
  "relatedParty": [
    {
      "id": "1-3GF5A7",
      "role": "customer",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    }
  ]
}

Definitions

Each of the request parameters is detailed.

Characteristic Sub-Resource Table for request.

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[201]

Created - request successful, settlementAccount has been created. Response body may contain an entity corresponding to the created resource.

{
  "id": "1-A87HB",
  "relatedParty": [
    {
      "id": "1-3GF5A7",
      "role": "customer",
      "@type": "RelatedParty",
      "@referredType": "Customer"
    }
  ],
  "@type": "settlementAccount"
}

Definitions

Each of the request parameters is detailed.

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. example is mentioned below.

{
    "errors": [
        {
            "code": 400,
            "message": "CREATE_SETTLEMENTACCOUNT:FAILED",
            "description": "El valor del campo Payment Method del business component Com Invoice Profile no coincide con ningún valor de la lista de selección enlazada PickList Payment Method.(SBL-DAT-00225)."
        }
    ]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method PATCH not allowed for : /{businessId}/settlementAccount"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": ""
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation PATCH /settlementAccount for Business Id: xxxx not implemented"
    }]
  }

/settlementAccount [GET]

This operation retrieves customer's billing profile entities.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

https://[localhost]:[port]/tmf-api/accountManagement/v4/{businessId}/settlementAccount

URL PARAMS

Header

Security Headers

query Parameters

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[200]

OK - settlementAccount request processed successfully. Response body may contain an entity corresponding to the requested resource.

[
    {
        "id": "1-29K8VCO",
        "paymentPlan": [
            {
                "planType": "PAYMENT",
                "paymentMethod": {
                    "id": "CARGO AUTOMATICO"
                }
            }
        ],
        "relatedParty": [
            {
                "id": "1-N2C3HF",
                "role": "customer",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            }
        ],
        "@type": "settlementAccount"
    }
]

Definitions

Each of the request parameters is detailed.

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. example is mentioned below.

{
    "errors": [
        {
            "code": 400,
            "message": "APIKIT:BAD_REQUEST",
            "description": "/relatedParty/0 required key [id] not found"
        }
    ]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method PATCH not allowed for : /{businessId}/settlementAccount"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": ""
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation PATCH /settlementAccount for Business Id: xxxx not implemented"
    }]
  }

####