[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator

OrgPaymentMethods

Defines the properties of the org payment method.


Properties

commitAggregate Optional

Defines the properties of the Aggregate Commit Contract.


commitContracts Optional

Defines the properties of the Org commit contract item.


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.


payByInvoiceAccounts Optional

Defines the properties of the org payment by invoice item.

JSON Example

{
    "OrgPaymentMethods": {
        "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": "..."
            }
        ]
    },
    "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": "..."
        }
    ]
}
[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
Returned By

Get Payment Method

Feedback

Was this page helpful?