---
title: Update Status of Payment Method Token
slug: api/update-status-of-payment-method-token
docTags:
createdAt: 2025-01-06T23:43:35.319Z
---
{
"id": "-FN0H9jpaiRFhPF661MyM",
"type": "api-oas-v2",
"data": {
"method": "PATCH",
"url": "https://sand-api.monoova.com/au/card/ccm/PaymentMethodToken/{customerId}/{clientPaymentTokenUniqueReference}",
"servers": [
{
"url": "https://sand-api.monoova.com/au/card/ccm/PaymentMethodToken/{customerId}/{clientPaymentTokenUniqueReference}",
"description": "Sandbox URL"
},
{
"url": "https://api.monoova.com/au/card/ccm/PaymentMethodToken/{customerId}/{clientPaymentTokenUniqueReference}",
"description": "Production URL"
}
],
"name": "Update Status of Payment Method Token",
"description": "This endpoint can be used to update the status of a paymentMethodToken.",
"contentType": "application/json-patch+json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "customerId",
"type": "string",
"description": "Customer ID as specified in Credit Card - Generate Client Session.
"
},
{
"kind": "required",
"name": "clientPaymentTokenUniqueReference",
"type": "string",
"description": "Client Payment Token Unique Reference as specified in Credit Card - Generate Client Session.
"
}
],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "optional",
"name": "body",
"type": "object",
"description": "",
"customType": "UpdatePaymentMethodTokenStatusDto",
"schema": [
{
"name": "status",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "The new status to which the paymentMethodToken should be changed.",
"enum": [
"Active",
"Paused",
"Deleted"
]
}
],
"modelRef": "#/components/schemas/UpdatePaymentMethodTokenStatusDto",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "BearerAuth",
"name": "BearerAuth",
"kind": "optional",
"type": "http",
"scheme": "bearer"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "OK",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "UpdatePaymentMethodTokenStatusResponse",
"schema": [
{
"name": "traceId",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Unique id for logging"
}
],
"modelRef": "#/components/schemas/UpdatePaymentMethodTokenStatusResponse",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad Request",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "traceId",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Unique id for logging"
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"nullable": true,
"description": "",
"modelRef": "#/components/schemas/ErrorDto",
"customType": "ErrorDto[]",
"schema": [
{
"name": "errorCode",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Monoova error code",
"enum": [
"CCM_REQ_BODY_INVALID",
"CCM_REQUEST_EMPTY",
"CCM_VALIDATION_ERROR",
"CCM_ACCTID_REQUIRED",
"CCM_UID_REQUIRED",
"CCM_UID_INVALID",
"CCM_PARENTUID_REQUIRED",
"CCM_PARENTUID_INVALID",
"CCM_CUSTOMER_REQUIRED",
"CCM_DETAILS_REQUIRED",
"CCM_AMOUNT_REQUIRED",
"CCM_AMOUNT_INVALID",
"CCM_CAPTURE_AMOUNT_INVALID",
"CCM_VAULT_AMOUNT_INVALID",
"CCM_AMOUNT_DECIMALS",
"CCM_REF_AMOUNT_DECIMALS",
"CCM_REF_AMOUNT_INVALID",
"CCM_ACCTLIMIT_REQUIRED",
"CCM_ACCTLIMIT_INVALID",
"CCM_REFUND_LIMIT_EXCEEDED",
"CCM_DESC_REQUIRED",
"CCM_DESC_LENGTH",
"CCM_DESC_INVALID",
"CCM_TREF_REQUIRED",
"CCM_TREF_PROHIBITED",
"CCM_TREF_LENGTH",
"CCM_TREF_INVALID",
"CCM_SOS_INVALID",
"CCM_ALLOWCREDIT_INVALID",
"CCM_SURCHARGE_INVALID",
"CCM_CAPTURE_INVALID",
"CCM_REASON_INVALID",
"CCM_SCHEMETYPE_REQUIRED",
"CCM_SCHEMELIST_REQUIRED",
"CCM_SCHEME_REQUIRED",
"CCM_SCHEMETYPE_INVALID",
"CCM_CARDTYPE_INVALID",
"CCM_FEETYPE_REQUIRED",
"CCM_FEETYPE_INVALID",
"CCM_CUSTID_REQUIRED",
"CCM_TOKENREF_REQUIRED",
"CCM_TOKENSTS_REQUIRED",
"CCM_TOKENSTS_INVALID",
"CCM_CUSTID_INVALID",
"CCM_EMAIL_MAXLEN",
"CCM_EMAIL_INVALID",
"CCM_BILLADDR_REQUIRED",
"CCM_FIRSTNAME_REQUIRED",
"CCM_FIRSTNAME_LENGTH",
"CCM_FIRSTNAME_INVALID",
"CCM_LASTNAME_REQUIRED",
"CCM_LASTNAME_LENGTH",
"CCM_LASTNAME_INVALID",
"CCM_STREET_REQUIRED",
"CCM_STREET_MIN_LINES",
"CCM_STREET_MAX_LINES",
"CCM_STREET_INVALID",
"CCM_STREET_LENGTH",
"CCM_SUBURB_REQUIRED",
"CCM_SUBURB_LENGTH",
"CCM_SUBURB_INVALID",
"CCM_STATE_REQUIRED",
"CCM_STATE_LENGTH",
"CCM_STATE_INVALID",
"CCM_POSTCODE_REQUIRED",
"CCM_POSTCODE_LENGTH",
"CCM_POSTCODE_INVALID",
"CCM_COUNTRY_REQUIRED",
"CCM_COUNTRY_INVALID",
"CCM_MRCH_CAT_REQUIRED",
"CCM_MRCH_CAT_INVALID",
"CCM_MRCH_NAME_REQUIRED",
"CCM_MRCH_NAME_LENGTH",
"CCM_MRCH_NAME_INVALID",
"CCM_MRCH_PHONE_LENGTH",
"CCM_MRCH_PHONE_INVALID",
"CCM_MRCH_EMAIL_REQUIRED",
"CCM_MRCH_EMAIL_LENGTH",
"CCM_MRCH_EMAIL_INVALID",
"CCM_MRCH_ADDR_REQUIRED",
"CCM_MRCH_STREET_REQUIRED",
"CCM_MRCH_STREET_LENGTH",
"CCM_MRCH_STREET_INVALID",
"CCM_MRCH_SUBURB_REQUIRED",
"CCM_MRCH_SUBURB_LENGTH",
"CCM_MRCH_SUBURB_INVALID",
"CCM_MRCH_STATE_REQUIRED",
"CCM_MRCH_STATE_NOTFOUND",
"CCM_MRCH_STATE_INVALID",
"CCM_MRCH_POSTCODE_REQUIRED",
"CCM_MRCH_POSTCODE_NOTFOUND",
"CCM_MRCH_POSTCODE_INVALID",
"CCM_MRCH_COUNTRY_REQUIRED",
"CCM_MRCH_COUNTRY_NOTFOUND",
"CCM_WORK_FLOW_LENGTH",
"CCM_CRTD_STARTDATE_REQUIRED",
"CCM_STARTDATE_ACCTID_REQUIRED",
"CCM_STARTDATE_CUSTID_REQUIRED",
"CCM_CRTD_STARTDATE_INVALID",
"CCM_CRTD_ENDDATE_INVALID",
"CCM_CRTD_ENDDATE_PROHIB",
"CCM_PG_SZ_INVALID",
"CCM_PG_NUM_INVALID",
"CCM_BUSINESS_RULE_ERROR",
"CCM_TRN_EXISTS",
"CCM_TRNUID_NOT_FOUND_ERROR",
"CCM_TRN_NOT_FOUND_ERROR",
"CCM_LINK_NOT_FOUND_ERROR",
"CCM_ACC_EXISTS",
"CCM_ACC_NOT_FOUND_ERROR",
"CCM_CM_NOT_FOUND_ERROR",
"CCM_CM_NOT_ACTIVE_ERROR",
"CCM_CM_NOT_COMPLETE_ERROR",
"CCM_ACC_DISABLED_ERROR",
"CCM_ACC_LIMIT_REACHED",
"CCM_TRN_LIMIT_REACHED",
"CCM_PM_DISABLED_ERROR",
"CCM_PM_EXISTS",
"CCM_PM_NOT_FOUND_ERROR",
"CCM_PM_STATUS_INVALID",
"CCM_STATUS_INVALID",
"CCM_DATETYPE_INVALID",
"CCM_TRNTYPE_INVALID",
"CCM_JOB_EXISTS",
"CCM_JOB_NOT_FOUND_ERROR",
"CCM_REF_INVALID_STATUS",
"CCM_REF_EXISTING",
"CCM_REF_TOO_LATE",
"CCM_JOBID_INVALID",
"CCM_MRCH_IND_REQUIRED",
"CCM_SELLERID_LENGTH",
"CCM_PPDAYS_REQUIRED",
"CCM_PPDAYS_INVALID",
"CCM_PCT_PREPAID_REQUIRED",
"CCM_PCT_PREPAID_INVALID",
"CCM_INVALID_DATE_ONLY_STRING",
"CCM_ACC_PM_DISABLED",
"CCM_ACC_FEE_DISABLED",
"CCM_ACC_FEE_NOT_CONFIGURED",
"CCM_CUST_INDEX_REQUIRED",
"CCM_TOKEN_INDEX_REQUIRED",
"CCM_UNHANDLED_TRANSACTION_TYPE",
"CCM_REFUND_NOT_FOUND_ERROR",
"CCM_UPDATE_UNMATCHED_REFUND_DISALLOWED",
"CCM_UPDATE_UNMATCHED_PAYMENT_DISALLOWED",
"CCM_UPDATE_UNMATCHED_SETTLEMENT_ERROR",
"CCM_TRANSACTION_UNIQUE_REFERENCE_REQUIRED_UPDATE_UNMATCHED_SETTLED_PAYMENT_CANCELLATION",
"CCM_PARENT_TRANSACTION_UNIQUE_REFERENCE_REQUIRED_UPDATE_UNMATCHED_SETTLED_REFUND",
"CCM_GPGroupId_REQUIRED_UPDATE_UNMATCHED_SETTLED_REFUND",
"CCM_STATUS_PROHIB",
"CCM_LEDGER_INVALID",
"CCM_LEDGER_REQUIRED",
"CCM_LEDGER_PATTERN",
"CCM_LEDGER_CHECKSUM",
"CCM_LEDGER_NOT_PAYMENT",
"CCM_LEDGER_INVALID_STATUS",
"CCM_ACM_ERROR",
"CCM_ACM_TIMEOUT",
"CCM_CC_GATEWAY_ERROR",
"CCM_CC_GATEWAY_TIMEOUT",
"CCM_MAPPING_ERROR",
"CCM_TRN_CREATE_ERROR",
"CCM_TRN_UPDATE_ERROR",
"CCM_TRNUID_NOT_UNIQUE",
"CCM_TRN_NOT_UNIQUE",
"CCM_ACC_CREATE_ERROR",
"CCM_ACC_UPDATE_ERROR",
"CCM_ACC_UID_NOT_UNIQUE",
"CCM_PM_CREATE_ERROR",
"CCM_PM_UPDATE_ERROR",
"CCM_PM_NOT_UNIQUE",
"CCM_DUPLICATED_SETTLEMENT_CREATE_ERROR",
"CCM_FAILED_TRANSACTION_CREATE_ERROR",
"CCM_EMPTY_BATCH_ID",
"CCM_EMPTY_TRANSACTION_UNIQUE_REFERENCE",
"CCM_EMPTY_SETTLEMENT_ORIGINAL",
"CCM_EMPTY_SETTLEMENT_DUPLICATE",
"CCM_EMPTY_SETTLEMENTS_LIST",
"CCM_JOB_CREATE_ERROR",
"CCM_JOB_UPDATE_ERROR",
"CCM_JOB_EXPIRED",
"CCM_UID_CREATE_ERROR",
"CCM_CC_GWM_ERROR",
"CCM_CC_GWM_TIMEOUT",
"CCM_FUNDS_DECLINED",
"CCM_REFUND_REJECTED",
"CCM_CANCEL_INVALID",
"CCM_UNEXPECTED_ERROR"
]
},
{
"name": "errorMessage",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "More detailed description of the specific error which may include information from the specific request."
},
{
"name": "sourceErrorCode",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Error code from upstream system, if any.
"
},
{
"name": "sourceErrorMessage",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Error message from upstream system, if any.
"
}
]
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "403",
"description": "Forbidden",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "traceId",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Unique id for logging"
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"nullable": true,
"description": "",
"modelRef": "#/components/schemas/ErrorDto",
"customType": "ErrorDto[]",
"schema": [
{
"name": "errorCode",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Monoova error code",
"enum": [
"CCM_REQ_BODY_INVALID",
"CCM_REQUEST_EMPTY",
"CCM_VALIDATION_ERROR",
"CCM_ACCTID_REQUIRED",
"CCM_UID_REQUIRED",
"CCM_UID_INVALID",
"CCM_PARENTUID_REQUIRED",
"CCM_PARENTUID_INVALID",
"CCM_CUSTOMER_REQUIRED",
"CCM_DETAILS_REQUIRED",
"CCM_AMOUNT_REQUIRED",
"CCM_AMOUNT_INVALID",
"CCM_CAPTURE_AMOUNT_INVALID",
"CCM_VAULT_AMOUNT_INVALID",
"CCM_AMOUNT_DECIMALS",
"CCM_REF_AMOUNT_DECIMALS",
"CCM_REF_AMOUNT_INVALID",
"CCM_ACCTLIMIT_REQUIRED",
"CCM_ACCTLIMIT_INVALID",
"CCM_REFUND_LIMIT_EXCEEDED",
"CCM_DESC_REQUIRED",
"CCM_DESC_LENGTH",
"CCM_DESC_INVALID",
"CCM_TREF_REQUIRED",
"CCM_TREF_PROHIBITED",
"CCM_TREF_LENGTH",
"CCM_TREF_INVALID",
"CCM_SOS_INVALID",
"CCM_ALLOWCREDIT_INVALID",
"CCM_SURCHARGE_INVALID",
"CCM_CAPTURE_INVALID",
"CCM_REASON_INVALID",
"CCM_SCHEMETYPE_REQUIRED",
"CCM_SCHEMELIST_REQUIRED",
"CCM_SCHEME_REQUIRED",
"CCM_SCHEMETYPE_INVALID",
"CCM_CARDTYPE_INVALID",
"CCM_FEETYPE_REQUIRED",
"CCM_FEETYPE_INVALID",
"CCM_CUSTID_REQUIRED",
"CCM_TOKENREF_REQUIRED",
"CCM_TOKENSTS_REQUIRED",
"CCM_TOKENSTS_INVALID",
"CCM_CUSTID_INVALID",
"CCM_EMAIL_MAXLEN",
"CCM_EMAIL_INVALID",
"CCM_BILLADDR_REQUIRED",
"CCM_FIRSTNAME_REQUIRED",
"CCM_FIRSTNAME_LENGTH",
"CCM_FIRSTNAME_INVALID",
"CCM_LASTNAME_REQUIRED",
"CCM_LASTNAME_LENGTH",
"CCM_LASTNAME_INVALID",
"CCM_STREET_REQUIRED",
"CCM_STREET_MIN_LINES",
"CCM_STREET_MAX_LINES",
"CCM_STREET_INVALID",
"CCM_STREET_LENGTH",
"CCM_SUBURB_REQUIRED",
"CCM_SUBURB_LENGTH",
"CCM_SUBURB_INVALID",
"CCM_STATE_REQUIRED",
"CCM_STATE_LENGTH",
"CCM_STATE_INVALID",
"CCM_POSTCODE_REQUIRED",
"CCM_POSTCODE_LENGTH",
"CCM_POSTCODE_INVALID",
"CCM_COUNTRY_REQUIRED",
"CCM_COUNTRY_INVALID",
"CCM_MRCH_CAT_REQUIRED",
"CCM_MRCH_CAT_INVALID",
"CCM_MRCH_NAME_REQUIRED",
"CCM_MRCH_NAME_LENGTH",
"CCM_MRCH_NAME_INVALID",
"CCM_MRCH_PHONE_LENGTH",
"CCM_MRCH_PHONE_INVALID",
"CCM_MRCH_EMAIL_REQUIRED",
"CCM_MRCH_EMAIL_LENGTH",
"CCM_MRCH_EMAIL_INVALID",
"CCM_MRCH_ADDR_REQUIRED",
"CCM_MRCH_STREET_REQUIRED",
"CCM_MRCH_STREET_LENGTH",
"CCM_MRCH_STREET_INVALID",
"CCM_MRCH_SUBURB_REQUIRED",
"CCM_MRCH_SUBURB_LENGTH",
"CCM_MRCH_SUBURB_INVALID",
"CCM_MRCH_STATE_REQUIRED",
"CCM_MRCH_STATE_NOTFOUND",
"CCM_MRCH_STATE_INVALID",
"CCM_MRCH_POSTCODE_REQUIRED",
"CCM_MRCH_POSTCODE_NOTFOUND",
"CCM_MRCH_POSTCODE_INVALID",
"CCM_MRCH_COUNTRY_REQUIRED",
"CCM_MRCH_COUNTRY_NOTFOUND",
"CCM_WORK_FLOW_LENGTH",
"CCM_CRTD_STARTDATE_REQUIRED",
"CCM_STARTDATE_ACCTID_REQUIRED",
"CCM_STARTDATE_CUSTID_REQUIRED",
"CCM_CRTD_STARTDATE_INVALID",
"CCM_CRTD_ENDDATE_INVALID",
"CCM_CRTD_ENDDATE_PROHIB",
"CCM_PG_SZ_INVALID",
"CCM_PG_NUM_INVALID",
"CCM_BUSINESS_RULE_ERROR",
"CCM_TRN_EXISTS",
"CCM_TRNUID_NOT_FOUND_ERROR",
"CCM_TRN_NOT_FOUND_ERROR",
"CCM_LINK_NOT_FOUND_ERROR",
"CCM_ACC_EXISTS",
"CCM_ACC_NOT_FOUND_ERROR",
"CCM_CM_NOT_FOUND_ERROR",
"CCM_CM_NOT_ACTIVE_ERROR",
"CCM_CM_NOT_COMPLETE_ERROR",
"CCM_ACC_DISABLED_ERROR",
"CCM_ACC_LIMIT_REACHED",
"CCM_TRN_LIMIT_REACHED",
"CCM_PM_DISABLED_ERROR",
"CCM_PM_EXISTS",
"CCM_PM_NOT_FOUND_ERROR",
"CCM_PM_STATUS_INVALID",
"CCM_STATUS_INVALID",
"CCM_DATETYPE_INVALID",
"CCM_TRNTYPE_INVALID",
"CCM_JOB_EXISTS",
"CCM_JOB_NOT_FOUND_ERROR",
"CCM_REF_INVALID_STATUS",
"CCM_REF_EXISTING",
"CCM_REF_TOO_LATE",
"CCM_JOBID_INVALID",
"CCM_MRCH_IND_REQUIRED",
"CCM_SELLERID_LENGTH",
"CCM_PPDAYS_REQUIRED",
"CCM_PPDAYS_INVALID",
"CCM_PCT_PREPAID_REQUIRED",
"CCM_PCT_PREPAID_INVALID",
"CCM_INVALID_DATE_ONLY_STRING",
"CCM_ACC_PM_DISABLED",
"CCM_ACC_FEE_DISABLED",
"CCM_ACC_FEE_NOT_CONFIGURED",
"CCM_CUST_INDEX_REQUIRED",
"CCM_TOKEN_INDEX_REQUIRED",
"CCM_UNHANDLED_TRANSACTION_TYPE",
"CCM_REFUND_NOT_FOUND_ERROR",
"CCM_UPDATE_UNMATCHED_REFUND_DISALLOWED",
"CCM_UPDATE_UNMATCHED_PAYMENT_DISALLOWED",
"CCM_UPDATE_UNMATCHED_SETTLEMENT_ERROR",
"CCM_TRANSACTION_UNIQUE_REFERENCE_REQUIRED_UPDATE_UNMATCHED_SETTLED_PAYMENT_CANCELLATION",
"CCM_PARENT_TRANSACTION_UNIQUE_REFERENCE_REQUIRED_UPDATE_UNMATCHED_SETTLED_REFUND",
"CCM_GPGroupId_REQUIRED_UPDATE_UNMATCHED_SETTLED_REFUND",
"CCM_STATUS_PROHIB",
"CCM_LEDGER_INVALID",
"CCM_LEDGER_REQUIRED",
"CCM_LEDGER_PATTERN",
"CCM_LEDGER_CHECKSUM",
"CCM_LEDGER_NOT_PAYMENT",
"CCM_LEDGER_INVALID_STATUS",
"CCM_ACM_ERROR",
"CCM_ACM_TIMEOUT",
"CCM_CC_GATEWAY_ERROR",
"CCM_CC_GATEWAY_TIMEOUT",
"CCM_MAPPING_ERROR",
"CCM_TRN_CREATE_ERROR",
"CCM_TRN_UPDATE_ERROR",
"CCM_TRNUID_NOT_UNIQUE",
"CCM_TRN_NOT_UNIQUE",
"CCM_ACC_CREATE_ERROR",
"CCM_ACC_UPDATE_ERROR",
"CCM_ACC_UID_NOT_UNIQUE",
"CCM_PM_CREATE_ERROR",
"CCM_PM_UPDATE_ERROR",
"CCM_PM_NOT_UNIQUE",
"CCM_DUPLICATED_SETTLEMENT_CREATE_ERROR",
"CCM_FAILED_TRANSACTION_CREATE_ERROR",
"CCM_EMPTY_BATCH_ID",
"CCM_EMPTY_TRANSACTION_UNIQUE_REFERENCE",
"CCM_EMPTY_SETTLEMENT_ORIGINAL",
"CCM_EMPTY_SETTLEMENT_DUPLICATE",
"CCM_EMPTY_SETTLEMENTS_LIST",
"CCM_JOB_CREATE_ERROR",
"CCM_JOB_UPDATE_ERROR",
"CCM_JOB_EXPIRED",
"CCM_UID_CREATE_ERROR",
"CCM_CC_GWM_ERROR",
"CCM_CC_GWM_TIMEOUT",
"CCM_FUNDS_DECLINED",
"CCM_REFUND_REJECTED",
"CCM_CANCEL_INVALID",
"CCM_UNEXPECTED_ERROR"
]
},
{
"name": "errorMessage",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "More detailed description of the specific error which may include information from the specific request."
},
{
"name": "sourceErrorCode",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Error code from upstream system, if any.
"
},
{
"name": "sourceErrorMessage",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Error message from upstream system, if any.
"
}
]
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "Not Found",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "traceId",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Unique id for logging"
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"nullable": true,
"description": "",
"modelRef": "#/components/schemas/ErrorDto",
"customType": "ErrorDto[]",
"schema": [
{
"name": "errorCode",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Monoova error code",
"enum": [
"CCM_REQ_BODY_INVALID",
"CCM_REQUEST_EMPTY",
"CCM_VALIDATION_ERROR",
"CCM_ACCTID_REQUIRED",
"CCM_UID_REQUIRED",
"CCM_UID_INVALID",
"CCM_PARENTUID_REQUIRED",
"CCM_PARENTUID_INVALID",
"CCM_CUSTOMER_REQUIRED",
"CCM_DETAILS_REQUIRED",
"CCM_AMOUNT_REQUIRED",
"CCM_AMOUNT_INVALID",
"CCM_CAPTURE_AMOUNT_INVALID",
"CCM_VAULT_AMOUNT_INVALID",
"CCM_AMOUNT_DECIMALS",
"CCM_REF_AMOUNT_DECIMALS",
"CCM_REF_AMOUNT_INVALID",
"CCM_ACCTLIMIT_REQUIRED",
"CCM_ACCTLIMIT_INVALID",
"CCM_REFUND_LIMIT_EXCEEDED",
"CCM_DESC_REQUIRED",
"CCM_DESC_LENGTH",
"CCM_DESC_INVALID",
"CCM_TREF_REQUIRED",
"CCM_TREF_PROHIBITED",
"CCM_TREF_LENGTH",
"CCM_TREF_INVALID",
"CCM_SOS_INVALID",
"CCM_ALLOWCREDIT_INVALID",
"CCM_SURCHARGE_INVALID",
"CCM_CAPTURE_INVALID",
"CCM_REASON_INVALID",
"CCM_SCHEMETYPE_REQUIRED",
"CCM_SCHEMELIST_REQUIRED",
"CCM_SCHEME_REQUIRED",
"CCM_SCHEMETYPE_INVALID",
"CCM_CARDTYPE_INVALID",
"CCM_FEETYPE_REQUIRED",
"CCM_FEETYPE_INVALID",
"CCM_CUSTID_REQUIRED",
"CCM_TOKENREF_REQUIRED",
"CCM_TOKENSTS_REQUIRED",
"CCM_TOKENSTS_INVALID",
"CCM_CUSTID_INVALID",
"CCM_EMAIL_MAXLEN",
"CCM_EMAIL_INVALID",
"CCM_BILLADDR_REQUIRED",
"CCM_FIRSTNAME_REQUIRED",
"CCM_FIRSTNAME_LENGTH",
"CCM_FIRSTNAME_INVALID",
"CCM_LASTNAME_REQUIRED",
"CCM_LASTNAME_LENGTH",
"CCM_LASTNAME_INVALID",
"CCM_STREET_REQUIRED",
"CCM_STREET_MIN_LINES",
"CCM_STREET_MAX_LINES",
"CCM_STREET_INVALID",
"CCM_STREET_LENGTH",
"CCM_SUBURB_REQUIRED",
"CCM_SUBURB_LENGTH",
"CCM_SUBURB_INVALID",
"CCM_STATE_REQUIRED",
"CCM_STATE_LENGTH",
"CCM_STATE_INVALID",
"CCM_POSTCODE_REQUIRED",
"CCM_POSTCODE_LENGTH",
"CCM_POSTCODE_INVALID",
"CCM_COUNTRY_REQUIRED",
"CCM_COUNTRY_INVALID",
"CCM_MRCH_CAT_REQUIRED",
"CCM_MRCH_CAT_INVALID",
"CCM_MRCH_NAME_REQUIRED",
"CCM_MRCH_NAME_LENGTH",
"CCM_MRCH_NAME_INVALID",
"CCM_MRCH_PHONE_LENGTH",
"CCM_MRCH_PHONE_INVALID",
"CCM_MRCH_EMAIL_REQUIRED",
"CCM_MRCH_EMAIL_LENGTH",
"CCM_MRCH_EMAIL_INVALID",
"CCM_MRCH_ADDR_REQUIRED",
"CCM_MRCH_STREET_REQUIRED",
"CCM_MRCH_STREET_LENGTH",
"CCM_MRCH_STREET_INVALID",
"CCM_MRCH_SUBURB_REQUIRED",
"CCM_MRCH_SUBURB_LENGTH",
"CCM_MRCH_SUBURB_INVALID",
"CCM_MRCH_STATE_REQUIRED",
"CCM_MRCH_STATE_NOTFOUND",
"CCM_MRCH_STATE_INVALID",
"CCM_MRCH_POSTCODE_REQUIRED",
"CCM_MRCH_POSTCODE_NOTFOUND",
"CCM_MRCH_POSTCODE_INVALID",
"CCM_MRCH_COUNTRY_REQUIRED",
"CCM_MRCH_COUNTRY_NOTFOUND",
"CCM_WORK_FLOW_LENGTH",
"CCM_CRTD_STARTDATE_REQUIRED",
"CCM_STARTDATE_ACCTID_REQUIRED",
"CCM_STARTDATE_CUSTID_REQUIRED",
"CCM_CRTD_STARTDATE_INVALID",
"CCM_CRTD_ENDDATE_INVALID",
"CCM_CRTD_ENDDATE_PROHIB",
"CCM_PG_SZ_INVALID",
"CCM_PG_NUM_INVALID",
"CCM_BUSINESS_RULE_ERROR",
"CCM_TRN_EXISTS",
"CCM_TRNUID_NOT_FOUND_ERROR",
"CCM_TRN_NOT_FOUND_ERROR",
"CCM_LINK_NOT_FOUND_ERROR",
"CCM_ACC_EXISTS",
"CCM_ACC_NOT_FOUND_ERROR",
"CCM_CM_NOT_FOUND_ERROR",
"CCM_CM_NOT_ACTIVE_ERROR",
"CCM_CM_NOT_COMPLETE_ERROR",
"CCM_ACC_DISABLED_ERROR",
"CCM_ACC_LIMIT_REACHED",
"CCM_TRN_LIMIT_REACHED",
"CCM_PM_DISABLED_ERROR",
"CCM_PM_EXISTS",
"CCM_PM_NOT_FOUND_ERROR",
"CCM_PM_STATUS_INVALID",
"CCM_STATUS_INVALID",
"CCM_DATETYPE_INVALID",
"CCM_TRNTYPE_INVALID",
"CCM_JOB_EXISTS",
"CCM_JOB_NOT_FOUND_ERROR",
"CCM_REF_INVALID_STATUS",
"CCM_REF_EXISTING",
"CCM_REF_TOO_LATE",
"CCM_JOBID_INVALID",
"CCM_MRCH_IND_REQUIRED",
"CCM_SELLERID_LENGTH",
"CCM_PPDAYS_REQUIRED",
"CCM_PPDAYS_INVALID",
"CCM_PCT_PREPAID_REQUIRED",
"CCM_PCT_PREPAID_INVALID",
"CCM_INVALID_DATE_ONLY_STRING",
"CCM_ACC_PM_DISABLED",
"CCM_ACC_FEE_DISABLED",
"CCM_ACC_FEE_NOT_CONFIGURED",
"CCM_CUST_INDEX_REQUIRED",
"CCM_TOKEN_INDEX_REQUIRED",
"CCM_UNHANDLED_TRANSACTION_TYPE",
"CCM_REFUND_NOT_FOUND_ERROR",
"CCM_UPDATE_UNMATCHED_REFUND_DISALLOWED",
"CCM_UPDATE_UNMATCHED_PAYMENT_DISALLOWED",
"CCM_UPDATE_UNMATCHED_SETTLEMENT_ERROR",
"CCM_TRANSACTION_UNIQUE_REFERENCE_REQUIRED_UPDATE_UNMATCHED_SETTLED_PAYMENT_CANCELLATION",
"CCM_PARENT_TRANSACTION_UNIQUE_REFERENCE_REQUIRED_UPDATE_UNMATCHED_SETTLED_REFUND",
"CCM_GPGroupId_REQUIRED_UPDATE_UNMATCHED_SETTLED_REFUND",
"CCM_STATUS_PROHIB",
"CCM_LEDGER_INVALID",
"CCM_LEDGER_REQUIRED",
"CCM_LEDGER_PATTERN",
"CCM_LEDGER_CHECKSUM",
"CCM_LEDGER_NOT_PAYMENT",
"CCM_LEDGER_INVALID_STATUS",
"CCM_ACM_ERROR",
"CCM_ACM_TIMEOUT",
"CCM_CC_GATEWAY_ERROR",
"CCM_CC_GATEWAY_TIMEOUT",
"CCM_MAPPING_ERROR",
"CCM_TRN_CREATE_ERROR",
"CCM_TRN_UPDATE_ERROR",
"CCM_TRNUID_NOT_UNIQUE",
"CCM_TRN_NOT_UNIQUE",
"CCM_ACC_CREATE_ERROR",
"CCM_ACC_UPDATE_ERROR",
"CCM_ACC_UID_NOT_UNIQUE",
"CCM_PM_CREATE_ERROR",
"CCM_PM_UPDATE_ERROR",
"CCM_PM_NOT_UNIQUE",
"CCM_DUPLICATED_SETTLEMENT_CREATE_ERROR",
"CCM_FAILED_TRANSACTION_CREATE_ERROR",
"CCM_EMPTY_BATCH_ID",
"CCM_EMPTY_TRANSACTION_UNIQUE_REFERENCE",
"CCM_EMPTY_SETTLEMENT_ORIGINAL",
"CCM_EMPTY_SETTLEMENT_DUPLICATE",
"CCM_EMPTY_SETTLEMENTS_LIST",
"CCM_JOB_CREATE_ERROR",
"CCM_JOB_UPDATE_ERROR",
"CCM_JOB_EXPIRED",
"CCM_UID_CREATE_ERROR",
"CCM_CC_GWM_ERROR",
"CCM_CC_GWM_TIMEOUT",
"CCM_FUNDS_DECLINED",
"CCM_REFUND_REJECTED",
"CCM_CANCEL_INVALID",
"CCM_UNEXPECTED_ERROR"
]
},
{
"name": "errorMessage",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "More detailed description of the specific error which may include information from the specific request."
},
{
"name": "sourceErrorCode",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Error code from upstream system, if any.
"
},
{
"name": "sourceErrorMessage",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "Error message from upstream system, if any.
"
}
]
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "500",
"description": "Internal Server Error",
"jsonExample": "",
"isExpanded": true
},
{
"statusCode": "502",
"description": "Bad Gateway",
"jsonExample": "",
"isExpanded": true
},
{
"statusCode": "504",
"description": "Gateway Timeout",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "DUDxmpHPNH8TA-_Itkr0n",
"language": "curl",
"label": "cURL",
"code": "curl --request PATCH \\\n --url https://sand-api.monoova.com/au/card/ccm/PaymentMethodToken/{customerId}/{clientPaymentTokenUniqueReference} \\\n --header 'accept: application/json'"
},
{
"id": "zirj0HHXDqGob0Rg2lYZr",
"language": "csharp",
"label": "C#",
"code": "var options = new RestClientOptions(\"https://sand-api.monoova.com\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"/au/card/ccm/PaymentMethodToken/{customerId}/{clientPaymentTokenUniqueReference}\", Method.Patch);\nrequest.AddHeader(\"accept\", \"application/json\");\nrequest.AddHeader(\"content-type\", \"application/json-patch+json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
},
{
"id": "Wa2wRib2H4Z--Fcg1jj2a",
"language": "javascript",
"label": "JavaScript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json-patch+json\");\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/au/card/ccm/PaymentMethodToken/{customerId}/{clientPaymentTokenUniqueReference}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "nUibmV7V5HXRrR4-aISgC",
"language": "php",
"label": "PHP",
"code": " 'https://sand-api.monoova.com/au/card/ccm/PaymentMethodToken/{customerId}/{clientPaymentTokenUniqueReference}',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'PATCH',\n CURLOPT_HTTPHEADER => array(\n 'accept: application/json',\n 'content-type: application/json-patch+json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
}
],
"selectedLanguageId": "DUDxmpHPNH8TA-_Itkr0n"
},
"results": {
"languages": [
{
"id": "CXHOcoNXJCBDm1qvNPL9f",
"language": "200",
"code": "// OK\n{\n \"traceId\": \"\"\n}"
},
{
"id": "70Oz8D0Xcyjd53qrtLNSL",
"language": "400",
"code": "// Bad Request\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"sourceErrorCode\": \"\",\n \"sourceErrorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "KFB46RqTCqyl4PtvTrFqU",
"language": "403",
"code": "// Forbidden\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"sourceErrorCode\": \"\",\n \"sourceErrorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "7r5yvShlBsBWdmWloEqEA",
"language": "404",
"code": "// Not Found\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"sourceErrorCode\": \"\",\n \"sourceErrorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "2Zh3cd9h6O0NHVpG-zZ8S",
"language": "500",
"code": "// Internal Server Error\n"
},
{
"id": "g1zet_fHx6o8OS6yL2gvh",
"language": "502",
"code": "// Bad Gateway\n"
},
{
"id": "oWJHxdG9jHKVDfJMQyL1h",
"language": "504",
"code": "// Gateway Timeout\n"
}
],
"selectedLanguageId": "CXHOcoNXJCBDm1qvNPL9f"
}
},
"children": [
{
"text": ""
}
]
}