[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
Get Payment Method
DescriptionRetrieve details about the payment method of a specified provider organization.
Request
URLURL
https://console.navigator.vmware.com/cphub/api/core/v1/mgmt/orgs/{orgId}/payment-methods
Path Parameters
Path Parameters
string
orgId
Required
- ID of the MSP organization in CSP.
Parameter Serialization Style:
simple
Header Parameters
Header Parameters
string
csp-auth-token
Optional
- Access token generated from refresh token for authentication.
Parameter Serialization Style:
simple
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
OrgPaymentMethods
of type */*
{
"commitAggregate": [
{
"aggregateId": "...",
"commitContracts": [
{
"contractId": "...",
"contractNumber": "...",
"contractRefNumber": "...",
"contractSku": "...",
"contractType": "...",
"country": "...",
"currency": "...",
"defaultFlag": true,
"description": "...",
"endDate": 12345,
"isValid": true,
"minimumCommitment": 12345,
"mspId": "...",
"mspName": "...",
"paymentMethodId": "...",
"salesContactEmail": "...",
"salesContactFirstName": "...",
"salesContactLastName": "...",
"startDate": 12345,
"valid": true
},
{
"contractId": "...",
"contractNumber": "...",
"contractRefNumber": "...",
"contractSku": "...",
"contractType": "...",
"country": "...",
"currency": "...",
"defaultFlag": true,
"description": "...",
"endDate": 12345,
"isValid": true,
"minimumCommitment": 12345,
"mspId": "...",
"mspName": "...",
"paymentMethodId": "...",
"salesContactEmail": "...",
"salesContactFirstName": "...",
"salesContactLastName": "...",
"startDate": 12345,
"valid": true
}
],
"defaultFlag": true,
"enableFlag": true,
"isValid": true,
"paymentMethodId": "...",
"valid": true
},
{
"aggregateId": "...",
"commitContracts": [
{
"contractId": "...",
"contractNumber": "...",
"contractRefNumber": "...",
"contractSku": "...",
"contractType": "...",
"country": "...",
"currency": "...",
"defaultFlag": true,
"description": "...",
"endDate": 12345,
"isValid": true,
"minimumCommitment": 12345,
"mspId": "...",
"mspName": "...",
"paymentMethodId": "...",
"salesContactEmail": "...",
"salesContactFirstName": "...",
"salesContactLastName": "...",
"startDate": 12345,
"valid": true
},
{
"contractId": "...",
"contractNumber": "...",
"contractRefNumber": "...",
"contractSku": "...",
"contractType": "...",
"country": "...",
"currency": "...",
"defaultFlag": true,
"description": "...",
"endDate": 12345,
"isValid": true,
"minimumCommitment": 12345,
"mspId": "...",
"mspName": "...",
"paymentMethodId": "...",
"salesContactEmail": "...",
"salesContactFirstName": "...",
"salesContactLastName": "...",
"startDate": 12345,
"valid": true
}
],
"defaultFlag": true,
"enableFlag": true,
"isValid": true,
"paymentMethodId": "...",
"valid": true
}
],
"commitContracts": [
{
"contractId": "...",
"contractNumber": "...",
"contractRefNumber": "...",
"contractSku": "...",
"contractType": "...",
"country": "...",
"currency": "...",
"defaultFlag": true,
"description": "...",
"endDate": 12345,
"isValid": true,
"minimumCommitment": 12345,
"mspId": "...",
"mspName": "...",
"paymentMethodId": "...",
"salesContactEmail": "...",
"salesContactFirstName": "...",
"salesContactLastName": "...",
"startDate": 12345,
"valid": true
},
{
"contractId": "...",
"contractNumber": "...",
"contractRefNumber": "...",
"contractSku": "...",
"contractType": "...",
"country": "...",
"currency": "...",
"defaultFlag": true,
"description": "...",
"endDate": 12345,
"isValid": true,
"minimumCommitment": 12345,
"mspId": "...",
"mspName": "...",
"paymentMethodId": "...",
"salesContactEmail": "...",
"salesContactFirstName": "...",
"salesContactLastName": "...",
"startDate": 12345,
"valid": true
}
],
"creditCards": [
{
"currency": "...",
"customerNumber": "...",
"defaultFlag": true,
"expiryMonth": "...",
"expiryYear": "...",
"firstName": "...",
"lastFourDigits": "...",
"lastName": "...",
"nameOnCard": "...",
"nickName": "...",
"paymentOptionId": "...",
"shopperId": "..."
},
{
"currency": "...",
"customerNumber": "...",
"defaultFlag": true,
"expiryMonth": "...",
"expiryYear": "...",
"firstName": "...",
"lastFourDigits": "...",
"lastName": "...",
"nameOnCard": "...",
"nickName": "...",
"paymentOptionId": "...",
"shopperId": "..."
}
],
"funds": [
{
"balance": "...",
"currency": "...",
"customerNumber": "...",
"defaultFlag": true,
"eaName": "...",
"eaNumber": "...",
"fundGroupExpirationDate": "...",
"fundGroupId": "...",
"fundGroupName": "...",
"fundList": [
{
"fundBalance": "...",
"fundEndDate": "...",
"fundId": "...",
"fundStatus": "...",
"fundType": "...",
"fundTypeDescription": "..."
},
{
"fundBalance": "...",
"fundEndDate": "...",
"fundId": "...",
"fundStatus": "...",
"fundType": "...",
"fundTypeDescription": "..."
}
],
"fundSetterCustomerNumber": "..."
},
{
"balance": "...",
"currency": "...",
"customerNumber": "...",
"defaultFlag": true,
"eaName": "...",
"eaNumber": "...",
"fundGroupExpirationDate": "...",
"fundGroupId": "...",
"fundGroupName": "...",
"fundList": [
{
"fundBalance": "...",
"fundEndDate": "...",
"fundId": "...",
"fundStatus": "...",
"fundType": "...",
"fundTypeDescription": "..."
},
{
"fundBalance": "...",
"fundEndDate": "...",
"fundId": "...",
"fundStatus": "...",
"fundType": "...",
"fundTypeDescription": "..."
}
],
"fundSetterCustomerNumber": "..."
}
],
"payByInvoiceAccounts": [
{
"accountName": "...",
"customerNumber": "...",
"defaultFlag": true,
"eaNumber": "...",
"invalidityDetailsList": [
{
"error": "...",
"errorCode": "PBI_DISABLED"
},
{
"error": "...",
"errorCode": "FUND_EXPIRED"
}
],
"isValid": true,
"paymentOptionId": "..."
},
{
"accountName": "...",
"customerNumber": "...",
"defaultFlag": true,
"eaNumber": "...",
"invalidityDetailsList": [
{
"error": "...",
"errorCode": "PBI_DISABLED"
},
{
"error": "...",
"errorCode": "PBI_NOT_ACTIVE"
}
],
"isValid": true,
"paymentOptionId": "..."
}
]
}
array of
AggregateCommitContract
commitAggregate
Optional
Defines the properties of the Aggregate Commit Contract.
array of
OrgCommitContractItem
commitContracts
Optional
Defines the properties of the Org commit contract item.
array of
OrgCreditCardItem
creditCards
Optional
Defines the properties of the org credit card item.
array of
OrgFundGroupItem
funds
Optional
Defines the properties of the org fund group item.
array of
OrgPayByInvoiceItem
payByInvoiceAccounts
Optional
Defines the properties of the org payment by invoice item.
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl -H "csp-auth-token: string" https://console.navigator.vmware.com/cphub/api/core/v1/mgmt/orgs/{orgId}/payment-methods
[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
On This Page
Lifecycle Management Operations
post
post
patch
get
get
put
