Cancel a payment request

post https://api.sandbox.directdebit.belvo.com/payment_requests/{paymentRequestId}/cancel

Cancel a payment request.

📘
Info
You can only cancel a payment request when the status is in the initial state.

Responses

Response body

object

string

The unique identifier created by Belvo used to reference the payment request.

createdDate

date-time | null

The ISO-8601 timestamp when the payment request was created in Belvo's database.

lastUpdatedDate

date-time | null

The ISO-8601 timestamp when information regarding the payment request was last updated.

status

string

The status of the payment request. Can be either:

initial

The payment request has been created.
processing

The charge files have been generated for the payment request. Awaiting response from the financial institution.
successful

The financial institution has confirmed the payment request and the funds have been transferred.
failed

The financial institution has reported an error for the payment request and no funds have been transferred.
canceled

The request was canceled. This is only possible if the payment request has not transitioned to the processing status.

initial processing successful failed canceled

failedReason

string | null

The financial institution's failure code.

failedReasonMessage

string | null

The financial institution's failure message, describing the reason for the failure.

amount

string

The amount to debit from the customer.

currency

string

The three-letter ISO 4217 currency code of the transaction. At the moment, we only support mxn.

mxn

customer

string

The unique identifier created by Belvo used to reference the customer.

customerName

string

The name of the customer.

reference

string

length between 1 and 160

A reference for the payment request.

paymentMethod

object

type

string

The type of account. For Mexico, this value is set to bank_account.

bank_account

details

object

Details regarding the bank account associated with the payment method.

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.sandbox.directdebit.belvo.com/payment_requests/paymentRequestId/cancel \
3
     --header 'accept: application/json'


xxxxxxxxxx
21
 
1
{
2
  "id": "0d1a377b-b4c5-4a94-9e2e-83e59d1f6a9c",
3
  "createdDate": "2022-02-09T08:45:50.406032Z",
4
  "lastUpdatedDate": "2022-02-09T08:45:50.406032Z",
5
  "status": "processing",
6
  "failedReason": null,
7
  "failedReasonMessage": null,
8
  "amount": "100000.00",
9
  "currency": "mxn",
10
  "customer": "3118128a-6792-4b06-bd61-4acf6f6ad6b5",
11
  "customerName": "Carlos Vives",
12
  "reference": "Monthly gym subscription",
13
  "paymentMethod": {
14
    "type": "bank_account",
15
    "details": {
16
      "accountNumber": "445566790",
17
      "accountType": "savings",
18
      "bank": "mx_citi_banamex"
19
    }
20
  }
21
}

201Created

400Bad Request

401Unauthorized

404Not Found