Delete source

DELETE/sources/{sourceId}

Request

DELETEhttps://api.tst.au.apgpay.dev/sources/{sourceId}

curl -X DELETE https://api.tst.au.apgpay.dev/sources/{sourceId} \
  -H "Authorization: Bearer $API_KEY"

Remove a stored payment source.

Permissions

Required permission

customerPaymentSources:delete

Requires the `delete` action on `customerPaymentSources` for the supplied runtime context

Path parameters

sourceIdstring

required

Responses

No response body.

Error responses

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}