Skip to main content
POST
/
payments
/
{externalReferenceNo}
/
cancel
cURL
curl --request POST \
  --url https://api.dev.ecos.gcservices.io/payments/payment-order/v1/payments/{externalReferenceNo}/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "identification": "XYZ1234567890",
  "uetr": "AB1234567890CDEF1234567890ABCDEF",
  "etoeIdentification": "1234567890abcdef1234567890abcdef",
  "cancellationType": "SINGLE_PAYMENT_INSTANCE",
  "noOfInstances": "7"
}
'
{
  "reasonDescription": "Account number invalid or does not exist",
  "reasonCode": "AC01",
  "status": "failure"
}

Headers

​
Idempotent-Request-Key
string

Idempotent Request Key.

​
Timestamp
string<date-time>

Timestamp.

​
Used-Mechanism
string

Type of the payment.

Path Parameters

​
externalReferenceNo
string
required

Payment transaction ID.

Body

application/json
​
identification
string

An identifier that allows to uniquely refer to a payment transaction.

Example:

"XYZ1234567890"

​
uetr
string

Universally unique identifier to provide an end-to-end reference of a payment transaction.

Example:

"AB1234567890CDEF1234567890ABCDEF"

​
etoeIdentification
string

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

Example:

"1234567890abcdef1234567890abcdef"

​
cancellationType
enum<string>

Defines the the cancellation type that user wants can be anything from single to multiple instances

Available options:
SINGLE_PAYMENT_INSTANCE,
MULTIPLE_PAYMENT_INSTANCE,
COMPLETE_SCHEDULE
​
noOfInstances
string

Relevant in case user wants to cancel multiple upcoming payments.

Example:

"7"

Response

OK.

​
status
string

The status of the transaction.

Example:

"failure"

​
reasonCode
string

Reason code that connecting system accepted/rejected the payment.

Example:

"AC01"

​
reasonDescription
string

Human readable reason the core banking system accepted/rejected the payment or batch.

Example:

"Account number invalid or does not exist"