VE BankingDeveloper guide
API reference
Browse documentation

Look up and reverse payments

Reconcile by gateway ID or correlation reference, and reverse eligible C2P payments.

Payment lookup

By payment IDbash
curl "${API_URL}/v1/payments/PAYMENT_ID" \
  --header "x-api-key: ${VE_BANKING_API_KEY}"
By external referencebash
curl "${API_URL}/v1/payments/by-ref/order_demo_1042" \
  --header "x-api-key: ${VE_BANKING_API_KEY}"

Reverse a C2P payment

POST /v1/payments/:id/reverse is supported for C2P payments only. Banking-network rules and payment state determine whether a reversal can complete.

curlbash
curl --request POST "${API_URL}/v1/payments/PAYMENT_ID/reverse" \
  --header "x-api-key: ${VE_BANKING_API_KEY}"

Payment statuses

StatusMeaningNext action
PENDINGIntent created or operation awaiting completionWait for execution or reconcile by payment ID.
COMPLETEDThe banking network confirmed the paymentFulfill once your business checks pass.
FAILEDThe charge or verification failedInspect failureCode and decide whether to ask for corrected details.
REVERSEDA completed C2P payment was reversedUpdate the order and preserve reversal references.