Payment info

Access to payment info


Parameters

Name In Type Required Description
orgId path string true organization name
accountId path integer(int64) true account identifier

Request example

1
2
3
4
5

curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/paymentinfo \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code Meaning Description Schema
200 OK successful operation PaymentInfo
400 Bad Request Invalid request body ErrorMessage
404 Not Found Resource not found ErrorMessage
405 Method Not Allowed Method not allowed None

200 - instance of PaymentInfo

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "payment_method": "BANK_ACCOUNT",
  "bank_account": {
    "entity": "string",
    "subsidiary": "string",
    "control_digit": "string",
    "number": "string",
    "iban": "string"
  },
  "credit_card": {
    "reference": "string",
    "type_id": 0,
    "number": "string",
    "validity_date": "string"
  }
}
Name Type Required Description
payment_method PaymentMethod false none
bank_account BankAccount false none
credit_card CreditCard false none

Parameters

Name In Type Required Description
orgId path string true organization name
accountId path integer(int64) true account identifier
body body ChangeAccountPaymentInfoRequest true Change payment info for an account

Request body - instance of ChangeAccountPaymentInfoRequest

1
2
3
4
5
6
{
  "entity": "1111",
  "subsidiary": "1111",
  "control_digit": "30",
  "number": "1111111111"
}
Name Type Required Description
entity string true bank entity
subsidiary string true bank subsidiary
control_digit string true control digit
number string true account number

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

curl -X PATCH https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/paymentinfo \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'entity': '1111',
  'subsidiary': '1111',
  'control_digit': '30',
  'number': '1111111111'
}" 

Responses

Code Meaning Description Schema
201 Created successful operation None
400 Bad Request Invalid request body ErrorMessage
404 Not Found Resource not found ErrorMessage
405 Method Not Allowed Method not allowed None

400 - instance of ErrorMessage

Custom schema example

1
2
3
4
5
6
{
  "code": 0,
  "status": "string",
  "message": "string",
  "detailMsg": "string"
}
Name Type Required Description
code integer(int32) false Custom error code
status string false Status
message string false Status message
detailMsg string false Detailed description of the error

Endpoints

Signups

    Users

      Accounts

        Invoices

          Terms

            Payment info

              Account migrations

                Subscriptions

                  Products

                    Services

                      Bonuses

                        Promotions

                          Barrings

                            Consumption

                              Workorders

                                Penalties